From 30193215cfb4a9325c5a1b67d5b51abf5056be8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 15 Nov 2021 12:28:38 +0100 Subject: [PATCH] classref: Sync with latest 4.0-dev --- classes/class_@gdscript.rst | 19 +- classes/class_@globalscope.rst | 112 +- classes/class_aabb.rst | 133 +- classes/class_acceptdialog.rst | 6 +- classes/class_aescontext.rst | 2 +- classes/class_animatablebody2d.rst | 2 +- classes/class_animatablebody3d.rst | 2 +- classes/class_animatedsprite2d.rst | 2 +- classes/class_animatedsprite3d.rst | 2 +- classes/class_animatedtexture.rst | 2 +- classes/class_animation.rst | 150 +- classes/class_animationnode.rst | 6 +- classes/class_animationnodeadd2.rst | 2 +- classes/class_animationnodeadd3.rst | 2 +- classes/class_animationnodeanimation.rst | 41 +- classes/class_animationnodeblend2.rst | 2 +- classes/class_animationnodeblend3.rst | 2 +- classes/class_animationnodeblendspace1d.rst | 2 +- classes/class_animationnodeblendspace2d.rst | 2 +- classes/class_animationnodeblendtree.rst | 2 +- classes/class_animationnodeoneshot.rst | 2 +- classes/class_animationnodeoutput.rst | 2 +- classes/class_animationnodestatemachine.rst | 2 +- ...lass_animationnodestatemachineplayback.rst | 2 +- ...ss_animationnodestatemachinetransition.rst | 2 +- classes/class_animationnodetimescale.rst | 2 +- classes/class_animationnodetimeseek.rst | 2 +- classes/class_animationnodetransition.rst | 2 +- classes/class_animationplayer.rst | 2 +- classes/class_animationrootnode.rst | 2 +- classes/class_animationtrackeditplugin.rst | 2 +- classes/class_animationtree.rst | 6 +- classes/class_area2d.rst | 222 +- classes/class_area3d.rst | 252 ++- classes/class_array.rst | 260 +-- classes/class_arraymesh.rst | 2 +- classes/class_aspectratiocontainer.rst | 2 +- classes/class_astar.rst | 2 +- classes/class_astar2d.rst | 2 +- classes/class_atlastexture.rst | 2 +- classes/class_audiobuslayout.rst | 2 +- classes/class_audioeffect.rst | 2 +- classes/class_audioeffectamplify.rst | 2 +- classes/class_audioeffectbandlimitfilter.rst | 2 +- classes/class_audioeffectbandpassfilter.rst | 2 +- classes/class_audioeffectcapture.rst | 2 +- classes/class_audioeffectchorus.rst | 2 +- classes/class_audioeffectcompressor.rst | 2 +- classes/class_audioeffectdelay.rst | 2 +- classes/class_audioeffectdistortion.rst | 2 +- classes/class_audioeffecteq.rst | 2 +- classes/class_audioeffecteq10.rst | 2 +- classes/class_audioeffecteq21.rst | 2 +- classes/class_audioeffecteq6.rst | 2 +- classes/class_audioeffectfilter.rst | 2 +- classes/class_audioeffecthighpassfilter.rst | 2 +- classes/class_audioeffecthighshelffilter.rst | 2 +- classes/class_audioeffectinstance.rst | 2 +- classes/class_audioeffectlimiter.rst | 2 +- classes/class_audioeffectlowpassfilter.rst | 2 +- classes/class_audioeffectlowshelffilter.rst | 2 +- classes/class_audioeffectnotchfilter.rst | 2 +- classes/class_audioeffectpanner.rst | 2 +- classes/class_audioeffectphaser.rst | 2 +- classes/class_audioeffectpitchshift.rst | 2 +- classes/class_audioeffectrecord.rst | 2 +- classes/class_audioeffectreverb.rst | 2 +- classes/class_audioeffectspectrumanalyzer.rst | 2 +- ...ss_audioeffectspectrumanalyzerinstance.rst | 2 +- classes/class_audioeffectstereoenhance.rst | 2 +- classes/class_audiolistener2d.rst | 2 +- classes/class_audiolistener3d.rst | 2 +- classes/class_audioserver.rst | 2 +- classes/class_audiostream.rst | 2 +- classes/class_audiostreamgenerator.rst | 2 +- .../class_audiostreamgeneratorplayback.rst | 2 +- classes/class_audiostreammicrophone.rst | 2 +- classes/class_audiostreammp3.rst | 2 +- classes/class_audiostreamoggvorbis.rst | 2 +- classes/class_audiostreamplayback.rst | 2 +- .../class_audiostreamplaybackoggvorbis.rst | 2 +- .../class_audiostreamplaybackresampled.rst | 2 +- classes/class_audiostreamplayer.rst | 2 +- classes/class_audiostreamplayer2d.rst | 2 +- classes/class_audiostreamplayer3d.rst | 4 +- classes/class_audiostreamrandompitch.rst | 2 +- classes/class_audiostreamsample.rst | 6 +- classes/class_backbuffercopy.rst | 2 +- classes/class_basebutton.rst | 50 +- classes/class_basematerial3d.rst | 2 +- classes/class_basis.rst | 298 +-- classes/class_bitmap.rst | 4 +- classes/class_bone2d.rst | 2 +- classes/class_boneattachment3d.rst | 2 +- classes/class_bool.rst | 102 +- classes/class_boxcontainer.rst | 2 +- classes/class_boxmesh.rst | 2 +- classes/class_boxshape3d.rst | 2 +- classes/class_button.rst | 30 +- classes/class_buttongroup.rst | 2 +- classes/class_callable.rst | 162 +- classes/class_callbacktweener.rst | 2 +- classes/class_camera2d.rst | 2 +- classes/class_camera3d.rst | 2 +- classes/class_cameraeffects.rst | 2 +- classes/class_camerafeed.rst | 2 +- classes/class_cameraserver.rst | 2 +- classes/class_cameratexture.rst | 2 +- classes/class_canvasgroup.rst | 2 +- classes/class_canvasitem.rst | 14 +- classes/class_canvasitemmaterial.rst | 2 +- classes/class_canvaslayer.rst | 2 +- classes/class_canvasmodulate.rst | 2 +- classes/class_canvastexture.rst | 2 +- classes/class_capsulemesh.rst | 2 +- classes/class_capsuleshape2d.rst | 2 +- classes/class_capsuleshape3d.rst | 2 +- classes/class_centercontainer.rst | 2 +- classes/class_characterbody2d.rst | 2 +- classes/class_characterbody3d.rst | 2 +- classes/class_charfxtransform.rst | 4 +- classes/class_checkbox.rst | 20 +- classes/class_checkbutton.rst | 16 +- classes/class_circleshape2d.rst | 2 +- classes/class_classdb.rst | 2 +- classes/class_codeedit.rst | 4 +- classes/class_codehighlighter.rst | 2 +- classes/class_collisionobject2d.rst | 2 +- classes/class_collisionobject3d.rst | 2 +- classes/class_collisionpolygon2d.rst | 2 +- classes/class_collisionpolygon3d.rst | 2 +- classes/class_collisionshape2d.rst | 2 +- classes/class_collisionshape3d.rst | 2 +- classes/class_color.rst | 445 ++-- classes/class_colorpicker.rst | 2 +- classes/class_colorpickerbutton.rst | 20 +- classes/class_colorrect.rst | 2 +- classes/class_concavepolygonshape2d.rst | 2 +- classes/class_concavepolygonshape3d.rst | 2 +- classes/class_conetwistjoint3d.rst | 2 +- classes/class_configfile.rst | 2 +- classes/class_confirmationdialog.rst | 4 +- classes/class_container.rst | 2 +- classes/class_control.rst | 14 +- classes/class_convexpolygonshape2d.rst | 2 +- classes/class_convexpolygonshape3d.rst | 2 +- classes/class_cpuparticles2d.rst | 2 +- classes/class_cpuparticles3d.rst | 4 +- classes/class_crypto.rst | 2 +- classes/class_cryptokey.rst | 2 +- classes/class_csgbox3d.rst | 2 +- classes/class_csgcombiner3d.rst | 2 +- classes/class_csgcylinder3d.rst | 2 +- classes/class_csgmesh3d.rst | 2 +- classes/class_csgpolygon3d.rst | 2 +- classes/class_csgprimitive3d.rst | 2 +- classes/class_csgshape3d.rst | 2 +- classes/class_csgsphere3d.rst | 2 +- classes/class_csgtorus3d.rst | 2 +- classes/class_csharpscript.rst | 2 +- classes/class_cubemap.rst | 2 +- classes/class_cubemaparray.rst | 2 +- classes/class_curve.rst | 2 +- classes/class_curve2d.rst | 2 +- classes/class_curve3d.rst | 2 +- classes/class_curvetexture.rst | 2 +- classes/class_curvexyztexture.rst | 2 +- classes/class_cylindermesh.rst | 2 +- classes/class_cylindershape3d.rst | 2 +- classes/class_dampedspringjoint2d.rst | 2 +- classes/class_decal.rst | 2 +- classes/class_dictionary.rst | 106 +- classes/class_directionallight2d.rst | 4 +- classes/class_directionallight3d.rst | 14 +- classes/class_directory.rst | 2 +- classes/class_displayserver.rst | 52 +- classes/class_dtlsserver.rst | 2 +- classes/class_editorcommandpalette.rst | 2 +- classes/class_editordebuggerplugin.rst | 10 +- classes/class_editorexportplugin.rst | 6 +- classes/class_editorfeatureprofile.rst | 2 +- classes/class_editorfiledialog.rst | 4 +- classes/class_editorfilesystem.rst | 2 +- classes/class_editorfilesystemdirectory.rst | 2 +- classes/class_editorimportplugin.rst | 18 +- classes/class_editorinspector.rst | 2 +- classes/class_editorinspectorplugin.rst | 34 +- classes/class_editorinterface.rst | 14 +- classes/class_editornode3dgizmo.rst | 6 +- classes/class_editornode3dgizmoplugin.rst | 6 +- classes/class_editorpaths.rst | 2 +- classes/class_editorplugin.rst | 63 +- classes/class_editorproperty.rst | 64 +- .../class_editorresourceconversionplugin.rst | 2 +- classes/class_editorresourcepicker.rst | 6 +- classes/class_editorresourcepreview.rst | 2 +- .../class_editorresourcepreviewgenerator.rst | 2 +- ...st => class_editorsceneformatimporter.rst} | 83 +- ...=> class_editorsceneformatimporterfbx.rst} | 12 +- ...> class_editorsceneformatimportergltf.rst} | 12 +- classes/class_editorscenepostimport.rst | 2 +- classes/class_editorscenepostimportplugin.rst | 177 ++ classes/class_editorscript.rst | 2 +- classes/class_editorscriptpicker.rst | 2 +- classes/class_editorselection.rst | 2 +- classes/class_editorsettings.rst | 2 +- classes/class_editorspinslider.rst | 2 +- classes/class_editorsyntaxhighlighter.rst | 4 +- .../class_editortranslationparserplugin.rst | 6 +- classes/class_editorvcsinterface.rst | 2 +- classes/class_encodedobjectasid.rst | 2 +- classes/class_enetconnection.rst | 2 +- classes/class_enetmultiplayerpeer.rst | 2 +- classes/class_enetpacketpeer.rst | 2 +- classes/class_engine.rst | 2 +- classes/class_enginedebugger.rst | 2 +- classes/class_environment.rst | 198 +- classes/class_expression.rst | 2 +- classes/class_file.rst | 2 +- classes/class_filedialog.rst | 6 +- classes/class_filesystemdock.rst | 2 +- classes/class_float.rst | 260 +-- classes/class_fogmaterial.rst | 138 ++ classes/class_fogvolume.rst | 86 + classes/class_font.rst | 64 +- classes/class_fontdata.rst | 74 +- classes/class_gdnative.rst | 2 +- classes/class_gdnativelibrary.rst | 2 +- classes/class_gdscript.rst | 2 +- classes/class_generic6dofjoint3d.rst | 2 +- classes/class_geometry2d.rst | 2 +- classes/class_geometry3d.rst | 2 +- classes/class_geometryinstance3d.rst | 126 +- classes/class_gltfaccessor.rst | 2 +- classes/class_gltfanimation.rst | 2 +- classes/class_gltfbufferview.rst | 2 +- classes/class_gltfcamera.rst | 2 +- classes/class_gltfdocument.rst | 2 +- classes/class_gltfdocumentextension.rst | 2 +- ...tfdocumentextensionconvertimportermesh.rst | 2 +- classes/class_gltflight.rst | 2 +- classes/class_gltfmesh.rst | 28 +- classes/class_gltfnode.rst | 2 +- classes/class_gltfskeleton.rst | 2 +- classes/class_gltfskin.rst | 2 +- classes/class_gltfspecgloss.rst | 2 +- classes/class_gltfstate.rst | 2 +- classes/class_gltftexture.rst | 2 +- classes/class_godotsharp.rst | 2 +- classes/class_gpuparticles2d.rst | 2 +- classes/class_gpuparticles3d.rst | 2 +- classes/class_gpuparticlesattractor3d.rst | 2 +- classes/class_gpuparticlesattractorbox.rst | 2 +- classes/class_gpuparticlesattractorsphere.rst | 2 +- ...class_gpuparticlesattractorvectorfield.rst | 2 +- classes/class_gpuparticlescollision3d.rst | 2 +- classes/class_gpuparticlescollisionbox.rst | 2 +- ...class_gpuparticlescollisionheightfield.rst | 2 +- classes/class_gpuparticlescollisionsdf.rst | 2 +- classes/class_gpuparticlescollisionsphere.rst | 2 +- classes/class_gradient.rst | 59 +- ...exture.rst => class_gradienttexture1d.rst} | 32 +- classes/class_gradienttexture2d.rst | 207 ++ classes/class_graphedit.rst | 6 +- classes/class_graphnode.rst | 2 +- classes/class_gridcontainer.rst | 2 +- classes/class_gridmap.rst | 2 +- classes/class_groovejoint2d.rst | 2 +- classes/class_hashingcontext.rst | 2 +- classes/class_hboxcontainer.rst | 2 +- classes/class_heightmapshape3d.rst | 2 +- classes/class_hingejoint3d.rst | 2 +- classes/class_hmaccontext.rst | 2 +- classes/class_hscrollbar.rst | 2 +- classes/class_hseparator.rst | 2 +- classes/class_hslider.rst | 2 +- classes/class_hsplitcontainer.rst | 2 +- classes/class_httpclient.rst | 2 +- classes/class_httprequest.rst | 2 +- classes/class_image.rst | 2 +- classes/class_imagetexture.rst | 2 +- classes/class_imagetexture3d.rst | 2 +- classes/class_imagetexturelayered.rst | 2 +- classes/class_immediatemesh.rst | 2 +- classes/class_importermesh.rst | 2 +- classes/class_importermeshinstance3d.rst | 2 +- classes/class_input.rst | 224 +- classes/class_inputevent.rst | 2 +- classes/class_inputeventaction.rst | 2 +- classes/class_inputeventfromwindow.rst | 2 +- classes/class_inputeventgesture.rst | 2 +- classes/class_inputeventjoypadbutton.rst | 2 +- classes/class_inputeventjoypadmotion.rst | 2 +- classes/class_inputeventkey.rst | 16 +- classes/class_inputeventmagnifygesture.rst | 2 +- classes/class_inputeventmidi.rst | 2 +- classes/class_inputeventmouse.rst | 18 +- classes/class_inputeventmousebutton.rst | 2 +- classes/class_inputeventmousemotion.rst | 2 +- classes/class_inputeventpangesture.rst | 2 +- classes/class_inputeventscreendrag.rst | 4 +- classes/class_inputeventscreentouch.rst | 2 +- classes/class_inputeventshortcut.rst | 2 +- classes/class_inputeventwithmodifiers.rst | 2 +- classes/class_inputmap.rst | 2 +- classes/class_instanceplaceholder.rst | 2 +- classes/class_int.rst | 338 ++- classes/class_intervaltweener.rst | 2 +- classes/class_ip.rst | 2 +- classes/class_itemlist.rst | 32 +- classes/class_javaclass.rst | 2 +- classes/class_javaclasswrapper.rst | 2 +- classes/class_javascript.rst | 2 +- classes/class_javascriptobject.rst | 2 +- classes/class_jnisingleton.rst | 2 +- classes/class_joint2d.rst | 2 +- classes/class_joint3d.rst | 2 +- classes/class_json.rst | 2 +- classes/class_jsonrpc.rst | 2 +- classes/class_kinematiccollision2d.rst | 2 +- classes/class_kinematiccollision3d.rst | 2 +- classes/class_label.rst | 4 +- classes/class_light2d.rst | 2 +- classes/class_light3d.rst | 4 +- classes/class_lightmapgi.rst | 11 +- classes/class_lightmapgidata.rst | 2 +- classes/class_lightmapper.rst | 2 +- classes/class_lightmapperrd.rst | 2 +- classes/class_lightmapprobe.rst | 2 +- classes/class_lightoccluder2d.rst | 2 +- classes/class_line2d.rst | 2 +- classes/class_lineedit.rst | 60 +- classes/class_linkbutton.rst | 16 +- classes/class_mainloop.rst | 2 +- classes/class_margincontainer.rst | 2 +- classes/class_marshalls.rst | 2 +- classes/class_material.rst | 4 +- classes/class_menubutton.rst | 36 +- classes/class_mesh.rst | 2 +- classes/class_meshdatatool.rst | 2 +- classes/class_meshinstance2d.rst | 2 +- classes/class_meshinstance3d.rst | 34 +- classes/class_meshlibrary.rst | 2 +- classes/class_meshtexture.rst | 2 +- classes/class_methodtweener.rst | 2 +- classes/class_mobilevrinterface.rst | 34 +- classes/class_multimesh.rst | 2 +- classes/class_multimeshinstance2d.rst | 2 +- classes/class_multimeshinstance3d.rst | 2 +- classes/class_multiplayerapi.rst | 2 +- classes/class_multiplayerpeer.rst | 2 +- classes/class_multiplayerpeerextension.rst | 2 +- classes/class_multiplayerreplicator.rst | 2 +- classes/class_mutex.rst | 2 +- classes/class_nativeextension.rst | 2 +- classes/class_nativeextensionmanager.rst | 2 +- classes/class_nativescript.rst | 2 +- classes/class_navigationagent2d.rst | 2 +- classes/class_navigationagent3d.rst | 2 +- classes/class_navigationmesh.rst | 6 +- classes/class_navigationmeshgenerator.rst | 2 +- classes/class_navigationobstacle2d.rst | 44 +- classes/class_navigationobstacle3d.rst | 44 +- classes/class_navigationpolygon.rst | 6 +- classes/class_navigationregion2d.rst | 2 +- classes/class_navigationregion3d.rst | 2 +- classes/class_navigationserver2d.rst | 2 +- classes/class_navigationserver3d.rst | 2 +- classes/class_ninepatchrect.rst | 6 +- classes/class_node.rst | 384 ++-- classes/class_node2d.rst | 4 +- classes/class_node3d.rst | 167 +- classes/class_node3dgizmo.rst | 2 +- classes/class_nodepath.rst | 104 +- classes/class_noisetexture.rst | 7 +- classes/class_object.rst | 2 +- classes/class_occluder3d.rst | 2 +- classes/class_occluderinstance3d.rst | 2 +- classes/class_occluderpolygon2d.rst | 2 +- classes/class_oggpacketsequence.rst | 2 +- classes/class_oggpacketsequenceplayback.rst | 2 +- classes/class_omnilight3d.rst | 2 +- classes/class_opensimplexnoise.rst | 2 +- classes/class_optimizedtranslation.rst | 2 +- classes/class_optionbutton.rst | 18 +- classes/class_ormmaterial3d.rst | 2 +- classes/class_os.rst | 42 +- classes/class_packedbytearray.rst | 128 +- classes/class_packedcolorarray.rst | 198 +- classes/class_packeddatacontainer.rst | 2 +- classes/class_packeddatacontainerref.rst | 2 +- classes/class_packedfloat32array.rst | 198 +- classes/class_packedfloat64array.rst | 198 +- classes/class_packedint32array.rst | 198 +- classes/class_packedint64array.rst | 198 +- classes/class_packedscene.rst | 8 +- classes/class_packedstringarray.rst | 198 +- classes/class_packedvector2array.rst | 214 +- classes/class_packedvector3array.rst | 214 +- classes/class_packetpeer.rst | 2 +- classes/class_packetpeerdtls.rst | 2 +- classes/class_packetpeerextension.rst | 2 +- classes/class_packetpeerstream.rst | 2 +- classes/class_packetpeerudp.rst | 2 +- classes/class_panel.rst | 2 +- classes/class_panelcontainer.rst | 2 +- classes/class_panoramaskymaterial.rst | 2 +- classes/class_parallaxbackground.rst | 2 +- classes/class_parallaxlayer.rst | 2 +- classes/class_particlesmaterial.rst | 4 +- classes/class_path2d.rst | 2 +- classes/class_path3d.rst | 2 +- classes/class_pathfollow2d.rst | 2 +- classes/class_pathfollow3d.rst | 2 +- classes/class_pckpacker.rst | 2 +- classes/class_performance.rst | 2 +- classes/class_physicalbone2d.rst | 2 +- classes/class_physicalbone3d.rst | 110 +- classes/class_physicalskymaterial.rst | 2 +- classes/class_physicsbody2d.rst | 8 +- classes/class_physicsbody3d.rst | 8 +- classes/class_physicsdirectbodystate2d.rst | 64 +- classes/class_physicsdirectbodystate3d.rst | 18 +- classes/class_physicsdirectspacestate2d.rst | 78 +- classes/class_physicsdirectspacestate3d.rst | 70 +- classes/class_physicsmaterial.rst | 2 +- .../class_physicspointqueryparameters2d.rst | 140 ++ .../class_physicspointqueryparameters3d.rst | 122 ++ classes/class_physicsrayqueryparameters2d.rst | 158 ++ classes/class_physicsrayqueryparameters3d.rst | 176 ++ classes/class_physicsserver2d.rst | 496 ++--- classes/class_physicsserver3d.rst | 584 ++--- .../class_physicsshapequeryparameters2d.rst | 4 +- .../class_physicsshapequeryparameters3d.rst | 22 +- .../class_physicstestmotionparameters2d.rst | 2 +- .../class_physicstestmotionparameters3d.rst | 2 +- classes/class_physicstestmotionresult2d.rst | 2 +- classes/class_physicstestmotionresult3d.rst | 2 +- classes/class_pinjoint2d.rst | 2 +- classes/class_pinjoint3d.rst | 2 +- classes/class_plane.rst | 200 +- classes/class_planemesh.rst | 2 +- classes/class_pluginscript.rst | 2 +- classes/class_pointlight2d.rst | 4 +- classes/class_pointmesh.rst | 2 +- classes/class_polygon2d.rst | 2 +- classes/class_polygonpathfinder.rst | 2 +- classes/class_popup.rst | 2 +- classes/class_popupmenu.rst | 278 +-- classes/class_popuppanel.rst | 2 +- classes/class_position2d.rst | 2 +- classes/class_position3d.rst | 2 +- classes/class_primitivemesh.rst | 2 +- classes/class_prismmesh.rst | 2 +- classes/class_proceduralskymaterial.rst | 4 +- classes/class_progressbar.rst | 2 +- classes/class_projectsettings.rst | 366 +++- classes/class_propertytweener.rst | 2 +- classes/class_proximitygroup3d.rst | 2 +- classes/class_proxytexture.rst | 2 +- classes/class_quadmesh.rst | 2 +- classes/class_quaternion.rst | 298 +-- classes/class_randomnumbergenerator.rst | 2 +- classes/class_range.rst | 2 +- classes/class_raycast2d.rst | 22 +- classes/class_raycast3d.rst | 22 +- classes/class_rdattachmentformat.rst | 2 +- classes/class_rdframebufferpass.rst | 2 +- classes/class_rdpipelinecolorblendstate.rst | 2 +- ...ss_rdpipelinecolorblendstateattachment.rst | 2 +- classes/class_rdpipelinedepthstencilstate.rst | 2 +- classes/class_rdpipelinemultisamplestate.rst | 2 +- .../class_rdpipelinerasterizationstate.rst | 2 +- ...class_rdpipelinespecializationconstant.rst | 2 +- classes/class_rdsamplerstate.rst | 2 +- classes/class_rdshaderfile.rst | 2 +- classes/class_rdshadersource.rst | 2 +- classes/class_rdshaderspirv.rst | 2 +- classes/class_rdtextureformat.rst | 2 +- classes/class_rdtextureview.rst | 2 +- classes/class_rduniform.rst | 2 +- classes/class_rdvertexattribute.rst | 2 +- classes/class_rect2.rst | 117 +- classes/class_rect2i.rst | 107 +- classes/class_rectangleshape2d.rst | 2 +- classes/class_refcounted.rst | 8 +- classes/class_referencerect.rst | 2 +- classes/class_reflectionprobe.rst | 2 +- classes/class_regex.rst | 2 +- classes/class_regexmatch.rst | 2 +- classes/class_remotetransform2d.rst | 2 +- classes/class_remotetransform3d.rst | 2 +- classes/class_renderingdevice.rst | 6 +- classes/class_renderingserver.rst | 1884 +++++++++-------- classes/class_resource.rst | 4 +- classes/class_resourceformatloader.rst | 2 +- classes/class_resourceformatsaver.rst | 2 +- classes/class_resourceimporter.rst | 2 +- classes/class_resourceloader.rst | 2 +- classes/class_resourcepreloader.rst | 2 +- classes/class_resourcesaver.rst | 2 +- classes/class_resourceuid.rst | 2 +- classes/class_ribbontrailmesh.rst | 2 +- classes/class_richtexteffect.rst | 2 +- classes/class_richtextlabel.rst | 260 +-- classes/class_rid.rst | 102 +- classes/class_rigiddynamicbody2d.rst | 80 +- classes/class_rigiddynamicbody3d.rst | 80 +- classes/class_rootmotionview.rst | 2 +- classes/class_scenestate.rst | 8 +- classes/class_scenetree.rst | 11 +- classes/class_scenetreetimer.rst | 4 +- classes/class_script.rst | 2 +- classes/class_scriptcreatedialog.rst | 2 +- classes/class_scripteditor.rst | 2 +- classes/class_scripteditorbase.rst | 18 +- classes/class_scrollbar.rst | 2 +- classes/class_scrollcontainer.rst | 6 +- classes/class_segmentshape2d.rst | 2 +- classes/class_semaphore.rst | 2 +- classes/class_separationrayshape2d.rst | 2 +- classes/class_separationrayshape3d.rst | 2 +- classes/class_separator.rst | 2 +- classes/class_shader.rst | 32 +- classes/class_shaderglobalsoverride.rst | 2 +- classes/class_shadermaterial.rst | 2 +- classes/class_shape2d.rst | 2 +- classes/class_shape3d.rst | 2 +- classes/class_shapecast2d.rst | 382 ++++ classes/class_shortcut.rst | 2 +- classes/class_signal.rst | 108 +- classes/class_skeleton2d.rst | 2 +- classes/class_skeleton3d.rst | 128 +- classes/class_skeletonik3d.rst | 2 +- classes/class_skeletonmodification2d.rst | 2 +- classes/class_skeletonmodification2dccdik.rst | 2 +- .../class_skeletonmodification2dfabrik.rst | 2 +- .../class_skeletonmodification2djiggle.rst | 2 +- .../class_skeletonmodification2dlookat.rst | 2 +- ...ss_skeletonmodification2dphysicalbones.rst | 2 +- ...lass_skeletonmodification2dstackholder.rst | 2 +- .../class_skeletonmodification2dtwoboneik.rst | 2 +- classes/class_skeletonmodification3d.rst | 2 +- classes/class_skeletonmodification3dccdik.rst | 2 +- .../class_skeletonmodification3dfabrik.rst | 2 +- .../class_skeletonmodification3djiggle.rst | 2 +- .../class_skeletonmodification3dlookat.rst | 2 +- ...lass_skeletonmodification3dstackholder.rst | 2 +- .../class_skeletonmodification3dtwoboneik.rst | 2 +- classes/class_skeletonmodificationstack2d.rst | 2 +- classes/class_skeletonmodificationstack3d.rst | 2 +- classes/class_skin.rst | 2 +- classes/class_skinreference.rst | 2 +- classes/class_sky.rst | 2 +- classes/class_slider.rst | 2 +- classes/class_sliderjoint3d.rst | 2 +- classes/class_softdynamicbody3d.rst | 2 +- classes/class_spheremesh.rst | 2 +- classes/class_sphereshape3d.rst | 2 +- classes/class_spinbox.rst | 4 +- classes/class_splitcontainer.rst | 2 +- classes/class_spotlight3d.rst | 2 +- classes/class_springarm3d.rst | 2 +- classes/class_sprite2d.rst | 2 +- classes/class_sprite3d.rst | 2 +- classes/class_spritebase3d.rst | 2 +- classes/class_spriteframes.rst | 2 +- classes/class_standardmaterial3d.rst | 2 +- classes/class_staticbody2d.rst | 2 +- classes/class_staticbody3d.rst | 2 +- classes/class_streamcubemap.rst | 2 +- classes/class_streamcubemaparray.rst | 2 +- classes/class_streampeer.rst | 2 +- classes/class_streampeerbuffer.rst | 2 +- classes/class_streampeerextension.rst | 2 +- classes/class_streampeerssl.rst | 2 +- classes/class_streampeertcp.rst | 2 +- classes/class_streamtexture2d.rst | 2 +- classes/class_streamtexture2darray.rst | 2 +- classes/class_streamtexture3d.rst | 2 +- classes/class_streamtexturelayered.rst | 2 +- classes/class_string.rst | 262 ++- classes/class_stringname.rst | 80 +- classes/class_stylebox.rst | 2 +- classes/class_styleboxempty.rst | 2 +- classes/class_styleboxflat.rst | 2 +- classes/class_styleboxline.rst | 2 +- classes/class_styleboxtexture.rst | 2 +- classes/class_subviewport.rst | 2 +- classes/class_subviewportcontainer.rst | 2 +- classes/class_surfacetool.rst | 2 +- classes/class_syntaxhighlighter.rst | 2 +- classes/{class_tabs.rst => class_tabbar.rst} | 389 ++-- classes/class_tabcontainer.rst | 4 +- classes/class_tcpserver.rst | 2 +- classes/class_textedit.rst | 68 +- classes/class_textline.rst | 2 +- classes/class_textparagraph.rst | 26 +- classes/class_textserver.rst | 110 +- classes/class_textserveradvanced.rst | 2 +- classes/class_textserverextension.rst | 82 +- classes/class_textserverfallback.rst | 2 +- classes/class_textservermanager.rst | 2 +- classes/class_texture.rst | 2 +- classes/class_texture2d.rst | 4 +- classes/class_texture2darray.rst | 2 +- classes/class_texture3d.rst | 2 +- classes/class_texturebutton.rst | 2 +- classes/class_texturelayered.rst | 2 +- classes/class_textureprogressbar.rst | 2 +- classes/class_texturerect.rst | 2 +- classes/class_theme.rst | 2 +- classes/class_thread.rst | 28 +- classes/class_tiledata.rst | 2 +- classes/class_tilemap.rst | 220 +- classes/class_tilemappattern.rst | 134 ++ classes/class_tileset.rst | 42 +- classes/class_tilesetatlassource.rst | 172 +- .../class_tilesetscenescollectionsource.rst | 2 +- classes/class_tilesetsource.rst | 2 +- classes/class_time.rst | 16 +- classes/class_timer.rst | 6 +- classes/class_touchscreenbutton.rst | 2 +- classes/class_transform2d.rst | 282 +-- classes/class_transform3d.rst | 224 +- classes/class_translation.rst | 2 +- classes/class_translationserver.rst | 2 +- classes/class_tree.rst | 2 +- classes/class_treeitem.rst | 2 +- classes/class_trianglemesh.rst | 2 +- classes/class_tubetrailmesh.rst | 2 +- classes/class_tween.rst | 12 +- classes/class_tweener.rst | 2 +- classes/class_udpserver.rst | 2 +- classes/class_undoredo.rst | 24 +- classes/class_upnp.rst | 2 +- classes/class_upnpdevice.rst | 2 +- classes/class_variant.rst | 2 +- classes/class_vboxcontainer.rst | 2 +- classes/class_vector2.rst | 340 +-- classes/class_vector2i.rst | 354 ++-- classes/class_vector3.rst | 358 ++-- classes/class_vector3i.rst | 376 ++-- classes/class_vehiclebody3d.rst | 2 +- classes/class_vehiclewheel3d.rst | 2 +- classes/class_velocitytracker3d.rst | 2 +- classes/class_videoplayer.rst | 6 +- classes/class_videostream.rst | 4 +- classes/class_videostreamgdnative.rst | 2 +- classes/class_videostreamtheora.rst | 4 +- classes/class_videostreamwebm.rst | 56 - classes/class_viewport.rst | 40 +- classes/class_viewporttexture.rst | 2 +- classes/class_visibleonscreenenabler2d.rst | 2 +- classes/class_visibleonscreenenabler3d.rst | 2 +- classes/class_visibleonscreennotifier2d.rst | 2 +- classes/class_visibleonscreennotifier3d.rst | 2 +- classes/class_visualinstance3d.rst | 4 +- classes/class_visualscript.rst | 2 +- .../class_visualscriptbasictypeconstant.rst | 2 +- classes/class_visualscriptbuiltinfunc.rst | 52 +- classes/class_visualscriptclassconstant.rst | 2 +- classes/class_visualscriptcomment.rst | 2 +- classes/class_visualscriptcomposearray.rst | 2 +- classes/class_visualscriptcondition.rst | 2 +- classes/class_visualscriptconstant.rst | 2 +- classes/class_visualscriptconstructor.rst | 2 +- classes/class_visualscriptcustomnode.rst | 2 +- classes/class_visualscriptcustomnodes.rst | 2 +- classes/class_visualscriptdeconstruct.rst | 2 +- classes/class_visualscriptemitsignal.rst | 2 +- classes/class_visualscriptenginesingleton.rst | 2 +- classes/class_visualscriptexpression.rst | 2 +- classes/class_visualscriptfunction.rst | 2 +- classes/class_visualscriptfunctioncall.rst | 2 +- classes/class_visualscriptfunctionstate.rst | 2 +- classes/class_visualscriptglobalconstant.rst | 2 +- classes/class_visualscriptindexget.rst | 2 +- classes/class_visualscriptindexset.rst | 2 +- classes/class_visualscriptinputaction.rst | 2 +- classes/class_visualscriptiterator.rst | 2 +- classes/class_visualscriptlists.rst | 2 +- classes/class_visualscriptlocalvar.rst | 2 +- classes/class_visualscriptlocalvarset.rst | 2 +- classes/class_visualscriptmathconstant.rst | 2 +- classes/class_visualscriptnode.rst | 2 +- classes/class_visualscriptoperator.rst | 2 +- classes/class_visualscriptpreload.rst | 2 +- classes/class_visualscriptpropertyget.rst | 2 +- classes/class_visualscriptpropertyset.rst | 2 +- classes/class_visualscriptresourcepath.rst | 2 +- classes/class_visualscriptreturn.rst | 2 +- classes/class_visualscriptscenenode.rst | 2 +- classes/class_visualscriptscenetree.rst | 2 +- classes/class_visualscriptselect.rst | 2 +- classes/class_visualscriptself.rst | 2 +- classes/class_visualscriptsequence.rst | 2 +- classes/class_visualscriptsubcall.rst | 2 +- classes/class_visualscriptswitch.rst | 2 +- classes/class_visualscripttypecast.rst | 2 +- classes/class_visualscriptvariableget.rst | 2 +- classes/class_visualscriptvariableset.rst | 2 +- classes/class_visualscriptwhile.rst | 2 +- classes/class_visualscriptyield.rst | 2 +- classes/class_visualscriptyieldsignal.rst | 2 +- classes/class_visualshader.rst | 8 +- classes/class_visualshadernode.rst | 2 +- classes/class_visualshadernodebillboard.rst | 2 +- .../class_visualshadernodebooleanconstant.rst | 2 +- .../class_visualshadernodebooleanuniform.rst | 2 +- classes/class_visualshadernodeclamp.rst | 2 +- .../class_visualshadernodecolorconstant.rst | 2 +- classes/class_visualshadernodecolorfunc.rst | 2 +- classes/class_visualshadernodecolorop.rst | 2 +- .../class_visualshadernodecoloruniform.rst | 2 +- classes/class_visualshadernodecomment.rst | 2 +- classes/class_visualshadernodecompare.rst | 2 +- classes/class_visualshadernodeconstant.rst | 2 +- classes/class_visualshadernodecubemap.rst | 2 +- .../class_visualshadernodecubemapuniform.rst | 2 +- .../class_visualshadernodecurvetexture.rst | 2 +- .../class_visualshadernodecurvexyztexture.rst | 2 +- classes/class_visualshadernodecustom.rst | 60 +- classes/class_visualshadernodedeterminant.rst | 2 +- classes/class_visualshadernodedotproduct.rst | 2 +- classes/class_visualshadernodeexpression.rst | 2 +- classes/class_visualshadernodefaceforward.rst | 2 +- .../class_visualshadernodefloatconstant.rst | 2 +- classes/class_visualshadernodefloatfunc.rst | 2 +- classes/class_visualshadernodefloatop.rst | 2 +- .../class_visualshadernodefloatuniform.rst | 2 +- classes/class_visualshadernodefresnel.rst | 2 +- ...class_visualshadernodeglobalexpression.rst | 2 +- classes/class_visualshadernodegroupbase.rst | 2 +- classes/class_visualshadernodeif.rst | 2 +- classes/class_visualshadernodeinput.rst | 2 +- classes/class_visualshadernodeintconstant.rst | 2 +- classes/class_visualshadernodeintfunc.rst | 2 +- classes/class_visualshadernodeintop.rst | 2 +- classes/class_visualshadernodeintuniform.rst | 2 +- classes/class_visualshadernodeis.rst | 2 +- classes/class_visualshadernodemix.rst | 2 +- classes/class_visualshadernodemultiplyadd.rst | 2 +- .../class_visualshadernodeouterproduct.rst | 2 +- classes/class_visualshadernodeoutput.rst | 2 +- ...ss_visualshadernodeparticleaccelerator.rst | 2 +- ...ass_visualshadernodeparticleboxemitter.rst | 2 +- ...s_visualshadernodeparticleconevelocity.rst | 2 +- .../class_visualshadernodeparticleemit.rst | 2 +- .../class_visualshadernodeparticleemitter.rst | 28 +- ...ss_visualshadernodeparticlemeshemitter.rst | 73 + ...lshadernodeparticlemultiplybyaxisangle.rst | 2 +- .../class_visualshadernodeparticleoutput.rst | 2 +- ...ass_visualshadernodeparticlerandomness.rst | 2 +- ...ss_visualshadernodeparticleringemitter.rst | 2 +- ..._visualshadernodeparticlesphereemitter.rst | 2 +- .../class_visualshadernoderesizablebase.rst | 2 +- classes/class_visualshadernodesample3d.rst | 2 +- ...s_visualshadernodescalarderivativefunc.rst | 2 +- .../class_visualshadernodescreenuvtosdf.rst | 2 +- classes/class_visualshadernodesdfraymarch.rst | 2 +- .../class_visualshadernodesdftoscreenuv.rst | 2 +- classes/class_visualshadernodesmoothstep.rst | 2 +- classes/class_visualshadernodestep.rst | 2 +- classes/class_visualshadernodeswitch.rst | 2 +- classes/class_visualshadernodetexture.rst | 2 +- .../class_visualshadernodetexture2darray.rst | 2 +- ..._visualshadernodetexture2darrayuniform.rst | 2 +- classes/class_visualshadernodetexture3d.rst | 2 +- ...class_visualshadernodetexture3duniform.rst | 2 +- classes/class_visualshadernodetexturesdf.rst | 2 +- ...class_visualshadernodetexturesdfnormal.rst | 2 +- .../class_visualshadernodetextureuniform.rst | 2 +- ...isualshadernodetextureuniformtriplanar.rst | 2 +- ...class_visualshadernodetransformcompose.rst | 2 +- ...lass_visualshadernodetransformconstant.rst | 2 +- ...ass_visualshadernodetransformdecompose.rst | 2 +- .../class_visualshadernodetransformfunc.rst | 2 +- classes/class_visualshadernodetransformop.rst | 2 +- ...class_visualshadernodetransformuniform.rst | 2 +- ...class_visualshadernodetransformvecmult.rst | 2 +- classes/class_visualshadernodeuniform.rst | 2 +- classes/class_visualshadernodeuniformref.rst | 2 +- classes/class_visualshadernodeuvfunc.rst | 2 +- .../class_visualshadernodevec3constant.rst | 2 +- classes/class_visualshadernodevec3uniform.rst | 2 +- .../class_visualshadernodevectorcompose.rst | 2 +- .../class_visualshadernodevectordecompose.rst | 2 +- ...s_visualshadernodevectorderivativefunc.rst | 2 +- .../class_visualshadernodevectordistance.rst | 2 +- classes/class_visualshadernodevectorfunc.rst | 2 +- classes/class_visualshadernodevectorlen.rst | 2 +- classes/class_visualshadernodevectorop.rst | 2 +- .../class_visualshadernodevectorrefract.rst | 2 +- classes/class_voxelgi.rst | 14 +- classes/class_voxelgidata.rst | 2 +- classes/class_vscrollbar.rst | 2 +- classes/class_vseparator.rst | 2 +- classes/class_vslider.rst | 2 +- classes/class_vsplitcontainer.rst | 2 +- classes/class_weakref.rst | 2 +- classes/class_webrtcdatachannel.rst | 2 +- classes/class_webrtcdatachannelextension.rst | 2 +- classes/class_webrtcmultiplayerpeer.rst | 2 +- classes/class_webrtcpeerconnection.rst | 2 +- .../class_webrtcpeerconnectionextension.rst | 2 +- classes/class_websocketclient.rst | 2 +- classes/class_websocketmultiplayerpeer.rst | 2 +- classes/class_websocketpeer.rst | 4 +- classes/class_websocketserver.rst | 2 +- classes/class_webxrinterface.rst | 4 +- classes/class_window.rst | 2 +- classes/class_world2d.rst | 2 +- classes/class_world3d.rst | 2 +- classes/class_worldboundaryshape2d.rst | 2 +- classes/class_worldboundaryshape3d.rst | 2 +- classes/class_worldenvironment.rst | 2 +- classes/class_x509certificate.rst | 2 +- classes/class_xmlparser.rst | 2 +- classes/class_xranchor3d.rst | 77 +- classes/class_xrcamera3d.rst | 2 +- classes/class_xrcontroller3d.rst | 128 +- classes/class_xrinterface.rst | 173 +- classes/class_xrinterfaceextension.rst | 58 +- classes/class_xrnode3d.rst | 122 ++ classes/class_xrorigin3d.rst | 2 +- classes/class_xrpose.rst | 148 ++ classes/class_xrpositionaltracker.rst | 241 ++- classes/class_xrserver.rst | 40 +- 829 files changed, 12891 insertions(+), 7761 deletions(-) rename classes/{class_editorsceneimporter.rst => class_editorsceneformatimporter.rst} (50%) rename classes/{class_editorsceneimporterfbx.rst => class_editorsceneformatimporterfbx.rst} (80%) rename classes/{class_editorsceneimportergltf.rst => class_editorsceneformatimportergltf.rst} (65%) create mode 100644 classes/class_editorscenepostimportplugin.rst create mode 100644 classes/class_fogmaterial.rst create mode 100644 classes/class_fogvolume.rst rename classes/{class_gradienttexture.rst => class_gradienttexture1d.rst} (73%) create mode 100644 classes/class_gradienttexture2d.rst create mode 100644 classes/class_physicspointqueryparameters2d.rst create mode 100644 classes/class_physicspointqueryparameters3d.rst create mode 100644 classes/class_physicsrayqueryparameters2d.rst create mode 100644 classes/class_physicsrayqueryparameters3d.rst create mode 100644 classes/class_shapecast2d.rst rename classes/{class_tabs.rst => class_tabbar.rst} (59%) create mode 100644 classes/class_tilemappattern.rst delete mode 100644 classes/class_videostreamwebm.rst create mode 100644 classes/class_visualshadernodeparticlemeshemitter.rst create mode 100644 classes/class_xrnode3d.rst create mode 100644 classes/class_xrpose.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index cc159bb9f..f5c16939e 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the @GDScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -185,6 +185,8 @@ would print [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}] +**Note:** Not supported for calling from threads. Instead, this will return an empty array. + ---- .. _class_@GDScript_method_inst2dict: @@ -263,7 +265,16 @@ Returns a :ref:`Resource` from the filesystem located at ``path` - void **print_debug** **(** ... **)** |vararg| -Like :ref:`@GlobalScope.print`, but prints only when used in debug mode. +Like :ref:`@GlobalScope.print`, but includes the current stack frame when running with the debugger turned on. + +Output in the console would look something like this: + +:: + + Test print + At: res://test.gd:15:_process() + +**Note:** Not supported for calling from threads. Instead of the stack frame, this will print the thread ID. ---- @@ -271,7 +282,7 @@ Like :ref:`@GlobalScope.print`, but prints only - void **print_stack** **(** **)** -Prints a stack track at code location, only works when running with debugger turned on. +Prints a stack trace at the current code location. Only works when running with debugger turned on. Output in the console would look something like this: @@ -279,6 +290,8 @@ Output in the console would look something like this: Frame 0 - res://test.gd:16 in function '_process' +**Note:** Not supported for calling from threads. Instead of the stack trace, this will print the thread ID. + ---- .. _class_@GDScript_method_range: diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 4750b793e..39e2c61aa 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -181,6 +181,8 @@ Methods +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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 **)** | @@ -431,6 +433,8 @@ enum **InlineAlign**: .. _enum_@GlobalScope_Key: +.. _class_@GlobalScope_constant_KEY_SPECIAL: + .. _class_@GlobalScope_constant_KEY_ESCAPE: .. _class_@GlobalScope_constant_KEY_TAB: @@ -917,6 +921,8 @@ enum **InlineAlign**: enum **Key**: +- **KEY_SPECIAL** = **16777216** --- Keycodes with this bit applied are non-printable. + - **KEY_ESCAPE** = **16777217** --- Escape key. - **KEY_TAB** = **16777218** --- Tab key. @@ -1453,10 +1459,6 @@ enum **KeyModifierMask**: .. _class_@GlobalScope_constant_MOUSE_BUTTON_MIDDLE: -.. _class_@GlobalScope_constant_MOUSE_BUTTON_XBUTTON1: - -.. _class_@GlobalScope_constant_MOUSE_BUTTON_XBUTTON2: - .. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_UP: .. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_DOWN: @@ -1465,6 +1467,10 @@ enum **KeyModifierMask**: .. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_RIGHT: +.. _class_@GlobalScope_constant_MOUSE_BUTTON_XBUTTON1: + +.. _class_@GlobalScope_constant_MOUSE_BUTTON_XBUTTON2: + .. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_LEFT: .. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_RIGHT: @@ -1483,10 +1489,6 @@ enum **MouseButton**: - **MOUSE_BUTTON_MIDDLE** = **3** --- Middle mouse button. -- **MOUSE_BUTTON_XBUTTON1** = **8** --- Extra mouse button 1 (only present on some mice). - -- **MOUSE_BUTTON_XBUTTON2** = **9** --- Extra mouse button 2 (only present on some mice). - - **MOUSE_BUTTON_WHEEL_UP** = **4** --- Mouse wheel up. - **MOUSE_BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down. @@ -1495,6 +1497,10 @@ enum **MouseButton**: - **MOUSE_BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button (only present on some mice). +- **MOUSE_BUTTON_XBUTTON1** = **8** --- Extra mouse button 1 (only present on some mice). + +- **MOUSE_BUTTON_XBUTTON2** = **9** --- Extra mouse button 2 (only present on some mice). + - **MOUSE_BUTTON_MASK_LEFT** = **1** --- Left mouse button mask. - **MOUSE_BUTTON_MASK_RIGHT** = **2** --- Right mouse button mask. @@ -2151,7 +2157,7 @@ Unlike :ref:`PROPERTY_HINT_ENUM` .. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT_INTL: -.. _class_@GlobalScope_constant_PROPERTY_USAGE_NOEDITOR: +.. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_EDITOR: enum **PropertyUsageFlags**: @@ -2219,7 +2225,7 @@ enum **PropertyUsageFlags**: - **PROPERTY_USAGE_DEFAULT_INTL** = **71** --- Default usage for translatable strings (storage, editor, network and internationalized). -- **PROPERTY_USAGE_NOEDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network). +- **PROPERTY_USAGE_NO_EDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network). ---- @@ -2559,13 +2565,6 @@ enum **Variant.Operator**: - **OP_MAX** = **24** --- Represents the size of the :ref:`Variant.Operator` enum. -Constants ---------- - -.. _class_@GlobalScope_constant_SPKEY: - -- **SPKEY** = **16777216** --- Keycodes with this bit applied are non-printable. - Property Descriptions --------------------- @@ -2838,6 +2837,28 @@ Method Descriptions - :ref:`Variant` **abs** **(** :ref:`Variant` x **)** +Returns the absolute value of a :ref:`Variant` parameter ``x`` (i.e. non-negative value). Variant types :ref:`int`, :ref:`float` (real), :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3` and :ref:`Vector3i` are supported. + +:: + + var a = abs(-1) + # a is 1 + + var b = abs(-1.2) + # b is 1.2 + + var c = abs(Vector2(-3.5, -4)) + # c is (3.5, 4) + + var d = abs(Vector2i(-5, -6)) + # d is (5, 6) + + var e = abs(Vector3(-7, 8.5, -3.8)) + # e is (7, 8.5, 3.8) + + var f = abs(Vector3i(-7, -8, -9)) + # f is (7, 8, 9) + ---- .. _class_@GlobalScope_method_absf: @@ -2961,6 +2982,28 @@ See also :ref:`floor`, :ref:`round` **clamp** **(** :ref:`Variant` value, :ref:`Variant` min, :ref:`Variant` max **)** +Clamps the :ref:`Variant` ``value`` and returns a value not less than ``min`` and not more than ``max``. Variant types :ref:`int`, :ref:`float` (real), :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3` and :ref:`Vector3i` are supported. + +:: + + var a = clamp(-10, -1, 5) + # a is -1 + + var b = clamp(8.1, 0.9, 5.5) + # b is 5.5 + + var c = clamp(Vector2(-3.5, -4), Vector2(-3.2, -2), Vector2(2, 6.5)) + # c is (-3.2, -2) + + var d = clamp(Vector2i(7, 8), Vector2i(-3, -2), Vector2i(2, 6)) + # d is (2, 6) + + var e = clamp(Vector3(-7, 8.5, -3.8), Vector3(-3, -2, 5.4), Vector3(-2, 6, -4.1)) + # e is (-3, -2, 5.4) + + var f = clamp(Vector3i(-7, -8, -9), Vector3i(-1, 2, 3), Vector3i(-4, -5, -6)) + # f is (-4, -5, -6) + ---- .. _class_@GlobalScope_method_clampf: @@ -3221,6 +3264,8 @@ Returns whether ``x`` is an infinity value (either positive infinity or negative - :ref:`bool` **is_instance_id_valid** **(** :ref:`int` id **)** +Returns ``true`` if the Object that corresponds to ``instance_id`` is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID. + ---- .. _class_@GlobalScope_method_is_instance_valid: @@ -3425,6 +3470,27 @@ In other words, returns the smallest value ``a`` where ``a = pow(2, n)`` such th ---- +.. _class_@GlobalScope_method_pingpong: + +- :ref:`float` **pingpong** **(** :ref:`float` value, :ref:`float` length **)** + +Returns the ``value`` wrapped between ``0`` and the ``length``. If the limit is reached, the next value the function returned 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. + +:: + + pingpong(-3.0, 3.0) # Returns 3 + pingpong(-2.0, 3.0) # Returns 2 + pingpong(-1.0, 3.0) # Returns 1 + pingpong(0.0, 3.0) # Returns 0 + pingpong(1.0, 3.0) # Returns 1 + pingpong(2.0, 3.0) # Returns 2 + pingpong(3.0, 3.0) # Returns 3 + pingpong(4.0, 3.0) # Returns 2 + pingpong(5.0, 3.0) # Returns 1 + pingpong(6.0, 3.0) # Returns 0 + +---- + .. _class_@GlobalScope_method_posmod: - :ref:`int` **posmod** **(** :ref:`int` x, :ref:`int` y **)** @@ -3710,6 +3776,16 @@ Sets seed for the random number generator. - :ref:`Variant` **sign** **(** :ref:`Variant` x **)** +Returns the sign of ``x`` as same type of :ref:`Variant` as ``x`` with each component being -1, 0 and 1 for each negative, zero and positive values respectivelu. Variant types :ref:`int`, :ref:`float` (real), :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3` and :ref:`Vector3i` are supported. + +:: + + sign(-6.0) # Returns -1 + sign(0.0) # Returns 0 + sign(6.0) # Returns 1 + + sign(Vector3(-6.0, 0.0, 6.0) # Returns (-1, 0, 1) + ---- .. _class_@GlobalScope_method_signf: diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 066286e9a..5a758dc2f 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AABB.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -40,15 +40,20 @@ Properties | :ref:`Vector3` | :ref:`size` | ``Vector3(0, 0, 0)`` | +-------------------------------+-----------------------------------------------+----------------------+ +Constructors +------------ + ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`AABB` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`AABB` **(** :ref:`AABB` from **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`AABB` **(** **)** |constructor| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`AABB` **(** :ref:`AABB` from **)** |constructor| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** |constructor| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`abs` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -56,8 +61,6 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** |const| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_center` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** |const| | @@ -76,12 +79,14 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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_no_area` **(** **)** |const| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_no_surface` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_volume` **(** **)** |const| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** |const| | @@ -98,16 +103,21 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`AABB` right **)** |operator| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | **operator *** **(** :ref:`Transform3D` right **)** |operator| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`AABB` right **)** |operator| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`AABB` right **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`AABB` right **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -148,28 +158,29 @@ Size from :ref:`position` to :ref:`end` to fix it. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_AABB_method_AABB: +.. _class_AABB_constructor_AABB: -- :ref:`AABB` **AABB** **(** **)** |constructor| +- :ref:`AABB` **AABB** **(** **)** Constructs a default-initialized ``AABB`` with default (zero) values of :ref:`position` and :ref:`size`. ---- -- :ref:`AABB` **AABB** **(** :ref:`AABB` from **)** |constructor| +- :ref:`AABB` **AABB** **(** :ref:`AABB` from **)** Constructs an ``AABB`` as a copy of the given ``AABB``. ---- -- :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** |constructor| +- :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Constructs an ``AABB`` from a position and size. ----- +Method Descriptions +------------------- .. _class_AABB_method_abs: @@ -191,15 +202,28 @@ Returns ``true`` if this ``AABB`` completely encloses another one. - :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** |const| -Returns this ``AABB`` expanded to include a given point. +Returns a copy of this ``AABB`` expanded to include a given point. ----- +**Example:** -.. _class_AABB_method_get_area: -- :ref:`float` **get_area** **(** **)** |const| +.. tabs:: + + .. code-tab:: gdscript + + # position (-3, 2, 0), size (1, 1, 1) + var box = AABB(Vector3(-3, 2, 0), Vector3(1, 1, 1)) + # position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2) + var box2 = box.expand(Vector3(0, -1, 2)) + + .. code-tab:: csharp + + // position (-3, 2, 0), size (1, 1, 1) + var box = new AABB(new Vector3(-3, 2, 0), new Vector3(1, 1, 1)); + // position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2) + var box2 = box.Expand(new Vector3(0, -1, 2)); + -Returns the volume of the ``AABB``. ---- @@ -275,6 +299,14 @@ Returns the support point in a given direction. This is useful for collision det ---- +.. _class_AABB_method_get_volume: + +- :ref:`float` **get_volume** **(** **)** |const| + +Returns the volume of the ``AABB``. + +---- + .. _class_AABB_method_grow: - :ref:`AABB` **grow** **(** :ref:`float` by **)** |const| @@ -283,14 +315,6 @@ Returns a copy of the ``AABB`` grown a given amount of units towards all the sid ---- -.. _class_AABB_method_has_no_area: - -- :ref:`bool` **has_no_area** **(** **)** |const| - -Returns ``true`` if the ``AABB`` is flat or empty. - ----- - .. _class_AABB_method_has_no_surface: - :ref:`bool` **has_no_surface** **(** **)** |const| @@ -299,6 +323,14 @@ Returns ``true`` if the ``AABB`` is empty. ---- +.. _class_AABB_method_has_no_volume: + +- :ref:`bool` **has_no_volume** **(** **)** |const| + +Returns ``true`` if the ``AABB`` is flat or empty. + +---- + .. _class_AABB_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** |const| @@ -359,31 +391,32 @@ Returns ``true`` if this ``AABB`` and ``aabb`` are approximately equal, by calli Returns a larger ``AABB`` that contains both this ``AABB`` and ``with``. ----- +Operator Descriptions +--------------------- -.. _class_AABB_method_operator !=: +.. _class_AABB_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`AABB` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`AABB` right **)** ---- -.. _class_AABB_method_operator *: +.. _class_AABB_operator_mul_AABB: -- :ref:`AABB` **operator *** **(** :ref:`Transform3D` right **)** |operator| +- :ref:`AABB` **operator *** **(** :ref:`Transform3D` right **)** ---- -.. _class_AABB_method_operator ==: +.. _class_AABB_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`AABB` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`AABB` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 2c6bfd614..cd7dbac09 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AcceptDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -172,6 +172,8 @@ You can use :ref:`remove_button` method Returns the label used for built-in text. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_AcceptDialog_method_get_ok_button: @@ -180,6 +182,8 @@ Returns the label used for built-in text. Returns the OK :ref:`Button` instance. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_AcceptDialog_method_register_text_enter: diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index 981074146..b2e8bccaf 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AESContext.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animatablebody2d.rst b/classes/class_animatablebody2d.rst index f86e2aa73..ca52bcd4d 100644 --- a/classes/class_animatablebody2d.rst +++ b/classes/class_animatablebody2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatableBody2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animatablebody3d.rst b/classes/class_animatablebody3d.rst index 7268e9922..c574c4120 100644 --- a/classes/class_animatablebody3d.rst +++ b/classes/class_animatablebody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatableBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animatedsprite2d.rst b/classes/class_animatedsprite2d.rst index ec6090aae..4cc4f4dd7 100644 --- a/classes/class_animatedsprite2d.rst +++ b/classes/class_animatedsprite2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatedSprite2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 92fe4ce3e..93d8a6ddc 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatedSprite3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 1b07ef178..de7452eb0 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatedTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 8e478f35e..68b9e504e 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Animation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -53,13 +53,13 @@ Tutorials Properties ---------- -+---------------------------+------------------------------------------------+-----------+ -| :ref:`float` | :ref:`length` | ``1.0`` | -+---------------------------+------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`loop` | ``false`` | -+---------------------------+------------------------------------------------+-----------+ -| :ref:`float` | :ref:`step` | ``0.1`` | -+---------------------------+------------------------------------------------+-----------+ ++------------------------------------------+------------------------------------------------------+---------+ +| :ref:`float` | :ref:`length` | ``1.0`` | ++------------------------------------------+------------------------------------------------------+---------+ +| :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | ++------------------------------------------+------------------------------------------------------+---------+ +| :ref:`float` | :ref:`step` | ``0.1`` | ++------------------------------------------+------------------------------------------------------+---------+ Methods ------- @@ -103,11 +103,15 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** |const| | +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path, :ref:`TrackType` type **)** |const| | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_track_count` **(** **)** |const| | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -117,8 +121,14 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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 **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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:`int` | :ref:`scale_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` scale **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`track_find_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`bool` exact=false **)** |const| | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` track_idx **)** |const| | @@ -139,6 +149,8 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :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| | @@ -171,10 +183,6 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_swap` **(** :ref:`int` track_idx, :ref:`int` with_idx **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quaternion` rotation, :ref:`Vector3` scale **)** | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`value_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** |const| | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` track_idx **)** |const| | @@ -200,7 +208,13 @@ Enumerations .. _class_Animation_constant_TYPE_VALUE: -.. _class_Animation_constant_TYPE_TRANSFORM3D: +.. _class_Animation_constant_TYPE_POSITION_3D: + +.. _class_Animation_constant_TYPE_ROTATION_3D: + +.. _class_Animation_constant_TYPE_SCALE_3D: + +.. _class_Animation_constant_TYPE_BLEND_SHAPE: .. _class_Animation_constant_TYPE_METHOD: @@ -214,15 +228,21 @@ enum **TrackType**: - **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated. -- **TYPE_TRANSFORM3D** = **1** --- Transform3D tracks are used to change node local transforms or skeleton pose bones of 3D nodes. Transitions are interpolated. +- **TYPE_POSITION_3D** = **1** -- **TYPE_METHOD** = **2** --- Method tracks call functions with given arguments per key. +- **TYPE_ROTATION_3D** = **2** -- **TYPE_BEZIER** = **3** --- Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a :ref:`Color`). +- **TYPE_SCALE_3D** = **3** -- **TYPE_AUDIO** = **4** --- Audio tracks are used to play an audio stream with either type of :ref:`AudioStreamPlayer`. The stream can be trimmed and previewed in the animation. +- **TYPE_BLEND_SHAPE** = **4** -- **TYPE_ANIMATION** = **5** --- Animation tracks play animations in other :ref:`AnimationPlayer` nodes. +- **TYPE_METHOD** = **5** --- Method tracks call functions with given arguments per key. + +- **TYPE_BEZIER** = **6** --- Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a :ref:`Color`). + +- **TYPE_AUDIO** = **7** --- Audio tracks are used to play an audio stream with either type of :ref:`AudioStreamPlayer`. The stream can be trimmed and previewed in the animation. + +- **TYPE_ANIMATION** = **8** --- Animation tracks play animations in other :ref:`AnimationPlayer` nodes. ---- @@ -264,6 +284,24 @@ enum **UpdateMode**: - **UPDATE_CAPTURE** = **3** --- Same as linear interpolation, but also interpolates from the current value (i.e. dynamically at runtime) if the first key isn't at 0 seconds. +---- + +.. _enum_Animation_LoopMode: + +.. _class_Animation_constant_LOOP_NONE: + +.. _class_Animation_constant_LOOP_LINEAR: + +.. _class_Animation_constant_LOOP_PINGPONG: + +enum **LoopMode**: + +- **LOOP_NONE** = **0** --- At both ends of the animation, the animation will stop playing. + +- **LOOP_LINEAR** = **1** --- At both ends of the animation, the animation will be repeated without changing the playback direction. + +- **LOOP_PINGPONG** = **2** --- Repeats playback and reverse playback at both ends of the animation. + Property Descriptions --------------------- @@ -285,19 +323,19 @@ The total length of the animation (in seconds). ---- -.. _class_Animation_property_loop: +.. _class_Animation_property_loop_mode: -- :ref:`bool` **loop** +- :ref:`LoopMode` **loop_mode** -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_loop(value) | -+-----------+-----------------+ -| *Getter* | has_loop() | -+-----------+-----------------+ ++-----------+----------------------+ +| *Default* | ``0`` | ++-----------+----------------------+ +| *Setter* | set_loop_mode(value) | ++-----------+----------------------+ +| *Getter* | get_loop_mode() | ++-----------+----------------------+ -A flag indicating that the animation must loop. This is used for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. +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. ---- @@ -478,6 +516,12 @@ Sets the value of the key identified by ``key_idx`` to the given value. The ``tr ---- +.. _class_Animation_method_blend_shape_track_insert_key: + +- :ref:`int` **blend_shape_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` amount **)** + +---- + .. _class_Animation_method_clear: - void **clear** **(** **)** @@ -486,6 +530,12 @@ Clear the animation (clear all tracks and reset all). ---- +.. _class_Animation_method_compress: + +- void **compress** **(** :ref:`int` page_size=8192, :ref:`int` fps=120, :ref:`float` split_tolerance=4.0 **)** + +---- + .. _class_Animation_method_copy_track: - void **copy_track** **(** :ref:`int` track_idx, :ref:`Animation` to_animation **)** @@ -496,7 +546,7 @@ Adds a new track that is a copy of the given track from ``to_animation``. .. _class_Animation_method_find_track: -- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** |const| +- :ref:`int` **find_track** **(** :ref:`NodePath` path, :ref:`TrackType` type **)** |const| Returns the index of the specified track. If the track is not found, return -1. @@ -534,6 +584,12 @@ Returns the arguments values to be called on a method track for a given key in a ---- +.. _class_Animation_method_position_track_insert_key: + +- :ref:`int` **position_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` position **)** + +---- + .. _class_Animation_method_remove_track: - void **remove_track** **(** :ref:`int` track_idx **)** @@ -542,6 +598,18 @@ Removes a track by specifying the track index. ---- +.. _class_Animation_method_rotation_track_insert_key: + +- :ref:`int` **rotation_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Quaternion` rotation **)** + +---- + +.. _class_Animation_method_scale_track_insert_key: + +- :ref:`int` **scale_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` scale **)** + +---- + .. _class_Animation_method_track_find_key: - :ref:`int` **track_find_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`bool` exact=false **)** |const| @@ -622,6 +690,12 @@ Insert a generic key in a given track. ---- +.. _class_Animation_method_track_is_compressed: + +- :ref:`bool` **track_is_compressed** **(** :ref:`int` track_idx **)** |const| + +---- + .. _class_Animation_method_track_is_enabled: - :ref:`bool` **track_is_enabled** **(** :ref:`int` track_idx **)** |const| @@ -752,22 +826,6 @@ Swaps the track ``idx``'s index position with the track ``with_idx``. ---- -.. _class_Animation_method_transform_track_insert_key: - -- :ref:`int` **transform_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quaternion` rotation, :ref:`Vector3` scale **)** - -Insert a transform key for a transform track. - ----- - -.. _class_Animation_method_transform_track_interpolate: - -- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| - -Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quaternion`) and scale (:ref:`Vector3`). - ----- - .. _class_Animation_method_value_track_get_key_indices: - :ref:`PackedInt32Array` **value_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** |const| diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 0de0c6994..f6a7353cd 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -54,7 +54,7 @@ Methods +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_input` **(** :ref:`String` name **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_animation` **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | +| void | :ref:`blend_animation` **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend, :ref:`int` pingponged=0 **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -203,7 +203,7 @@ Adds an input to the node. This is only useful for nodes created for use in an : .. _class_AnimationNode_method_blend_animation: -- void **blend_animation** **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** +- void **blend_animation** **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend, :ref:`int` pingponged=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 ``seek`` happened. diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 56f7ea78a..15cf807e3 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeAdd2.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 2600f557d..a0723298d 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeAdd3.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index 4af250415..e655bb6d0 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeAnimation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -30,9 +30,26 @@ Tutorials Properties ---------- -+-------------------------------------+-------------------------------------------------------------------+---------+ -| :ref:`StringName` | :ref:`animation` | ``&""`` | -+-------------------------------------+-------------------------------------------------------------------+---------+ ++-------------------------------------------------------+-------------------------------------------------------------------+---------+ +| :ref:`StringName` | :ref:`animation` | ``&""`` | ++-------------------------------------------------------+-------------------------------------------------------------------+---------+ +| :ref:`PlayMode` | :ref:`play_mode` | ``0`` | ++-------------------------------------------------------+-------------------------------------------------------------------+---------+ + +Enumerations +------------ + +.. _enum_AnimationNodeAnimation_PlayMode: + +.. _class_AnimationNodeAnimation_constant_PLAY_MODE_FORWARD: + +.. _class_AnimationNodeAnimation_constant_PLAY_MODE_BACKWARD: + +enum **PlayMode**: + +- **PLAY_MODE_FORWARD** = **0** + +- **PLAY_MODE_BACKWARD** = **1** Property Descriptions --------------------- @@ -51,6 +68,22 @@ Property Descriptions Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player`. +---- + +.. _class_AnimationNodeAnimation_property_play_mode: + +- :ref:`PlayMode` **play_mode** + ++-----------+----------------------+ +| *Default* | ``0`` | ++-----------+----------------------+ +| *Setter* | set_play_mode(value) | ++-----------+----------------------+ +| *Getter* | get_play_mode() | ++-----------+----------------------+ + +Determines the playback direction of the animation. + .. |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.)` diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index a9e39852e..4197368e8 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlend2.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 31d47d6ec..e90c64998 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlend3.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index b51b879d3..3dc87b64c 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace1D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 67314b20a..58b3ebf96 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 6c5939a45..a9de99587 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendTree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index c26835e18..686e2a35f 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeOneShot.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index f8c46240c..b31276091 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeOutput.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 85532df8e..e9e74fe23 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachine.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index d53a390f5..3082567b7 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachinePlayback.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index b457c2b5e..ee3b11bc0 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachineTransition.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index 53241c4b5..5273c13b1 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeTimeScale.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index b44c6fc3a..f7daa5c7a 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeTimeSeek.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 0730da3af..b6df6a3f6 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeTransition.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 902f2b233..501aa064e 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationPlayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index 7a3bfbc25..9dfde92bb 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationRootNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index 7d8fe5859..4c3111928 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationTrackEditPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 60c311bb3..128e4dac0 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationTree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -137,7 +137,7 @@ The process mode of this ``AnimationTree``. See :ref:`AnimationProcessCallback`, the transformation will be cancelled visually, and the animation will appear to stay in place. See also :ref:`get_root_motion_transform` and :ref:`RootMotionView`. +If the track has type :ref:`Animation.TYPE_POSITION_3D`, :ref:`Animation.TYPE_ROTATION_3D` or :ref:`Animation.TYPE_SCALE_3D` the transformation will be cancelled visually, and the animation will appear to stay in place. See also :ref:`get_root_motion_transform` and :ref:`RootMotionView`. ---- @@ -168,7 +168,7 @@ Manually advance the animations by the specified time (in seconds). - :ref:`Transform3D` **get_root_motion_transform** **(** **)** |const| -Retrieve the motion of the :ref:`root_motion_track` as a :ref:`Transform3D` that can be used elsewhere. If :ref:`root_motion_track` is not a path to a track of type :ref:`Animation.TYPE_TRANSFORM3D`, returns an identity transformation. See also :ref:`root_motion_track` and :ref:`RootMotionView`. +Retrieve the motion of the :ref:`root_motion_track` as a :ref:`Transform3D` that can be used elsewhere. If :ref:`root_motion_track` is not a path to a track of type :ref:`Animation.TYPE_POSITION_3D`, :ref:`Animation.TYPE_SCALE_3D` or :ref:`Animation.TYPE_ROTATION_3D`, returns an identity transformation. See also :ref:`root_motion_track` and :ref:`RootMotionView`. ---- diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index c8dd522c2..476a74ef6 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Area2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -32,31 +32,37 @@ Tutorials Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`angular_damp` | ``1.0`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`StringName` | :ref:`audio_bus_name` | ``&"Master"`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`audio_bus_override` | ``false`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`gravity` | ``980.0`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`gravity_distance_scale` | ``0.0`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`gravity_point` | ``false`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`gravity_vec` | ``Vector2(0, 1)`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`linear_damp` | ``0.1`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`monitorable` | ``true`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`monitoring` | ``true`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`priority` | ``0.0`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ -| :ref:`SpaceOverride` | :ref:`space_override` | ``0`` | -+-------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`angular_damp` | ``1.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`SpaceOverride` | :ref:`angular_damp_space_override` | ``0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`StringName` | :ref:`audio_bus_name` | ``&"Master"`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`audio_bus_override` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`gravity` | ``980.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`gravity_direction` | ``Vector2(0, 1)`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`gravity_point` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`gravity_point_center` | ``Vector2(0, 1)`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`gravity_point_distance_scale` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`SpaceOverride` | :ref:`gravity_space_override` | ``0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`linear_damp` | ``0.1`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`SpaceOverride` | :ref:`linear_damp_space_override` | ``0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`monitorable` | ``true`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`monitoring` | ``true`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`priority` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------+ Methods ------- @@ -96,33 +102,33 @@ Emitted when another Area2D exits this Area2D. Requires :ref:`monitoring` area_rid, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_entered** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area2D's :ref:`Shape2D`\ s enters one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. +``area_rid`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. ``area`` the other Area2D. -``area_shape`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`PhysicsServer2D`. +``area_shape_index`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area2D_signal_area_shape_exited: -- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area2D's :ref:`Shape2D`\ s exits one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. +``area_rid`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. ``area`` the other Area2D. -``area_shape`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`PhysicsServer2D`. +``area_shape_index`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- @@ -148,33 +154,33 @@ Emitted when a :ref:`PhysicsBody2D` or :ref:`TileMap` body_rid, :ref:`Node2D` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s enters one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody2D` or :ref:`TileMap`. -``body_shape`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. +``body_shape_index`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area2D_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s exits one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody2D` or :ref:`TileMap`. -``body_shape`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. +``body_shape_index`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. Enumerations ------------ @@ -224,6 +230,22 @@ See :ref:`ProjectSettings.physics/2d/default_angular_damp` **angular_damp_space_override** + ++-----------+---------------------------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------------------------+ +| *Setter* | set_angular_damp_space_override_mode(value) | ++-----------+---------------------------------------------+ +| *Getter* | get_angular_damp_space_override_mode() | ++-----------+---------------------------------------------+ + +Override mode for angular damping calculations within this area. See :ref:`SpaceOverride` for possible values. + +---- + .. _class_Area2D_property_audio_bus_name: - :ref:`StringName` **audio_bus_name** @@ -268,23 +290,23 @@ If ``true``, the area's audio bus overrides the default audio bus. | *Getter* | get_gravity() | +-----------+--------------------+ -The area's gravity intensity (in pixels per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. +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. ---- -.. _class_Area2D_property_gravity_distance_scale: +.. _class_Area2D_property_gravity_direction: -- :ref:`float` **gravity_distance_scale** +- :ref:`Vector2` **gravity_direction** -+-----------+-----------------------------------+ -| *Default* | ``0.0`` | -+-----------+-----------------------------------+ -| *Setter* | set_gravity_distance_scale(value) | -+-----------+-----------------------------------+ -| *Getter* | get_gravity_distance_scale() | -+-----------+-----------------------------------+ ++-----------+------------------------------+ +| *Default* | ``Vector2(0, 1)`` | ++-----------+------------------------------+ +| *Setter* | set_gravity_direction(value) | ++-----------+------------------------------+ +| *Getter* | get_gravity_direction() | ++-----------+------------------------------+ -The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. +The area's gravity vector (not normalized). ---- @@ -300,23 +322,55 @@ The falloff factor for point gravity. The greater the value, the faster gravity | *Getter* | is_gravity_a_point() | +-----------+-----------------------------+ -If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). See also :ref:`space_override`. +If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_center`). See also :ref:`gravity_space_override`. ---- -.. _class_Area2D_property_gravity_vec: +.. _class_Area2D_property_gravity_point_center: -- :ref:`Vector2` **gravity_vec** +- :ref:`Vector2` **gravity_point_center** -+-----------+---------------------------+ -| *Default* | ``Vector2(0, 1)`` | -+-----------+---------------------------+ -| *Setter* | set_gravity_vector(value) | -+-----------+---------------------------+ -| *Getter* | get_gravity_vector() | -+-----------+---------------------------+ ++-----------+---------------------------------+ +| *Default* | ``Vector2(0, 1)`` | ++-----------+---------------------------------+ +| *Setter* | set_gravity_point_center(value) | ++-----------+---------------------------------+ +| *Getter* | get_gravity_point_center() | ++-----------+---------------------------------+ -The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. +If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. + +---- + +.. _class_Area2D_property_gravity_point_distance_scale: + +- :ref:`float` **gravity_point_distance_scale** + ++-----------+-----------------------------------------+ +| *Default* | ``0.0`` | ++-----------+-----------------------------------------+ +| *Setter* | set_gravity_point_distance_scale(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_gravity_point_distance_scale() | ++-----------+-----------------------------------------+ + +The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + +---- + +.. _class_Area2D_property_gravity_space_override: + +- :ref:`SpaceOverride` **gravity_space_override** + ++-----------+----------------------------------------+ +| *Default* | ``0`` | ++-----------+----------------------------------------+ +| *Setter* | set_gravity_space_override_mode(value) | ++-----------+----------------------------------------+ +| *Getter* | get_gravity_space_override_mode() | ++-----------+----------------------------------------+ + +Override mode for gravity calculations within this area. See :ref:`SpaceOverride` for possible values. ---- @@ -338,6 +392,22 @@ See :ref:`ProjectSettings.physics/2d/default_linear_damp` **linear_damp_space_override** + ++-----------+--------------------------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------------------------+ +| *Setter* | set_linear_damp_space_override_mode(value) | ++-----------+--------------------------------------------+ +| *Getter* | get_linear_damp_space_override_mode() | ++-----------+--------------------------------------------+ + +Override mode for linear damping calculations within this area. See :ref:`SpaceOverride` for possible values. + +---- + .. _class_Area2D_property_monitorable: - :ref:`bool` **monitorable** @@ -384,22 +454,6 @@ If ``true``, the area detects bodies or areas entering and exiting it. The area's priority. Higher priority areas are processed first. ----- - -.. _class_Area2D_property_space_override: - -- :ref:`SpaceOverride` **space_override** - -+-----------+--------------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------------+ -| *Setter* | set_space_override_mode(value) | -+-----------+--------------------------------+ -| *Getter* | get_space_override_mode() | -+-----------+--------------------------------+ - -Override mode for gravity and damping calculations within this area. See :ref:`SpaceOverride` for possible values. - Method Descriptions ------------------- @@ -407,7 +461,9 @@ Method Descriptions - :ref:`Area2D[]` **get_overlapping_areas** **(** **)** |const| -Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +Returns a list of intersecting ``Area2D``\ s. The overlapping area's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. + +For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. ---- @@ -415,7 +471,9 @@ Returns a list of intersecting ``Area2D``\ s. For performance reasons (collision - :ref:`Node2D[]` **get_overlapping_bodies** **(** **)** |const| -Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +Returns a list of intersecting :ref:`PhysicsBody2D`\ s. The overlapping body's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. + +For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. ---- diff --git a/classes/class_area3d.rst b/classes/class_area3d.rst index b553b9642..ada8818f9 100644 --- a/classes/class_area3d.rst +++ b/classes/class_area3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Area3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -28,45 +28,51 @@ Tutorials Properties ---------- -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`angular_damp` | ``0.1`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`StringName` | :ref:`audio_bus_name` | ``&"Master"`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`audio_bus_override` | ``false`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`gravity` | ``9.8`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`gravity_distance_scale` | ``0.0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`gravity_point` | ``false`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`Vector3` | :ref:`gravity_vec` | ``Vector3(0, -1, 0)`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`linear_damp` | ``0.1`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`monitorable` | ``true`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`monitoring` | ``true`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`priority` | ``0.0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`reverb_bus_amount` | ``0.0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`reverb_bus_enable` | ``false`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`StringName` | :ref:`reverb_bus_name` | ``&"Master"`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`reverb_bus_uniformity` | ``0.0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`SpaceOverride` | :ref:`space_override` | ``0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`wind_attenuation_factor` | ``0.0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`wind_force_magnitude` | ``0.0`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ -| :ref:`NodePath` | :ref:`wind_source_path` | ``NodePath("")`` | -+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angular_damp` | ``0.1`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`SpaceOverride` | :ref:`angular_damp_space_override` | ``0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`StringName` | :ref:`audio_bus_name` | ``&"Master"`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`audio_bus_override` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`gravity` | ``9.8`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`gravity_direction` | ``Vector3(0, -1, 0)`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`gravity_point` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`gravity_point_center` | ``Vector3(0, -1, 0)`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`gravity_point_distance_scale` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`SpaceOverride` | :ref:`gravity_space_override` | ``0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`linear_damp` | ``0.1`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`SpaceOverride` | :ref:`linear_damp_space_override` | ``0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`monitorable` | ``true`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`monitoring` | ``true`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`priority` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`reverb_bus_amount` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`reverb_bus_enable` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`StringName` | :ref:`reverb_bus_name` | ``&"Master"`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`reverb_bus_uniformity` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`wind_attenuation_factor` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`wind_force_magnitude` | ``0.0`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`NodePath` | :ref:`wind_source_path` | ``NodePath("")`` | ++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+ Methods ------- @@ -106,33 +112,33 @@ Emitted when another Area3D exits this Area3D. Requires :ref:`monitoring` area_rid, :ref:`Area3D` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_entered** **(** :ref:`RID` area_rid, :ref:`Area3D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area3D's :ref:`Shape3D`\ s enters one of this Area3D's :ref:`Shape3D`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area3D's :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. +``area_rid`` the :ref:`RID` of the other Area3D's :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. ``area`` the other Area3D. -``area_shape`` the index of the :ref:`Shape3D` of the other Area3D used by the :ref:`PhysicsServer3D`. +``area_shape_index`` the index of the :ref:`Shape3D` of the other Area3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. +``local_shape_index`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area3D_signal_area_shape_exited: -- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area3D` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area3D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** -Emitted when one of another Area3D's :ref:`Shape3D`\ s enters one of this Area3D's :ref:`Shape3D`\ s. Requires :ref:`monitoring` to be set to ``true``. +Emitted when one of another Area3D's :ref:`Shape3D`\ s exits one of this Area3D's :ref:`Shape3D`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area3D's :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. +``area_rid`` the :ref:`RID` of the other Area3D's :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. ``area`` the other Area3D. -``area_shape`` the index of the :ref:`Shape3D` of the other Area3D used by the :ref:`PhysicsServer3D`. +``area_shape_index`` the index of the :ref:`Shape3D` of the other Area3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. +``local_shape_index`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- @@ -158,33 +164,33 @@ Emitted when a :ref:`PhysicsBody3D` or :ref:`GridMap` body_rid, :ref:`Node3D` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node3D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody3D` or :ref:`GridMap`'s :ref:`Shape3D`\ s enters one of this Area3D's :ref:`Shape3D`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody3D` or :ref:`GridMap`. -``body_shape`` the index of the :ref:`Shape3D` of the :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. +``body_shape_index`` the index of the :ref:`Shape3D` of the :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. +``local_shape_index`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area3D_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node3D` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node3D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody3D` or :ref:`GridMap`'s :ref:`Shape3D`\ s enters one of this Area3D's :ref:`Shape3D`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody3D` or :ref:`GridMap`. -``body_shape`` the index of the :ref:`Shape3D` of the :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. +``body_shape_index`` the index of the :ref:`Shape3D` of the :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. +``local_shape_index`` the index of the :ref:`Shape3D` of this Area3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``self.shape_owner_get_owner(local_shape_index)``. Enumerations ------------ @@ -234,6 +240,22 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` **angular_damp_space_override** + ++-----------+---------------------------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------------------------+ +| *Setter* | set_angular_damp_space_override_mode(value) | ++-----------+---------------------------------------------+ +| *Getter* | get_angular_damp_space_override_mode() | ++-----------+---------------------------------------------+ + +Override mode for angular damping calculations within this area. See :ref:`SpaceOverride` for possible values. + +---- + .. _class_Area3D_property_audio_bus_name: - :ref:`StringName` **audio_bus_name** @@ -278,23 +300,23 @@ If ``true``, the area's audio bus overrides the default audio bus. | *Getter* | get_gravity() | +-----------+--------------------+ -The area's gravity intensity (in meters per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. +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. ---- -.. _class_Area3D_property_gravity_distance_scale: +.. _class_Area3D_property_gravity_direction: -- :ref:`float` **gravity_distance_scale** +- :ref:`Vector3` **gravity_direction** -+-----------+-----------------------------------+ -| *Default* | ``0.0`` | -+-----------+-----------------------------------+ -| *Setter* | set_gravity_distance_scale(value) | -+-----------+-----------------------------------+ -| *Getter* | get_gravity_distance_scale() | -+-----------+-----------------------------------+ ++-----------+------------------------------+ +| *Default* | ``Vector3(0, -1, 0)`` | ++-----------+------------------------------+ +| *Setter* | set_gravity_direction(value) | ++-----------+------------------------------+ +| *Getter* | get_gravity_direction() | ++-----------+------------------------------+ -The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. +The area's gravity vector (not normalized). ---- @@ -310,23 +332,55 @@ The falloff factor for point gravity. The greater the value, the faster gravity | *Getter* | is_gravity_a_point() | +-----------+-----------------------------+ -If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). See also :ref:`space_override`. +If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_center`). See also :ref:`gravity_space_override`. ---- -.. _class_Area3D_property_gravity_vec: +.. _class_Area3D_property_gravity_point_center: -- :ref:`Vector3` **gravity_vec** +- :ref:`Vector3` **gravity_point_center** -+-----------+---------------------------+ -| *Default* | ``Vector3(0, -1, 0)`` | -+-----------+---------------------------+ -| *Setter* | set_gravity_vector(value) | -+-----------+---------------------------+ -| *Getter* | get_gravity_vector() | -+-----------+---------------------------+ ++-----------+---------------------------------+ +| *Default* | ``Vector3(0, -1, 0)`` | ++-----------+---------------------------------+ +| *Setter* | set_gravity_point_center(value) | ++-----------+---------------------------------+ +| *Getter* | get_gravity_point_center() | ++-----------+---------------------------------+ -The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. +If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. + +---- + +.. _class_Area3D_property_gravity_point_distance_scale: + +- :ref:`float` **gravity_point_distance_scale** + ++-----------+-----------------------------------------+ +| *Default* | ``0.0`` | ++-----------+-----------------------------------------+ +| *Setter* | set_gravity_point_distance_scale(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_gravity_point_distance_scale() | ++-----------+-----------------------------------------+ + +The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + +---- + +.. _class_Area3D_property_gravity_space_override: + +- :ref:`SpaceOverride` **gravity_space_override** + ++-----------+----------------------------------------+ +| *Default* | ``0`` | ++-----------+----------------------------------------+ +| *Setter* | set_gravity_space_override_mode(value) | ++-----------+----------------------------------------+ +| *Getter* | get_gravity_space_override_mode() | ++-----------+----------------------------------------+ + +Override mode for gravity calculations within this area. See :ref:`SpaceOverride` for possible values. ---- @@ -348,6 +402,22 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` **linear_damp_space_override** + ++-----------+--------------------------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------------------------+ +| *Setter* | set_linear_damp_space_override_mode(value) | ++-----------+--------------------------------------------+ +| *Getter* | get_linear_damp_space_override_mode() | ++-----------+--------------------------------------------+ + +Override mode for linear damping calculations within this area. See :ref:`SpaceOverride` for possible values. + +---- + .. _class_Area3D_property_monitorable: - :ref:`bool` **monitorable** @@ -460,22 +530,6 @@ The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ---- -.. _class_Area3D_property_space_override: - -- :ref:`SpaceOverride` **space_override** - -+-----------+--------------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------------+ -| *Setter* | set_space_override_mode(value) | -+-----------+--------------------------------+ -| *Getter* | get_space_override_mode() | -+-----------+--------------------------------+ - -Override mode for gravity and damping calculations within this area. See :ref:`SpaceOverride` for possible values. - ----- - .. _class_Area3D_property_wind_attenuation_factor: - :ref:`float` **wind_attenuation_factor** @@ -529,7 +583,9 @@ Method Descriptions - :ref:`Area3D[]` **get_overlapping_areas** **(** **)** |const| -Returns a list of intersecting ``Area3D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +Returns a list of intersecting ``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. + +For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. ---- @@ -537,7 +593,9 @@ Returns a list of intersecting ``Area3D``\ s. For performance reasons (collision - :ref:`Node3D[]` **get_overlapping_bodies** **(** **)** |const| -Returns a list of intersecting :ref:`PhysicsBody3D`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +Returns a list of intersecting :ref:`PhysicsBody3D`\ 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. + +For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. ---- diff --git a/classes/class_array.rst b/classes/class_array.rst index 4deec5a91..9b76807ae 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -67,31 +67,36 @@ Arrays can be concatenated using the ``+`` operator: **Note:** When declaring an array with ``const``, the array itself can still be mutated by defining the values at individual indices or pushing/removing elements. Using ``const`` will only prevent assigning the constant with another value after it was initialized. +Constructors +------------ + ++---------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`Array` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedByteArray` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedColorArray` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedFloat32Array` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedFloat64Array` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedInt32Array` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedInt64Array` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedStringArray` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedVector2Array` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PackedVector3Array` from **)** |constructor| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`append` **(** :ref:`Variant` value **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -135,26 +140,6 @@ Methods +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`min` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | **operator +** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`Array` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`pop_at` **(** :ref:`int` position **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`pop_back` **(** **)** | @@ -186,76 +171,102 @@ Methods | void | :ref:`sort_custom` **(** :ref:`Callable` func **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_Array_method_Array: ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** :ref:`Array` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator >` **(** :ref:`Array` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator >=` **(** :ref:`Array` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`operator []` **(** :ref:`int` index **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ -- :ref:`Array` **Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_Array_constructor_Array: + +- :ref:`Array` **Array** **(** **)** Constructs an empty ``Array``. ---- -- :ref:`Array` **Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`Array` from **)** Constructs an ``Array`` as a copy of the given ``Array``. ---- -- :ref:`Array` **Array** **(** :ref:`PackedByteArray` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedByteArray` from **)** Constructs an array from a :ref:`PackedByteArray`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedColorArray` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedColorArray` from **)** Constructs an array from a :ref:`PackedColorArray`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedFloat32Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedFloat32Array` from **)** Constructs an array from a :ref:`PackedFloat32Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedFloat64Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedFloat64Array` from **)** Constructs an array from a :ref:`PackedFloat64Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedInt32Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedInt32Array` from **)** Constructs an array from a :ref:`PackedInt32Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedInt64Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedInt64Array` from **)** Constructs an array from a :ref:`PackedInt64Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedStringArray` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedStringArray` from **)** Constructs an array from a :ref:`PackedStringArray`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedVector2Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedVector2Array` from **)** Constructs an array from a :ref:`PackedVector2Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PackedVector3Array` from **)** |constructor| +- :ref:`Array` **Array** **(** :ref:`PackedVector3Array` from **)** Constructs an array from a :ref:`PackedVector3Array`. ----- +Method Descriptions +------------------- .. _class_Array_method_append: @@ -536,62 +547,6 @@ Returns the minimum value contained in the array if all elements are of comparab ---- -.. _class_Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator +: - -- :ref:`Array` **operator +** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator <: - -- :ref:`bool` **operator <** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator <=: - -- :ref:`bool` **operator <=** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator >: - -- :ref:`bool` **operator >** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator >=: - -- :ref:`bool` **operator >=** **(** :ref:`Array` right **)** |operator| - ----- - -.. _class_Array_method_operator []: - -- void **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_Array_method_pop_at: - :ref:`Variant` **pop_at** **(** :ref:`int` position **)** @@ -755,15 +710,19 @@ Sorts the array using a custom method. The custom method receives two arguments .. code-tab:: gdscript - class MyCustomSorter: - static func sort_ascending(a, b): - if a[0] < b[0]: - return true - return false + func sort_ascending(a, b): + if a[0] < b[0]: + return true + return false - var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] - my_items.sort_custom(MyCustomSorter.sort_ascending) - print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]]. + func _ready(): + var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] + my_items.sort_custom(sort_ascending) + print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]]. + + # Descending, lambda version. + my_items.sort_custom(func(a, b): return a[0] > b[0]) + print(my_items) # Prints [[9, Rice], [5, Potato], [4, Tomato]]. .. code-tab:: csharp @@ -771,6 +730,63 @@ Sorts the array using a custom method. The custom method receives two arguments +Operator Descriptions +--------------------- + +.. _class_Array_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_sum_Array: + +- :ref:`Array` **operator +** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_lt_bool: + +- :ref:`bool` **operator <** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_lte_bool: + +- :ref:`bool` **operator <=** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_gte_bool: + +- :ref:`bool` **operator >=** **(** :ref:`Array` right **)** + +---- + +.. _class_Array_operator_idx_void: + +- void **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 655f39dbf..6ac93e166 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ArrayMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_aspectratiocontainer.rst b/classes/class_aspectratiocontainer.rst index b7c2bfd4f..8c05a06e7 100644 --- a/classes/class_aspectratiocontainer.rst +++ b/classes/class_aspectratiocontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AspectRatioContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 888743bdc..f47858642 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AStar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index b293255e4..5e37d1827 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AStar2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 1244fe022..98f3b0fff 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AtlasTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index 743924365..1b121e141 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioBusLayout.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index eb1bc0ec1..725971d6d 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index ba84fcddb..7518c9acb 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectAmplify.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index 1bc226ffd..5c95aee61 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectBandLimitFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index 3c4e55e45..d3f5df948 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectBandPassFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index a26f5475f..c9817d6e8 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectCapture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index ebceb564e..150cd94c4 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectChorus.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index ee624b94e..ba9724a1c 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectCompressor.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 5ebe8924d..cfbda667c 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectDelay.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 1e977c8c3..8c388c7df 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectDistortion.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index e10f4ae17..3db9fe843 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index 4f7e3313d..65b54aa2a 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ10.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index 52ff84233..e8c666700 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ21.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index bfee2aba2..80139a376 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ6.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 3d7d5327e..89be8e474 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index 5500293a3..8e7b507c9 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectHighPassFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 19fcde178..099d5bdd7 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectHighShelfFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index 01e2593f3..cdce8cffa 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectInstance.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 7265577ee..b5e53a739 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectLimiter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index b2f91ee0d..a6aa7af1f 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectLowPassFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 4819f8335..e17fd636b 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectLowShelfFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 9784a4bff..16cb07341 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectNotchFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index 2516ebe63..cb2ef64dc 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index e3592bd4b..5f5f6b867 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectPhaser.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 7f3e4ef89..0b732fef0 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectPitchShift.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index 72ecf9031..18285e7cd 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectRecord.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 7f6596698..49673f5c5 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectReverb.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index d39290b38..7fe766861 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst index 87f8d6527..0aeee0839 100644 --- a/classes/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzerInstance.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 8659642a6..1845acb84 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectStereoEnhance.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiolistener2d.rst b/classes/class_audiolistener2d.rst index 335c06a41..d4e525c34 100644 --- a/classes/class_audiolistener2d.rst +++ b/classes/class_audiolistener2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioListener2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiolistener3d.rst b/classes/class_audiolistener3d.rst index 3e415c08e..15db39860 100644 --- a/classes/class_audiolistener3d.rst +++ b/classes/class_audiolistener3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioListener3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 34590c04d..bd88db3cc 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 24bbd3d9d..26ffe19c5 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStream.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index 40a22024f..b47268b0c 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamGenerator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index 4ccc419af..a1a462eba 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamGeneratorPlayback.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index f7bde2fc6..8fc8f54df 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamMicrophone.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index 2ec300365..7d872f48b 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamMP3.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 6daa80766..59e1f11c7 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamOGGVorbis.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index fa60602d7..8f9977054 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamPlayback.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamplaybackoggvorbis.rst b/classes/class_audiostreamplaybackoggvorbis.rst index 78a9fa09c..01647b4c9 100644 --- a/classes/class_audiostreamplaybackoggvorbis.rst +++ b/classes/class_audiostreamplaybackoggvorbis.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamPlaybackOGGVorbis.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index 43aefb09d..68c8aa009 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamPlaybackResampled.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 8f55f7b59..8a3f7c4b8 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamPlayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 892dc8e57..715667915 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamPlayer2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index e63522cc2..bc29c5f67 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamPlayer3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -117,7 +117,7 @@ enum **AttenuationModel**: - **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. -- **ATTENUATION_DISABLED** = **3** --- No dampening of loudness according to distance. The sound will still be heard positionally, unlike an :ref:`AudioStreamPlayer`. +- **ATTENUATION_DISABLED** = **3** --- No dampening of loudness according to distance. The sound will still be heard positionally, unlike an :ref:`AudioStreamPlayer`. :ref:`ATTENUATION_DISABLED` can be combined with a :ref:`max_distance` value greater than ``0.0`` to achieve linear attenuation clamped to a sphere of a defined size. ---- diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 1e44d19cd..5359a0b13 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamRandomPitch.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 71d87d335..a43b94edf 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioStreamSample.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -73,7 +73,7 @@ enum **Format**: .. _class_AudioStreamSample_constant_LOOP_FORWARD: -.. _class_AudioStreamSample_constant_LOOP_PING_PONG: +.. _class_AudioStreamSample_constant_LOOP_PINGPONG: .. _class_AudioStreamSample_constant_LOOP_BACKWARD: @@ -83,7 +83,7 @@ enum **LoopMode**: - **LOOP_FORWARD** = **1** --- Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing forward only. -- **LOOP_PING_PONG** = **2** --- Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing back and forth. +- **LOOP_PINGPONG** = **2** --- Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing back and forth. - **LOOP_BACKWARD** = **3** --- Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing backward only. diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index af96e7615..dac206b4b 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BackBufferCopy.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 162f1bc7a..64da2dda5 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BaseButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,29 +23,29 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`ActionMode` | :ref:`action_mode` | ``1`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`ButtonGroup` | :ref:`button_group` | | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`int` | :ref:`button_mask` | ``1`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`disabled` | ``false`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`FocusMode` | focus_mode | ``2`` *(parent override)* | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`keep_pressed_outside` | ``false`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`pressed` | ``false`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`Shortcut` | :ref:`shortcut` | | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`Node` | :ref:`shortcut_context` | | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`shortcut_in_tooltip` | ``true`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`toggle_mode` | ``false`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`ActionMode` | :ref:`action_mode` | ``1`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`ButtonGroup` | :ref:`button_group` | | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`MouseButton` | :ref:`button_mask` | ``1`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`disabled` | ``false`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`FocusMode` | focus_mode | ``2`` *(parent override)* | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`keep_pressed_outside` | ``false`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`pressed` | ``false`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`Shortcut` | :ref:`shortcut` | | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`Node` | :ref:`shortcut_context` | | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`shortcut_in_tooltip` | ``true`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`toggle_mode` | ``false`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ Methods ------- @@ -173,7 +173,7 @@ The :ref:`ButtonGroup` associated with the button. Not to be .. _class_BaseButton_property_button_mask: -- :ref:`int` **button_mask** +- :ref:`MouseButton` **button_mask** +-----------+------------------------+ | *Default* | ``1`` | diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 4448be032..c75435b43 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BaseMaterial3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index f86d75789..478c75a10 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Basis.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -50,78 +50,100 @@ Properties | :ref:`Vector3` | :ref:`z` | ``Vector3(0, 0, 1)`` | +-------------------------------+----------------------------------+----------------------+ +Constructors +------------ + ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Basis` from **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quaternion` from **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** **)** |constructor| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Basis` from **)** |constructor| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** |constructor| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` euler **)** |constructor| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quaternion` from **)** |constructor| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** |constructor| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`determinant` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`from_scale` **(** :ref:`Vector3` scale **)** |static| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`get_rotation_quaternion` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`inverse` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0) **)** |static| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Basis` right **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | **operator *** **(** :ref:`Basis` right **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | **operator *** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | **operator *** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Basis` right **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`orthonormalized` **(** **)** |const| | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** |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` **(** :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:`int` | :ref:`get_orthogonal_index` **(** **)** |const| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quaternion` | :ref:`get_rotation_quaternion` **(** **)** |const| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_scale` **(** **)** |const| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`inverse` **(** **)** |const| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b **)** |const| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0) **)** |static| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`orthonormalized` **(** **)** |const| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** |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| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++-------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Basis` right **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`operator []` **(** :ref:`int` index **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Basis_constant_EULER_ORDER_XYZ: + +.. _class_Basis_constant_EULER_ORDER_XZY: + +.. _class_Basis_constant_EULER_ORDER_YXZ: + +.. _class_Basis_constant_EULER_ORDER_YZX: + +.. _class_Basis_constant_EULER_ORDER_ZXY: + +.. _class_Basis_constant_EULER_ORDER_ZYX: + .. _class_Basis_constant_IDENTITY: .. _class_Basis_constant_FLIP_X: @@ -130,6 +152,18 @@ Constants .. _class_Basis_constant_FLIP_Z: +- **EULER_ORDER_XYZ** = **0** + +- **EULER_ORDER_XZY** = **1** + +- **EULER_ORDER_YXZ** = **2** + +- **EULER_ORDER_YZX** = **3** + +- **EULER_ORDER_ZXY** = **4** + +- **EULER_ORDER_ZYX** = **5** + - **IDENTITY** = **Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)** --- The identity basis, with no rotation or scaling applied. This is identical to calling ``Basis()`` without any parameters. This constant can be used to make your code clearer, and for consistency with C#. @@ -177,48 +211,41 @@ The basis matrix's Y vector (column 1). Equivalent to array index ``1``. The basis matrix's Z vector (column 2). Equivalent to array index ``2``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Basis_method_Basis: +.. _class_Basis_constructor_Basis: -- :ref:`Basis` **Basis** **(** **)** |constructor| +- :ref:`Basis` **Basis** **(** **)** Constructs a default-initialized ``Basis`` set to :ref:`IDENTITY`. ---- -- :ref:`Basis` **Basis** **(** :ref:`Basis` from **)** |constructor| +- :ref:`Basis` **Basis** **(** :ref:`Basis` from **)** Constructs a ``Basis`` as a copy of the given ``Basis``. ---- -- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** |constructor| +- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Constructs a pure rotation basis matrix, rotated around the given ``axis`` by ``phi``, in radians. The axis must be a normalized vector. ---- -- :ref:`Basis` **Basis** **(** :ref:`Vector3` euler **)** |constructor| - -Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when \*composing\*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle). - -Consider using the :ref:`Quaternion` constructor instead, which uses a quaternion instead of Euler angles. - ----- - -- :ref:`Basis` **Basis** **(** :ref:`Quaternion` from **)** |constructor| +- :ref:`Basis` **Basis** **(** :ref:`Quaternion` from **)** Constructs a pure rotation basis matrix from the given quaternion. ---- -- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** |constructor| +- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Constructs a basis matrix from 3 axis vectors (matrix columns). ----- +Method Descriptions +------------------- .. _class_Basis_method_determinant: @@ -230,6 +257,12 @@ A negative determinant means the basis has a negative scale. A zero determinant ---- +.. _class_Basis_method_from_euler: + +- :ref:`Basis` **from_euler** **(** :ref:`Vector3` euler, :ref:`int` order=2 **)** |static| + +---- + .. _class_Basis_method_from_scale: - :ref:`Basis` **from_scale** **(** :ref:`Vector3` scale **)** |static| @@ -240,7 +273,7 @@ Constructs a pure scale basis matrix with no rotation or shearing. The scale val .. _class_Basis_method_get_euler: -- :ref:`Vector3` **get_euler** **(** **)** |const| +- :ref:`Vector3` **get_euler** **(** :ref:`int` order=2 **)** |const| Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). @@ -298,54 +331,6 @@ The up axis (+Y) points as close to the ``up`` vector as possible while staying ---- -.. _class_Basis_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Basis` right **)** |operator| - ----- - -.. _class_Basis_method_operator *: - -- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** |operator| - ----- - -- :ref:`Basis` **operator *** **(** :ref:`Basis` right **)** |operator| - ----- - -- :ref:`Basis` **operator *** **(** :ref:`float` right **)** |operator| - -This operator multiplies all components of the ``Basis``, which scales it uniformly. - ----- - -- :ref:`Basis` **operator *** **(** :ref:`int` right **)** |operator| - -This operator multiplies all components of the ``Basis``, which scales it uniformly. - ----- - -.. _class_Basis_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Basis` right **)** |operator| - ----- - -.. _class_Basis_method_operator []: - -- :ref:`Vector3` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_Basis_method_orthonormalized: - :ref:`Basis` **orthonormalized** **(** **)** |const| @@ -408,6 +393,55 @@ Transposed dot product with the Z axis of the matrix. Returns the transposed version of the matrix. +Operator Descriptions +--------------------- + +.. _class_Basis_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Basis` right **)** + +---- + +.. _class_Basis_operator_mul_Basis: + +- :ref:`Basis` **operator *** **(** :ref:`Basis` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** + +---- + +- :ref:`Basis` **operator *** **(** :ref:`float` right **)** + +This operator multiplies all components of the ``Basis``, which scales it uniformly. + +---- + +- :ref:`Basis` **operator *** **(** :ref:`int` right **)** + +This operator multiplies all components of the ``Basis``, which scales it uniformly. + +---- + +.. _class_Basis_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Basis` right **)** + +---- + +.. _class_Basis_operator_idx_Vector3: + +- :ref:`Vector3` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 226c83c5d..71f1078ec 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BitMap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -88,7 +88,7 @@ Returns the amount of bitmap elements that are set to ``true``. - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** -Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied. +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`. ---- diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index ce2218815..ef35eb3c7 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Bone2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index ed7a1738d..bac5a8ae0 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BoneAttachment3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 8295f3063..2beb00850 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the bool.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -118,97 +118,105 @@ The following code will set ``can_shoot`` to ``false`` and start a timer. This w -Methods -------- +Constructors +------------ -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** **)** |constructor| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`bool` from **)** |constructor| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** |constructor| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** |constructor| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`bool` right **)** |operator| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`bool` right **)** |operator| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`bool` right **)** |operator| | -+-------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`bool` right **)** |operator| | -+-------------------------+----------------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------+-------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_bool_method_bool: ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`bool` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator <` **(** :ref:`bool` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`bool` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator >` **(** :ref:`bool` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------+ -- :ref:`bool` **bool** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_bool_constructor_bool: + +- :ref:`bool` **bool** **(** **)** Constructs a default-initialized ``bool`` set to ``false``. ---- -- :ref:`bool` **bool** **(** :ref:`bool` from **)** |constructor| +- :ref:`bool` **bool** **(** :ref:`bool` from **)** Constructs a ``bool`` as a copy of the given ``bool``. ---- -- :ref:`bool` **bool** **(** :ref:`float` from **)** |constructor| +- :ref:`bool` **bool** **(** :ref:`float` from **)** Cast a :ref:`float` value to a boolean value, this method will return ``false`` if ``0.0`` is passed in, and ``true`` for all other floats. ---- -- :ref:`bool` **bool** **(** :ref:`int` from **)** |constructor| +- :ref:`bool` **bool** **(** :ref:`int` from **)** Cast an :ref:`int` value to a boolean value, this method will return ``false`` if ``0`` is passed in, and ``true`` for all other ints. ----- +Operator Descriptions +--------------------- -.. _class_bool_method_operator !=: +.. _class_bool_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`bool` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`bool` right **)** Returns ``true`` if two bools are different, i.e. one is ``true`` and the other is ``false``. ---- -.. _class_bool_method_operator <: +.. _class_bool_operator_lt_bool: -- :ref:`bool` **operator <** **(** :ref:`bool` right **)** |operator| +- :ref:`bool` **operator <** **(** :ref:`bool` right **)** -Returns ``true`` if left operand is ``false`` and right operand is ``true``. +Returns ``true`` if the left operand is ``false`` and the right operand is ``true``. ---- -.. _class_bool_method_operator ==: +.. _class_bool_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`bool` right **)** |operator| +- :ref:`bool` **operator ==** **(** **)** Returns ``true`` if two bools are equal, i.e. both are ``true`` or both are ``false``. ---- -.. _class_bool_method_operator >: +- :ref:`bool` **operator ==** **(** :ref:`bool` right **)** -- :ref:`bool` **operator >** **(** :ref:`bool` right **)** |operator| +Returns ``true`` if two bools are equal, i.e. both are ``true`` or both are ``false``. -Returns ``true`` if left operand is ``true`` and right operand is ``false``. +---- + +.. _class_bool_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`bool` right **)** + +Returns ``true`` if the left operand is ``true`` and the right operand is ``false``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index fbbdd2232..8abf1b471 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BoxContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_boxmesh.rst b/classes/class_boxmesh.rst index 37dbbdd15..4e29cf5cd 100644 --- a/classes/class_boxmesh.rst +++ b/classes/class_boxmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BoxMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_boxshape3d.rst b/classes/class_boxshape3d.rst index bd3087958..7fd0a17d7 100644 --- a/classes/class_boxshape3d.rst +++ b/classes/class_boxshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BoxShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_button.rst b/classes/class_button.rst index 3f82c58e1..bdf2428fd 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Button.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -114,6 +114,8 @@ Theme Properties +---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.2)`` | +---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.94, 0.94, 0.94, 1)`` | +---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | @@ -130,6 +132,8 @@ Theme Properties +---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`icon_disabled_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`icon_focus_color` | ``Color(1, 1, 1, 1)`` | ++---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`icon_hover_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`icon_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | @@ -383,6 +387,18 @@ Text :ref:`Color` used when the ``Button`` is disabled. ---- +.. _class_Button_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+--------------------------------+ +| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------+--------------------------------+ + +Text :ref:`Color` used when the ``Button`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_Button_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** @@ -471,6 +487,18 @@ Icon modulate :ref:`Color` used when the ``Button`` is disabled. ---- +.. _class_Button_theme_color_icon_focus_color: + +- :ref:`Color` **icon_focus_color** + ++-----------+-----------------------+ +| *Default* | ``Color(1, 1, 1, 1)`` | ++-----------+-----------------------+ + +Icon modulate :ref:`Color` used when the ``Button`` is focused. Only replaces the normal modulate color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_Button_theme_color_icon_hover_color: - :ref:`Color` **icon_hover_color** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index ddefa918f..3c850c80c 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ButtonGroup.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_callable.rst b/classes/class_callable.rst index e5b2812af..11083aa0d 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Callable.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -49,75 +49,86 @@ Description +Constructors +------------ + ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Callable` | :ref:`Callable` **(** **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Callable` | :ref:`Callable` **(** :ref:`Callable` from **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Callable` | :ref:`Callable` **(** :ref:`Object` object, :ref:`StringName` method **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Callable` | :ref:`Callable` **(** **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Callable` | :ref:`Callable` **(** :ref:`Callable` from **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Callable` | :ref:`Callable` **(** :ref:`Object` object, :ref:`StringName` method **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Callable` | :ref:`bind` **(** ... **)** |vararg| |const| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** ... **)** |vararg| |const| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** ... **)** |vararg| |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| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Callable` right **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Callable` right **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`Variant` | :ref:`call` **(** ... **)** |vararg| |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_deferred` **(** ... **)** |vararg| |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| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_Callable_method_Callable: ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Callable` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Callable` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ -- :ref:`Callable` **Callable** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_Callable_constructor_Callable: + +- :ref:`Callable` **Callable** **(** **)** Constructs a null ``Callable`` with no object nor method bound. ---- -- :ref:`Callable` **Callable** **(** :ref:`Callable` from **)** |constructor| +- :ref:`Callable` **Callable** **(** :ref:`Callable` from **)** Constructs a ``Callable`` as a copy of the given ``Callable``. ---- -- :ref:`Callable` **Callable** **(** :ref:`Object` object, :ref:`StringName` method **)** |constructor| +- :ref:`Callable` **Callable** **(** :ref:`Object` object, :ref:`StringName` method **)** Creates a new ``Callable`` for the method called ``method`` in the specified ``object``. ----- +Method Descriptions +------------------- .. _class_Callable_method_bind: @@ -207,30 +218,6 @@ Returns ``true`` if the object exists and has a valid function assigned, or is a ---- -.. _class_Callable_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Callable` right **)** |operator| - -Returns ``true`` if both ``Callable``\ s invoke different targets. - ----- - -.. _class_Callable_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Callable` right **)** |operator| - -Returns ``true`` if both ``Callable``\ s invoke the same custom target. - ----- - .. _class_Callable_method_rpc: - void **rpc** **(** ... **)** |vararg| |const| @@ -253,6 +240,31 @@ Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer do Returns a copy of this ``Callable`` with the arguments unbound. Calling the returned ``Callable`` will call the method without the extra arguments that are supplied in the ``Callable`` on which you are calling this method. +Operator Descriptions +--------------------- + +.. _class_Callable_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Callable` right **)** + +Returns ``true`` if both ``Callable``\ s invoke different targets. + +---- + +.. _class_Callable_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Callable` right **)** + +Returns ``true`` if both ``Callable``\ s invoke the same custom target. + .. |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.)` diff --git a/classes/class_callbacktweener.rst b/classes/class_callbacktweener.rst index ef6c51299..25510ce9c 100644 --- a/classes/class_callbacktweener.rst +++ b/classes/class_callbacktweener.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CallbackTweener.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 516e24c42..66fcf3c9d 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Camera2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_camera3d.rst b/classes/class_camera3d.rst index 109b90d1b..2dc5d2327 100644 --- a/classes/class_camera3d.rst +++ b/classes/class_camera3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Camera3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cameraeffects.rst b/classes/class_cameraeffects.rst index e115d3010..255376961 100644 --- a/classes/class_cameraeffects.rst +++ b/classes/class_cameraeffects.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CameraEffects.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index cb78a45be..6a20dc2a1 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CameraFeed.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index 6b5b0e358..b2b9dafe3 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CameraServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 5c48398d1..f7eeaf1ae 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CameraTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_canvasgroup.rst b/classes/class_canvasgroup.rst index a38543be3..6fe39bdd1 100644 --- a/classes/class_canvasgroup.rst +++ b/classes/class_canvasgroup.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CanvasGroup.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index ccae88b07..a92adb829 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CanvasItem.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -78,7 +78,7 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next="", :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| | +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next="", :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,7 +96,7 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| | +| void | :ref:`draw_multiline_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture2D` texture **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -114,7 +114,7 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| | +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -506,7 +506,7 @@ Draws an arc between the given angles. The larger the value of ``point_count``, .. _class_CanvasItem_method_draw_char: -- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next="", :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| +- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next="", :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character. @@ -582,7 +582,7 @@ Draws multiple, parallel lines with a uniform ``width`` and segment-by-segment c .. _class_CanvasItem_method_draw_multiline_string: -- void **draw_multiline_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| +- void **draw_multiline_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| Breaks ``text`` to the lines and draws it using the specified ``font`` at the ``position`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``clip_w`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -656,7 +656,7 @@ Sets a custom transform for drawing via matrix. Anything drawn afterwards will b .. _class_CanvasItem_method_draw_string: -- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| +- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| Draws ``text`` using the specified ``font`` at the ``position`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``clip_w`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index f4e43afa5..83bcd2d66 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CanvasItemMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 79fa3485f..883e625dd 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CanvasLayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index f0bd6e0bd..86c3059d8 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CanvasModulate.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_canvastexture.rst b/classes/class_canvastexture.rst index 212f08d55..f08e6e686 100644 --- a/classes/class_canvastexture.rst +++ b/classes/class_canvastexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CanvasTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 556bc9d12..9aa2616a7 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CapsuleMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 57cd3fb91..4c8529021 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CapsuleShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_capsuleshape3d.rst b/classes/class_capsuleshape3d.rst index 907f86fe3..926e5661b 100644 --- a/classes/class_capsuleshape3d.rst +++ b/classes/class_capsuleshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CapsuleShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 677b7edb6..0b0820c4a 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CenterContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index 3992b1f27..7b17dbeca 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CharacterBody2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index 65bf242ec..8f2ced558 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CharacterBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index 3fa1c4b97..7b04cfe02 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CharFXTransform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -83,7 +83,7 @@ The color the character will be drawn with. | *Getter* | get_elapsed_time() | +-----------+-------------------------+ -The time elapsed since the :ref:`RichTextLabel` was added to the scene tree (in seconds). Time stops when the project is paused depending on the value of the :ref:`RichTextLabel`'s :ref:`Node.process_mode`. +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. **Note:** Time still passes while the :ref:`RichTextLabel` is hidden. diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index d6e26f2a8..7004c6c03 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CheckBox.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -49,6 +49,8 @@ Theme Properties +-----------------------------------+--------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.2)`` | +-----------------------------------+--------------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------------------------------+--------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.94, 0.94, 0.94, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | @@ -111,6 +113,8 @@ The check icon to display when the ``CheckBox`` is checked. - :ref:`Texture2D` **checked_disabled** +The check icon to display when the ``CheckBox`` is checked and disabled. + ---- .. _class_CheckBox_theme_style_disabled: @@ -161,6 +165,18 @@ The ``CheckBox`` text's font color when it's disabled. ---- +.. _class_CheckBox_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+--------------------------------+ +| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------+--------------------------------+ + +The ``CheckBox`` text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_CheckBox_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** @@ -313,6 +329,8 @@ The check icon to display when the ``CheckBox`` is unchecked. - :ref:`Texture2D` **unchecked_disabled** +The check icon to display when the ``CheckBox`` is unchecked and disabled. + .. |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.)` diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index e74c6623e..ddd952685 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CheckButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -45,6 +45,8 @@ Theme Properties +-----------------------------------+-----------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.2)`` | +-----------------------------------+-----------------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------------------------------+-----------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.94, 0.94, 0.94, 1)`` | +-----------------------------------+-----------------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | @@ -147,6 +149,18 @@ The ``CheckButton`` text's font color when it's disabled. ---- +.. _class_CheckButton_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+--------------------------------+ +| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------+--------------------------------+ + +The ``CheckButton`` text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_CheckButton_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index fccc1a8cc..e56aacad3 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CircleShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 9da557de0..07d191de1 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ClassDB.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_codeedit.rst b/classes/class_codeedit.rst index 28eaf704d..52e4b8564 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CodeEdit.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -64,8 +64,6 @@ Properties +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`int[]` | :ref:`line_length_guidelines` | ``[]`` | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ -| :ref:`Array` | structured_text_bidi_override_options | ``[]`` *(parent override)* | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`bool` | :ref:`symbol_lookup_on_click` | ``false`` | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`TextDirection` | text_direction | ``1`` *(parent override)* | diff --git a/classes/class_codehighlighter.rst b/classes/class_codehighlighter.rst index 8c20421cc..3bef0510b 100644 --- a/classes/class_codehighlighter.rst +++ b/classes/class_codehighlighter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CodeHighlighter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 91f11a0ad..3a192dcd6 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CollisionObject2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_collisionobject3d.rst b/classes/class_collisionobject3d.rst index 27f6c23b3..3c0d4a834 100644 --- a/classes/class_collisionobject3d.rst +++ b/classes/class_collisionobject3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CollisionObject3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 1e3391b9b..9b20faa5a 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CollisionPolygon2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_collisionpolygon3d.rst b/classes/class_collisionpolygon3d.rst index 308e640ed..b91143733 100644 --- a/classes/class_collisionpolygon3d.rst +++ b/classes/class_collisionpolygon3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CollisionPolygon3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 13938c032..8fcafff43 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CollisionShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_collisionshape3d.rst b/classes/class_collisionshape3d.rst index f138eb743..a99745428 100644 --- a/classes/class_collisionshape3d.rst +++ b/classes/class_collisionshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CollisionShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_color.rst b/classes/class_color.rst index a074bad42..e6fa3b5eb 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Color.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -60,102 +60,114 @@ Properties | :ref:`float` | :ref:`v` | ``0.0`` | +---------------------------+------------------------------------+---------+ +Constructors +------------ + ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`Color` from **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`Color` from, :ref:`float` alpha **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` code **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` code, :ref:`float` alpha **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** |constructor| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`int` | :ref:`find_named_color` **(** :ref:`String` name **)** |static| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`from_rgbe9995` **(** :ref:`int` rgbe **)** |static| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`from_string` **(** :ref:`String` str, :ref:`Color` default **)** |static| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_named_color` **(** :ref:`int` idx **)** |static| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_named_color_count` **(** **)** |static| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_color_name` **(** :ref:`int` idx **)** |static| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`bool` | **operator !=** **(** **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Color` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator *** **(** :ref:`Color` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator *** **(** :ref:`float` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator *** **(** :ref:`int` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator +** **(** :ref:`Color` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator -** **(** :ref:`Color` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator /** **(** :ref:`Color` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator /** **(** :ref:`float` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator /** **(** :ref:`int` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Color` right **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator unary+** **(** **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator unary-** **(** **)** |operator| | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` **(** :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:`int` | :ref:`find_named_color` **(** :ref:`String` name **)** |static| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :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:`Color` | :ref:`get_named_color` **(** :ref:`int` idx **)** |static| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_named_color_count` **(** **)** |static| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_named_color_name` **(** :ref:`int` idx **)** |static| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** :ref:`Color` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`operator unary+` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`operator unary-` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ Constants --------- @@ -877,24 +889,18 @@ The HSV saturation of this color, on the range 0 to 1. The HSV value (brightness) of this color, on the range 0 to 1. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Color_method_Color: +.. _class_Color_constructor_Color: -- :ref:`Color` **Color** **(** **)** |constructor| +- :ref:`Color` **Color** **(** **)** Constructs a default-initialized ``Color`` with all components set to ``0``. ---- -- :ref:`Color` **Color** **(** :ref:`Color` from **)** |constructor| - -Constructs a ``Color`` as a copy of the given ``Color``. - ----- - -- :ref:`Color` **Color** **(** :ref:`Color` from, :ref:`float` alpha **)** |constructor| +- :ref:`Color` **Color** **(** :ref:`Color` from, :ref:`float` alpha **)** Constructs a ``Color`` from an existing color, but with a custom alpha value. @@ -913,38 +919,25 @@ Constructs a ``Color`` from an existing color, but with a custom alpha value. ---- -- :ref:`Color` **Color** **(** :ref:`String` code **)** |constructor| +- :ref:`Color` **Color** **(** :ref:`Color` from **)** + +Constructs a ``Color`` as a copy of the given ``Color``. + +---- + +- :ref:`Color` **Color** **(** :ref:`String` code **)** Constructs a ``Color`` either from an HTML color code or from a standardized color name. Supported color names are the same as the constants. ---- -- :ref:`Color` **Color** **(** :ref:`String` code, :ref:`float` alpha **)** |constructor| +- :ref:`Color` **Color** **(** :ref:`String` code, :ref:`float` alpha **)** Constructs a ``Color`` either from an HTML color code or from a standardized color name, with ``alpha`` on the range of 0 to 1. Supported color names are the same as the constants. ---- -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** |constructor| - -Constructs a ``Color`` from RGBA values, typically between 0 and 1. - - -.. tabs:: - - .. code-tab:: gdscript - - var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)` - - .. code-tab:: csharp - - var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)` - - - ----- - -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** |constructor| +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** Constructs a ``Color`` from RGB values, typically between 0 and 1. Alpha will be 1. @@ -963,6 +956,26 @@ Constructs a ``Color`` from RGB values, typically between 0 and 1. Alpha will be ---- +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** + +Constructs a ``Color`` from RGBA values, typically between 0 and 1. + + +.. tabs:: + + .. code-tab:: gdscript + + var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)` + + .. code-tab:: csharp + + var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)` + + + +Method Descriptions +------------------- + .. _class_Color_method_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** |const| @@ -1023,6 +1036,27 @@ Returns a new color resulting from making this color darker by the specified per - :ref:`int` **find_named_color** **(** :ref:`String` name **)** |static| +---- + +.. _class_Color_method_from_hsv: + +- :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` alpha=1.0 **)** |static| + +Constructs a color from an `HSV profile `__. ``h`` (hue), ``s`` (saturation), and ``v`` (value) are typically between 0 and 1. + + +.. tabs:: + + .. code-tab:: gdscript + + var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) + + .. code-tab:: csharp + + var c = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f); + + + ---- .. _class_Color_method_from_rgbe9995: @@ -1156,84 +1190,6 @@ Returns a new color resulting from making this color lighter by the specified pe ----- - -.. _class_Color_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Color` right **)** |operator| - ----- - -.. _class_Color_method_operator *: - -- :ref:`Color` **operator *** **(** :ref:`Color` right **)** |operator| - ----- - -- :ref:`Color` **operator *** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Color` **operator *** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Color_method_operator +: - -- :ref:`Color` **operator +** **(** :ref:`Color` right **)** |operator| - ----- - -.. _class_Color_method_operator -: - -- :ref:`Color` **operator -** **(** :ref:`Color` right **)** |operator| - ----- - -.. _class_Color_method_operator /: - -- :ref:`Color` **operator /** **(** :ref:`Color` right **)** |operator| - ----- - -- :ref:`Color` **operator /** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Color` **operator /** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Color_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Color` right **)** |operator| - ----- - -.. _class_Color_method_operator []: - -- :ref:`float` **operator []** **(** :ref:`int` index **)** |operator| - ----- - -.. _class_Color_method_operator unary+: - -- :ref:`Color` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Color_method_operator unary-: - -- :ref:`Color` **operator unary-** **(** **)** |operator| - ---- .. _class_Color_method_to_abgr32: @@ -1399,6 +1355,85 @@ Returns the color converted to a 64-bit integer in RGBA format (each word repres +Operator Descriptions +--------------------- + +.. _class_Color_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Color` right **)** + +---- + +.. _class_Color_operator_mul_Color: + +- :ref:`Color` **operator *** **(** :ref:`Color` right **)** + +---- + +- :ref:`Color` **operator *** **(** :ref:`float` right **)** + +---- + +- :ref:`Color` **operator *** **(** :ref:`int` right **)** + +---- + +.. _class_Color_operator_sum_Color: + +- :ref:`Color` **operator +** **(** :ref:`Color` right **)** + +---- + +.. _class_Color_operator_dif_Color: + +- :ref:`Color` **operator -** **(** :ref:`Color` right **)** + +---- + +.. _class_Color_operator_div_Color: + +- :ref:`Color` **operator /** **(** :ref:`Color` right **)** + +---- + +- :ref:`Color` **operator /** **(** :ref:`float` right **)** + +---- + +- :ref:`Color` **operator /** **(** :ref:`int` right **)** + +---- + +.. _class_Color_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Color` right **)** + +---- + +.. _class_Color_operator_idx_float: + +- :ref:`float` **operator []** **(** :ref:`int` index **)** + +---- + +.. _class_Color_operator_unplus_Color: + +- :ref:`Color` **operator unary+** **(** **)** + +---- + +.. _class_Color_operator_unminus_Color: + +- :ref:`Color` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 2238e3a53..4101f2048 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ColorPicker.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 9f2d5cbc0..45b9575e0 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ColorPickerButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -65,6 +65,8 @@ Theme Properties +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.3)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | @@ -151,6 +153,8 @@ Method Descriptions Returns the :ref:`ColorPicker` that this node toggles. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_ColorPickerButton_method_get_popup: @@ -159,6 +163,8 @@ Returns the :ref:`ColorPicker` that this node toggles. 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. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`Window.visible` property. + Theme Property Descriptions --------------------------- @@ -218,6 +224,18 @@ Text :ref:`Color` used when the ``ColorPickerButton`` is disabled. ---- +.. _class_ColorPickerButton_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+-----------------------+ +| *Default* | ``Color(1, 1, 1, 1)`` | ++-----------+-----------------------+ + +Text :ref:`Color` used when the ``ColorPickerButton`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_ColorPickerButton_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index fab7c7fb3..3e6371ca9 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ColorRect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 005a04169..2f8532467 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_concavepolygonshape3d.rst b/classes/class_concavepolygonshape3d.rst index 54af2936e..5bc3764a1 100644 --- a/classes/class_concavepolygonshape3d.rst +++ b/classes/class_concavepolygonshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_conetwistjoint3d.rst b/classes/class_conetwistjoint3d.rst index c1ceba101..634f5773b 100644 --- a/classes/class_conetwistjoint3d.rst +++ b/classes/class_conetwistjoint3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConeTwistJoint3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index f2133fe36..854c26229 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConfigFile.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index e1ca999bd..36b7c9fa2 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConfirmationDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -62,6 +62,8 @@ Method Descriptions Returns the cancel button. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + .. |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.)` diff --git a/classes/class_container.rst b/classes/class_container.rst index be595f65e..48ae7d993 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Container.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_control.rst b/classes/class_control.rst index 8c75cba1e..0d159634a 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Control.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BaseButton`, :ref:`ColorRect`, :ref:`Container`, :ref:`EditorDebuggerPlugin`, :ref:`GraphEdit`, :ref:`ItemList`, :ref:`Label`, :ref:`LineEdit`, :ref:`NinePatchRect`, :ref:`Panel`, :ref:`Range`, :ref:`ReferenceRect`, :ref:`RichTextLabel`, :ref:`Separator`, :ref:`Tabs`, :ref:`TextEdit`, :ref:`TextureRect`, :ref:`Tree`, :ref:`VideoPlayer` +**Inherited By:** :ref:`BaseButton`, :ref:`ColorRect`, :ref:`Container`, :ref:`EditorDebuggerPlugin`, :ref:`GraphEdit`, :ref:`ItemList`, :ref:`Label`, :ref:`LineEdit`, :ref:`NinePatchRect`, :ref:`Panel`, :ref:`Range`, :ref:`ReferenceRect`, :ref:`RichTextLabel`, :ref:`Separator`, :ref:`TabBar`, :ref:`TextEdit`, :ref:`TextureRect`, :ref:`Tree`, :ref:`VideoPlayer` All user interface nodes inherit from Control. A control's anchors and offsets adapt its position and size relative to its parent. @@ -272,7 +272,7 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_forwarding` **(** :ref:`Node` target **)** | +| void | :ref:`set_drag_forwarding` **(** :ref:`Object` target **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1240,7 +1240,7 @@ The node's scale, relative to its :ref:`rect_size`__ instead of scaling Controls individually. -**Note:** If the Control node is a child of a :ref:`Container` node, the scale will be reset to ``Vector2(1, 1)`` when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using ``yield(get_tree(), "process_frame")`` then set its :ref:`rect_scale` property. +**Note:** If the Control node is a child of a :ref:`Container` node, the scale will be reset to ``Vector2(1, 1)`` when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using ``await get_tree().process_frame`` then set its :ref:`rect_scale` property. ---- @@ -2252,11 +2252,11 @@ Sets :ref:`offset_left` and :ref:`offset_top .. _class_Control_method_set_drag_forwarding: -- void **set_drag_forwarding** **(** :ref:`Node` target **)** +- void **set_drag_forwarding** **(** :ref:`Object` target **)** -Forwards the handling of this control's drag and drop to ``target`` node. +Forwards the handling of this control's drag and drop to ``target`` object. -Forwarding can be implemented in the target node similar to the methods :ref:`_get_drag_data`, :ref:`_can_drop_data`, and :ref:`_drop_data` but with two differences: +Forwarding can be implemented in the target object similar to the methods :ref:`_get_drag_data`, :ref:`_can_drop_data`, and :ref:`_drop_data` but with two differences: 1. The function name must be suffixed with **_fw** diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 59137ec26..fd5d8d96b 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConvexPolygonShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_convexpolygonshape3d.rst b/classes/class_convexpolygonshape3d.rst index 15fee28a5..ef52ab138 100644 --- a/classes/class_convexpolygonshape3d.rst +++ b/classes/class_convexpolygonshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ConvexPolygonShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index ac0db76b6..a6b5418b7 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CPUParticles2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index 6980c7410..95aa65124 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CPUParticles3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -556,7 +556,7 @@ Each particle's initial color. To have particle display color in a :ref:`BaseMat | *Getter* | get_color_ramp() | +----------+-----------------------+ -Each particle's color will vary along this :ref:`GradientTexture` over its lifetime (multiplied with :ref:`color`). +Each particle's color will vary along this :ref:`GradientTexture1D` over its lifetime (multiplied with :ref:`color`). ---- diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index ea0b497e5..5aa6525e5 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Crypto.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index 7943d2baf..67e347aa5 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CryptoKey.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgbox3d.rst b/classes/class_csgbox3d.rst index 19cccc55c..fa3beae4f 100644 --- a/classes/class_csgbox3d.rst +++ b/classes/class_csgbox3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGBox3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgcombiner3d.rst b/classes/class_csgcombiner3d.rst index b41b7a621..255c5dcb8 100644 --- a/classes/class_csgcombiner3d.rst +++ b/classes/class_csgcombiner3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGCombiner3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgcylinder3d.rst b/classes/class_csgcylinder3d.rst index 6370d39a0..ae3c881dd 100644 --- a/classes/class_csgcylinder3d.rst +++ b/classes/class_csgcylinder3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGCylinder3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgmesh3d.rst b/classes/class_csgmesh3d.rst index 86a549bc5..b65895562 100644 --- a/classes/class_csgmesh3d.rst +++ b/classes/class_csgmesh3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGMesh3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgpolygon3d.rst b/classes/class_csgpolygon3d.rst index 742d57932..4ca325c3f 100644 --- a/classes/class_csgpolygon3d.rst +++ b/classes/class_csgpolygon3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGPolygon3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgprimitive3d.rst b/classes/class_csgprimitive3d.rst index 43d7b3cf7..3bae451ac 100644 --- a/classes/class_csgprimitive3d.rst +++ b/classes/class_csgprimitive3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGPrimitive3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index 94cb12c85..21ec91190 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgsphere3d.rst b/classes/class_csgsphere3d.rst index 5fc0fffd5..44bf27426 100644 --- a/classes/class_csgsphere3d.rst +++ b/classes/class_csgsphere3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGSphere3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csgtorus3d.rst b/classes/class_csgtorus3d.rst index aefb0284c..abc209e80 100644 --- a/classes/class_csgtorus3d.rst +++ b/classes/class_csgtorus3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSGTorus3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index f5f0241be..c14e66c5f 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CSharpScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 2efcf52c7..5acc97d36 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Cubemap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cubemaparray.rst b/classes/class_cubemaparray.rst index a1067aa23..70672a10a 100644 --- a/classes/class_cubemaparray.rst +++ b/classes/class_cubemaparray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CubemapArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 5ed242425..cb321a83c 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Curve.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 9989b4174..0c8e17a5d 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Curve2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index f48359e93..f2cad4d85 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Curve3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 3d8fbe5bf..cafca3de4 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CurveTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_curvexyztexture.rst b/classes/class_curvexyztexture.rst index 70f7b8f93..dabaf9b9c 100644 --- a/classes/class_curvexyztexture.rst +++ b/classes/class_curvexyztexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CurveXYZTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 7a5727a7f..043122378 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CylinderMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_cylindershape3d.rst b/classes/class_cylindershape3d.rst index dae974559..6ce500bb6 100644 --- a/classes/class_cylindershape3d.rst +++ b/classes/class_cylindershape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CylinderShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index e9f658124..9cb8dd52b 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the DampedSpringJoint2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_decal.rst b/classes/class_decal.rst index 53b29fbdb..47edc8890 100644 --- a/classes/class_decal.rst +++ b/classes/class_decal.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Decal.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 84610b6c5..a5c7233dc 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Dictionary.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -242,13 +242,18 @@ Tutorials - `OS Test Demo `__ +Constructors +------------ + ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`Dictionary` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`Dictionary` **(** :ref:`Dictionary` from **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`Dictionary` **(** **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`Dictionary` **(** :ref:`Dictionary` from **)** |constructor| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -268,37 +273,43 @@ Methods +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`keys` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Dictionary` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Dictionary` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | **operator []** **(** :ref:`Variant` key **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`values` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_Dictionary_method_Dictionary: ++-------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Dictionary` right **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Dictionary` right **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`operator []` **(** :ref:`Variant` key **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------+ -- :ref:`Dictionary` **Dictionary** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_Dictionary_constructor_Dictionary: + +- :ref:`Dictionary` **Dictionary** **(** **)** Constructs an empty ``Dictionary``. ---- -- :ref:`Dictionary` **Dictionary** **(** :ref:`Dictionary` from **)** |constructor| +- :ref:`Dictionary` **Dictionary** **(** :ref:`Dictionary` from **)** Constructs a ``Dictionary`` as a copy of the given ``Dictionary``. ----- +Method Descriptions +------------------- .. _class_Dictionary_method_clear: @@ -419,32 +430,6 @@ Returns the list of keys in the ``Dictionary``. ---- -.. _class_Dictionary_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Dictionary` right **)** |operator| - ----- - -.. _class_Dictionary_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Dictionary` right **)** |operator| - ----- - -.. _class_Dictionary_method_operator []: - -- :ref:`Variant` **operator []** **(** :ref:`Variant` key **)** |operator| - ----- - .. _class_Dictionary_method_size: - :ref:`int` **size** **(** **)** |const| @@ -459,6 +444,33 @@ Returns the number of keys in the dictionary. Returns the list of values in the ``Dictionary``. +Operator Descriptions +--------------------- + +.. _class_Dictionary_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Dictionary` right **)** + +---- + +.. _class_Dictionary_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Dictionary` right **)** + +---- + +.. _class_Dictionary_operator_idx_Variant: + +- :ref:`Variant` **operator []** **(** :ref:`Variant` key **)** + .. |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.)` diff --git a/classes/class_directionallight2d.rst b/classes/class_directionallight2d.rst index 2ef5239fe..79b08ffa0 100644 --- a/classes/class_directionallight2d.rst +++ b/classes/class_directionallight2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the DirectionalLight2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -37,7 +37,7 @@ Property Descriptions | *Getter* | get_height() | +-----------+-------------------+ -The height of the light. Used with 2D normal mapping. +The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to the plane) to 1 (perpendicular to the plane). ---- diff --git a/classes/class_directionallight3d.rst b/classes/class_directionallight3d.rst index 75a4f0709..a0cdef31e 100644 --- a/classes/class_directionallight3d.rst +++ b/classes/class_directionallight3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the DirectionalLight3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -82,7 +82,7 @@ Property Descriptions | *Getter* | is_blend_splits_enabled() | +-----------+---------------------------+ -If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. +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`. ---- @@ -98,7 +98,7 @@ If ``true``, shadow detail is sacrificed in exchange for smoother transitions be | *Getter* | 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. +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). ---- @@ -114,7 +114,7 @@ Proportion of :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_2_SPLITS`` or ``SHADOW_PARALLEL_4_SPLITS``. +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`. ---- @@ -178,7 +178,7 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow | *Getter* | 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 ``SHADOW_PARALLEL_2_SPLITS`` or ``SHADOW_PARALLEL_4_SPLITS``. +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`. ---- @@ -194,7 +194,7 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado | *Getter* | 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 ``SHADOW_PARALLEL_4_SPLITS``. +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`. ---- diff --git a/classes/class_directory.rst b/classes/class_directory.rst index b892ffa0f..ba2f7bfdb 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Directory.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 815611bf8..fbaaeaca7 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the DisplayServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -19,8 +19,12 @@ Methods +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`clipboard_get` **(** **)** |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`clipboard_get_primary` **(** **)** |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clipboard_set` **(** :ref:`String` clipboard **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clipboard_set_primary` **(** :ref:`String` clipboard_primary **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`console_set_visible` **(** :ref:`bool` console_visible **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_sub_window` **(** :ref:`WindowMode` mode, :ref:`VSyncMode` vsync_mode, :ref:`int` flags, :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** | @@ -267,6 +271,8 @@ Enumerations .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS: +.. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY: + enum **Feature**: - **FEATURE_GLOBAL_MENU** = **0** @@ -305,6 +311,8 @@ enum **Feature**: - **FEATURE_SWAP_BUFFERS** = **17** +- **FEATURE_CLIPBOARD_PRIMARY** = **19** + ---- .. _enum_DisplayServer_MouseMode: @@ -579,12 +587,36 @@ Method Descriptions - :ref:`String` **clipboard_get** **(** **)** |const| +Returns the user's clipboard as a string if possible. + +---- + +.. _class_DisplayServer_method_clipboard_get_primary: + +- :ref:`String` **clipboard_get_primary** **(** **)** |const| + +Returns the user's primary clipboard as a string if possible. + +**Note:** This method is only implemented on Linux. + ---- .. _class_DisplayServer_method_clipboard_set: - void **clipboard_set** **(** :ref:`String` clipboard **)** +Sets the user's clipboard content to the given string. + +---- + +.. _class_DisplayServer_method_clipboard_set_primary: + +- void **clipboard_set_primary** **(** :ref:`String` clipboard_primary **)** + +Sets the user's primary clipboard content to the given string. + +**Note:** This method is only implemented on Linux. + ---- .. _class_DisplayServer_method_console_set_visible: @@ -891,6 +923,8 @@ Sets active keyboard layout. - :ref:`Vector2i` **mouse_get_position** **(** **)** |const| +Returns the mouse cursor's current position. + ---- .. _class_DisplayServer_method_mouse_set_mode: @@ -903,6 +937,8 @@ Sets active keyboard layout. - void **mouse_warp_to_position** **(** :ref:`Vector2i` position **)** +Sets the mouse cursor position to the given ``position``. + ---- .. _class_DisplayServer_method_process_events: @@ -1124,6 +1160,8 @@ Shows the virtual keyboard if the platform has one. - :ref:`bool` **window_get_flag** **(** :ref:`WindowFlags` flag, :ref:`int` window_id=0 **)** |const| +Returns the current value of the given window's ``flag``. + ---- .. _class_DisplayServer_method_window_get_max_size: @@ -1142,7 +1180,7 @@ Shows the virtual keyboard if the platform has one. - :ref:`WindowMode` **window_get_mode** **(** :ref:`int` window_id=0 **)** |const| -Returns the current window's mode. +Returns the mode of the given window. ---- @@ -1150,6 +1188,8 @@ Returns the current window's mode. - :ref:`Vector2i` **window_get_position** **(** :ref:`int` window_id=0 **)** |const| +Returns the position of the given window to on the screen. + ---- .. _class_DisplayServer_method_window_get_real_size: @@ -1200,6 +1240,8 @@ Returns the VSync mode of the given window. - void **window_set_flag** **(** :ref:`WindowFlags` flag, :ref:`bool` enabled, :ref:`int` window_id=0 **)** +Enables or disables the given window's given ``flag``. See :ref:`WindowFlags` for possible values and their behavior. + ---- .. _class_DisplayServer_method_window_set_ime_active: @@ -1297,6 +1339,8 @@ Passing an empty array will disable passthrough support (all mouse events will b - void **window_set_position** **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** +Sets the position of the given window to ``position``. + ---- .. _class_DisplayServer_method_window_set_rect_changed_callback: @@ -1309,12 +1353,16 @@ Passing an empty array will disable passthrough support (all mouse events will b - void **window_set_size** **(** :ref:`Vector2i` size, :ref:`int` window_id=0 **)** +Sets the size of the given window to ``size``. + ---- .. _class_DisplayServer_method_window_set_title: - void **window_set_title** **(** :ref:`String` title, :ref:`int` window_id=0 **)** +Sets the title of the given window to ``title``. + ---- .. _class_DisplayServer_method_window_set_transient: diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index 6af8efa72..c6edf491a 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the DTLSServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorcommandpalette.rst b/classes/class_editorcommandpalette.rst index d4bd914b7..252ac794e 100644 --- a/classes/class_editorcommandpalette.rst +++ b/classes/class_editorcommandpalette.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorCommandPalette.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index 3519ada8c..92721f196 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorDebuggerPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,11 +16,13 @@ A base class to implement debugger plugins. Description ----------- -All debugger plugin scripts must extend ``EditorDebuggerPlugin``. It provides functions related to editor side of debugger. +``EditorDebuggerPlugin`` provides functions related to the editor side of the debugger. -You don't need to instantiate this class. That is handled by the debugger itself. :ref:`Control` nodes can be added as child nodes to provide a GUI front-end for the plugin. +You don't need to instantiate this class; that is automatically handled by the debugger. :ref:`Control` nodes can be added as child nodes to provide a GUI for the plugin. -Do not queue_free/reparent it's instance otherwise the instance becomes unusable. +Do not free or reparent this node, otherwise it becomes unusable. + +To use ``EditorDebuggerPlugin``, register it using the :ref:`EditorPlugin.add_debugger_plugin` method first. Methods ------- diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 12f65afd1..0467d663c 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorExportPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,9 @@ A script that is executed when exporting the project. Description ----------- -Editor export plugins are automatically activated whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, :ref:`_export_begin` is called at the beginning of the export process and then :ref:`_export_file` is called for each exported file. +``EditorExportPlugin``\ s are automatically invoked whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, :ref:`_export_begin` is called at the beginning of the export process and then :ref:`_export_file` is called for each exported file. + +To use ``EditorExportPlugin``, register it using the :ref:`EditorPlugin.add_export_plugin` method first. Methods ------- diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index 1473e2511..164b8526d 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorFeatureProfile.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 0cfbe45cd..88937ca07 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorFileDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -291,6 +291,8 @@ Removes all filters except for "All Files (\*)". Returns the ``VBoxContainer`` used to display the file system. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_EditorFileDialog_method_invalidate: diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 3fe86bf3f..ab7ec2768 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorFileSystem.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 2f1d45da3..542a79552 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorFileSystemDirectory.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index fbd0c8fce..648c1db3c 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorImportPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,9 +16,9 @@ Registers a custom resource importer in the editor. Use the class to parse any f Description ----------- -EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. +``EditorImportPlugin``\ s provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. -EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`_get_recognized_extensions` and :ref:`_get_resource_type`. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.godot/imported`` directory. +EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`_get_recognized_extensions` and :ref:`_get_resource_type`. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.godot/imported`` directory (see :ref:`ProjectSettings.application/config/use_hidden_project_data_directory`). Below is an example EditorImportPlugin that imports a :ref:`Mesh` from a file with the extension ".special" or ".spec": @@ -128,6 +128,8 @@ Below is an example EditorImportPlugin that imports a :ref:`Mesh` fr +To use ``EditorImportPlugin``, register it using the :ref:`EditorPlugin.add_import_plugin` method first. + Tutorials --------- @@ -137,13 +139,13 @@ Methods ------- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_import_options` **(** :ref:`int` preset_index **)** |virtual| |const| | +| :ref:`Array` | :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:`StringName` option_name, :ref:`Dictionary` options **)** |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| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -167,7 +169,7 @@ Method Descriptions .. _class_EditorImportPlugin_method__get_import_options: -- :ref:`Array` **_get_import_options** **(** :ref:`int` preset_index **)** |virtual| |const| +- :ref:`Array` **_get_import_options** **(** :ref:`String` path, :ref:`int` preset_index **)** |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). @@ -191,7 +193,7 @@ Gets the unique name of the importer. .. _class_EditorImportPlugin_method__get_option_visibility: -- :ref:`bool` **_get_option_visibility** **(** :ref:`StringName` option_name, :ref:`Dictionary` options **)** |virtual| |const| +- :ref:`bool` **_get_option_visibility** **(** :ref:`String` path, :ref:`StringName` option_name, :ref:`Dictionary` options **)** |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: @@ -270,7 +272,7 @@ Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``" - :ref:`String` **_get_save_extension** **(** **)** |virtual| |const| -Gets the extension used to save this resource in the ``.godot/imported`` directory. +Gets the extension used to save this resource in the ``.godot/imported`` directory (see :ref:`ProjectSettings.application/config/use_hidden_project_data_directory`). ---- diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index a3ab33f52..0fe37efcf 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorInspector.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 5f8a4222a..ecbd4b7dc 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorInspectorPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,9 +16,7 @@ Plugin for adding custom property editors on inspector. Description ----------- -These plugins allow adding custom property editors to :ref:`EditorInspector`. - -Plugins are registered via :ref:`EditorPlugin.add_inspector_plugin`. +``EditorInspectorPlugin`` allows adding custom property editors to :ref:`EditorInspector`. When an object is edited, the :ref:`_can_handle` function is called and must return ``true`` if the object type is supported. @@ -30,6 +28,8 @@ Finally, :ref:`_parse_end` will b On each of these calls, the "add" functions can be called. +To use ``EditorInspectorPlugin``, register it using the :ref:`EditorPlugin.add_inspector_plugin` method first. + Tutorials --------- @@ -41,11 +41,13 @@ Methods +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_can_handle` **(** :ref:`Variant` object **)** |virtual| |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_parse_begin` **(** **)** |virtual| | +| void | :ref:`_parse_begin` **(** :ref:`Object` object **)** |virtual| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_parse_category` **(** :ref:`Object` object, :ref:`String` category **)** |virtual| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_parse_end` **(** **)** |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:`int` type, :ref:`String` name, :ref:`int` hint_type, :ref:`String` hint_string, :ref:`int` usage_flags, :ref:`bool` wide **)** |virtual| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,9 +71,9 @@ Returns ``true`` if this object can be handled by this plugin. .. _class_EditorInspectorPlugin_method__parse_begin: -- void **_parse_begin** **(** **)** |virtual| +- void **_parse_begin** **(** :ref:`Object` object **)** |virtual| -Called to allow adding controls at the beginning of the list. +Called to allow adding controls at the beginning of the property list for ``object``. ---- @@ -79,13 +81,23 @@ Called to allow adding controls at the beginning of the list. - void **_parse_category** **(** :ref:`Object` object, :ref:`String` category **)** |virtual| +Called to allow adding controls at the beginning of a category in the property list for ``object``. + ---- .. _class_EditorInspectorPlugin_method__parse_end: -- void **_parse_end** **(** **)** |virtual| +- void **_parse_end** **(** :ref:`Object` object **)** |virtual| -Called to allow adding controls at the end of the list. +Called to allow adding controls at the end of the property list for ``object``. + +---- + +.. _class_EditorInspectorPlugin_method__parse_group: + +- void **_parse_group** **(** :ref:`Object` object, :ref:`String` group **)** |virtual| + +Called to allow adding controls at the beginning of a group or a sub-group in the property list for ``object``. ---- @@ -93,7 +105,7 @@ Called to allow adding controls at the end of the list. - :ref:`bool` **_parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` name, :ref:`int` hint_type, :ref:`String` hint_string, :ref:`int` usage_flags, :ref:`bool` wide **)** |virtual| -Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty`. Returning ``true`` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. +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. ---- diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 8d693809b..05625c088 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorInterface.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -140,6 +140,8 @@ Edits the given :ref:`Resource`. 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. +**Warning:** Removing and freeing this node will render the editor useless and may cause a crash. + ---- .. _class_EditorInterface_method_get_command_palette: @@ -148,6 +150,8 @@ Returns the main container of Godot editor's window. For example, you can use it Returns the editor's :ref:`EditorCommandPalette` instance. +**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. + ---- .. _class_EditorInterface_method_get_current_path: @@ -174,6 +178,8 @@ Returns the main editor control. Use this as a parent for main screens. **Note:** This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. +**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. + ---- .. _class_EditorInterface_method_get_editor_paths: @@ -206,6 +212,8 @@ Returns the editor's :ref:`EditorSettings` instance. Returns the editor's :ref:`FileSystemDock` instance. +**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. + ---- .. _class_EditorInterface_method_get_inspector: @@ -214,6 +222,8 @@ Returns the editor's :ref:`FileSystemDock` instance. Returns the editor's :ref:`EditorInspector` instance. +**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. + ---- .. _class_EditorInterface_method_get_open_scenes: @@ -254,6 +264,8 @@ Returns the editor's :ref:`EditorResourcePreview` i Returns the editor's :ref:`ScriptEditor` instance. +**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. + ---- .. _class_EditorInterface_method_get_selected_path: diff --git a/classes/class_editornode3dgizmo.rst b/classes/class_editornode3dgizmo.rst index 9a72baf39..1d64dc785 100644 --- a/classes/class_editornode3dgizmo.rst +++ b/classes/class_editornode3dgizmo.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorNode3DGizmo.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -64,7 +64,7 @@ Methods +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_subgizmo_selection` **(** **)** |const| | +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subgizmo_selected` **(** :ref:`int` arg0 **)** |const| | +| :ref:`bool` | :ref:`is_subgizmo_selected` **(** :ref:`int` id **)** |const| | +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -252,7 +252,7 @@ Returns a list of the currently selected subgizmos. Can be used to highlight sel .. _class_EditorNode3DGizmo_method_is_subgizmo_selected: -- :ref:`bool` **is_subgizmo_selected** **(** :ref:`int` arg0 **)** |const| +- :ref:`bool` **is_subgizmo_selected** **(** :ref:`int` id **)** |const| Returns ``true`` if the given subgizmo is currently selected. Can be used to highlight selected elements during :ref:`_redraw`. diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index ec4486630..194088d73 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorNode3DGizmoPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,9 @@ Used by the editor to define Node3D gizmo types. Description ----------- -EditorNode3DGizmoPlugin allows you to define a new type of Gizmo. There are two main ways to do so: extending ``EditorNode3DGizmoPlugin`` for the simpler gizmos, or creating a new :ref:`EditorNode3DGizmo` type. See the tutorial in the documentation for more info. +``EditorNode3DGizmoPlugin`` allows you to define a new type of Gizmo. There are two main ways to do so: extending ``EditorNode3DGizmoPlugin`` for the simpler gizmos, or creating a new :ref:`EditorNode3DGizmo` type. See the tutorial in the documentation for more info. + +To use ``EditorNode3DGizmoPlugin``, register it using the :ref:`EditorPlugin.add_spatial_gizmo_plugin` method first. Tutorials --------- diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index 471363484..d15bceb73 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorPaths.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 6bc11f661..b91858f2f 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -43,7 +43,7 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_forward_3d_force_draw_over_viewport` **(** :ref:`Control` viewport_control **)** |virtual| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_forward_3d_gui_input` **(** :ref:`Camera3D` viewport_camera, :ref:`InputEvent` event **)** |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| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,9 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | +| void | :ref:`add_scene_format_importer_plugin` **(** :ref:`EditorSceneFormatImporter` scene_format_importer **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_scene_post_import_plugin` **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_spatial_gizmo_plugin` **(** :ref:`EditorNode3DGizmoPlugin` plugin **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,7 +135,9 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | +| 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_spatial_gizmo_plugin` **(** :ref:`EditorNode3DGizmoPlugin` plugin **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -395,7 +399,7 @@ You need to enable calling of this method by using :ref:`set_force_draw_over_for .. _class_EditorPlugin_method__forward_3d_gui_input: -- :ref:`bool` **_forward_3d_gui_input** **(** :ref:`Camera3D` viewport_camera, :ref:`InputEvent` event **)** |virtual| +- :ref:`int` **_forward_3d_gui_input** **(** :ref:`Camera3D` viewport_camera, :ref:`InputEvent` event **)** |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. Intercepts the :ref:`InputEvent`, if ``return true`` ``EditorPlugin`` consumes the ``event``, otherwise forwards ``event`` to other Editor classes. Example: @@ -406,14 +410,14 @@ Called when there is a root node in the current edited scene, :ref:`_handles # Consumes InputEventMouseMotion and forwards other InputEvent types. func _forward_canvas_gui_input(event): - return event is InputEventMouseMotion + if (event is InputEventMouseMotion): + return true + return false .. code-tab:: csharp // Consumes InputEventMouseMotion and forwards other InputEvent types. public override bool ForwardCanvasGuiInput(InputEvent @event) { - return @event is InputEventMouseMotion; + if (@event is InputEventMouseMotion) { + return true; + } + return false } @@ -740,7 +749,7 @@ See :ref:`add_inspector_plugin` Registers a new :ref:`EditorImportPlugin`. Import plugins are used to import custom and unsupported assets as a custom :ref:`Resource` type. -**Note:** If you want to import custom 3D asset formats use :ref:`add_scene_import_plugin` instead. +**Note:** If you want to import custom 3D asset formats use :ref:`add_scene_format_importer_plugin` instead. See :ref:`add_inspector_plugin` for an example of how to register a plugin. @@ -772,11 +781,19 @@ Registers a new :ref:`EditorInspectorPlugin`. Inspe ---- -.. _class_EditorPlugin_method_add_scene_import_plugin: +.. _class_EditorPlugin_method_add_scene_format_importer_plugin: -- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** +- void **add_scene_format_importer_plugin** **(** :ref:`EditorSceneFormatImporter` scene_format_importer **)** -Registers a new :ref:`EditorSceneImporter`. Scene importers are used to import custom 3D asset formats as scenes. +Registers a new :ref:`EditorSceneFormatImporter`. Scene importers are used to import custom 3D asset formats as scenes. + +---- + +.. _class_EditorPlugin_method_add_scene_post_import_plugin: + +- void **add_scene_post_import_plugin** **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin **)** + +Add a :ref:`EditorScenePostImportPlugin`. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. ---- @@ -840,6 +857,8 @@ Gets the Editor's dialogue used for making scripts. **Note:** Users can configure it before use. +**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. + ---- .. _class_EditorPlugin_method_get_undo_redo: @@ -946,11 +965,19 @@ Removes an inspector plugin registered by :ref:`add_import_plugin` scene_importer **)** +- void **remove_scene_format_importer_plugin** **(** :ref:`EditorSceneFormatImporter` scene_format_importer **)** -Removes a scene importer registered by :ref:`add_scene_import_plugin`. +Removes a scene format importer registered by :ref:`add_scene_format_importer_plugin`. + +---- + +.. _class_EditorPlugin_method_remove_scene_post_import_plugin: + +- void **remove_scene_post_import_plugin** **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin **)** + +Remove the :ref:`EditorScenePostImportPlugin`, added with :ref:`add_scene_post_import_plugin`. ---- diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index b0aa20b30..c5bbc7601 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorProperty.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,21 +21,21 @@ This control allows property editing for one or multiple properties into :ref:`E Properties ---------- -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`checkable` | ``false`` | -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`checked` | ``false`` | -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`deletable` | ``false`` | -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`draw_red` | ``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`` | ++-----------------------------+-----------------------------------------------------------------+-----------+ Methods ------- @@ -87,7 +87,7 @@ Do not emit this manually, use the :ref:`emit_changed` property, :ref:`String` bool **)** +- **property_checked** **(** :ref:`StringName` property, :ref:`bool` checked **)** Emitted when a property was checked. Used internally. @@ -117,6 +117,16 @@ Emit it if you want to key a property with a single value. ---- +.. _class_EditorProperty_signal_property_pinned: + +- **property_pinned** **(** :ref:`StringName` property, :ref:`bool` pinned **)** + +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. + +The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instancing chain, a script or a builtin class. + +---- + .. _class_EditorProperty_signal_resource_selected: - **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** @@ -182,19 +192,19 @@ Used by the inspector, set to ``true`` when the property can be deleted by the u ---- -.. _class_EditorProperty_property_draw_red: +.. _class_EditorProperty_property_draw_warning: -- :ref:`bool` **draw_red** +- :ref:`bool` **draw_warning** -+-----------+---------------------+ -| *Default* | ``false`` | -+-----------+---------------------+ -| *Setter* | set_draw_red(value) | -+-----------+---------------------+ -| *Getter* | is_draw_red() | -+-----------+---------------------+ ++-----------+-------------------------+ +| *Default* | ``false`` | ++-----------+-------------------------+ +| *Setter* | set_draw_warning(value) | ++-----------+-------------------------+ +| *Getter* | is_draw_warning() | ++-----------+-------------------------+ -Used by the inspector, set to ``true`` when the property must draw with error color. This is used for editable children's properties. +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. ---- diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index fb08aa717..250889980 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorResourceConversionPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorresourcepicker.rst b/classes/class_editorresourcepicker.rst index c3506d2a8..79a70179d 100644 --- a/classes/class_editorresourcepicker.rst +++ b/classes/class_editorresourcepicker.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorResourcePicker.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -61,9 +61,9 @@ Emitted when the value of the edited resource was changed. .. _class_EditorResourcePicker_signal_resource_selected: -- **resource_selected** **(** :ref:`Resource` resource **)** +- **resource_selected** **(** :ref:`Resource` resource, :ref:`bool` edit **)** -Emitted when the resource value was set and user clicked to edit it. +Emitted when the resource value was set and user clicked to edit it. When ``edit`` is ``true``, the signal was caused by the context menu "Edit" option. Property Descriptions --------------------- diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 71905c973..a885bc859 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorResourcePreview.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 79e3643f6..2f6c3b8c2 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorResourcePreviewGenerator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneformatimporter.rst similarity index 50% rename from classes/class_editorsceneimporter.rst rename to classes/class_editorsceneformatimporter.rst index dda7d1590..579273f4f 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -1,49 +1,60 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the EditorSceneImporter.xml source instead. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorSceneFormatImporter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_EditorSceneImporter: +.. _class_EditorSceneFormatImporter: -EditorSceneImporter -=================== +EditorSceneFormatImporter +========================= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`EditorSceneImporterFBX`, :ref:`EditorSceneImporterGLTF` +**Inherited By:** :ref:`EditorSceneFormatImporterFBX`, :ref:`EditorSceneFormatImporterGLTF` Imports scenes from third-parties' 3D files. +Description +----------- + +``EditorSceneFormatImporter`` allows to define an importer script for a third-party 3D format. + +To use ``EditorSceneFormatImporter``, register it using the :ref:`EditorPlugin.add_scene_format_importer_plugin` method first. + Methods ------- -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`_get_extensions` **(** **)** |virtual| |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_import_flags` **(** **)** |virtual| |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`import_animation_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`String` option **)** |virtual| |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`import_animation_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- -.. _class_EditorSceneImporter_constant_IMPORT_SCENE: +.. _class_EditorSceneFormatImporter_constant_IMPORT_SCENE: -.. _class_EditorSceneImporter_constant_IMPORT_ANIMATION: +.. _class_EditorSceneFormatImporter_constant_IMPORT_ANIMATION: -.. _class_EditorSceneImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES: +.. _class_EditorSceneFormatImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES: -.. _class_EditorSceneImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS: +.. _class_EditorSceneFormatImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS: -.. _class_EditorSceneImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS: +.. _class_EditorSceneFormatImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS: - **IMPORT_SCENE** = **1** @@ -58,37 +69,49 @@ Constants Method Descriptions ------------------- -.. _class_EditorSceneImporter_method__get_extensions: +.. _class_EditorSceneFormatImporter_method__get_extensions: - :ref:`PackedStringArray` **_get_extensions** **(** **)** |virtual| |const| ---- -.. _class_EditorSceneImporter_method__get_import_flags: +.. _class_EditorSceneFormatImporter_method__get_import_flags: - :ref:`int` **_get_import_flags** **(** **)** |virtual| |const| ---- -.. _class_EditorSceneImporter_method__import_animation: +.. _class_EditorSceneFormatImporter_method__get_import_options: + +- void **_get_import_options** **(** :ref:`String` path **)** |virtual| + +---- + +.. _class_EditorSceneFormatImporter_method__get_option_visibility: + +- :ref:`Variant` **_get_option_visibility** **(** :ref:`String` path, :ref:`String` option **)** |virtual| |const| + +---- + +.. _class_EditorSceneFormatImporter_method__import_animation: - :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| ---- -.. _class_EditorSceneImporter_method__import_scene: +.. _class_EditorSceneFormatImporter_method__import_scene: - :ref:`Object` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| ---- -.. _class_EditorSceneImporter_method_import_animation_from_other_importer: +.. _class_EditorSceneFormatImporter_method_import_animation_from_other_importer: - :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** ---- -.. _class_EditorSceneImporter_method_import_scene_from_other_importer: +.. _class_EditorSceneFormatImporter_method_import_scene_from_other_importer: - :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** diff --git a/classes/class_editorsceneimporterfbx.rst b/classes/class_editorsceneformatimporterfbx.rst similarity index 80% rename from classes/class_editorsceneimporterfbx.rst rename to classes/class_editorsceneformatimporterfbx.rst index 45ad2121f..4baf2d9a6 100644 --- a/classes/class_editorsceneimporterfbx.rst +++ b/classes/class_editorsceneformatimporterfbx.rst @@ -1,15 +1,15 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the EditorSceneImporterFBX.xml source instead. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorSceneFormatImporterFBX.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_EditorSceneImporterFBX: +.. _class_EditorSceneFormatImporterFBX: -EditorSceneImporterFBX -====================== +EditorSceneFormatImporterFBX +============================ -**Inherits:** :ref:`EditorSceneImporter` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`EditorSceneFormatImporter` **<** :ref:`RefCounted` **<** :ref:`Object` FBX 3D asset importer. diff --git a/classes/class_editorsceneimportergltf.rst b/classes/class_editorsceneformatimportergltf.rst similarity index 65% rename from classes/class_editorsceneimportergltf.rst rename to classes/class_editorsceneformatimportergltf.rst index 7cb028c95..75fd5eeae 100644 --- a/classes/class_editorsceneimportergltf.rst +++ b/classes/class_editorsceneformatimportergltf.rst @@ -1,15 +1,15 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the EditorSceneImporterGLTF.xml source instead. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorSceneFormatImporterGLTF.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_EditorSceneImporterGLTF: +.. _class_EditorSceneFormatImporterGLTF: -EditorSceneImporterGLTF -======================= +EditorSceneFormatImporterGLTF +============================= -**Inherits:** :ref:`EditorSceneImporter` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`EditorSceneFormatImporter` **<** :ref:`RefCounted` **<** :ref:`Object` diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 9a19f4dee..7e8032833 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorScenePostImport.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst new file mode 100644 index 000000000..62bffd5e9 --- /dev/null +++ b/classes/class_editorscenepostimportplugin.rst @@ -0,0 +1,177 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorScenePostImportPlugin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorScenePostImportPlugin: + +EditorScenePostImportPlugin +=========================== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Plugin to control and modifying the process of importing a scene. + +Description +----------- + +This plugin type exists to modify the process of importing scenes, allowing to change the content as well as add importer options at every stage of the process. + +Methods +------- + ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`String` option **)** |virtual| |const| | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_get_option_visibility` **(** :ref:`String` path, :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=7 **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_option_value` **(** :ref:`StringName` name **)** |const| | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_EditorScenePostImportPlugin_InternalImportCategory: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_NODE: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MESH: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MATERIAL: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_ANIMATION: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE: + +.. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MAX: + +enum **InternalImportCategory**: + +- **INTERNAL_IMPORT_CATEGORY_NODE** = **0** + +- **INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE** = **1** + +- **INTERNAL_IMPORT_CATEGORY_MESH** = **2** + +- **INTERNAL_IMPORT_CATEGORY_MATERIAL** = **3** + +- **INTERNAL_IMPORT_CATEGORY_ANIMATION** = **4** + +- **INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE** = **5** + +- **INTERNAL_IMPORT_CATEGORY_MAX** = **6** + +Method Descriptions +------------------- + +.. _class_EditorScenePostImportPlugin_method__get_import_options: + +- void **_get_import_options** **(** :ref:`String` path **)** |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`. + +---- + +.. _class_EditorScenePostImportPlugin_method__get_internal_import_options: + +- void **_get_internal_import_options** **(** :ref:`int` category **)** |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`. + +---- + +.. _class_EditorScenePostImportPlugin_method__get_internal_option_update_view_required: + +- :ref:`Variant` **_get_internal_option_update_view_required** **(** :ref:`int` category, :ref:`String` option **)** |virtual| |const| + +Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. + +---- + +.. _class_EditorScenePostImportPlugin_method__get_internal_option_visibility: + +- :ref:`Variant` **_get_internal_option_visibility** **(** :ref:`int` category, :ref:`String` option **)** |virtual| |const| + +Return true or false whether a given option should be visible. Return null to ignore. + +---- + +.. _class_EditorScenePostImportPlugin_method__get_option_visibility: + +- :ref:`Variant` **_get_option_visibility** **(** :ref:`String` path, :ref:`String` option **)** |virtual| |const| + +Return true or false whether a given option should be visible. Return null to ignore. + +---- + +.. _class_EditorScenePostImportPlugin_method__internal_process: + +- void **_internal_process** **(** :ref:`int` category, :ref:`Node` base_node, :ref:`Node` node, :ref:`Resource` resource **)** |virtual| + +Process a specific node or resource for a given category. + +---- + +.. _class_EditorScenePostImportPlugin_method__post_process: + +- void **_post_process** **(** :ref:`Node` scene **)** |virtual| + +Post process the scene. This function is called after the final scene has been configured. + +---- + +.. _class_EditorScenePostImportPlugin_method__pre_process: + +- void **_pre_process** **(** :ref:`Node` scene **)** |virtual| + +Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. + +---- + +.. _class_EditorScenePostImportPlugin_method_add_import_option: + +- void **add_import_option** **(** :ref:`String` name, :ref:`Variant` value **)** + +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`. + +---- + +.. _class_EditorScenePostImportPlugin_method_add_import_option_advanced: + +- 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=7 **)** + +Add a specific import option. This function can only be called from :ref:`_get_import_options` and :ref:`_get_internal_import_options`. + +---- + +.. _class_EditorScenePostImportPlugin_method_get_option_value: + +- :ref:`Variant` **get_option_value** **(** :ref:`StringName` name **)** |const| + +Query the value of an option. This function can only be called from those querying visibility, or processing. + +.. |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.)` diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index e8d4449fc..be1a31149 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorscriptpicker.rst b/classes/class_editorscriptpicker.rst index 92d7e33d1..5a93fe7fe 100644 --- a/classes/class_editorscriptpicker.rst +++ b/classes/class_editorscriptpicker.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorScriptPicker.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index e55f33d89..493ef6836 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorSelection.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index ef13c0402..663567d91 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorSettings.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index ab090f0c7..bfa7aa6b8 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorSpinSlider.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_editorsyntaxhighlighter.rst b/classes/class_editorsyntaxhighlighter.rst index 047e6c9d3..ecf8155aa 100644 --- a/classes/class_editorsyntaxhighlighter.rst +++ b/classes/class_editorsyntaxhighlighter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorSyntaxHighlighter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,7 +18,7 @@ Description Base syntax highlighter resource all editor syntax highlighters extend from, it is used in the :ref:`ScriptEditor`. -Add a syntax highlighter to an individual script by calling ScriptEditorBase._add_syntax_highlighter (currently not working). To apply to all scripts on open, call :ref:`ScriptEditor.register_syntax_highlighter` +Add a syntax highlighter to an individual script by calling :ref:`ScriptEditorBase.add_syntax_highlighter`. To apply to all scripts on open, call :ref:`ScriptEditor.register_syntax_highlighter` Methods ------- diff --git a/classes/class_editortranslationparserplugin.rst b/classes/class_editortranslationparserplugin.rst index fe48037dd..30f0f4223 100644 --- a/classes/class_editortranslationparserplugin.rst +++ b/classes/class_editortranslationparserplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorTranslationParserPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,7 @@ Plugin for adding custom parsers to extract strings that are to be translated fr Description ----------- -Plugins are registered via :ref:`EditorPlugin.add_translation_parser_plugin` method. To define the parsing and string extraction logic, override the :ref:`_parse_file` method in script. +``EditorTranslationParserPlugin`` is invoked when a file is being parsed to extract strings that require translation. To define the parsing and string extraction logic, override the :ref:`_parse_file` method in script. Add the extracted strings to argument ``msgids`` or ``msgids_context_plural`` if context or plural is used. @@ -133,6 +133,8 @@ For example: +To use ``EditorTranslationParserPlugin``, register it using the :ref:`EditorPlugin.add_translation_parser_plugin` method first. + Methods ------- diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index c5e2a7c46..5752d10eb 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorVCSInterface.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 0818aa315..6e9d74a9a 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EncodedObjectAsID.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_enetconnection.rst b/classes/class_enetconnection.rst index 8386d8a3d..7fb38dd30 100644 --- a/classes/class_enetconnection.rst +++ b/classes/class_enetconnection.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ENetConnection.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_enetmultiplayerpeer.rst b/classes/class_enetmultiplayerpeer.rst index 7f66daec1..56c4aabe6 100644 --- a/classes/class_enetmultiplayerpeer.rst +++ b/classes/class_enetmultiplayerpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ENetMultiplayerPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_enetpacketpeer.rst b/classes/class_enetpacketpeer.rst index c47848354..3e7dfd64c 100644 --- a/classes/class_enetpacketpeer.rst +++ b/classes/class_enetpacketpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ENetPacketPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_engine.rst b/classes/class_engine.rst index f3457f8b5..2e8b10d8e 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Engine.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_enginedebugger.rst b/classes/class_enginedebugger.rst index 3cab28d2c..76f26cac6 100644 --- a/classes/class_enginedebugger.rst +++ b/classes/class_enginedebugger.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EngineDebugger.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 91e3a714b..1c660ace9 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Environment.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -57,8 +57,6 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`ambient_light_energy` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ -| :ref:`Color` | :ref:`ambient_light_occlusion_color` | ``Color(0, 0, 0, 1)`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`ambient_light_sky_contribution` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`AmbientSource` | :ref:`ambient_light_source` | ``0`` | @@ -199,20 +197,26 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`tonemap_white` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ -| :ref:`float` | :ref:`volumetric_fog_density` | ``0.01`` | +| :ref:`Color` | :ref:`volumetric_fog_albedo` | ``Color(1, 1, 1, 1)`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`volumetric_fog_ambient_inject` | ``0.0`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`volumetric_fog_anisotropy` | ``0.2`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`volumetric_fog_density` | ``0.05`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`volumetric_fog_detail_spread` | ``2.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ +| :ref:`Color` | :ref:`volumetric_fog_emission` | ``Color(0, 0, 0, 1)`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`volumetric_fog_emission_energy` | ``1.0`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`bool` | :ref:`volumetric_fog_enabled` | ``false`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`volumetric_fog_gi_inject` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`volumetric_fog_length` | ``64.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ -| :ref:`Color` | :ref:`volumetric_fog_light` | ``Color(0, 0, 0, 1)`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ -| :ref:`float` | :ref:`volumetric_fog_light_energy` | ``1.0`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`volumetric_fog_temporal_reprojection_amount` | ``0.9`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`bool` | :ref:`volumetric_fog_temporal_reprojection_enabled` | ``true`` | @@ -386,28 +390,6 @@ enum **SDFGIYScale**: - **SDFGI_Y_SCALE_50_PERCENT** = **2** ----- - -.. _enum_Environment_VolumetricFogShadowFilter: - -.. _class_Environment_constant_VOLUMETRIC_FOG_SHADOW_FILTER_DISABLED: - -.. _class_Environment_constant_VOLUMETRIC_FOG_SHADOW_FILTER_LOW: - -.. _class_Environment_constant_VOLUMETRIC_FOG_SHADOW_FILTER_MEDIUM: - -.. _class_Environment_constant_VOLUMETRIC_FOG_SHADOW_FILTER_HIGH: - -enum **VolumetricFogShadowFilter**: - -- **VOLUMETRIC_FOG_SHADOW_FILTER_DISABLED** = **0** - -- **VOLUMETRIC_FOG_SHADOW_FILTER_LOW** = **1** - -- **VOLUMETRIC_FOG_SHADOW_FILTER_MEDIUM** = **2** - -- **VOLUMETRIC_FOG_SHADOW_FILTER_HIGH** = **3** - Property Descriptions --------------------- @@ -437,7 +419,7 @@ The global brightness value of the rendered scene. Effective only if ``adjustmen | *Getter* | 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:`GradientTexture` for a 1-dimensional LUT, or a :ref:`Texture3D` for a more complex LUT. Effective only if ``adjustment_enabled`` is ``true``. +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 ``adjustment_enabled`` is ``true``. ---- @@ -521,20 +503,6 @@ The ambient light's energy. The higher the value, the stronger the light. ---- -.. _class_Environment_property_ambient_light_occlusion_color: - -- :ref:`Color` **ambient_light_occlusion_color** - -+-----------+-----------------------+ -| *Default* | ``Color(0, 0, 0, 1)`` | -+-----------+-----------------------+ -| *Setter* | set_ao_color(value) | -+-----------+-----------------------+ -| *Getter* | get_ao_color() | -+-----------+-----------------------+ - ----- - .. _class_Environment_property_ambient_light_sky_contribution: - :ref:`float` **ambient_light_sky_contribution** @@ -785,6 +753,8 @@ If ``true``, fog effects are enabled. | *Getter* | get_fog_height() | +-----------+-----------------------+ +The height at which the height fog effect begins. + ---- .. _class_Environment_property_fog_height_density: @@ -799,6 +769,8 @@ If ``true``, fog effects are enabled. | *Getter* | get_fog_height_density() | +-----------+-------------------------------+ +The density used to increase fog as height decreases. To make fog increase as height increases, use a negative value. + ---- .. _class_Environment_property_fog_light_color: @@ -935,7 +907,7 @@ The bleed scale of the HDR glow. | *Getter* | get_glow_hdr_bleed_threshold() | +-----------+-------------------------------------+ -The lower threshold of the HDR glow. When using the GLES2 renderer (which doesn't support HDR), this needs to be below ``1.0`` for glow to be visible. A value of ``0.9`` works well in this case. +The lower threshold of the HDR glow. When using the OpenGL renderer (which doesn't support HDR), this needs to be below ``1.0`` for glow to be visible. A value of ``0.9`` works well in this case. ---- @@ -951,7 +923,7 @@ The lower threshold of the HDR glow. When using the GLES2 renderer (which doesn' | *Getter* | get_glow_intensity() | +-----------+---------------------------+ -The overall brightness multiplier of the glow effect. When using the GLES2 renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering. +The overall brightness multiplier of the glow effect. When using the OpenGL renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering. ---- @@ -1109,7 +1081,7 @@ If ``true``, glow levels will be normalized so that summed together their intens | *Getter* | 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 GLES2 renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering. +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 OpenGL renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering. ---- @@ -1181,7 +1153,9 @@ The strength of the glow effect. This applies as the glow is blurred across the | *Getter* | is_sdfgi_enabled() | +-----------+--------------------------+ -If ``true``, enables signed distance field global illumination. +If ``true``, enables signed distance field global illumination for meshes that have their :ref:`GeometryInstance3D.gi_mode` set to :ref:`GeometryInstance3D.GI_MODE_BAKED`. 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. + +**Performance:** SDFGI is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider :ref:`LightmapGI` instead). To improve SDFGI performance, enable :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution` in the Project Settings. **Note:** Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. @@ -1385,7 +1359,7 @@ If ``true``, screen-space reflections are enabled. Screen-space reflections are | *Getter* | get_ssr_fade_in() | +-----------+------------------------+ -The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection). +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``). ---- @@ -1401,7 +1375,7 @@ The fade-in distance for screen-space reflections. Affects the area from the ref | *Getter* | get_ssr_fade_out() | +-----------+-------------------------+ -The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection. +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``). ---- @@ -1613,18 +1587,68 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m ---- +.. _class_Environment_property_volumetric_fog_albedo: + +- :ref:`Color` **volumetric_fog_albedo** + ++-----------+----------------------------------+ +| *Default* | ``Color(1, 1, 1, 1)`` | ++-----------+----------------------------------+ +| *Setter* | set_volumetric_fog_albedo(value) | ++-----------+----------------------------------+ +| *Getter* | 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. + +---- + +.. _class_Environment_property_volumetric_fog_ambient_inject: + +- :ref:`float` **volumetric_fog_ambient_inject** + ++-----------+------------------------------------------+ +| *Default* | ``0.0`` | ++-----------+------------------------------------------+ +| *Setter* | set_volumetric_fog_ambient_inject(value) | ++-----------+------------------------------------------+ +| *Getter* | get_volumetric_fog_ambient_inject() | ++-----------+------------------------------------------+ + +Scales the strength of ambient light used in the volumetric fog. A value of ``0`` means that ambient light will not impact the volumetric fog. + +---- + +.. _class_Environment_property_volumetric_fog_anisotropy: + +- :ref:`float` **volumetric_fog_anisotropy** + ++-----------+--------------------------------------+ +| *Default* | ``0.2`` | ++-----------+--------------------------------------+ +| *Setter* | set_volumetric_fog_anisotropy(value) | ++-----------+--------------------------------------+ +| *Getter* | get_volumetric_fog_anisotropy() | ++-----------+--------------------------------------+ + +The direction of scattered light as it goes through the volumetric fog. A value close ``1`` means almost all light is scattered forward. A value close to ``0`` means light is scattered equally in all directions. A value close to ``-1`` means light is scattered mostly backward. Fog and mist scatter light slightly forward, while smoke scatters light equally in all directions. + +---- + .. _class_Environment_property_volumetric_fog_density: - :ref:`float` **volumetric_fog_density** +-----------+-----------------------------------+ -| *Default* | ``0.01`` | +| *Default* | ``0.05`` | +-----------+-----------------------------------+ | *Setter* | set_volumetric_fog_density(value) | +-----------+-----------------------------------+ | *Getter* | get_volumetric_fog_density() | +-----------+-----------------------------------+ +The base density of the volumetric fog. Set this to the lowest density you want to have globally. + ---- .. _class_Environment_property_volumetric_fog_detail_spread: @@ -1639,6 +1663,40 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m | *Getter* | 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. + +---- + +.. _class_Environment_property_volumetric_fog_emission: + +- :ref:`Color` **volumetric_fog_emission** + ++-----------+------------------------------------+ +| *Default* | ``Color(0, 0, 0, 1)`` | ++-----------+------------------------------------+ +| *Setter* | set_volumetric_fog_emission(value) | ++-----------+------------------------------------+ +| *Getter* | 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. + +---- + +.. _class_Environment_property_volumetric_fog_emission_energy: + +- :ref:`float` **volumetric_fog_emission_energy** + ++-----------+-------------------------------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------------------------------+ +| *Setter* | set_volumetric_fog_emission_energy(value) | ++-----------+-------------------------------------------+ +| *Getter* | get_volumetric_fog_emission_energy() | ++-----------+-------------------------------------------+ + +The brightness of the emitted light from the volumetric fog. + ---- .. _class_Environment_property_volumetric_fog_enabled: @@ -1653,6 +1711,8 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m | *Getter* | 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. + ---- .. _class_Environment_property_volumetric_fog_gi_inject: @@ -1667,6 +1727,8 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m | *Getter* | get_volumetric_fog_gi_inject() | +-----------+-------------------------------------+ +Scales the strength of Global Illumination used in the volumetric fog. A value of ``0`` means that Global Illumination will not impact the volumetric fog. + ---- .. _class_Environment_property_volumetric_fog_length: @@ -1681,33 +1743,7 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m | *Getter* | get_volumetric_fog_length() | +-----------+----------------------------------+ ----- - -.. _class_Environment_property_volumetric_fog_light: - -- :ref:`Color` **volumetric_fog_light** - -+-----------+---------------------------------+ -| *Default* | ``Color(0, 0, 0, 1)`` | -+-----------+---------------------------------+ -| *Setter* | set_volumetric_fog_light(value) | -+-----------+---------------------------------+ -| *Getter* | get_volumetric_fog_light() | -+-----------+---------------------------------+ - ----- - -.. _class_Environment_property_volumetric_fog_light_energy: - -- :ref:`float` **volumetric_fog_light_energy** - -+-----------+----------------------------------------+ -| *Default* | ``1.0`` | -+-----------+----------------------------------------+ -| *Setter* | set_volumetric_fog_light_energy(value) | -+-----------+----------------------------------------+ -| *Getter* | get_volumetric_fog_light_energy() | -+-----------+----------------------------------------+ +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. ---- @@ -1723,6 +1759,8 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m | *Getter* | 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. + ---- .. _class_Environment_property_volumetric_fog_temporal_reprojection_enabled: @@ -1737,6 +1775,8 @@ The white reference value for tonemapping. Only effective if the :ref:`tonemap_m | *Getter* | 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 does lead 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. + Method Descriptions ------------------- diff --git a/classes/class_expression.rst b/classes/class_expression.rst index b913f23a8..78c30774a 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Expression.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_file.rst b/classes/class_file.rst index d9df484e2..7e3362a8f 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the File.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index f716d5c8e..a3b5b8ee4 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the FileDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -319,6 +319,8 @@ Clear all currently selected items in the dialog. Returns the LineEdit for the selected file. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_FileDialog_method_get_vbox: @@ -327,6 +329,8 @@ Returns the LineEdit for the selected file. Returns the vertical box container of the dialog, custom controls can be added to it. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_FileDialog_method_invalidate: diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index 7a135fc09..64c5835c8 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the FileSystemDock.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_float.rst b/classes/class_float.rst index a4ecc60e5..cf2ba5c15 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the float.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -27,135 +27,147 @@ Tutorials - `Wikipedia: Single-precision floating-point format `__ -Methods -------- +Constructors +------------ -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`float` from **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator *** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator *** **(** :ref:`Vector2i` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator *** **(** :ref:`Vector3i` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator *** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator *** **(** :ref:`Color` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator *** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator +** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator +** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator -** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator -** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator /** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator /** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator unary+** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator unary-** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`float` from **)** | ++---------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | ++---------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | ++---------------------------+----------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_float_method_float: ++-------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`float` right **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`int` right **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`operator *` **(** :ref:`float` 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:`Color` | :ref:`operator *` **(** :ref:`Color` 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:`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:`float` **float** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_float_constructor_float: + +- :ref:`float` **float** **(** **)** Constructs a default-initialized ``float`` set to ``0.0``. ---- -- :ref:`float` **float** **(** :ref:`float` from **)** |constructor| +- :ref:`float` **float** **(** :ref:`float` from **)** Constructs a ``float`` as a copy of the given ``float``. ---- -- :ref:`float` **float** **(** :ref:`bool` from **)** |constructor| +- :ref:`float` **float** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to a floating-point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0. ---- -- :ref:`float` **float** **(** :ref:`int` from **)** |constructor| +- :ref:`float` **float** **(** :ref:`int` from **)** Cast an :ref:`int` value to a floating-point value, ``float(1)`` will be equal to ``1.0``. ----- +Operator Descriptions +--------------------- -.. _class_float_method_operator !=: +.. _class_float_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`float` right **)** Returns ``true`` if two floats are different from each other. ---- -- :ref:`bool` **operator !=** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`int` right **)** Returns ``true`` if the integer has different value than the float. ---- -.. _class_float_method_operator *: +.. _class_float_operator_mul_float: -- :ref:`float` **operator *** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator *** **(** :ref:`float` right **)** Multiplies two ``float``\ s. ---- -- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** |operator| +- :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** + +Multiplies each component of the :ref:`Quaternion` by the given ``float``. + +---- + +- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** Multiplies each component of the :ref:`Vector2` by the given ``float``. @@ -165,7 +177,7 @@ Multiplies each component of the :ref:`Vector2` by the given ``fl ---- -- :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** |operator| +- :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** Multiplies each component of the :ref:`Vector2i` by the given ``float``. @@ -175,25 +187,19 @@ Multiplies each component of the :ref:`Vector2i` by the given `` ---- -- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** |operator| +- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** Multiplies each component of the :ref:`Vector3` by the given ``float``. ---- -- :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** |operator| +- :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** Multiplies each component of the :ref:`Vector3i` by the given ``float``. ---- -- :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** |operator| - -Multiplies each component of the :ref:`Quaternion` by the given ``float``. - ----- - -- :ref:`Color` **operator *** **(** :ref:`Color` right **)** |operator| +- :ref:`Color` **operator *** **(** :ref:`Color` right **)** Multiplies each component of the :ref:`Color` by the given ``float``. @@ -203,89 +209,89 @@ Multiplies each component of the :ref:`Color` by the given ``float` ---- -- :ref:`float` **operator *** **(** :ref:`int` right **)** |operator| +- :ref:`float` **operator *** **(** :ref:`int` right **)** Multiplies a ``float`` and an :ref:`int`. The result is a ``float``. ---- -.. _class_float_method_operator +: +.. _class_float_operator_sum_float: -- :ref:`float` **operator +** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator +** **(** :ref:`float` right **)** Adds two floats. ---- -- :ref:`float` **operator +** **(** :ref:`int` right **)** |operator| +- :ref:`float` **operator +** **(** :ref:`int` right **)** Adds a ``float`` and an :ref:`int`. The result is a ``float``. ---- -.. _class_float_method_operator -: +.. _class_float_operator_dif_float: -- :ref:`float` **operator -** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator -** **(** :ref:`float` right **)** Subtracts a float from a float. ---- -- :ref:`float` **operator -** **(** :ref:`int` right **)** |operator| +- :ref:`float` **operator -** **(** :ref:`int` right **)** Subtracts an :ref:`int` from a ``float``. The result is a ``float``. ---- -.. _class_float_method_operator /: +.. _class_float_operator_div_float: -- :ref:`float` **operator /** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator /** **(** :ref:`float` right **)** Divides two floats. ---- -- :ref:`float` **operator /** **(** :ref:`int` right **)** |operator| +- :ref:`float` **operator /** **(** :ref:`int` right **)** Divides a ``float`` by an :ref:`int`. The result is a ``float``. ---- -.. _class_float_method_operator <: +.. _class_float_operator_lt_bool: -- :ref:`bool` **operator <** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator <** **(** :ref:`float` right **)** Returns ``true`` the left float is less than the right one. ---- -- :ref:`bool` **operator <** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator <** **(** :ref:`int` right **)** Returns ``true`` if this ``float`` is less than the given :ref:`int`. ---- -.. _class_float_method_operator <=: +.. _class_float_operator_lte_bool: -- :ref:`bool` **operator <=** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator <=** **(** :ref:`float` right **)** Returns ``true`` the left integer is less than or equal to the right one. ---- -- :ref:`bool` **operator <=** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator <=** **(** :ref:`int` right **)** Returns ``true`` if this ``float`` is less than or equal to the given :ref:`int`. ---- -.. _class_float_method_operator ==: +.. _class_float_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`float` right **)** Returns ``true`` if both floats are exactly equal. @@ -293,51 +299,51 @@ Returns ``true`` if both floats are exactly equal. ---- -- :ref:`bool` **operator ==** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`int` right **)** Returns ``true`` if the ``float`` and the given :ref:`int` are equal. ---- -.. _class_float_method_operator >: +.. _class_float_operator_gt_bool: -- :ref:`bool` **operator >** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator >** **(** :ref:`float` right **)** Returns ``true`` the left float is greater than the right one. ---- -- :ref:`bool` **operator >** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator >** **(** :ref:`int` right **)** Returns ``true`` if this ``float`` is greater than the given :ref:`int`. ---- -.. _class_float_method_operator >=: +.. _class_float_operator_gte_bool: -- :ref:`bool` **operator >=** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator >=** **(** :ref:`float` right **)** Returns ``true`` the left float is greater than or equal to the right one. ---- -- :ref:`bool` **operator >=** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator >=** **(** :ref:`int` right **)** Returns ``true`` if this ``float`` is greater than or equal to the given :ref:`int`. ---- -.. _class_float_method_operator unary+: +.. _class_float_operator_unplus_float: -- :ref:`float` **operator unary+** **(** **)** |operator| +- :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. ---- -.. _class_float_method_operator unary-: +.. _class_float_operator_unminus_float: -- :ref:`float` **operator unary-** **(** **)** |operator| +- :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. diff --git a/classes/class_fogmaterial.rst b/classes/class_fogmaterial.rst new file mode 100644 index 000000000..5b7250d9a --- /dev/null +++ b/classes/class_fogmaterial.rst @@ -0,0 +1,138 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the FogMaterial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_FogMaterial: + +FogMaterial +=========== + +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +:ref:`Material` used with a :ref:`FogVolume` to draw things with the volumetric fog effect. + +Description +----------- + +A :ref:`Material` resource that can be used by :ref:`FogVolume`\ s to draw volumetric effects. + +Properties +---------- + ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ +| :ref:`Color` | :ref:`albedo` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`density` | ``1.0`` | ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ +| :ref:`Texture3D` | :ref:`density_texture` | | ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`edge_fade` | ``0.1`` | ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ +| :ref:`Color` | :ref:`emission` | ``Color(0, 0, 0, 1)`` | ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`height_falloff` | ``0.0`` | ++-----------------------------------+--------------------------------------------------------------------+-----------------------+ + +Property Descriptions +--------------------- + +.. _class_FogMaterial_property_albedo: + +- :ref:`Color` **albedo** + ++-----------+-----------------------+ +| *Default* | ``Color(1, 1, 1, 1)`` | ++-----------+-----------------------+ +| *Setter* | set_albedo(value) | ++-----------+-----------------------+ +| *Getter* | get_albedo() | ++-----------+-----------------------+ + +Sets 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`. + +---- + +.. _class_FogMaterial_property_density: + +- :ref:`float` **density** + ++-----------+--------------------+ +| *Default* | ``1.0`` | ++-----------+--------------------+ +| *Setter* | set_density(value) | ++-----------+--------------------+ +| *Getter* | get_density() | ++-----------+--------------------+ + +Sets the density of the :ref:`FogVolume`. Denser objects are more opaque, but may suffer from under-sampling artifacts that look like stripes. + +---- + +.. _class_FogMaterial_property_density_texture: + +- :ref:`Texture3D` **density_texture** + ++----------+----------------------------+ +| *Setter* | set_density_texture(value) | ++----------+----------------------------+ +| *Getter* | get_density_texture() | ++----------+----------------------------+ + +Sets a 3D texture that is used to scale the :ref:`density` of the :ref:`FogVolume`. + +---- + +.. _class_FogMaterial_property_edge_fade: + +- :ref:`float` **edge_fade** + ++-----------+----------------------+ +| *Default* | ``0.1`` | ++-----------+----------------------+ +| *Setter* | set_edge_fade(value) | ++-----------+----------------------+ +| *Getter* | get_edge_fade() | ++-----------+----------------------+ + +Sets the hardness of the edges of the :ref:`FogVolume`. A higher number will result in softer edges while a lower number will result in harder edges. + +---- + +.. _class_FogMaterial_property_emission: + +- :ref:`Color` **emission** + ++-----------+-----------------------+ +| *Default* | ``Color(0, 0, 0, 1)`` | ++-----------+-----------------------+ +| *Setter* | set_emission(value) | ++-----------+-----------------------+ +| *Getter* | get_emission() | ++-----------+-----------------------+ + +Sets 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. + +---- + +.. _class_FogMaterial_property_height_falloff: + +- :ref:`float` **height_falloff** + ++-----------+---------------------------+ +| *Default* | ``0.0`` | ++-----------+---------------------------+ +| *Setter* | set_height_falloff(value) | ++-----------+---------------------------+ +| *Getter* | get_height_falloff() | ++-----------+---------------------------+ + +Sets 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`` results in uniform-density fog. The height threshold is determined by the height of the associated :ref:`FogVolume`. + +.. |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.)` diff --git a/classes/class_fogvolume.rst b/classes/class_fogvolume.rst new file mode 100644 index 000000000..aabdd747f --- /dev/null +++ b/classes/class_fogvolume.rst @@ -0,0 +1,86 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the FogVolume.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_FogVolume: + +FogVolume +========= + +**Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +A node used to add local fog with the volumetric fog effect. + +Description +----------- + +``FogVolume``\ s are used to add localized fog into the global volumetric fog effect. + +Performance of ``FogVolume``\ s is directly related to their relative size on the screen and the complexity of their attached :ref:`FogMaterial`. It is best to keep ``FogVolume``\ s relatively small and simple where possible. + +Properties +---------- + ++------------------------------------------------------------+----------------------------------------------------+----------------------+ +| :ref:`Vector3` | :ref:`extents` | ``Vector3(1, 1, 1)`` | ++------------------------------------------------------------+----------------------------------------------------+----------------------+ +| :ref:`Material` | :ref:`material` | | ++------------------------------------------------------------+----------------------------------------------------+----------------------+ +| :ref:`FogVolumeShape` | :ref:`shape` | ``1`` | ++------------------------------------------------------------+----------------------------------------------------+----------------------+ + +Property Descriptions +--------------------- + +.. _class_FogVolume_property_extents: + +- :ref:`Vector3` **extents** + ++-----------+----------------------+ +| *Default* | ``Vector3(1, 1, 1)`` | ++-----------+----------------------+ +| *Setter* | set_extents(value) | ++-----------+----------------------+ +| *Getter* | get_extents() | ++-----------+----------------------+ + +Sets the size of the ``FogVolume`` when :ref:`shape` is :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX`. + +---- + +.. _class_FogVolume_property_material: + +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +Sets the :ref:`Material` to be used by the ``FogVolume``. Can be either a :ref:`FogMaterial` or a custom :ref:`ShaderMaterial`. + +---- + +.. _class_FogVolume_property_shape: + +- :ref:`FogVolumeShape` **shape** + ++-----------+------------------+ +| *Default* | ``1`` | ++-----------+------------------+ +| *Setter* | set_shape(value) | ++-----------+------------------+ +| *Getter* | get_shape() | ++-----------+------------------+ + +Sets the shape of the ``FogVolume`` to either :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX`, or :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_WORLD`. + +.. |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.)` diff --git a/classes/class_font.rst b/classes/class_font.rst index b620b0d3f..159a52ec6 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Font.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -96,8 +96,6 @@ Use script overrides to specify supported scripts for bitmap font or for less co Properties ---------- -+-------------------------------------+-------------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`base_size` | ``16`` | +-------------------------------------+-------------------------------------------------------------------------+--------+ | :ref:`int` | :ref:`spacing_bottom` | ``0`` | +-------------------------------------+-------------------------------------------------------------------------+--------+ @@ -114,15 +112,15 @@ Methods +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_data` **(** **)** | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=0, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| | +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=0, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline_string` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| | +| void | :ref:`draw_multiline_string` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| | +| void | :ref:`draw_string` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ascent` **(** :ref:`int` size=-1 **)** |const| | +| :ref:`float` | :ref:`get_ascent` **(** :ref:`int` size=16 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0, :ref:`int` size=-1 **)** |const| | +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0, :ref:`int` size=16 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`FontData` | :ref:`get_data` **(** :ref:`int` idx **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -130,21 +128,21 @@ Methods +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_data_rid` **(** :ref:`int` idx **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_descent` **(** :ref:`int` size=-1 **)** |const| | +| :ref:`float` | :ref:`get_descent` **(** :ref:`int` size=16 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** :ref:`int` size=-1 **)** |const| | +| :ref:`float` | :ref:`get_height` **(** :ref:`int` size=16 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_multiline_string_size` **(** :ref:`String` text, :ref:`float` width=-1, :ref:`int` size=-1, :ref:`int` flags=96 **)** |const| | +| :ref:`Vector2` | :ref:`get_multiline_string_size` **(** :ref:`String` text, :ref:`float` width=-1, :ref:`int` size=16, :ref:`int` flags=96 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_spacing` **(** :ref:`SpacingType` spacing **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` text, :ref:`int` size=-1, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` flags=3 **)** |const| | +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` text, :ref:`int` size=16, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` flags=3 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_supported_chars` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_underline_position` **(** :ref:`int` size=-1 **)** |const| | +| :ref:`float` | :ref:`get_underline_position` **(** :ref:`int` size=16 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_underline_thickness` **(** :ref:`int` size=-1 **)** |const| | +| :ref:`float` | :ref:`get_underline_thickness` **(** :ref:`int` size=16 **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_char` **(** :ref:`int` char **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -160,22 +158,6 @@ Methods Property Descriptions --------------------- -.. _class_Font_property_base_size: - -- :ref:`int` **base_size** - -+-----------+----------------------+ -| *Default* | ``16`` | -+-----------+----------------------+ -| *Setter* | set_base_size(value) | -+-----------+----------------------+ -| *Getter* | get_base_size() | -+-----------+----------------------+ - -Default font size. - ----- - .. _class_Font_property_spacing_bottom: - :ref:`int` **spacing_bottom** @@ -243,7 +225,7 @@ Removes all font data sourcers for the set. .. _class_Font_method_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=0, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=0, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0) **)** |const| Draw a single Unicode character ``char`` into a canvas item using the font, at a given position, with ``modulate`` color, and optionally kerning if ``next`` is passed. ``position`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -253,7 +235,7 @@ Draw a single Unicode character ``char`` into a canvas item using the font, at a .. _class_Font_method_draw_multiline_string: -- void **draw_multiline_string** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| +- void **draw_multiline_string** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` max_lines=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=99 **)** |const| Breaks ``text`` to the lines using rules specified by ``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. ``position`` specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -263,7 +245,7 @@ See also :ref:`CanvasItem.draw_multiline_string` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| +- void **draw_string** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_modulate=Color(1, 1, 1, 0), :ref:`int` flags=3 **)** |const| Draw ``text`` into a canvas item using the font, at a given position, with ``modulate`` color, optionally clipping the width and aligning horizontally. ``position`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -273,7 +255,7 @@ See also :ref:`CanvasItem.draw_string`. .. _class_Font_method_get_ascent: -- :ref:`float` **get_ascent** **(** :ref:`int` size=-1 **)** |const| +- :ref:`float` **get_ascent** **(** :ref:`int` size=16 **)** |const| Returns the average font ascent (number of pixels above the baseline). @@ -283,7 +265,7 @@ Returns the average font ascent (number of pixels above the baseline). .. _class_Font_method_get_char_size: -- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0, :ref:`int` size=-1 **)** |const| +- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0, :ref:`int` size=16 **)** |const| Returns the size of a character, optionally taking kerning into account if the next character is provided. @@ -317,7 +299,7 @@ Returns TextServer RID of the font data resources. .. _class_Font_method_get_descent: -- :ref:`float` **get_descent** **(** :ref:`int` size=-1 **)** |const| +- :ref:`float` **get_descent** **(** :ref:`int` size=16 **)** |const| Returns the average font descent (number of pixels below the baseline). @@ -327,7 +309,7 @@ Returns the average font descent (number of pixels below the baseline). .. _class_Font_method_get_height: -- :ref:`float` **get_height** **(** :ref:`int` size=-1 **)** |const| +- :ref:`float` **get_height** **(** :ref:`int` size=16 **)** |const| Returns the total average font height (ascent plus descent) in pixels. @@ -337,7 +319,7 @@ Returns the total average font height (ascent plus descent) in pixels. .. _class_Font_method_get_multiline_string_size: -- :ref:`Vector2` **get_multiline_string_size** **(** :ref:`String` text, :ref:`float` width=-1, :ref:`int` size=-1, :ref:`int` flags=96 **)** |const| +- :ref:`Vector2` **get_multiline_string_size** **(** :ref:`String` text, :ref:`float` width=-1, :ref:`int` size=16, :ref:`int` flags=96 **)** |const| Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. @@ -355,7 +337,7 @@ Returns the spacing for the given ``type`` (see :ref:`SpacingType` **get_string_size** **(** :ref:`String` text, :ref:`int` size=-1, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` flags=3 **)** |const| +- :ref:`Vector2` **get_string_size** **(** :ref:`String` text, :ref:`int` size=16, :ref:`HAlign` align=0, :ref:`float` width=-1, :ref:`int` flags=3 **)** |const| Returns the size of a bounding box of a string, taking kerning and advance into account. @@ -377,7 +359,7 @@ If a given character is included in more than one font data source, it appears o .. _class_Font_method_get_underline_position: -- :ref:`float` **get_underline_position** **(** :ref:`int` size=-1 **)** |const| +- :ref:`float` **get_underline_position** **(** :ref:`int` size=16 **)** |const| Return average pixel offset of the underline below the baseline. @@ -387,7 +369,7 @@ Return average pixel offset of the underline below the baseline. .. _class_Font_method_get_underline_thickness: -- :ref:`float` **get_underline_thickness** **(** :ref:`int` size=-1 **)** |const| +- :ref:`float` **get_underline_thickness** **(** :ref:`int` size=16 **)** |const| Return average thickness of the underline. diff --git a/classes/class_fontdata.rst b/classes/class_fontdata.rst index 0ff01745d..684cc3ec3 100644 --- a/classes/class_fontdata.rst +++ b/classes/class_fontdata.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the FontData.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -47,9 +47,15 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_descent` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_font_name` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_font_style` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_font_style_name` **(** **)** |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` char, :ref:`int` variation_selector, :ref:`int` arg2 **)** |const| | +| :ref:`int` | :ref:`get_glyph_index` **(** :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_glyph_list` **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -85,7 +91,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_size_cache_list` **(** :ref:`int` cache_index **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` arg2 **)** |const| | +| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` spacing_type **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_supported_chars` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -143,6 +149,12 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_descent` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` descent **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font_name` **(** :ref:`String` name **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font_style` **(** :ref:`int` style **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font_style_name` **(** :ref:`String` name **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_force_autohinter` **(** :ref:`bool` force_autohinter **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glyph_advance` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** | @@ -173,7 +185,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_script_support_override` **(** :ref:`String` script, :ref:`bool` supported **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spacing` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` spacing, :ref:`int` arg3 **)** | +| void | :ref:`set_spacing` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` spacing_type, :ref:`int` value **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_image` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -281,6 +293,30 @@ Returns font descent (number of pixels below the baseline). ---- +.. _class_FontData_method_get_font_name: + +- :ref:`String` **get_font_name** **(** **)** |const| + +Returns font family name. + +---- + +.. _class_FontData_method_get_font_style: + +- :ref:`int` **get_font_style** **(** **)** |const| + +Returns font style flags, see :ref:`FontStyle`. + +---- + +.. _class_FontData_method_get_font_style_name: + +- :ref:`String` **get_font_style_name** **(** **)** |const| + +Returns font style name. + +---- + .. _class_FontData_method_get_glyph_advance: - :ref:`Vector2` **get_glyph_advance** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`int` glyph **)** |const| @@ -293,7 +329,7 @@ Returns glyph advance (offset of the next glyph). .. _class_FontData_method_get_glyph_index: -- :ref:`int` **get_glyph_index** **(** :ref:`int` char, :ref:`int` variation_selector, :ref:`int` arg2 **)** |const| +- :ref:`int` **get_glyph_index** **(** :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. @@ -437,7 +473,7 @@ Return list of the font sizes in the cache. Each size is ``Vector2i`` with font .. _class_FontData_method_get_spacing: -- :ref:`int` **get_spacing** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` arg2 **)** |const| +- :ref:`int` **get_spacing** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` spacing_type **)** |const| Returns extra spacing added between glyphs in pixels. @@ -673,6 +709,30 @@ Sets the font descent (number of pixels below the baseline). ---- +.. _class_FontData_method_set_font_name: + +- void **set_font_name** **(** :ref:`String` name **)** + +Sets the font family name. + +---- + +.. _class_FontData_method_set_font_style: + +- void **set_font_style** **(** :ref:`int` style **)** + +Sets the font style flags, see :ref:`FontStyle`. + +---- + +.. _class_FontData_method_set_font_style_name: + +- void **set_font_style_name** **(** :ref:`String` name **)** + +Sets the font style name. + +---- + .. _class_FontData_method_set_force_autohinter: - void **set_force_autohinter** **(** :ref:`bool` force_autohinter **)** @@ -799,7 +859,7 @@ Adds override for :ref:`is_script_supported` cache_index, :ref:`int` size, :ref:`SpacingType` spacing, :ref:`int` arg3 **)** +- void **set_spacing** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`SpacingType` spacing_type, :ref:`int` value **)** Sets extra spacing added between glyphs in pixels. diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 1b707ca11..032937276 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GDNative.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index ca6498433..10cb8f469 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GDNativeLibrary.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 5f9010c6e..c37d48d93 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GDScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index 913e8177b..996d69b19 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Generic6DOFJoint3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_geometry2d.rst b/classes/class_geometry2d.rst index c9ce67dd2..690589cf8 100644 --- a/classes/class_geometry2d.rst +++ b/classes/class_geometry2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Geometry2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_geometry3d.rst b/classes/class_geometry3d.rst index c238ea128..b58465eba 100644 --- a/classes/class_geometry3d.rst +++ b/classes/class_geometry3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Geometry3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index 8867f4eda..5900bf8cc 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GeometryInstance3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,29 +23,33 @@ Base node for geometry-based visual instances. Shares some common functionality Properties ---------- -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | ``1`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`extra_cull_margin` | ``0.0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`LightmapScale` | :ref:`gi_lightmap_scale` | ``0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`GIMode` | :ref:`gi_mode` | ``0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`ignore_occlusion_culling` | ``false`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`lod_bias` | ``1.0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`Material` | :ref:`material_override` | | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`visibility_range_begin` | ``0.0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`visibility_range_begin_margin` | ``0.0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`visibility_range_end` | ``0.0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`visibility_range_end_margin` | ``0.0`` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | ``1`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`extra_cull_margin` | ``0.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`LightmapScale` | :ref:`gi_lightmap_scale` | ``0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`GIMode` | :ref:`gi_mode` | ``0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`ignore_occlusion_culling` | ``false`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`lod_bias` | ``1.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`Material` | :ref:`material_override` | | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`transparency` | ``0.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`visibility_range_begin` | ``0.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`visibility_range_begin_margin` | ``0.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`visibility_range_end` | ``0.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`visibility_range_end_margin` | ``0.0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`VisibilityRangeFadeMode` | :ref:`visibility_range_fade_mode` | ``0`` | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ Methods ------- @@ -73,7 +77,7 @@ Enumerations enum **ShadowCastingSetting**: -- **SHADOW_CASTING_SETTING_OFF** = **0** --- Will not cast any shadows. +- **SHADOW_CASTING_SETTING_OFF** = **0** --- Will not cast any shadows. Use this to improve performance for small geometry that is unlikely to cast noticeable shadows (such as debris). - **SHADOW_CASTING_SETTING_ON** = **1** --- Will cast shadows from all visible faces in the GeometryInstance3D. @@ -99,11 +103,11 @@ In other words, the actual mesh will not be visible, only the shadows casted fro enum **GIMode**: -- **GI_MODE_DISABLED** = **0** +- **GI_MODE_DISABLED** = **0** --- Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using :ref:`VoxelGI` and SDFGI, the geometry will *receive* indirect lighting and reflections but will not be considered in GI baking. When using :ref:`LightmapGI`, the object will receive indirect lighting using lightmap probes instead of using the lightmap texture. -- **GI_MODE_BAKED** = **1** +- **GI_MODE_BAKED** = **1** --- Baked global illumination mode. Use for static objects that contribute to global illumination (such as level geometry). This GI mode is effective when using :ref:`VoxelGI`, SDFGI and :ref:`LightmapGI`. -- **GI_MODE_DYNAMIC** = **2** +- **GI_MODE_DYNAMIC** = **2** --- Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using :ref:`VoxelGI`, but it has a higher performance impact than :ref:`GI_MODE_BAKED`. ---- @@ -121,15 +125,33 @@ enum **GIMode**: enum **LightmapScale**: -- **LIGHTMAP_SCALE_1X** = **0** +- **LIGHTMAP_SCALE_1X** = **0** --- The standard texel density for lightmapping with :ref:`LightmapGI`. -- **LIGHTMAP_SCALE_2X** = **1** +- **LIGHTMAP_SCALE_2X** = **1** --- Multiplies texel density by 2× for lightmapping with :ref:`LightmapGI`. To ensure consistency in texel density, use this when scaling a mesh by a factor between 1.5 and 3.0. -- **LIGHTMAP_SCALE_4X** = **2** +- **LIGHTMAP_SCALE_4X** = **2** --- Multiplies texel density by 4× for lightmapping with :ref:`LightmapGI`. To ensure consistency in texel density, use this when scaling a mesh by a factor between 3.0 and 6.0. -- **LIGHTMAP_SCALE_8X** = **3** +- **LIGHTMAP_SCALE_8X** = **3** --- Multiplies texel density by 8× for lightmapping with :ref:`LightmapGI`. To ensure consistency in texel density, use this when scaling a mesh by a factor greater than 6.0. -- **LIGHTMAP_SCALE_MAX** = **4** +- **LIGHTMAP_SCALE_MAX** = **4** --- Represents the size of the :ref:`LightmapScale` enum. + +---- + +.. _enum_GeometryInstance3D_VisibilityRangeFadeMode: + +.. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_DISABLED: + +.. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_SELF: + +.. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES: + +enum **VisibilityRangeFadeMode**: + +- **VISIBILITY_RANGE_FADE_DISABLED** = **0** --- Will not fade itself nor its visibility dependencies, hysteresis will be used instead. See :ref:`visibility_range_begin` and :ref:`Node3D.visibility_parent` for more information. + +- **VISIBILITY_RANGE_FADE_SELF** = **1** --- Will fade-out itself when reaching the limits of its own visibility range. The fading range is determined by :ref:`visibility_range_begin_margin` and :ref:`visibility_range_end_margin`. + +- **VISIBILITY_RANGE_FADE_DEPENDENCIES** = **2** --- Will fade-in its visibility dependencies (see :ref:`Node3D.visibility_parent`) when reaching the limits of its own visibility range. The fading range is determined by :ref:`visibility_range_begin_margin` and :ref:`visibility_range_end_margin`. Property Descriptions --------------------- @@ -178,6 +200,8 @@ The extra distance added to the GeometryInstance3D's bounding box (:ref:`AABB`. 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. + ---- .. _class_GeometryInstance3D_property_gi_mode: @@ -192,6 +216,8 @@ The extra distance added to the GeometryInstance3D's bounding box (:ref:`AABB` **transparency** + ++-----------+-------------------------+ +| *Default* | ``0.0`` | ++-----------+-------------------------+ +| *Setter* | set_transparency(value) | ++-----------+-------------------------+ +| *Getter* | get_transparency() | ++-----------+-------------------------+ + +Transparency applied to the whole geometry. In spatial shaders, transparency is set as the default value of the ``ALPHA`` built-in. + +---- + .. _class_GeometryInstance3D_property_visibility_range_begin: - :ref:`float` **visibility_range_begin** @@ -282,7 +324,7 @@ Margin for the :ref:`visibility_range_begin` into account as well. The default value of 0 is used to disable the range check.. +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. ---- @@ -300,6 +342,22 @@ Distance from which the GeometryInstance3D will be hidden, taking :ref:`visibili 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. +---- + +.. _class_GeometryInstance3D_property_visibility_range_fade_mode: + +- :ref:`VisibilityRangeFadeMode` **visibility_range_fade_mode** + ++-----------+---------------------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------------------+ +| *Setter* | set_visibility_range_fade_mode(value) | ++-----------+---------------------------------------+ +| *Getter* | 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. + Method Descriptions ------------------- diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index 95f5c4b25..fb112f8e8 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFAccessor.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index f6776fbcc..b43809e5c 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFAnimation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 7963e3d01..468fd59fa 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFBufferView.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfcamera.rst b/classes/class_gltfcamera.rst index b990e1965..f92935039 100644 --- a/classes/class_gltfcamera.rst +++ b/classes/class_gltfcamera.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFCamera.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index 131752ba3..b293c2c27 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFDocument.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index c15b30cbb..177c4be4f 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFDocumentExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index 270f538a7..fed7335ea 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFDocumentExtensionConvertImporterMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index 6087774c0..4ee636cf0 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFLight.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 93408729e..62feba766 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,11 +16,13 @@ GLTFMesh Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------------+--------------------------+ -| :ref:`PackedFloat32Array` | :ref:`blend_weights` | ``PackedFloat32Array()`` | -+-----------------------------------------------------+-------------------------------------------------------------+--------------------------+ -| :ref:`ImporterMesh` | :ref:`mesh` | | -+-----------------------------------------------------+-------------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ +| :ref:`PackedFloat32Array` | :ref:`blend_weights` | ``PackedFloat32Array()`` | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ +| :ref:`Array` | :ref:`instance_materials` | ``[]`` | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ +| :ref:`ImporterMesh` | :ref:`mesh` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ Property Descriptions --------------------- @@ -39,6 +41,20 @@ Property Descriptions ---- +.. _class_GLTFMesh_property_instance_materials: + +- :ref:`Array` **instance_materials** + ++-----------+-------------------------------+ +| *Default* | ``[]`` | ++-----------+-------------------------------+ +| *Setter* | set_instance_materials(value) | ++-----------+-------------------------------+ +| *Getter* | get_instance_materials() | ++-----------+-------------------------------+ + +---- + .. _class_GLTFMesh_property_mesh: - :ref:`ImporterMesh` **mesh** diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 226eb1f53..118c89b45 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index 44d98acef..113279ac5 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFSkeleton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 85faab823..855624b7a 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFSkin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfspecgloss.rst b/classes/class_gltfspecgloss.rst index 311b2f468..eee86675c 100644 --- a/classes/class_gltfspecgloss.rst +++ b/classes/class_gltfspecgloss.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFSpecGloss.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 07e84af4b..d1e485f5f 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index d250af2ea..1e7d58db6 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GLTFTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index d590d059f..d9891f888 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GodotSharp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index 1414cffaa..9e8a348b7 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticles2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index e2552eb9b..31b2de716 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticles3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlesattractor3d.rst b/classes/class_gpuparticlesattractor3d.rst index 525ebb208..a49a07646 100644 --- a/classes/class_gpuparticlesattractor3d.rst +++ b/classes/class_gpuparticlesattractor3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesAttractor3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlesattractorbox.rst b/classes/class_gpuparticlesattractorbox.rst index 4bd250b39..f9e12a280 100644 --- a/classes/class_gpuparticlesattractorbox.rst +++ b/classes/class_gpuparticlesattractorbox.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesAttractorBox.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlesattractorsphere.rst b/classes/class_gpuparticlesattractorsphere.rst index 3234d069b..f60ea226d 100644 --- a/classes/class_gpuparticlesattractorsphere.rst +++ b/classes/class_gpuparticlesattractorsphere.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesAttractorSphere.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlesattractorvectorfield.rst b/classes/class_gpuparticlesattractorvectorfield.rst index 2dcff8754..e678c4c88 100644 --- a/classes/class_gpuparticlesattractorvectorfield.rst +++ b/classes/class_gpuparticlesattractorvectorfield.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesAttractorVectorField.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlescollision3d.rst b/classes/class_gpuparticlescollision3d.rst index 26f3ee45e..63eab826f 100644 --- a/classes/class_gpuparticlescollision3d.rst +++ b/classes/class_gpuparticlescollision3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesCollision3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlescollisionbox.rst b/classes/class_gpuparticlescollisionbox.rst index 6770e4dcf..64d9087b2 100644 --- a/classes/class_gpuparticlescollisionbox.rst +++ b/classes/class_gpuparticlescollisionbox.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesCollisionBox.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlescollisionheightfield.rst b/classes/class_gpuparticlescollisionheightfield.rst index d8d5f0319..c45c887c1 100644 --- a/classes/class_gpuparticlescollisionheightfield.rst +++ b/classes/class_gpuparticlescollisionheightfield.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesCollisionHeightField.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlescollisionsdf.rst b/classes/class_gpuparticlescollisionsdf.rst index e3fb1509c..5effd1150 100644 --- a/classes/class_gpuparticlescollisionsdf.rst +++ b/classes/class_gpuparticlescollisionsdf.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesCollisionSDF.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gpuparticlescollisionsphere.rst b/classes/class_gpuparticlescollisionsphere.rst index d32e37bab..e91c5dcf9 100644 --- a/classes/class_gpuparticlescollisionsphere.rst +++ b/classes/class_gpuparticlescollisionsphere.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GPUParticlesCollisionSphere.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 588f5ac0c..5b89019de 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Gradient.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,11 +21,13 @@ Given a set of colors, this resource will interpolate them in order. This means Properties ---------- -+-----------------------------------------------------+-------------------------------------------------+----------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`colors` | ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` | -+-----------------------------------------------------+-------------------------------------------------+----------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`offsets` | ``PackedFloat32Array(0, 1)`` | -+-----------------------------------------------------+-------------------------------------------------+----------------------------------------------+ ++-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`colors` | ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` | ++-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ +| :ref:`InterpolationMode` | :ref:`interpolation_mode` | ``0`` | ++-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`offsets` | ``PackedFloat32Array(0, 1)`` | ++-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ Methods ------- @@ -43,11 +45,32 @@ Methods +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` point **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +Enumerations +------------ + +.. _enum_Gradient_InterpolationMode: + +.. _class_Gradient_constant_GRADIENT_INTERPOLATE_LINEAR: + +.. _class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT: + +.. _class_Gradient_constant_GRADIENT_INTERPOLATE_CUBIC: + +enum **InterpolationMode**: + +- **GRADIENT_INTERPOLATE_LINEAR** = **0** --- Linear interpolation. + +- **GRADIENT_INTERPOLATE_CONSTANT** = **1** --- Constant interpolation, color changes abruptly at each point and stays uniform between. This might cause visible aliasing when used for a gradient texture in some cases. + +- **GRADIENT_INTERPOLATE_CUBIC** = **2** --- Cubic interpolation. + Property Descriptions --------------------- @@ -67,6 +90,22 @@ Gradient's colors returned as a :ref:`PackedColorArray`. ---- +.. _class_Gradient_property_interpolation_mode: + +- :ref:`InterpolationMode` **interpolation_mode** + ++-----------+-------------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------------+ +| *Setter* | set_interpolation_mode(value) | ++-----------+-------------------------------+ +| *Getter* | get_interpolation_mode() | ++-----------+-------------------------------+ + +Defines how the colors between points of the gradient are interpolated. See :ref:`InterpolationMode` for available modes. + +---- + .. _class_Gradient_property_offsets: - :ref:`PackedFloat32Array` **offsets** @@ -132,6 +171,14 @@ Removes the color at the index ``point``. ---- +.. _class_Gradient_method_reverse: + +- void **reverse** **(** **)** + +Reverses/mirrors the gradient. + +---- + .. _class_Gradient_method_set_color: - void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture1d.rst similarity index 73% rename from classes/class_gradienttexture.rst rename to classes/class_gradienttexture1d.rst index 28b9890a5..4e892eaba 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture1d.rst @@ -1,13 +1,13 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the GradientTexture.xml source instead. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the GradientTexture1D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_GradientTexture: +.. _class_GradientTexture1D: -GradientTexture -=============== +GradientTexture1D +================= **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` @@ -16,23 +16,23 @@ Gradient-filled texture. Description ----------- -GradientTexture uses a :ref:`Gradient` to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). +GradientTexture1D uses a :ref:`Gradient` to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). Properties ---------- -+---------------------------------+----------------------------------------------------------+-----------+ -| :ref:`Gradient` | :ref:`gradient` | | -+---------------------------------+----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`use_hdr` | ``false`` | -+---------------------------------+----------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`width` | ``2048`` | -+---------------------------------+----------------------------------------------------------+-----------+ ++---------------------------------+------------------------------------------------------------+-----------+ +| :ref:`Gradient` | :ref:`gradient` | | ++---------------------------------+------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`use_hdr` | ``false`` | ++---------------------------------+------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`width` | ``2048`` | ++---------------------------------+------------------------------------------------------------+-----------+ Property Descriptions --------------------- -.. _class_GradientTexture_property_gradient: +.. _class_GradientTexture1D_property_gradient: - :ref:`Gradient` **gradient** @@ -46,7 +46,7 @@ The :ref:`Gradient` that will be used to fill the texture. ---- -.. _class_GradientTexture_property_use_hdr: +.. _class_GradientTexture1D_property_use_hdr: - :ref:`bool` **use_hdr** @@ -62,7 +62,7 @@ If ``true``, the generated texture will support high dynamic range (:ref:`Image. ---- -.. _class_GradientTexture_property_width: +.. _class_GradientTexture1D_property_width: - :ref:`int` **width** diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst new file mode 100644 index 000000000..510c3f6d6 --- /dev/null +++ b/classes/class_gradienttexture2d.rst @@ -0,0 +1,207 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the GradientTexture2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_GradientTexture2D: + +GradientTexture2D +================= + +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Gradient-filled 2D texture. + +Description +----------- + +The texture uses a :ref:`Gradient` to fill the texture data in 2D space. The gradient is filled according to the specified :ref:`fill` and :ref:`repeat` types using colors obtained from the gradient. The texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width` and :ref:`height`). + +Properties +---------- + ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`Fill` | :ref:`fill` | ``0`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`fill_from` | ``Vector2(0, 0)`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`fill_to` | ``Vector2(1, 0)`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`Gradient` | :ref:`gradient` | | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`height` | ``64`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`Repeat` | :ref:`repeat` | ``0`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`use_hdr` | ``false`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`width` | ``64`` | ++----------------------------------------------+--------------------------------------------------------------+-------------------+ + +Enumerations +------------ + +.. _enum_GradientTexture2D_Fill: + +.. _class_GradientTexture2D_constant_FILL_LINEAR: + +.. _class_GradientTexture2D_constant_FILL_RADIAL: + +enum **Fill**: + +- **FILL_LINEAR** = **0** --- The colors are linearly interpolated in a straight line. + +- **FILL_RADIAL** = **1** --- The colors are linearly interpolated in a circular pattern. + +---- + +.. _enum_GradientTexture2D_Repeat: + +.. _class_GradientTexture2D_constant_REPEAT_NONE: + +.. _class_GradientTexture2D_constant_REPEAT: + +.. _class_GradientTexture2D_constant_REPEAT_MIRROR: + +enum **Repeat**: + +- **REPEAT_NONE** = **0** --- The gradient fill is restricted to the range defined by :ref:`fill_from` to :ref:`fill_to` offsets. + +- **REPEAT** = **1** --- The texture is filled starting from :ref:`fill_from` to :ref:`fill_to` offsets, repeating the same pattern in both directions. + +- **REPEAT_MIRROR** = **2** --- The texture is filled starting from :ref:`fill_from` to :ref:`fill_to` offsets, mirroring the pattern in both directions. + +Property Descriptions +--------------------- + +.. _class_GradientTexture2D_property_fill: + +- :ref:`Fill` **fill** + ++-----------+-----------------+ +| *Default* | ``0`` | ++-----------+-----------------+ +| *Setter* | set_fill(value) | ++-----------+-----------------+ +| *Getter* | 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. + +---- + +.. _class_GradientTexture2D_property_fill_from: + +- :ref:`Vector2` **fill_from** + ++-----------+----------------------+ +| *Default* | ``Vector2(0, 0)`` | ++-----------+----------------------+ +| *Setter* | set_fill_from(value) | ++-----------+----------------------+ +| *Getter* | get_fill_from() | ++-----------+----------------------+ + +The initial offset used to fill the texture specified in UV coordinates. + +---- + +.. _class_GradientTexture2D_property_fill_to: + +- :ref:`Vector2` **fill_to** + ++-----------+--------------------+ +| *Default* | ``Vector2(1, 0)`` | ++-----------+--------------------+ +| *Setter* | set_fill_to(value) | ++-----------+--------------------+ +| *Getter* | get_fill_to() | ++-----------+--------------------+ + +The final offset used to fill the texture specified in UV coordinates. + +---- + +.. _class_GradientTexture2D_property_gradient: + +- :ref:`Gradient` **gradient** + ++----------+---------------------+ +| *Setter* | set_gradient(value) | ++----------+---------------------+ +| *Getter* | get_gradient() | ++----------+---------------------+ + +The :ref:`Gradient` used to fill the texture. + +---- + +.. _class_GradientTexture2D_property_height: + +- :ref:`int` **height** + ++-----------+-------------------+ +| *Default* | ``64`` | ++-----------+-------------------+ +| *Setter* | set_height(value) | ++-----------+-------------------+ +| *Getter* | get_height() | ++-----------+-------------------+ + +The number of vertical color samples that will be obtained from the :ref:`Gradient`, which also represents the texture's height. + +---- + +.. _class_GradientTexture2D_property_repeat: + +- :ref:`Repeat` **repeat** + ++-----------+-------------------+ +| *Default* | ``0`` | ++-----------+-------------------+ +| *Setter* | set_repeat(value) | ++-----------+-------------------+ +| *Getter* | 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. + +---- + +.. _class_GradientTexture2D_property_use_hdr: + +- :ref:`bool` **use_hdr** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_use_hdr(value) | ++-----------+--------------------+ +| *Getter* | 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). + +---- + +.. _class_GradientTexture2D_property_width: + +- :ref:`int` **width** + ++-----------+------------------+ +| *Default* | ``64`` | ++-----------+------------------+ +| *Setter* | set_width(value) | ++-----------+------------------+ +| *Getter* | get_width() | ++-----------+------------------+ + +The number of horizontal color samples that will be obtained from the :ref:`Gradient`, which also represents the texture's width. + +.. |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.)` diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 18ff85891..57f930e81 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GraphEdit.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -558,9 +558,9 @@ Returns an Array containing the list of connections. A connection consists in a - :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** -Gets the :ref:`HBoxContainer` that contains the zooming and grid snap controls in the top left of the graph. +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. -Warning: The intended usage of this function is to allow you to reposition or add your own custom controls to the container. This is an internal control and as such should not be freed. If you wish to hide this or any of its children, use their :ref:`CanvasItem.visible` property instead. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. ---- diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 22395cb1e..f38f410f1 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GraphNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 0cb55e182..f5c159d3c 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GridContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 63570cf52..3b205985d 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GridMap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index ad97b1b66..8b77298e2 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the GrooveJoint2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index 79b0f03f5..235060f54 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HashingContext.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index e37aaaa77..30347b211 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HBoxContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst index 767030800..fce4fcbe8 100644 --- a/classes/class_heightmapshape3d.rst +++ b/classes/class_heightmapshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HeightMapShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hingejoint3d.rst b/classes/class_hingejoint3d.rst index d29b8d349..e3dedb8ae 100644 --- a/classes/class_hingejoint3d.rst +++ b/classes/class_hingejoint3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HingeJoint3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hmaccontext.rst b/classes/class_hmaccontext.rst index fa256843d..af81c2c8b 100644 --- a/classes/class_hmaccontext.rst +++ b/classes/class_hmaccontext.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HMACContext.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 402504e23..601d8fdab 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HScrollBar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 692668c25..0c8567c16 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HSeparator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index d03f72d64..3054244f1 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HSlider.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index 8340fddd1..efbe2c164 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HSplitContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index b1555a632..20ab861f2 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HTTPClient.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index e775d8f8b..71c27ed54 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the HTTPRequest.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_image.rst b/classes/class_image.rst index 8b705efd5..e3bbeb806 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Image.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 80770b446..430b0e0d2 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ImageTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_imagetexture3d.rst b/classes/class_imagetexture3d.rst index bea0ae6b7..c0bfb0482 100644 --- a/classes/class_imagetexture3d.rst +++ b/classes/class_imagetexture3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ImageTexture3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_imagetexturelayered.rst b/classes/class_imagetexturelayered.rst index 118f80dd4..3973b2a94 100644 --- a/classes/class_imagetexturelayered.rst +++ b/classes/class_imagetexturelayered.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ImageTextureLayered.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_immediatemesh.rst b/classes/class_immediatemesh.rst index cab6b3e3d..8a4d700a7 100644 --- a/classes/class_immediatemesh.rst +++ b/classes/class_immediatemesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ImmediateMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 0575f5ff3..5c8e63f4f 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ImporterMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index 259fb5f21..5cc7d78b9 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ImporterMeshInstance3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_input.rst b/classes/class_input.rst index ad3358e21..318a6b9d0 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Input.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -30,85 +30,95 @@ Tutorials Methods ------- -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`Array` | :ref:`get_connected_joypads` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`JoyAxis` axis **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`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_joy_button_pressed` **(** :ref:`int` device, :ref:`JoyButton` button **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`Key` keycode **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`MouseButton` button **)** |const| | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`vibrate_handheld` **(** :ref:`int` duration_ms=500 **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`Array` | :ref:`get_connected_joypads` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`JoyAxis` axis **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MouseButton` | :ref:`get_mouse_button_mask` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** |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_joy_button_pressed` **(** :ref:`int` device, :ref:`JoyButton` button **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`Key` keycode **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`MouseButton` button **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_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 **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`vibrate_handheld` **(** :ref:`int` duration_ms=500 **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -202,6 +212,8 @@ enum **CursorShape**: - **CURSOR_DRAG** = **6** --- Drag cursor. Usually displayed when dragging something. +**Note:** Windows lacks a dragging cursor, so :ref:`CURSOR_DRAG` is the same as :ref:`CURSOR_MOVE` for this platform. + - **CURSOR_CAN_DROP** = **7** --- Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position. - **CURSOR_FORBIDDEN** = **8** --- Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled. @@ -253,6 +265,16 @@ Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally up ---- +.. _class_Input_method_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:`set_use_accumulated_input`) or agile input flushing (:ref:`ProjectSettings.input_devices/buffering/agile_event_flushing`). + +The engine will already do this itself at key execution points (at least once per frame). However, this can be useful in advanced cases where you want precise control over the timing of event handling. + +---- + .. _class_Input_method_get_accelerometer: - :ref:`Vector3` **get_accelerometer** **(** **)** |const| @@ -391,7 +413,7 @@ Returns the magnetic field strength in micro-Tesla for all axes of the device's .. _class_Input_method_get_mouse_button_mask: -- :ref:`int` **get_mouse_button_mask** **(** **)** |const| +- :ref:`MouseButton` **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. @@ -528,6 +550,16 @@ Removes all mappings from the internal database that match the given GUID. ---- +.. _class_Input_method_set_accelerometer: + +- void **set_accelerometer** **(** :ref:`Vector3` value **)** + +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. + +**Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS. + +---- + .. _class_Input_method_set_custom_mouse_cursor: - void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** @@ -556,6 +588,36 @@ Sets the default cursor shape to be used in the viewport instead of :ref:`CURSOR ---- +.. _class_Input_method_set_gravity: + +- void **set_gravity** **(** :ref:`Vector3` value **)** + +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. + +**Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS. + +---- + +.. _class_Input_method_set_gyroscope: + +- void **set_gyroscope** **(** :ref:`Vector3` value **)** + +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. + +**Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS. + +---- + +.. _class_Input_method_set_magnetometer: + +- void **set_magnetometer** **(** :ref:`Vector3` value **)** + +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. + +**Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS. + +---- + .. _class_Input_method_set_mouse_mode: - void **set_mouse_mode** **(** :ref:`MouseMode` mode **)** diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 6611a8f2b..72fcdf216 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEvent.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 6baec7df8..cdfbc3805 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventAction.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventfromwindow.rst b/classes/class_inputeventfromwindow.rst index 221b29631..b36b93bed 100644 --- a/classes/class_inputeventfromwindow.rst +++ b/classes/class_inputeventfromwindow.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventFromWindow.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 59d0ac0d9..d6e96de5e 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventGesture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 2a8b2c906..9a1f7132b 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventJoypadButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index c26ae79a2..c383641c8 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventJoypadMotion.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index fedd0c68b..52fbbeb9e 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventKey.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -41,11 +41,11 @@ Properties Methods ------- -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_keycode_with_modifiers` **(** **)** |const| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_physical_keycode_with_modifiers` **(** **)** |const| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Key` | :ref:`get_keycode_with_modifiers` **(** **)** |const| | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Key` | :ref:`get_physical_keycode_with_modifiers` **(** **)** |const| | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -137,7 +137,7 @@ Method Descriptions .. _class_InputEventKey_method_get_keycode_with_modifiers: -- :ref:`int` **get_keycode_with_modifiers** **(** **)** |const| +- :ref:`Key` **get_keycode_with_modifiers** **(** **)** |const| Returns the keycode combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers`. @@ -147,7 +147,7 @@ To get a human-readable representation of the ``InputEventKey`` with modifiers, .. _class_InputEventKey_method_get_physical_keycode_with_modifiers: -- :ref:`int` **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`. diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 9af6aa458..5a5af0b20 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventMagnifyGesture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index 757e153e7..2d13767ca 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventMIDI.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 9302bd8b4..cd81524cb 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventMouse.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -28,20 +28,20 @@ Tutorials Properties ---------- -+-------------------------------+------------------------------------------------------------------------+-------------------+ -| :ref:`int` | :ref:`button_mask` | ``0`` | -+-------------------------------+------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`global_position` | ``Vector2(0, 0)`` | -+-------------------------------+------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | -+-------------------------------+------------------------------------------------------------------------+-------------------+ ++---------------------------------------------------+------------------------------------------------------------------------+-------------------+ +| :ref:`MouseButton` | :ref:`button_mask` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`global_position` | ``Vector2(0, 0)`` | ++---------------------------------------------------+------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | ++---------------------------------------------------+------------------------------------------------------------------------+-------------------+ Property Descriptions --------------------- .. _class_InputEventMouse_property_button_mask: -- :ref:`int` **button_mask** +- :ref:`MouseButton` **button_mask** +-----------+------------------------+ | *Default* | ``0`` | diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index b0459cbc9..24848945c 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventMouseButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 2a3438f10..e20c6f0f4 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventMouseMotion.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 3b82513d9..299289311 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventPanGesture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 590dd9f35..792a84a87 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventScreenDrag.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -83,7 +83,7 @@ The drag position. | *Getter* | get_relative() | +-----------+---------------------+ -The drag position relative to its start position. +The drag position relative to the previous position (position at the last frame). ---- diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 160d1f3cc..6c8620dcf 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventScreenTouch.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventshortcut.rst b/classes/class_inputeventshortcut.rst index 6b4ec780d..1eb3361c1 100644 --- a/classes/class_inputeventshortcut.rst +++ b/classes/class_inputeventshortcut.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventShortcut.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 93ce3c656..eb19eddea 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputEventWithModifiers.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index b1a216a6e..4d6f44fe1 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InputMap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 665b6cadf..6c6f5ea96 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the InstancePlaceholder.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_int.rst b/classes/class_int.rst index bd83464c2..4c96de962 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the int.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -53,143 +53,149 @@ It can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854 -Methods -------- +Constructors +------------ -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`int` from **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** |constructor| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator %** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator &** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator *** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator *** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator *** **(** :ref:`Vector2i` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator *** **(** :ref:`Vector3i` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator *** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator *** **(** :ref:`Color` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator +** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator +** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator -** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator -** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator /** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator /** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator <<** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator >>** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator ^** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator unary+** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator unary-** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator |** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator ~** **(** **)** |operator| | -+-------------------------------------+-------------------------------------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** **)** | ++-----------------------+----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`int` from **)** | ++-----------------------+----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | ++-----------------------+----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | ++-----------------------+----------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_int_method_int: ++-------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :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:`int` | :ref:`operator *` **(** :ref:`int` right **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`operator *` **(** :ref:`float` 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:`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:`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:`int` **int** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_int_constructor_int: + +- :ref:`int` **int** **(** **)** Constructs a default-initialized ``int`` set to ``0``. ---- -- :ref:`int` **int** **(** :ref:`int` from **)** |constructor| +- :ref:`int` **int** **(** :ref:`int` from **)** Constructs an ``int`` as a copy of the given ``int``. ---- -- :ref:`int` **int** **(** :ref:`bool` from **)** |constructor| +- :ref:`int` **int** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. ---- -- :ref:`int` **int** **(** :ref:`float` from **)** |constructor| +- :ref:`int` **int** **(** :ref:`float` from **)** Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds ``from`` towards zero), so for example ``int(2.7)`` will be equals to 2, ``int(0.1)`` will be equals to 0 and ``int(-2.7)`` will be equals to -2. This operation is also called truncation. ----- +Operator Descriptions +--------------------- -.. _class_int_method_operator !=: +.. _class_int_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`float` right **)** Returns ``true`` if operands are different from each other. ---- -- :ref:`bool` **operator !=** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`int` right **)** Returns ``true`` if operands are different from each other. ---- -.. _class_int_method_operator %: +.. _class_int_operator_mod_int: -- :ref:`int` **operator %** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator %** **(** :ref:`int` right **)** Returns the result of the modulo operator for two integers, i.e. the remainder after dividing both numbers. @@ -201,9 +207,9 @@ Returns the result of the modulo operator for two integers, i.e. the remainder a ---- -.. _class_int_method_operator &: +.. _class_int_operator_bwand_int: -- :ref:`int` **operator &** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator &** **(** :ref:`int` right **)** Returns the result of bitwise ``AND`` operation for two integers. @@ -223,23 +229,31 @@ It's useful to retrieve binary flags from a variable. ---- -.. _class_int_method_operator *: +.. _class_int_operator_mul_Color: -- :ref:`int` **operator *** **(** :ref:`int` right **)** |operator| +- :ref:`Color` **operator *** **(** :ref:`Color` right **)** + +---- + +- :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** + +---- + +- :ref:`int` **operator *** **(** :ref:`int` right **)** Multiplies two ``int``\ s. ---- -- :ref:`float` **operator *** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator *** **(** :ref:`float` right **)** Multiplies an ``int`` and a :ref:`float`. The result is a :ref:`float`. ---- -- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** |operator| +- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** -Multiplies each component of the vector by the given integer. +Multiplies each component of the :ref:`Vector2` by the given ``int``. :: @@ -247,71 +261,55 @@ Multiplies each component of the vector by the given integer. ---- -- :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** |operator| +- :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** -Multiplies each component of the integer vector by the given integer. +Multiplies each component of the :ref:`Vector2i` by the given ``int``. ---- -- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** |operator| +- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** -Multiplies each component of the vector by the given integer. +Multiplies each component of the :ref:`Vector3` by the given ``int``. ---- -- :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** |operator| +- :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** -Multiplies each component of the integer vector by the given integer. +Multiplies each component of the :ref:`Vector3i` by the given ``int``. ---- -- :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** |operator| +.. _class_int_operator_sum_float: -Multiplies each component of the quaternion by the given integer. +- :ref:`float` **operator +** **(** :ref:`float` right **)** + +Adds an ``int`` and a :ref:`float`. The result is a :ref:`float`. ---- -- :ref:`Color` **operator *** **(** :ref:`Color` right **)** |operator| - -Multiplies each component of the color by the given integer. - -:: - - print(2 * Color(0.5, 0.5, 0.5)) # Color(1, 1, 1) - ----- - -.. _class_int_method_operator +: - -- :ref:`int` **operator +** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator +** **(** :ref:`int` right **)** Adds two integers. ---- -- :ref:`float` **operator +** **(** :ref:`float` right **)** |operator| +.. _class_int_operator_dif_float: -Adds an ``int`` to a :ref:`float`. The result is a :ref:`float`. - ----- - -.. _class_int_method_operator -: - -- :ref:`float` **operator -** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator -** **(** :ref:`float` right **)** Subtracts a :ref:`float` from an ``int``. The result is a :ref:`float`. ---- -- :ref:`int` **operator -** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator -** **(** :ref:`int` right **)** Subtracts two integers. ---- -.. _class_int_method_operator /: +.. _class_int_operator_div_float: -- :ref:`float` **operator /** **(** :ref:`float` right **)** |operator| +- :ref:`float` **operator /** **(** :ref:`float` right **)** Divides an ``int`` by a :ref:`float`. The result is a :ref:`float`. @@ -321,7 +319,7 @@ Divides an ``int`` by a :ref:`float`. The result is a :ref:`float` **operator /** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator /** **(** :ref:`int` right **)** Divides two integers. The decimal part of the result is discarded (truncated). @@ -332,23 +330,23 @@ Divides two integers. The decimal part of the result is discarded (truncated). ---- -.. _class_int_method_operator <: +.. _class_int_operator_lt_bool: -- :ref:`bool` **operator <** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator <** **(** :ref:`float` right **)** Returns ``true`` if this ``int`` is less than the given :ref:`float`. ---- -- :ref:`bool` **operator <** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator <** **(** :ref:`int` right **)** Returns ``true`` the left integer is less than the right one. ---- -.. _class_int_method_operator <<: +.. _class_int_operator_bwsl_int: -- :ref:`int` **operator <<** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator <<** **(** :ref:`int` right **)** Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2. @@ -359,69 +357,69 @@ Performs bitwise shift left operation on the integer. Effectively the same as mu ---- -.. _class_int_method_operator <=: +.. _class_int_operator_lte_bool: -- :ref:`bool` **operator <=** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator <=** **(** :ref:`float` right **)** Returns ``true`` if this ``int`` is less than or equal to the given :ref:`float`. ---- -- :ref:`bool` **operator <=** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator <=** **(** :ref:`int` right **)** Returns ``true`` the left integer is less than or equal to the right one. ---- -.. _class_int_method_operator ==: +.. _class_int_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`float` right **)** Returns ``true`` if the integer is equal to the given :ref:`float`. ---- -- :ref:`bool` **operator ==** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`int` right **)** Returns ``true`` if both integers are equal. ---- -.. _class_int_method_operator >: +.. _class_int_operator_gt_bool: -- :ref:`bool` **operator >** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator >** **(** :ref:`float` right **)** Returns ``true`` if this ``int`` is greater than the given :ref:`float`. ---- -- :ref:`bool` **operator >** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator >** **(** :ref:`int` right **)** Returns ``true`` the left integer is greater than the right one. ---- -.. _class_int_method_operator >=: +.. _class_int_operator_gte_bool: -- :ref:`bool` **operator >=** **(** :ref:`float` right **)** |operator| +- :ref:`bool` **operator >=** **(** :ref:`float` right **)** Returns ``true`` if this ``int`` is greater than or equal to the given :ref:`float`. ---- -- :ref:`bool` **operator >=** **(** :ref:`int` right **)** |operator| +- :ref:`bool` **operator >=** **(** :ref:`int` right **)** Returns ``true`` the left integer is greater than or equal to the right one. ---- -.. _class_int_method_operator >>: +.. _class_int_operator_bwsr_int: -- :ref:`int` **operator >>** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator >>** **(** :ref:`int` right **)** Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2. @@ -432,9 +430,9 @@ Performs bitwise shift right operation on the integer. Effectively the same as d ---- -.. _class_int_method_operator ^: +.. _class_int_operator_bwxor_int: -- :ref:`int` **operator ^** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator ^** **(** :ref:`int` right **)** Returns the result of bitwise ``XOR`` operation for two integers. @@ -445,25 +443,25 @@ Returns the result of bitwise ``XOR`` operation for two integers. ---- -.. _class_int_method_operator unary+: +.. _class_int_operator_unplus_int: -- :ref:`int` **operator unary+** **(** **)** |operator| +- :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. ---- -.. _class_int_method_operator unary-: +.. _class_int_operator_unminus_int: -- :ref:`int` **operator unary-** **(** **)** |operator| +- :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. ---- -.. _class_int_method_operator |: +.. _class_int_operator_bwor_int: -- :ref:`int` **operator |** **(** :ref:`int` right **)** |operator| +- :ref:`int` **operator |** **(** :ref:`int` right **)** Returns the result of bitwise ``OR`` operation for two integers. @@ -483,9 +481,9 @@ It's useful to store binary flags in a variable. ---- -.. _class_int_method_operator ~: +.. _class_int_operator_bwnot_int: -- :ref:`int` **operator ~** **(** **)** |operator| +- :ref:`int` **operator ~** **(** **)** Returns the result of bitwise ``NOT`` operation for the integer. It's effectively equal to ``-int + 1``. diff --git a/classes/class_intervaltweener.rst b/classes/class_intervaltweener.rst index 75805f2b8..26164e831 100644 --- a/classes/class_intervaltweener.rst +++ b/classes/class_intervaltweener.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the IntervalTweener.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_ip.rst b/classes/class_ip.rst index f211a47df..055ebd36e 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the IP.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 69844f9fd..d1cd1ecc4 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ItemList.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -42,6 +42,8 @@ Properties +------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------+ | :ref:`float` | :ref:`icon_scale` | ``1.0`` | +------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------+ +| :ref:`int` | :ref:`items_count` | ``0`` | ++------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------+ | :ref:`int` | :ref:`max_columns` | ``1`` | +------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------+ | :ref:`int` | :ref:`max_text_lines` | ``1`` | @@ -75,8 +77,6 @@ Methods +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** |const| | @@ -398,6 +398,22 @@ The scale of icon applied after :ref:`fixed_icon_size` **items_count** + ++-----------+-----------------------+ +| *Default* | ``0`` | ++-----------+-----------------------+ +| *Setter* | set_item_count(value) | ++-----------+-----------------------+ +| *Getter* | get_item_count() | ++-----------+-----------------------+ + +The number of items currently in the list. + +---- + .. _class_ItemList_property_max_columns: - :ref:`int` **max_columns** @@ -557,14 +573,6 @@ When there is no item at that point, -1 will be returned if ``exact`` is ``true` ---- -.. _class_ItemList_method_get_item_count: - -- :ref:`int` **get_item_count** **(** **)** |const| - -Returns the number of items currently in the list. - ----- - .. _class_ItemList_method_get_item_custom_bg_color: - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** |const| @@ -667,6 +675,8 @@ Returns an array with the indexes of the selected items. Returns the :ref:`Object` ID associated with the list. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_ItemList_method_is_anything_selected: diff --git a/classes/class_javaclass.rst b/classes/class_javaclass.rst index aaf4587c6..190fc0279 100644 --- a/classes/class_javaclass.rst +++ b/classes/class_javaclass.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JavaClass.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index a9ac32312..e380c1a06 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JavaClassWrapper.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index 86642e87c..c965e828c 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JavaScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_javascriptobject.rst b/classes/class_javascriptobject.rst index 70a0d7134..6a76aa45f 100644 --- a/classes/class_javascriptobject.rst +++ b/classes/class_javascriptobject.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JavaScriptObject.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_jnisingleton.rst b/classes/class_jnisingleton.rst index ef459e2d6..099bf7768 100644 --- a/classes/class_jnisingleton.rst +++ b/classes/class_jnisingleton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JNISingleton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index eb4c2a51d..92912432e 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Joint2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_joint3d.rst b/classes/class_joint3d.rst index 0263b41a2..0bf5d66b0 100644 --- a/classes/class_joint3d.rst +++ b/classes/class_joint3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Joint3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_json.rst b/classes/class_json.rst index f3243f337..fae9911d1 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JSON.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index ec902e9bc..6a026344e 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the JSONRPC.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index f1908c7d6..c51a876f4 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the KinematicCollision2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_kinematiccollision3d.rst b/classes/class_kinematiccollision3d.rst index 698060d02..2bfce6af3 100644 --- a/classes/class_kinematiccollision3d.rst +++ b/classes/class_kinematiccollision3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the KinematicCollision3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_label.rst b/classes/class_label.rst index 180976c06..5b5daa9c2 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Label.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -624,7 +624,7 @@ The vertical offset of the text's shadow. | *Default* | ``1`` | +-----------+-------+ -Shadow outline size. If set to 1 or greater, the shadow will be displayed around the whole text as an outline. +The size of the shadow outline. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 0255af9f7..defe719e3 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Light2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index 79359deda..d7e46f71d 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Light3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -217,7 +217,7 @@ If ``true``, the light only appears in the editor and will not be visible at run | *Getter* | get_param() | +-----------+------------------+ -The light's angular size in degrees. Only available for :ref:`DirectionalLight3D`\ s. For reference, the Sun from the Earth is approximately ``0.5``. +The light's angular size in degrees. Increasing this will make shadows softer at greater distances. Only available for :ref:`DirectionalLight3D`\ s. For reference, the Sun from the Earth is approximately ``0.5``. ---- diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index ecacc393f..ae6b580b7 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LightmapGI.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,16 @@ LightmapGI **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +Computes and stores baked lightmaps for fast global illumination. +Description +----------- + +The ``LightmapGI`` node is used to compute and store baked lightmaps. Lightmaps are used to provide high-quality indirect lighting with very little light leaking. ``LightmapGI`` can also provide rough reflections using spherical harmonics if :ref:`directional` is enabled. Dynamic objects can receive indirect lighting thanks to *light probes*, which can be automatically placed by setting :ref:`generate_probes_subdiv`. Additional lightmap probes can also be added by creating :ref:`LightmapProbe` nodes. The downside is that lightmaps are fully static and cannot be baked in an exported project. Baking a ``LightmapGI`` node is also slower compared to :ref:`VoxelGI`. + +**Procedural generation:** Lightmap baking functionality is only available in the editor. This means ``LightmapGI`` is not suited to procedurally generated or user-built levels. For procedurally generated or user-built levels, use :ref:`VoxelGI` or SDFGI instead (see :ref:`Environment.sdfgi_enabled`). + +**Performance:** ``LightmapGI`` provides the best possible run-time performance for global illumination. It is suitable for low-end hardware including integrated graphics and mobile devices. Properties ---------- diff --git a/classes/class_lightmapgidata.rst b/classes/class_lightmapgidata.rst index 243e5a132..eefca28c4 100644 --- a/classes/class_lightmapgidata.rst +++ b/classes/class_lightmapgidata.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LightmapGIData.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_lightmapper.rst b/classes/class_lightmapper.rst index bcc746174..df9269769 100644 --- a/classes/class_lightmapper.rst +++ b/classes/class_lightmapper.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Lightmapper.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_lightmapperrd.rst b/classes/class_lightmapperrd.rst index 704a00ff0..32d33a4a3 100644 --- a/classes/class_lightmapperrd.rst +++ b/classes/class_lightmapperrd.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LightmapperRD.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_lightmapprobe.rst b/classes/class_lightmapprobe.rst index c0e51622b..8b5c4d1b1 100644 --- a/classes/class_lightmapprobe.rst +++ b/classes/class_lightmapprobe.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LightmapProbe.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index f69fced7f..acf4b7a27 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LightOccluder2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 6d72f3406..24775a1ed 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Line2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 2d27096a2..1748ad13a 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LineEdit.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -82,18 +82,24 @@ Properties +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`draw_control_chars` | ``false`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`editable` | ``true`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`expand_to_text_length` | ``false`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`flat` | ``false`` | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` *(parent override)* | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`String` | :ref:`language` | ``""`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`int` | :ref:`max_length` | ``0`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`middle_mouse_paste_enabled` | ``true`` | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`CursorShape` | mouse_default_cursor_shape | ``1`` *(parent override)* | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`placeholder_alpha` | ``0.6`` | @@ -502,6 +508,22 @@ If ``true``, the context menu will appear when right-clicked. ---- +.. _class_LineEdit_property_deselect_on_focus_loss_enabled: + +- :ref:`bool` **deselect_on_focus_loss_enabled** + ++-----------+-------------------------------------------+ +| *Default* | ``true`` | ++-----------+-------------------------------------------+ +| *Setter* | set_deselect_on_focus_loss_enabled(value) | ++-----------+-------------------------------------------+ +| *Getter* | is_deselect_on_focus_loss_enabled() | ++-----------+-------------------------------------------+ + +If ``true``, the selected text will be deselected when focus is lost. + +---- + .. _class_LineEdit_property_draw_control_chars: - :ref:`bool` **draw_control_chars** @@ -550,6 +572,22 @@ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:` ---- +.. _class_LineEdit_property_flat: + +- :ref:`bool` **flat** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flat(value) | ++-----------+-----------------+ +| *Getter* | is_flat() | ++-----------+-----------------+ + +If ``true``, the ``LineEdit`` don't display decoration. + +---- + .. _class_LineEdit_property_language: - :ref:`String` **language** @@ -609,6 +647,24 @@ When a limit is defined, characters that would exceed :ref:`max_length` **middle_mouse_paste_enabled** + ++-----------+---------------------------------------+ +| *Default* | ``true`` | ++-----------+---------------------------------------+ +| *Setter* | set_middle_mouse_paste_enabled(value) | ++-----------+---------------------------------------+ +| *Getter* | is_middle_mouse_paste_enabled() | ++-----------+---------------------------------------+ + +If ``false``, using middle mouse button to paste clipboard will be disabled. + +**Note:** This method is only implemented on Linux. + ---- .. _class_LineEdit_property_placeholder_alpha: @@ -850,6 +906,8 @@ Clears the current selection. Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the ``LineEdit``. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`Window.visible` property. + ---- .. _class_LineEdit_method_get_opentype_feature: diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index f6368492b..836888f96 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the LinkButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -62,6 +62,8 @@ Theme Properties +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color(0.88, 0.88, 0.88, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.94, 0.94, 0.94, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | @@ -247,6 +249,18 @@ Default text :ref:`Color` of the ``LinkButton``. ---- +.. _class_LinkButton_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+--------------------------------+ +| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------+--------------------------------+ + +Text :ref:`Color` used when the ``LinkButton`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_LinkButton_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 1808f8a80..526de0397 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MainLoop.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index ec82232c6..192325356 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MarginContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 9e8da4be2..c313aa9d8 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Marshalls.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_material.rst b/classes/class_material.rst index 973df8a3c..0d61f1bb1 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Material.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ Material **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`BaseMaterial3D`, :ref:`CanvasItemMaterial`, :ref:`PanoramaSkyMaterial`, :ref:`ParticlesMaterial`, :ref:`PhysicalSkyMaterial`, :ref:`ProceduralSkyMaterial`, :ref:`ShaderMaterial` +**Inherited By:** :ref:`BaseMaterial3D`, :ref:`CanvasItemMaterial`, :ref:`FogMaterial`, :ref:`PanoramaSkyMaterial`, :ref:`ParticlesMaterial`, :ref:`PhysicalSkyMaterial`, :ref:`ProceduralSkyMaterial`, :ref:`ShaderMaterial` Abstract base :ref:`Resource` for coloring and shading geometry. diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 2a6b2a96a..76f49e559 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MenuButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -32,6 +32,8 @@ Properties +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+ | :ref:`FocusMode` | focus_mode | ``0`` *(parent override)* | +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+ +| :ref:`int` | :ref:`items_count` | ``0`` | ++-----------------------------------------------+-------------------------------------------------------------------+------------------------------+ | :ref:`bool` | :ref:`switch_on_hover` | ``false`` | +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+ | :ref:`bool` | toggle_mode | ``true`` *(parent override)* | @@ -60,6 +62,8 @@ Theme Properties +---------------------------------+------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(1, 1, 1, 0.3)`` | +---------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++---------------------------------+------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.94, 0.94, 0.94, 1)`` | +---------------------------------+------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | @@ -91,6 +95,22 @@ Emitted when the :ref:`PopupMenu` of this MenuButton is about t Property Descriptions --------------------- +.. _class_MenuButton_property_items_count: + +- :ref:`int` **items_count** + ++-----------+-----------------------+ +| *Default* | ``0`` | ++-----------+-----------------------+ +| *Setter* | set_item_count(value) | ++-----------+-----------------------+ +| *Getter* | get_item_count() | ++-----------+-----------------------+ + +The number of items currently in the list. + +---- + .. _class_MenuButton_property_switch_on_hover: - :ref:`bool` **switch_on_hover** @@ -114,6 +134,8 @@ Method Descriptions Returns the :ref:`PopupMenu` contained in this button. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`Window.visible` property. + ---- .. _class_MenuButton_method_set_disable_shortcuts: @@ -173,6 +195,18 @@ Text :ref:`Color` used when the ``MenuButton`` is disabled. ---- +.. _class_MenuButton_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+--------------------------------+ +| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------+--------------------------------+ + +Text :ref:`Color` used when the ``MenuButton`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_MenuButton_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index aa7784789..dd768959f 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Mesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index c7665873e..7378f5848 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MeshDataTool.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 316fd0c9a..1d728d908 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MeshInstance2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index dc99d4df0..e69a8040f 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MeshInstance3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -54,12 +54,20 @@ Methods +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -147,6 +155,12 @@ This helper creates a :ref:`StaticBody3D` child node with a ---- +.. _class_MeshInstance3D_method_find_blend_shape_by_name: + +- :ref:`int` **find_blend_shape_by_name** **(** :ref:`StringName` name **)** + +---- + .. _class_MeshInstance3D_method_get_active_material: - :ref:`Material` **get_active_material** **(** :ref:`int` surface **)** |const| @@ -155,6 +169,18 @@ Returns the :ref:`Material` that will be used by the :ref:`Mesh< ---- +.. _class_MeshInstance3D_method_get_blend_shape_count: + +- :ref:`int` **get_blend_shape_count** **(** **)** |const| + +---- + +.. _class_MeshInstance3D_method_get_blend_shape_value: + +- :ref:`float` **get_blend_shape_value** **(** :ref:`int` blend_shape_idx **)** |const| + +---- + .. _class_MeshInstance3D_method_get_surface_override_material: - :ref:`Material` **get_surface_override_material** **(** :ref:`int` surface **)** |const| @@ -171,6 +197,12 @@ Returns the number of surface override materials. This is equivalent to :ref:`Me ---- +.. _class_MeshInstance3D_method_set_blend_shape_value: + +- void **set_blend_shape_value** **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** + +---- + .. _class_MeshInstance3D_method_set_surface_override_material: - void **set_surface_override_material** **(** :ref:`int` surface, :ref:`Material` material **)** diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index ff1295980..db1250156 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MeshLibrary.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index c0d34ff37..20aec02a2 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MeshTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_methodtweener.rst b/classes/class_methodtweener.rst index d0ee1ca1d..ee13c6167 100644 --- a/classes/class_methodtweener.rst +++ b/classes/class_methodtweener.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MethodTweener.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index f9fba227d..862860eb3 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MobileVRInterface.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -31,21 +31,23 @@ You can initialise this interface as follows: Properties ---------- -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`display_to_lens` | ``4.0`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`display_width` | ``14.5`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`eye_height` | ``1.85`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`iod` | ``6.0`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`k1` | ``0.215`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`k2` | ``0.215`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`oversample` | ``1.5`` | -+---------------------------+--------------------------------------------------------------------------+-----------+ ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`display_to_lens` | ``4.0`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`display_width` | ``14.5`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`eye_height` | ``1.85`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`iod` | ``6.0`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`k1` | ``0.215`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`k2` | ``0.215`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`oversample` | ``1.5`` | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ +| :ref:`PlayAreaMode` | xr_play_area_mode | ``1`` *(parent override)* | ++----------------------------------------------------+--------------------------------------------------------------------------+---------------------------+ Property Descriptions --------------------- diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 558ca7305..8f9d21f51 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index 66d0e8a6a..66e7d3044 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiMeshInstance2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_multimeshinstance3d.rst b/classes/class_multimeshinstance3d.rst index 2d5386ece..2c773b284 100644 --- a/classes/class_multimeshinstance3d.rst +++ b/classes/class_multimeshinstance3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiMeshInstance3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 0e215db11..a1ae912b4 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiplayerAPI.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_multiplayerpeer.rst b/classes/class_multiplayerpeer.rst index 5ff323bd3..5d1863187 100644 --- a/classes/class_multiplayerpeer.rst +++ b/classes/class_multiplayerpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiplayerPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_multiplayerpeerextension.rst b/classes/class_multiplayerpeerextension.rst index f60fe0d26..5f2cb8fdb 100644 --- a/classes/class_multiplayerpeerextension.rst +++ b/classes/class_multiplayerpeerextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiplayerPeerExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_multiplayerreplicator.rst b/classes/class_multiplayerreplicator.rst index f0fd239fa..5fbd6ea8e 100644 --- a/classes/class_multiplayerreplicator.rst +++ b/classes/class_multiplayerreplicator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the MultiplayerReplicator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index f96be553b..9a2619677 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Mutex.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_nativeextension.rst b/classes/class_nativeextension.rst index 41caf1e94..051fc4552 100644 --- a/classes/class_nativeextension.rst +++ b/classes/class_nativeextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NativeExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_nativeextensionmanager.rst b/classes/class_nativeextensionmanager.rst index 8f01c19a3..4b1000e2e 100644 --- a/classes/class_nativeextensionmanager.rst +++ b/classes/class_nativeextensionmanager.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NativeExtensionManager.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index c8cc18493..025477916 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NativeScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index bf196f020..a6e17e1e2 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationAgent2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationagent3d.rst b/classes/class_navigationagent3d.rst index aec739177..40a488fbb 100644 --- a/classes/class_navigationagent3d.rst +++ b/classes/class_navigationagent3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationAgent3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 99abc42be..65c8490e1 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -33,7 +33,7 @@ Properties +---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`agent/max_slope` | ``45.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/radius` | ``0.6`` | +| :ref:`float` | :ref:`agent/radius` | ``1.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`cell/height` | ``0.2`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ @@ -220,7 +220,7 @@ The maximum slope that is considered walkable, in degrees. - :ref:`float` **agent/radius** +-----------+-------------------------+ -| *Default* | ``0.6`` | +| *Default* | ``1.0`` | +-----------+-------------------------+ | *Setter* | set_agent_radius(value) | +-----------+-------------------------+ diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index 640bb0ed2..ef0d29bf0 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationMeshGenerator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index 29cb86666..c4d33ef95 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationObstacle2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,6 +18,48 @@ Description 2D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. ``NavigationObstacle2D`` is physics safe. +Properties +---------- + ++---------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`estimate_radius` | ``true`` | ++---------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`radius` | ``1.0`` | ++---------------------------+-----------------------------------------------------------------------------+----------+ + +Property Descriptions +--------------------- + +.. _class_NavigationObstacle2D_property_estimate_radius: + +- :ref:`bool` **estimate_radius** + ++-----------+----------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------+ +| *Setter* | set_estimate_radius(value) | ++-----------+----------------------------+ +| *Getter* | is_radius_estimated() | ++-----------+----------------------------+ + +Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius. + +---- + +.. _class_NavigationObstacle2D_property_radius: + +- :ref:`float` **radius** + ++-----------+-------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ + +The radius of the agent. Used only if :ref:`estimate_radius` is set to false. + .. |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.)` diff --git a/classes/class_navigationobstacle3d.rst b/classes/class_navigationobstacle3d.rst index 366eef60a..761f6ae1f 100644 --- a/classes/class_navigationobstacle3d.rst +++ b/classes/class_navigationobstacle3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationObstacle3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,6 +18,48 @@ Description 3D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. ``NavigationObstacle3D`` is physics safe. +Properties +---------- + ++---------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`estimate_radius` | ``true`` | ++---------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`radius` | ``1.0`` | ++---------------------------+-----------------------------------------------------------------------------+----------+ + +Property Descriptions +--------------------- + +.. _class_NavigationObstacle3D_property_estimate_radius: + +- :ref:`bool` **estimate_radius** + ++-----------+----------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------+ +| *Setter* | set_estimate_radius(value) | ++-----------+----------------------------+ +| *Getter* | is_radius_estimated() | ++-----------+----------------------------+ + +Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius. + +---- + +.. _class_NavigationObstacle3D_property_radius: + +- :ref:`float` **radius** + ++-----------+-------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ + +The radius of the agent. Used only if :ref:`estimate_radius` is set to false. + .. |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.)` diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index fb8c069b9..7fd1e5893 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationPolygon.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -51,7 +51,7 @@ Using :ref:`add_polygon` and indices var polygon = NavigationPolygon.new() var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.vertices = vertices - var indices = PackedInt32Array(0, 3, 1) + var indices = PackedInt32Array([0, 1, 2, 3]) polygon.add_polygon(indices) $NavigationRegion2D.navpoly = polygon @@ -60,7 +60,7 @@ Using :ref:`add_polygon` and indices var polygon = new NavigationPolygon(); var vertices = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; polygon.Vertices = vertices; - var indices = new int[] { 0, 3, 1 }; + var indices = new int[] { 0, 1, 2, 3 }; polygon.AddPolygon(indices); GetNode("NavigationRegion2D").Navpoly = polygon; diff --git a/classes/class_navigationregion2d.rst b/classes/class_navigationregion2d.rst index 886d4dc9a..dd0c33bf0 100644 --- a/classes/class_navigationregion2d.rst +++ b/classes/class_navigationregion2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationRegion2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationregion3d.rst b/classes/class_navigationregion3d.rst index d77d814b2..e426fc312 100644 --- a/classes/class_navigationregion3d.rst +++ b/classes/class_navigationregion3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationRegion3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index f2266b400..9e0890804 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationServer2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 240b54c8d..a26b38541 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NavigationServer3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 3c108e6a8..681bf8cf8 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NinePatchRect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -78,11 +78,11 @@ enum **AxisStretchMode**: - **AXIS_STRETCH_MODE_TILE** = **1** --- Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges. -**Note:** Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like :ref:`AXIS_STRETCH_MODE_STRETCH`. +**Note:** Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like :ref:`AXIS_STRETCH_MODE_STRETCH`. - **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than :ref:`AXIS_STRETCH_MODE_STRETCH`. The texture must be seamless for this to work without displaying artifacts between edges. -**Note:** Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like :ref:`AXIS_STRETCH_MODE_STRETCH`. +**Note:** Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like :ref:`AXIS_STRETCH_MODE_STRETCH`. Property Descriptions --------------------- diff --git a/classes/class_node.rst b/classes/class_node.rst index 776f7eb22..e2f4a8f2f 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Node.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -50,186 +50,184 @@ Tutorials Properties ---------- -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`MultiplayerAPI` | :ref:`custom_multiplayer` | | -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`MultiplayerAPI` | :ref:`multiplayer` | | -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`StringName` | :ref:`name` | | -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`Node` | :ref:`owner` | | -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`ProcessMode` | :ref:`process_mode` | ``0`` | -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`process_priority` | ``0`` | -+---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`scene_file_path` | | -+---------------------------------------------+-------------------------------------------------------------------+-------+ ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`MultiplayerAPI` | :ref:`custom_multiplayer` | | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`String` | :ref:`editor_description` | ``""`` | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`MultiplayerAPI` | :ref:`multiplayer` | | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`StringName` | :ref:`name` | | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`Node` | :ref:`owner` | | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`ProcessMode` | :ref:`process_mode` | ``0`` | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`process_priority` | ``0`` | ++---------------------------------------------+-------------------------------------------------------------------+--------+ +| :ref:`String` | :ref:`scene_file_path` | | ++---------------------------------------------+-------------------------------------------------------------------+--------+ Methods ------- -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** |virtual| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** |virtual| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :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:`_unhandled_input` **(** :ref:`InputEvent` event **)** |virtual| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` event **)** |virtual| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false, :ref:`InternalMode` internal=0 **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sibling` **(** :ref:`Node` sibling, :ref:`bool` legible_unique_name=false **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Tween` | :ref:`create_tween` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_parent` **(** :ref:`String` mask **)** |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:`String` | :ref:`get_editor_description` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** :ref:`bool` include_internal=false **)** |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 **)** |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:`Viewport` | :ref:`get_viewport` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_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_physics_processing` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** |const| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`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:`raise` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`StringName` group **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_groups=false **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`StringName` method, ... **)** |vararg| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rpc_config` **(** :ref:`StringName` method, :ref:`RPCMode` rpc_mode, :ref:`TransferMode` transfer_mode=2, :ref:`int` channel=0 **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** |vararg| | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable_instance` **(** :ref:`Node` node, :ref:`bool` is_editable **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_description` **(** :ref:`String` editor_description **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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:`update_configuration_warnings` **(** **)** | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** |virtual| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** |virtual| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :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:`_unhandled_input` **(** :ref:`InputEvent` event **)** |virtual| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` event **)** |virtual| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false, :ref:`InternalMode` internal=0 **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_sibling` **(** :ref:`Node` sibling, :ref:`bool` legible_unique_name=false **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Tween` | :ref:`create_tween` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_parent` **(** :ref:`String` mask **)** |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:`Array` | :ref:`get_groups` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** :ref:`bool` include_internal=false **)** |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 **)** |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:`Viewport` | :ref:`get_viewport` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_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_physics_processing` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`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:`raise` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`StringName` group **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_groups=false **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc` **(** :ref:`StringName` method, ... **)** |vararg| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rpc_config` **(** :ref:`StringName` method, :ref:`RPCMode` rpc_mode, :ref:`bool` call_local=false, :ref:`TransferMode` transfer_mode=2, :ref:`int` channel=0 **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** |vararg| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_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:`update_configuration_warnings` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -539,6 +537,22 @@ The override to the default :ref:`MultiplayerAPI`. Set to ---- +.. _class_Node_property_editor_description: + +- :ref:`String` **editor_description** + ++-----------+-------------------------------+ +| *Default* | ``""`` | ++-----------+-------------------------------+ +| *Setter* | set_editor_description(value) | ++-----------+-------------------------------+ +| *Getter* | get_editor_description() | ++-----------+-------------------------------+ + +Add a custom description to a node. + +---- + .. _class_Node_property_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -907,12 +921,6 @@ If ``include_internal`` is ``false``, the returned array won't include internal ---- -.. _class_Node_method_get_editor_description: - -- :ref:`String` **get_editor_description** **(** **)** |const| - ----- - .. _class_Node_method_get_groups: - :ref:`Array` **get_groups** **(** **)** |const| @@ -1316,6 +1324,8 @@ Removes a node and sets all its children as children of the parent node (if it e Removes a child node. The node is NOT deleted and must be deleted manually. +**Note:** This function may set the :ref:`owner` of the removed Node (or its descendants) to be ``null``, if that :ref:`owner` is no longer a parent or ancestor. + ---- .. _class_Node_method_remove_from_group: @@ -1356,7 +1366,7 @@ Sends a remote procedure call request for the given ``method`` to peers on the n .. _class_Node_method_rpc_config: -- :ref:`int` **rpc_config** **(** :ref:`StringName` method, :ref:`RPCMode` rpc_mode, :ref:`TransferMode` transfer_mode=2, :ref:`int` channel=0 **)** +- :ref:`int` **rpc_config** **(** :ref:`StringName` method, :ref:`RPCMode` rpc_mode, :ref:`bool` call_local=false, :ref:`TransferMode` transfer_mode=2, :ref:`int` channel=0 **)** Changes the RPC mode for the given ``method`` to the given ``rpc_mode``, optionally specifying the ``transfer_mode`` and ``channel`` (on supported peers). See :ref:`RPCMode` and :ref:`TransferMode`. An alternative is annotating methods and properties with the corresponding annotation (``@rpc(any)``, ``@rpc(auth)``). By default, methods are not exposed to networking (and RPCs). @@ -1386,12 +1396,6 @@ Sets the editable children state of ``node`` relative to this node. This method ---- -.. _class_Node_method_set_editor_description: - -- void **set_editor_description** **(** :ref:`String` editor_description **)** - ----- - .. _class_Node_method_set_multiplayer_authority: - void **set_multiplayer_authority** **(** :ref:`int` id, :ref:`bool` recursive=true **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 2d7ccf001..60a6f78ce 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Node2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedSprite2D`, :ref:`AudioListener2D`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasGroup`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`GPUParticles2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`NavigationRegion2D`, :ref:`ParallaxLayer`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`Skeleton2D`, :ref:`Sprite2D`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibleOnScreenNotifier2D` +**Inherited By:** :ref:`AnimatedSprite2D`, :ref:`AudioListener2D`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasGroup`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`GPUParticles2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`NavigationRegion2D`, :ref:`ParallaxLayer`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`ShapeCast2D`, :ref:`Skeleton2D`, :ref:`Sprite2D`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibleOnScreenNotifier2D` A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index. diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index c5bf348a2..048cdbf23 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Node3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,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:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`Position3D`, :ref:`ProximityGroup3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRAnchor3D`, :ref:`XRController3D`, :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:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`Position3D`, :ref:`ProximityGroup3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` Most basic 3D game object, parent of all 3D-related nodes. @@ -34,23 +34,31 @@ Tutorials Properties ---------- -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform3D` | :ref:`global_transform` | | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotation` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`scale` | ``Vector3(1, 1, 1)`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`top_level` | ``false`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`NodePath` | :ref:`visibility_parent` | ``NodePath("")`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`visible` | ``true`` | -+---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Basis` | :ref:`basis` | | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform3D` | :ref:`global_transform` | | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Quaternion` | :ref:`quaternion` | | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotation` | ``Vector3(0, 0, 0)`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`RotationEditMode` | :ref:`rotation_edit_mode` | ``0`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`RotationOrder` | :ref:`rotation_order` | ``2`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`scale` | ``Vector3(1, 1, 1)`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`top_level` | ``false`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`NodePath` | :ref:`visibility_parent` | ``NodePath("")`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`visible` | ``true`` | ++-------------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ Methods ------- @@ -114,6 +122,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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| | @@ -136,6 +146,55 @@ Signals Emitted when node visibility changes. +Enumerations +------------ + +.. _enum_Node3D_RotationEditMode: + +.. _class_Node3D_constant_ROTATION_EDIT_MODE_EULER: + +.. _class_Node3D_constant_ROTATION_EDIT_MODE_QUATERNION: + +.. _class_Node3D_constant_ROTATION_EDIT_MODE_BASIS: + +enum **RotationEditMode**: + +- **ROTATION_EDIT_MODE_EULER** = **0** + +- **ROTATION_EDIT_MODE_QUATERNION** = **1** + +- **ROTATION_EDIT_MODE_BASIS** = **2** + +---- + +.. _enum_Node3D_RotationOrder: + +.. _class_Node3D_constant_ROTATION_ORDER_XYZ: + +.. _class_Node3D_constant_ROTATION_ORDER_XZY: + +.. _class_Node3D_constant_ROTATION_ORDER_YXZ: + +.. _class_Node3D_constant_ROTATION_ORDER_YZX: + +.. _class_Node3D_constant_ROTATION_ORDER_ZXY: + +.. _class_Node3D_constant_ROTATION_ORDER_ZYX: + +enum **RotationOrder**: + +- **ROTATION_ORDER_XYZ** = **0** + +- **ROTATION_ORDER_XZY** = **1** + +- **ROTATION_ORDER_YXZ** = **2** + +- **ROTATION_ORDER_YZX** = **3** + +- **ROTATION_ORDER_ZXY** = **4** + +- **ROTATION_ORDER_ZYX** = **5** + Constants --------- @@ -160,6 +219,20 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` **basis** + ++----------+------------------+ +| *Setter* | set_basis(value) | ++----------+------------------+ +| *Getter* | get_basis() | ++----------+------------------+ + +Direct access to the 3x3 basis of the :ref:`Transform3D` property. + +---- + .. _class_Node3D_property_global_transform: - :ref:`Transform3D` **global_transform** @@ -190,6 +263,20 @@ Local position or translation of this node relative to the parent. This is equiv ---- +.. _class_Node3D_property_quaternion: + +- :ref:`Quaternion` **quaternion** + ++----------+-----------------------+ +| *Setter* | set_quaternion(value) | ++----------+-----------------------+ +| *Getter* | get_quaternion() | ++----------+-----------------------+ + +Access to the node rotation as a :ref:`Quaternion`. This property is ideal for tweening complex rotations. + +---- + .. _class_Node3D_property_rotation: - :ref:`Vector3` **rotation** @@ -202,12 +289,44 @@ Local position or translation of this node relative to the parent. This is equiv | *Getter* | get_rotation() | +-----------+----------------------+ -Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). +Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotaton in the order specified by the :ref:`rotation_order` property. **Note:** In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. ---- +.. _class_Node3D_property_rotation_edit_mode: + +- :ref:`RotationEditMode` **rotation_edit_mode** + ++-----------+-------------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------------+ +| *Setter* | set_rotation_edit_mode(value) | ++-----------+-------------------------------+ +| *Getter* | get_rotation_edit_mode() | ++-----------+-------------------------------+ + +Specify how rotation (and scale) will be presented in the editor. + +---- + +.. _class_Node3D_property_rotation_order: + +- :ref:`RotationOrder` **rotation_order** + ++-----------+---------------------------+ +| *Default* | ``2`` | ++-----------+---------------------------+ +| *Setter* | set_rotation_order(value) | ++-----------+---------------------------+ +| *Getter* | 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. + +---- + .. _class_Node3D_property_scale: - :ref:`Vector3` **scale** @@ -527,6 +646,14 @@ Sets whether the node notifies about its global and local transformation changes ---- +.. _class_Node3D_method_set_subgizmo_selection: + +- void **set_subgizmo_selection** **(** :ref:`Node3DGizmo` gizmo, :ref:`int` id, :ref:`Transform3D` transform **)** + +Set subgizmo selection for this node in the editor. + +---- + .. _class_Node3D_method_show: - void **show** **(** **)** diff --git a/classes/class_node3dgizmo.rst b/classes/class_node3dgizmo.rst index 5a0783636..dc2db3b6f 100644 --- a/classes/class_node3dgizmo.rst +++ b/classes/class_node3dgizmo.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Node3DGizmo.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index e98b887eb..4305ad9ba 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NodePath.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -42,59 +42,69 @@ Tutorials - `2D Role Playing Game Demo `__ +Constructors +------------ + ++---------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`NodePath` **(** **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`NodePath` from **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`NodePath` from **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** |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:`bool` | :ref:`is_absolute` **(** **)** |const| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** |const| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`NodePath` right **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`NodePath` right **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** |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:`bool` | :ref:`is_absolute` **(** **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_NodePath_method_NodePath: ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`NodePath` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`NodePath` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------+ -- :ref:`NodePath` **NodePath** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_NodePath_constructor_NodePath: + +- :ref:`NodePath` **NodePath** **(** **)** Constructs an empty ``NodePath``. ---- -- :ref:`NodePath` **NodePath** **(** :ref:`NodePath` from **)** |constructor| +- :ref:`NodePath` **NodePath** **(** :ref:`NodePath` from **)** Constructs a ``NodePath`` as a copy of the given ``NodePath``. ---- -- :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** |constructor| +- :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** Creates a NodePath from a string, e.g. ``"Path2D/PathFollow2D/Sprite2D:texture:size"``. A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, ``"."`` and ``".."`` indicate the current node and its parent. @@ -117,7 +127,8 @@ Examples of valid NodePaths (assuming that those nodes exist and have the refere # Absolute path (from "root") "/root/Level/Path2D" ----- +Method Descriptions +------------------- .. _class_NodePath_method_get_as_property_path: @@ -257,25 +268,26 @@ Returns ``true`` if the node path is absolute (as opposed to relative), which me Returns ``true`` if the node path is empty. ----- +Operator Descriptions +--------------------- -.. _class_NodePath_method_operator !=: +.. _class_NodePath_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`NodePath` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`NodePath` right **)** ---- -.. _class_NodePath_method_operator ==: +.. _class_NodePath_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`NodePath` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`NodePath` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index 2bcafb962..b50c435c2 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the NoiseTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -24,8 +24,9 @@ The class uses :ref:`Thread`\ s to generate the texture data inter :: - var texture = preload("res://noise.tres") - yield(texture, "changed") + var texture = NoiseTexture.new() + texture.noise = OpenSimplexNoise.new() + await texture.changed var image = texture.get_image() var data = image.get_data() diff --git a/classes/class_object.rst b/classes/class_object.rst index 0de7a3aab..82cc7339e 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Object.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_occluder3d.rst b/classes/class_occluder3d.rst index 9baded6c9..5223af87c 100644 --- a/classes/class_occluder3d.rst +++ b/classes/class_occluder3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Occluder3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_occluderinstance3d.rst b/classes/class_occluderinstance3d.rst index 13a1869f9..9a4bd5232 100644 --- a/classes/class_occluderinstance3d.rst +++ b/classes/class_occluderinstance3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OccluderInstance3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 5522418f6..fdeb60287 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OccluderPolygon2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_oggpacketsequence.rst b/classes/class_oggpacketsequence.rst index 7f2bad473..313d1d2c8 100644 --- a/classes/class_oggpacketsequence.rst +++ b/classes/class_oggpacketsequence.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OGGPacketSequence.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_oggpacketsequenceplayback.rst b/classes/class_oggpacketsequenceplayback.rst index 5763d5ce5..47e30eed7 100644 --- a/classes/class_oggpacketsequenceplayback.rst +++ b/classes/class_oggpacketsequenceplayback.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OGGPacketSequencePlayback.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_omnilight3d.rst b/classes/class_omnilight3d.rst index 7ee7166be..18f562a08 100644 --- a/classes/class_omnilight3d.rst +++ b/classes/class_omnilight3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OmniLight3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index 63c245e2e..372492352 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OpenSimplexNoise.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_optimizedtranslation.rst b/classes/class_optimizedtranslation.rst index 43ee76096..bc787d3d7 100644 --- a/classes/class_optimizedtranslation.rst +++ b/classes/class_optimizedtranslation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OptimizedTranslation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 61da13d00..3f8b607ef 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OptionButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -100,6 +100,8 @@ Theme Properties +-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.2)`` | +-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.94, 0.94, 0.94, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | @@ -246,6 +248,8 @@ Returns the text of the item at index ``idx``. Returns the :ref:`PopupMenu` contained in this button. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`Window.visible` property. + ---- .. _class_OptionButton_method_get_selected_id: @@ -407,6 +411,18 @@ Text :ref:`Color` used when the ``OptionButton`` is disabled. ---- +.. _class_OptionButton_theme_color_font_focus_color: + +- :ref:`Color` **font_focus_color** + ++-----------+--------------------------------+ +| *Default* | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------+--------------------------------+ + +Text :ref:`Color` used when the ``OptionButton`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + +---- + .. _class_OptionButton_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** diff --git a/classes/class_ormmaterial3d.rst b/classes/class_ormmaterial3d.rst index 02816325a..f8934f1ff 100644 --- a/classes/class_ormmaterial3d.rst +++ b/classes/class_ormmaterial3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ORMMaterial3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_os.rst b/classes/class_os.rst index 17ce0a212..bae56ced0 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the OS.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -42,6 +42,8 @@ Methods +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close_midi_inputs` **(** **)** | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_instance` **(** :ref:`PackedStringArray` arguments **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_process` **(** :ref:`String` path, :ref:`PackedStringArray` arguments **)** | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`delay_msec` **(** :ref:`int` msec **)** |const| | @@ -54,7 +56,7 @@ Methods +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`Array` output=[], :ref:`bool` read_stderr=false **)** | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_keycode_from_string` **(** :ref:`String` string **)** |const| | +| :ref:`Key` | :ref:`find_keycode_from_string` **(** :ref:`String` string **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_cache_dir` **(** **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +74,7 @@ Methods +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_granted_permissions` **(** **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_keycode_string` **(** :ref:`int` code **)** |const| | +| :ref:`String` | :ref:`get_keycode_string` **(** :ref:`Key` code **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale` **(** **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -140,15 +142,15 @@ Enumerations .. _enum_OS_VideoDriver: -.. _class_OS_constant_VIDEO_DRIVER_GLES2: - .. _class_OS_constant_VIDEO_DRIVER_VULKAN: +.. _class_OS_constant_VIDEO_DRIVER_OPENGL_3: + enum **VideoDriver**: -- **VIDEO_DRIVER_GLES2** = **0** --- The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web. +- **VIDEO_DRIVER_VULKAN** = **0** --- The Vulkan rendering backend. It requires Vulkan 1.0 support and automatically uses features from Vulkan 1.1 and 1.2 if available. -- **VIDEO_DRIVER_VULKAN** = **1** --- The Vulkan rendering backend. +- **VIDEO_DRIVER_OPENGL_3** = **1** --- The OpenGL 3 rendering backend. It uses OpenGL 3.3 Core Profile on desktop platforms, OpenGL ES 3.0 on mobile devices, and WebGL 2.0 on HTML5. ---- @@ -338,11 +340,23 @@ Shuts down system MIDI driver. ---- +.. _class_OS_method_create_instance: + +- :ref:`int` **create_instance** **(** :ref:`PackedStringArray` arguments **)** + +Creates a new instance of Godot that runs independently. The ``arguments`` are used in the given order and separated by a space. + +If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill`). If the process creation fails, the method will return ``-1``. + +**Note:** This method is implemented on Android, iOS, Linux, macOS and Windows. + +---- + .. _class_OS_method_create_process: - :ref:`int` **create_process** **(** :ref:`String` path, :ref:`PackedStringArray` arguments **)** -Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The file specified in ``path`` must exist and be executable. Platform path resolution will be used. The ``arguments`` are used in the given order and separated by a space. +Creates a new process that runs independently of Godot. It will not terminate if 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. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill`). If the process creation fails, the method will return ``-1``. @@ -365,7 +379,7 @@ See :ref:`execute` if you wish to run an external comma **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows. -**Note:** On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export. +**Note:** On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export or system .app bundle, system .app bundles will ignore arguments. ---- @@ -375,7 +389,7 @@ See :ref:`execute` if you wish to run an external comma Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_msec` will do nothing and will print an error message. -**Note:** :ref:`delay_msec` is a *blocking* way to delay code execution. To delay code execution in a non-blocking way, see :ref:`SceneTree.create_timer`. Yielding with :ref:`SceneTree.create_timer` will delay the execution of code placed below the ``yield`` without affecting the rest of the project (or editor, for :ref:`EditorPlugin`\ s and :ref:`EditorScript`\ s). +**Note:** :ref:`delay_msec` is a *blocking* way to delay code execution. To delay code execution in a non-blocking way, see :ref:`SceneTree.create_timer`. Awaiting with :ref:`SceneTree.create_timer` will delay the execution of code placed below the ``await`` without affecting the rest of the project (or editor, for :ref:`EditorPlugin`\ s and :ref:`EditorScript`\ s). **Note:** When :ref:`delay_msec` is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When using :ref:`delay_msec` as part of an :ref:`EditorPlugin` or :ref:`EditorScript`, it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process). @@ -387,7 +401,7 @@ Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must b Delays execution of the current thread by ``usec`` microseconds. ``usec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_usec` will do nothing and will print an error message. -**Note:** :ref:`delay_usec` is a *blocking* way to delay code execution. To delay code execution in a non-blocking way, see :ref:`SceneTree.create_timer`. Yielding with :ref:`SceneTree.create_timer` will delay the execution of code placed below the ``yield`` without affecting the rest of the project (or editor, for :ref:`EditorPlugin`\ s and :ref:`EditorScript`\ s). +**Note:** :ref:`delay_usec` is a *blocking* way to delay code execution. To delay code execution in a non-blocking way, see :ref:`SceneTree.create_timer`. Awaiting with :ref:`SceneTree.create_timer` will delay the execution of code placed below the ``await`` without affecting the rest of the project (or editor, for :ref:`EditorPlugin`\ s and :ref:`EditorScript`\ s). **Note:** When :ref:`delay_usec` is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When using :ref:`delay_usec` as part of an :ref:`EditorPlugin` or :ref:`EditorScript`, it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process). @@ -467,7 +481,7 @@ To execute a composite command, a platform-specific shell can be invoked. For ex .. _class_OS_method_find_keycode_from_string: -- :ref:`int` **find_keycode_from_string** **(** :ref:`String` string **)** |const| +- :ref:`Key` **find_keycode_from_string** **(** :ref:`String` string **)** |const| Returns the keycode of the given string (e.g. "Escape"). @@ -572,6 +586,8 @@ Returns the value of an environment variable. Returns an empty string if the env Returns the path to the current engine executable. +**Note:** On macOS, always use :ref:`create_instance` instead of relying on executable path. + ---- .. _class_OS_method_get_granted_permissions: @@ -586,7 +602,7 @@ With this function, you can get the list of dangerous permissions that have been .. _class_OS_method_get_keycode_string: -- :ref:`String` **get_keycode_string** **(** :ref:`int` code **)** |const| +- :ref:`String` **get_keycode_string** **(** :ref:`Key` code **)** |const| Returns the given keycode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``). diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index a2608e54c..35905abf8 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedByteArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,15 +16,20 @@ Description An :ref:`Array` specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes. +Constructors +------------ + ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`PackedByteArray` from **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`Array` from **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** **)** |constructor| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`PackedByteArray` from **)** |constructor| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`Array` from **)** |constructor| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`append` **(** :ref:`int` value **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -110,18 +115,6 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedByteArray` right **)** |operator| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | **operator +** **(** :ref:`PackedByteArray` right **)** |operator| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedByteArray` right **)** |operator| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`push_back` **(** :ref:`int` value **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove` **(** :ref:`int` index **)** | @@ -147,28 +140,46 @@ Methods | :ref:`PackedInt64Array` | :ref:`to_int64_array` **(** **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedByteArray_method_PackedByteArray: ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedByteArray` right **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`operator +` **(** :ref:`PackedByteArray` right **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedByteArray` right **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedByteArray` **PackedByteArray** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedByteArray_constructor_PackedByteArray: + +- :ref:`PackedByteArray` **PackedByteArray** **(** **)** Constructs an empty ``PackedByteArray``. ---- -- :ref:`PackedByteArray` **PackedByteArray** **(** :ref:`PackedByteArray` from **)** |constructor| +- :ref:`PackedByteArray` **PackedByteArray** **(** :ref:`PackedByteArray` from **)** Constructs a ``PackedByteArray`` as a copy of the given ``PackedByteArray``. ---- -- :ref:`PackedByteArray` **PackedByteArray** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedByteArray` **PackedByteArray** **(** :ref:`Array` from **)** Constructs a new ``PackedByteArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedByteArray_method_append: @@ -475,38 +486,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedByteArray_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedByteArray` right **)** |operator| - ----- - -.. _class_PackedByteArray_method_operator +: - -- :ref:`PackedByteArray` **operator +** **(** :ref:`PackedByteArray` right **)** |operator| - ----- - -.. _class_PackedByteArray_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedByteArray` right **)** |operator| - ----- - -.. _class_PackedByteArray_method_operator []: - -- :ref:`int` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedByteArray_method_push_back: - :ref:`bool` **push_back** **(** :ref:`int` value **)** @@ -617,6 +596,39 @@ The size of the new array will be ``byte_array.size() / 8``. If the original data can't be converted to signed 64-bit integers, the resulting data is undefined. +Operator Descriptions +--------------------- + +.. _class_PackedByteArray_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedByteArray` right **)** + +---- + +.. _class_PackedByteArray_operator_sum_PackedByteArray: + +- :ref:`PackedByteArray` **operator +** **(** :ref:`PackedByteArray` right **)** + +---- + +.. _class_PackedByteArray_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedByteArray` right **)** + +---- + +.. _class_PackedByteArray_operator_idx_int: + +- :ref:`int` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index b04949b76..27ae15cb2 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedColorArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,85 +16,96 @@ Description An :ref:`Array` specifically designed to hold :ref:`Color`. Packs data tightly, so it saves memory for large array sizes. +Constructors +------------ + ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`PackedColorArray` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`PackedColorArray` from **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`Array` from **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`duplicate` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Color` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedColorArray` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | **operator +** **(** :ref:`PackedColorArray` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedColorArray` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`Color` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`Color` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`duplicate` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Color` value **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`Color` value **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedColorArray_method_PackedColorArray: ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedColorArray` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`operator +` **(** :ref:`PackedColorArray` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedColorArray` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`operator []` **(** :ref:`int` index **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedColorArray` **PackedColorArray** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedColorArray_constructor_PackedColorArray: + +- :ref:`PackedColorArray` **PackedColorArray** **(** **)** Constructs an empty ``PackedColorArray``. ---- -- :ref:`PackedColorArray` **PackedColorArray** **(** :ref:`PackedColorArray` from **)** |constructor| +- :ref:`PackedColorArray` **PackedColorArray** **(** :ref:`PackedColorArray` from **)** Constructs a ``PackedColorArray`` as a copy of the given ``PackedColorArray``. ---- -- :ref:`PackedColorArray` **PackedColorArray** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedColorArray` **PackedColorArray** **(** :ref:`Array` from **)** Constructs a new ``PackedColorArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedColorArray_method_append: @@ -162,38 +173,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedColorArray_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedColorArray` right **)** |operator| - ----- - -.. _class_PackedColorArray_method_operator +: - -- :ref:`PackedColorArray` **operator +** **(** :ref:`PackedColorArray` right **)** |operator| - ----- - -.. _class_PackedColorArray_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedColorArray` right **)** |operator| - ----- - -.. _class_PackedColorArray_method_operator []: - -- :ref:`Color` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedColorArray_method_push_back: - :ref:`bool` **push_back** **(** :ref:`Color` value **)** @@ -260,6 +239,39 @@ Sorts the elements of the array in ascending order. - :ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +Operator Descriptions +--------------------- + +.. _class_PackedColorArray_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedColorArray` right **)** + +---- + +.. _class_PackedColorArray_operator_sum_PackedColorArray: + +- :ref:`PackedColorArray` **operator +** **(** :ref:`PackedColorArray` right **)** + +---- + +.. _class_PackedColorArray_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedColorArray` right **)** + +---- + +.. _class_PackedColorArray_operator_idx_Color: + +- :ref:`Color` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 388e30a22..3c9fb9cee 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedDataContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index db4f12725..69a4dc849 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedDataContainerRef.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst index 229b36aa2..03bfab19a 100644 --- a/classes/class_packedfloat32array.rst +++ b/classes/class_packedfloat32array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedFloat32Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,85 +18,96 @@ An :ref:`Array` specifically designed to hold 32-bit floating-point If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array`. +Constructors +------------ + ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`PackedFloat32Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`PackedFloat32Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`duplicate` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`float` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedFloat32Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | **operator +** **(** :ref:`PackedFloat32Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedFloat32Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`float` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`float` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`duplicate` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`float` value **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`float` value **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedFloat32Array_method_PackedFloat32Array: ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedFloat32Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`operator +` **(** :ref:`PackedFloat32Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedFloat32Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedFloat32Array_constructor_PackedFloat32Array: + +- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** **)** Constructs an empty ``PackedFloat32Array``. ---- -- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`PackedFloat32Array` from **)** |constructor| +- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`PackedFloat32Array` from **)** Constructs a ``PackedFloat32Array`` as a copy of the given ``PackedFloat32Array``. ---- -- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`Array` from **)** Constructs a new ``PackedFloat32Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedFloat32Array_method_append: @@ -164,38 +175,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedFloat32Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedFloat32Array` right **)** |operator| - ----- - -.. _class_PackedFloat32Array_method_operator +: - -- :ref:`PackedFloat32Array` **operator +** **(** :ref:`PackedFloat32Array` right **)** |operator| - ----- - -.. _class_PackedFloat32Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedFloat32Array` right **)** |operator| - ----- - -.. _class_PackedFloat32Array_method_operator []: - -- :ref:`float` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedFloat32Array_method_push_back: - :ref:`bool` **push_back** **(** :ref:`float` value **)** @@ -266,6 +245,39 @@ Returns a copy of the data converted to a :ref:`PackedByteArray` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedFloat32Array` right **)** + +---- + +.. _class_PackedFloat32Array_operator_sum_PackedFloat32Array: + +- :ref:`PackedFloat32Array` **operator +** **(** :ref:`PackedFloat32Array` right **)** + +---- + +.. _class_PackedFloat32Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedFloat32Array` right **)** + +---- + +.. _class_PackedFloat32Array_operator_idx_float: + +- :ref:`float` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index 0b64ac011..af97569a8 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedFloat64Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,85 +18,96 @@ An :ref:`Array` specifically designed to hold 64-bit floating-point If you only need to pack 32-bit floats tightly, see :ref:`PackedFloat32Array` for a more memory-friendly alternative. +Constructors +------------ + ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`PackedFloat64Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`PackedFloat64Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat64Array` | :ref:`duplicate` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`float` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedFloat64Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat64Array` | **operator +** **(** :ref:`PackedFloat64Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedFloat64Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`float` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`float` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat64Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`duplicate` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`float` value **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`float` value **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedFloat64Array_method_PackedFloat64Array: ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedFloat64Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`operator +` **(** :ref:`PackedFloat64Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedFloat64Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedFloat64Array_constructor_PackedFloat64Array: + +- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** **)** Constructs an empty ``PackedFloat64Array``. ---- -- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`PackedFloat64Array` from **)** |constructor| +- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`PackedFloat64Array` from **)** Constructs a ``PackedFloat64Array`` as a copy of the given ``PackedFloat64Array``. ---- -- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`Array` from **)** Constructs a new ``PackedFloat64Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedFloat64Array_method_append: @@ -164,38 +175,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedFloat64Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedFloat64Array` right **)** |operator| - ----- - -.. _class_PackedFloat64Array_method_operator +: - -- :ref:`PackedFloat64Array` **operator +** **(** :ref:`PackedFloat64Array` right **)** |operator| - ----- - -.. _class_PackedFloat64Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedFloat64Array` right **)** |operator| - ----- - -.. _class_PackedFloat64Array_method_operator []: - -- :ref:`float` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedFloat64Array_method_push_back: - :ref:`bool` **push_back** **(** :ref:`float` value **)** @@ -266,6 +245,39 @@ Returns a copy of the data converted to a :ref:`PackedByteArray` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedFloat64Array` right **)** + +---- + +.. _class_PackedFloat64Array_operator_sum_PackedFloat64Array: + +- :ref:`PackedFloat64Array` **operator +** **(** :ref:`PackedFloat64Array` right **)** + +---- + +.. _class_PackedFloat64Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedFloat64Array` right **)** + +---- + +.. _class_PackedFloat64Array_operator_idx_float: + +- :ref:`float` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index 62b49c717..a3d8426e7 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedInt32Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,85 +18,96 @@ An :ref:`Array` specifically designed to hold 32-bit integer values **Note:** This type stores signed 32-bit integers, which means it can take values in the interval ``[-2^31, 2^31 - 1]``, i.e. ``[-2147483648, 2147483647]``. Exceeding those bounds will wrap around. In comparison, :ref:`int` uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see :ref:`PackedInt64Array`. +Constructors +------------ + ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`PackedInt32Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`PackedInt32Array` from **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`Array` from **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`duplicate` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`int` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedInt32Array` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | **operator +** **(** :ref:`PackedInt32Array` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedInt32Array` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`int` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`duplicate` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`int` value **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedInt32Array_method_PackedInt32Array: ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedInt32Array` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`operator +` **(** :ref:`PackedInt32Array` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedInt32Array` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedInt32Array` **PackedInt32Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedInt32Array_constructor_PackedInt32Array: + +- :ref:`PackedInt32Array` **PackedInt32Array** **(** **)** Constructs an empty ``PackedInt32Array``. ---- -- :ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`PackedInt32Array` from **)** |constructor| +- :ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`PackedInt32Array` from **)** Constructs a ``PackedInt32Array`` as a copy of the given ``PackedInt32Array``. ---- -- :ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`Array` from **)** Constructs a new ``PackedInt32Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedInt32Array_method_append: @@ -164,38 +175,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedInt32Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedInt32Array` right **)** |operator| - ----- - -.. _class_PackedInt32Array_method_operator +: - -- :ref:`PackedInt32Array` **operator +** **(** :ref:`PackedInt32Array` right **)** |operator| - ----- - -.. _class_PackedInt32Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedInt32Array` right **)** |operator| - ----- - -.. _class_PackedInt32Array_method_operator []: - -- :ref:`int` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedInt32Array_method_push_back: - :ref:`bool` **push_back** **(** :ref:`int` value **)** @@ -266,6 +245,39 @@ Returns a copy of the data converted to a :ref:`PackedByteArray` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedInt32Array` right **)** + +---- + +.. _class_PackedInt32Array_operator_sum_PackedInt32Array: + +- :ref:`PackedInt32Array` **operator +** **(** :ref:`PackedInt32Array` right **)** + +---- + +.. _class_PackedInt32Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedInt32Array` right **)** + +---- + +.. _class_PackedInt32Array_operator_idx_int: + +- :ref:`int` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index 2b86cf141..d4480dd96 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedInt64Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,85 +18,96 @@ An :ref:`Array` specifically designed to hold 64-bit integer values **Note:** This type stores signed 64-bit integers, which means it can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854775808, 9223372036854775807]``. Exceeding those bounds will wrap around. If you only need to pack 32-bit integers tightly, see :ref:`PackedInt32Array` for a more memory-friendly alternative. +Constructors +------------ + ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`PackedInt64Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`PackedInt64Array` from **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`Array` from **)** |constructor| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`duplicate` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`int` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedInt64Array` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | **operator +** **(** :ref:`PackedInt64Array` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedInt64Array` right **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`int` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`duplicate` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`int` value **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedInt64Array_method_PackedInt64Array: ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedInt64Array` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`operator +` **(** :ref:`PackedInt64Array` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedInt64Array` right **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedInt64Array` **PackedInt64Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedInt64Array_constructor_PackedInt64Array: + +- :ref:`PackedInt64Array` **PackedInt64Array** **(** **)** Constructs an empty ``PackedInt64Array``. ---- -- :ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`PackedInt64Array` from **)** |constructor| +- :ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`PackedInt64Array` from **)** Constructs a ``PackedInt64Array`` as a copy of the given ``PackedInt64Array``. ---- -- :ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`Array` from **)** Constructs a new ``PackedInt64Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedInt64Array_method_append: @@ -164,38 +175,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedInt64Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedInt64Array` right **)** |operator| - ----- - -.. _class_PackedInt64Array_method_operator +: - -- :ref:`PackedInt64Array` **operator +** **(** :ref:`PackedInt64Array` right **)** |operator| - ----- - -.. _class_PackedInt64Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedInt64Array` right **)** |operator| - ----- - -.. _class_PackedInt64Array_method_operator []: - -- :ref:`int` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedInt64Array_method_push_back: - :ref:`bool` **push_back** **(** :ref:`int` value **)** @@ -266,6 +245,39 @@ Returns a copy of the data converted to a :ref:`PackedByteArray` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedInt64Array` right **)** + +---- + +.. _class_PackedInt64Array_operator_sum_PackedInt64Array: + +- :ref:`PackedInt64Array` **operator +** **(** :ref:`PackedInt64Array` right **)** + +---- + +.. _class_PackedInt64Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedInt64Array` right **)** + +---- + +.. _class_PackedInt64Array_operator_idx_int: + +- :ref:`int` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 9f8e55a3a..3e85e6342 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedScene.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -134,6 +134,8 @@ Enumerations .. _class_PackedScene_constant_GEN_EDIT_STATE_MAIN: +.. _class_PackedScene_constant_GEN_EDIT_STATE_MAIN_INHERITED: + enum **GenEditState**: - **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`instantiate`, blocks edits to the scene state. @@ -146,6 +148,10 @@ enum **GenEditState**: **Note:** Only available in editor builds. +- **GEN_EDIT_STATE_MAIN_INHERITED** = **3** --- It's similar to :ref:`GEN_EDIT_STATE_MAIN`, but for the case where the scene is being instantiated to be the base of another one. + +**Note:** Only available in editor builds. + Property Descriptions --------------------- diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst index 444226769..befba73df 100644 --- a/classes/class_packedstringarray.rst +++ b/classes/class_packedstringarray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedStringArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,85 +21,96 @@ Tutorials - `OS Test Demo `__ +Constructors +------------ + ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`PackedStringArray` from **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`Array` from **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** **)** |constructor| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`PackedStringArray` from **)** |constructor| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`Array` from **)** |constructor| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`duplicate` **(** **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`String` value **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedStringArray` right **)** |operator| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | **operator +** **(** :ref:`PackedStringArray` right **)** |operator| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedStringArray` right **)** |operator| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | **operator []** **(** :ref:`int` index **)** |operator| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`String` value **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`String` value **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`duplicate` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`String` value **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`String` value **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedStringArray_method_PackedStringArray: ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedStringArray` right **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`operator +` **(** :ref:`PackedStringArray` right **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedStringArray` right **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`operator []` **(** :ref:`int` index **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedStringArray` **PackedStringArray** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedStringArray_constructor_PackedStringArray: + +- :ref:`PackedStringArray` **PackedStringArray** **(** **)** Constructs an empty ``PackedStringArray``. ---- -- :ref:`PackedStringArray` **PackedStringArray** **(** :ref:`PackedStringArray` from **)** |constructor| +- :ref:`PackedStringArray` **PackedStringArray** **(** :ref:`PackedStringArray` from **)** Constructs a ``PackedStringArray`` as a copy of the given ``PackedStringArray``. ---- -- :ref:`PackedStringArray` **PackedStringArray** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedStringArray` **PackedStringArray** **(** :ref:`Array` from **)** Constructs a new ``PackedStringArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedStringArray_method_append: @@ -167,38 +178,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedStringArray_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedStringArray` right **)** |operator| - ----- - -.. _class_PackedStringArray_method_operator +: - -- :ref:`PackedStringArray` **operator +** **(** :ref:`PackedStringArray` right **)** |operator| - ----- - -.. _class_PackedStringArray_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedStringArray` right **)** |operator| - ----- - -.. _class_PackedStringArray_method_operator []: - -- :ref:`String` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedStringArray_method_push_back: - :ref:`bool` **push_back** **(** :ref:`String` value **)** @@ -265,6 +244,39 @@ Sorts the elements of the array in ascending order. - :ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +Operator Descriptions +--------------------- + +.. _class_PackedStringArray_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedStringArray` right **)** + +---- + +.. _class_PackedStringArray_operator_sum_PackedStringArray: + +- :ref:`PackedStringArray` **operator +** **(** :ref:`PackedStringArray` right **)** + +---- + +.. _class_PackedStringArray_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedStringArray` right **)** + +---- + +.. _class_PackedStringArray_operator_idx_String: + +- :ref:`String` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index 558c845c4..bd286bde4 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedVector2Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,87 +21,98 @@ Tutorials - `2D Navigation Astar Demo `__ +Constructors +------------ + ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`PackedVector2Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`PackedVector2Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | :ref:`duplicate` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Vector2` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedVector2Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | **operator *** **(** :ref:`Transform2D` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | **operator +** **(** :ref:`PackedVector2Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedVector2Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`Vector2` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`Vector2` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`duplicate` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Vector2` value **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`Vector2` value **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedVector2Array_method_PackedVector2Array: ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** :ref:`PackedVector2Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`operator []` **(** :ref:`int` index **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedVector2Array` **PackedVector2Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedVector2Array_constructor_PackedVector2Array: + +- :ref:`PackedVector2Array` **PackedVector2Array** **(** **)** Constructs an empty ``PackedVector2Array``. ---- -- :ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`PackedVector2Array` from **)** |constructor| +- :ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`PackedVector2Array` from **)** Constructs a ``PackedVector2Array`` as a copy of the given ``PackedVector2Array``. ---- -- :ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`Array` from **)** Constructs a new ``PackedVector2Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedVector2Array_method_append: @@ -169,44 +180,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedVector2Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedVector2Array` right **)** |operator| - ----- - -.. _class_PackedVector2Array_method_operator *: - -- :ref:`PackedVector2Array` **operator *** **(** :ref:`Transform2D` right **)** |operator| - ----- - -.. _class_PackedVector2Array_method_operator +: - -- :ref:`PackedVector2Array` **operator +** **(** :ref:`PackedVector2Array` right **)** |operator| - ----- - -.. _class_PackedVector2Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedVector2Array` right **)** |operator| - ----- - -.. _class_PackedVector2Array_method_operator []: - -- :ref:`Vector2` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedVector2Array_method_push_back: - :ref:`bool` **push_back** **(** :ref:`Vector2` value **)** @@ -273,6 +246,45 @@ Sorts the elements of the array in ascending order. - :ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +Operator Descriptions +--------------------- + +.. _class_PackedVector2Array_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedVector2Array` right **)** + +---- + +.. _class_PackedVector2Array_operator_mul_PackedVector2Array: + +- :ref:`PackedVector2Array` **operator *** **(** :ref:`Transform2D` right **)** + +---- + +.. _class_PackedVector2Array_operator_sum_PackedVector2Array: + +- :ref:`PackedVector2Array` **operator +** **(** :ref:`PackedVector2Array` right **)** + +---- + +.. _class_PackedVector2Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedVector2Array` right **)** + +---- + +.. _class_PackedVector2Array_operator_idx_Vector2: + +- :ref:`Vector2` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index e8c1fdce4..491bfc48a 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PackedVector3Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,87 +16,98 @@ Description An :ref:`Array` specifically designed to hold :ref:`Vector3`. Packs data tightly, so it saves memory for large array sizes. +Constructors +------------ + ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`PackedVector3Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`PackedVector3Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`Array` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | :ref:`duplicate` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Vector3` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`PackedVector3Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | **operator *** **(** :ref:`Transform3D` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | **operator +** **(** :ref:`PackedVector3Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`PackedVector3Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_back` **(** :ref:`Vector3` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` index **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reverse` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` index, :ref:`Vector3` value **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`duplicate` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Vector3` value **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** :ref:`int` index **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reverse` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` index, :ref:`Vector3` value **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** |const| | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_PackedVector3Array_method_PackedVector3Array: ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** :ref:`PackedVector3Array` right **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`operator []` **(** :ref:`int` index **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`PackedVector3Array` **PackedVector3Array** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_PackedVector3Array_constructor_PackedVector3Array: + +- :ref:`PackedVector3Array` **PackedVector3Array** **(** **)** Constructs an empty ``PackedVector3Array``. ---- -- :ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`PackedVector3Array` from **)** |constructor| +- :ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`PackedVector3Array` from **)** Constructs a ``PackedVector3Array`` as a copy of the given ``PackedVector3Array``. ---- -- :ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`Array` from **)** |constructor| +- :ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`Array` from **)** Constructs a new ``PackedVector3Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ----- +Method Descriptions +------------------- .. _class_PackedVector3Array_method_append: @@ -164,44 +175,6 @@ Returns ``true`` if the array is empty. ---- -.. _class_PackedVector3Array_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`PackedVector3Array` right **)** |operator| - ----- - -.. _class_PackedVector3Array_method_operator *: - -- :ref:`PackedVector3Array` **operator *** **(** :ref:`Transform3D` right **)** |operator| - ----- - -.. _class_PackedVector3Array_method_operator +: - -- :ref:`PackedVector3Array` **operator +** **(** :ref:`PackedVector3Array` right **)** |operator| - ----- - -.. _class_PackedVector3Array_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`PackedVector3Array` right **)** |operator| - ----- - -.. _class_PackedVector3Array_method_operator []: - -- :ref:`Vector3` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_PackedVector3Array_method_push_back: - :ref:`bool` **push_back** **(** :ref:`Vector3` value **)** @@ -268,6 +241,45 @@ Sorts the elements of the array in ascending order. - :ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +Operator Descriptions +--------------------- + +.. _class_PackedVector3Array_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`PackedVector3Array` right **)** + +---- + +.. _class_PackedVector3Array_operator_mul_PackedVector3Array: + +- :ref:`PackedVector3Array` **operator *** **(** :ref:`Transform3D` right **)** + +---- + +.. _class_PackedVector3Array_operator_sum_PackedVector3Array: + +- :ref:`PackedVector3Array` **operator +** **(** :ref:`PackedVector3Array` right **)** + +---- + +.. _class_PackedVector3Array_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`PackedVector3Array` right **)** + +---- + +.. _class_PackedVector3Array_operator_idx_Vector3: + +- :ref:`Vector3` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 8977deb98..ab1716332 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PacketPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index 29c246b7c..265bacb44 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PacketPeerDTLS.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index f7bd3f841..2692fcdeb 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PacketPeerExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 09ccd374e..3eea010d9 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PacketPeerStream.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index d3470d5d2..2726a1c47 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PacketPeerUDP.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 426bcd7a3..2efb43d35 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Panel.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index cb7711be1..250c9794d 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PanelContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_panoramaskymaterial.rst b/classes/class_panoramaskymaterial.rst index 1ea3e9a5d..47ac93487 100644 --- a/classes/class_panoramaskymaterial.rst +++ b/classes/class_panoramaskymaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PanoramaSkyMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 9561e3278..2bd4b1a0a 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ParallaxBackground.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 532f3da83..4e4f586fd 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ParallaxLayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 9b90c03a1..d934fe0f5 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ParticlesMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -612,7 +612,7 @@ Each particle's initial color. If the :ref:`GPUParticles2D | *Getter* | get_color_ramp() | +----------+-----------------------+ -Each particle's color will vary along this :ref:`GradientTexture` over its lifetime (multiplied with :ref:`color`). +Each particle's color will vary along this :ref:`GradientTexture1D` over its lifetime (multiplied with :ref:`color`). ---- diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index b20fe24a3..1eb02393f 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Path2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_path3d.rst b/classes/class_path3d.rst index ad518f935..d9181fe67 100644 --- a/classes/class_path3d.rst +++ b/classes/class_path3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Path3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index fca5f3a1d..c63b49b43 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PathFollow2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pathfollow3d.rst b/classes/class_pathfollow3d.rst index 4a6bb2d1b..c707d464c 100644 --- a/classes/class_pathfollow3d.rst +++ b/classes/class_pathfollow3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PathFollow3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 7e02d14ca..6a7d7e76d 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PCKPacker.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 55b9b30da..bc3809f45 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Performance.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicalbone2d.rst b/classes/class_physicalbone2d.rst index c947ab8de..d8ace02c3 100644 --- a/classes/class_physicalbone2d.rst +++ b/classes/class_physicalbone2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicalBone2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicalbone3d.rst b/classes/class_physicalbone3d.rst index a40be3a2b..23a7dbcc1 100644 --- a/classes/class_physicalbone3d.rst +++ b/classes/class_physicalbone3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicalBone3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,29 +16,33 @@ PhysicalBone3D Properties ---------- -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | ``-1.0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform3D` | :ref:`body_offset` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | ``0.0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`can_sleep` | ``true`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`friction` | ``1.0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | ``1.0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform3D` | :ref:`joint_offset` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`joint_rotation` | ``Vector3(0, 0, 0)`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_type` | ``0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | ``-1.0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`mass` | ``1.0`` | -+-------------------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`angular_damp` | ``0.0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`DampMode` | :ref:`angular_damp_mode` | ``0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform3D` | :ref:`body_offset` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ``0.0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`can_sleep` | ``true`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ``1.0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`gravity_scale` | ``1.0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform3D` | :ref:`joint_offset` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`joint_rotation` | ``Vector3(0, 0, 0)`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`JointType` | :ref:`joint_type` | ``0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`linear_damp` | ``0.0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`DampMode` | :ref:`linear_damp_mode` | ``0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`mass` | ``1.0`` | ++-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ Methods ------- @@ -58,6 +62,20 @@ Methods Enumerations ------------ +.. _enum_PhysicalBone3D_DampMode: + +.. _class_PhysicalBone3D_constant_DAMP_MODE_COMBINE: + +.. _class_PhysicalBone3D_constant_DAMP_MODE_REPLACE: + +enum **DampMode**: + +- **DAMP_MODE_COMBINE** = **0** --- In this mode, the body's damping value is added to any value set in areas or the default value. + +- **DAMP_MODE_REPLACE** = **1** --- In this mode, the body's damping value replaces any value set in areas or the default value. + +---- + .. _enum_PhysicalBone3D_JointType: .. _class_PhysicalBone3D_constant_JOINT_TYPE_NONE: @@ -94,14 +112,32 @@ Property Descriptions - :ref:`float` **angular_damp** +-----------+-------------------------+ -| *Default* | ``-1.0`` | +| *Default* | ``0.0`` | +-----------+-------------------------+ | *Setter* | set_angular_damp(value) | +-----------+-------------------------+ | *Getter* | get_angular_damp() | +-----------+-------------------------+ -Damps the body's rotation if greater than ``0``. +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. + +See :ref:`ProjectSettings.physics/3d/default_angular_damp` for more details about damping. + +---- + +.. _class_PhysicalBone3D_property_angular_damp_mode: + +- :ref:`DampMode` **angular_damp_mode** + ++-----------+------------------------------+ +| *Default* | ``0`` | ++-----------+------------------------------+ +| *Setter* | set_angular_damp_mode(value) | ++-----------+------------------------------+ +| *Getter* | get_angular_damp_mode() | ++-----------+------------------------------+ + +Defines how :ref:`angular_damp` is applied. See :ref:`DampMode` for possible values. ---- @@ -238,14 +274,32 @@ Sets the joint type. See :ref:`JointType` for pos - :ref:`float` **linear_damp** +-----------+------------------------+ -| *Default* | ``-1.0`` | +| *Default* | ``0.0`` | +-----------+------------------------+ | *Setter* | set_linear_damp(value) | +-----------+------------------------+ | *Getter* | get_linear_damp() | +-----------+------------------------+ -Damps the body's movement if greater than ``0``. +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. + +See :ref:`ProjectSettings.physics/3d/default_linear_damp` for more details about damping. + +---- + +.. _class_PhysicalBone3D_property_linear_damp_mode: + +- :ref:`DampMode` **linear_damp_mode** + ++-----------+-----------------------------+ +| *Default* | ``0`` | ++-----------+-----------------------------+ +| *Setter* | set_linear_damp_mode(value) | ++-----------+-----------------------------+ +| *Getter* | get_linear_damp_mode() | ++-----------+-----------------------------+ + +Defines how :ref:`linear_damp` is applied. See :ref:`DampMode` for possible values. ---- diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index 0d4786286..f0cb99310 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicalSkyMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index c38d8e871..785dc2b9a 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsBody2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -72,7 +72,7 @@ Returns an array of nodes that were added as collision exceptions for this body. Moves the body along the vector ``linear_velocity``. This method should be used in :ref:`Node._physics_process` (or in a method called by :ref:`Node._physics_process`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. -The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision. +The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision when stopped, or when touching another body along the motion. If ``test_only`` is ``true``, the body does not move but the would-be collision information is given. @@ -94,9 +94,9 @@ Removes a body from the list of bodies that this body can't collide with. Checks for collisions without moving the body. This method should be used in :ref:`Node._physics_process` (or in a method called by :ref:`Node._physics_process`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. -Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``linear_velocity``. Returns ``true`` if a collision would occur. +Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``linear_velocity``. Returns ``true`` if a collision would stop the body from moving along the whole path. -``collision`` is an optional object of type :ref:`KinematicCollision2D`, which contains additional information about the collision (should there be one). +``collision`` is an optional object of type :ref:`KinematicCollision2D`, which contains additional information about the collision when stopped, or when touching another body along the motion. ``safe_margin`` is the extra margin used for collision recovery (see :ref:`CharacterBody2D.collision/safe_margin` for more details). diff --git a/classes/class_physicsbody3d.rst b/classes/class_physicsbody3d.rst index 2cf476553..6c8bf7633 100644 --- a/classes/class_physicsbody3d.rst +++ b/classes/class_physicsbody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -191,7 +191,7 @@ Returns an array of nodes that were added as collision exceptions for this body. Moves the body along the vector ``linear_velocity``. This method should be used in :ref:`Node._physics_process` (or in a method called by :ref:`Node._physics_process`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. -The body will stop if it collides. Returns a :ref:`KinematicCollision3D`, which contains information about the collision. +The body will stop if it collides. Returns a :ref:`KinematicCollision3D`, which contains information about the collision when stopped, or when touching another body along the motion. If ``test_only`` is ``true``, the body does not move but the would-be collision information is given. @@ -223,9 +223,9 @@ Locks or unlocks the specified linear or rotational ``axis`` depending on the va Checks for collisions without moving the body. This method should be used in :ref:`Node._physics_process` (or in a method called by :ref:`Node._physics_process`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. -Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform3D`, then tries to move the body along the vector ``linear_velocity``. Returns ``true`` if a collision would occur. +Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform3D`, then tries to move the body along the vector ``linear_velocity``. Returns ``true`` if a collision would stop the body from moving along the whole path. -``collision`` is an optional object of type :ref:`KinematicCollision3D`, which contains additional information about the collision (should there be one). +``collision`` is an optional object of type :ref:`KinematicCollision3D`, which contains additional information about the collision when stopped, or when touching another body along the motion. ``safe_margin`` is the extra margin used for collision recovery (see :ref:`CharacterBody3D.collision/safe_margin` for more details). diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 5aa1cd030..9f61fd472 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsDirectBodyState2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -28,29 +28,31 @@ Tutorials Properties ---------- -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`center_of_mass` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_inertia` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_mass` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_velocity` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`step` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_angular_damp` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`total_gravity` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_linear_damp` | -+---------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+---------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`center_of_mass` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`center_of_mass_local` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_inertia` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_mass` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`linear_velocity` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_angular_damp` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`total_gravity` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_linear_damp` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ Methods ------- @@ -120,7 +122,19 @@ The body's rotational velocity. | *Getter* | get_center_of_mass() | +----------+----------------------+ -The body's center of mass. +The body's center of mass position relative to the body's center in the global coordinate system. + +---- + +.. _class_PhysicsDirectBodyState2D_property_center_of_mass_local: + +- :ref:`Vector2` **center_of_mass_local** + ++----------+----------------------------+ +| *Getter* | get_center_of_mass_local() | ++----------+----------------------------+ + +The body's center of mass position in the body's local coordinate system. ---- diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index 44f2c9931..878f2a93f 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsDirectBodyState3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -33,6 +33,8 @@ Properties +---------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`center_of_mass` | +---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center_of_mass_local` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`inverse_inertia` | +---------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_mass` | @@ -124,7 +126,19 @@ The body's rotational velocity. | *Getter* | get_center_of_mass() | +----------+----------------------+ -The body's center of mass. +The body's center of mass position relative to the body's center in the global coordinate system. + +---- + +.. _class_PhysicsDirectBodyState3D_property_center_of_mass_local: + +- :ref:`Vector3` **center_of_mass_local** + ++----------+----------------------------+ +| *Getter* | get_center_of_mass_local() | ++----------+----------------------------+ + +The body's center of mass position in the body's local coordinate system. ---- diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index 60c1e93d6..42ae6de75 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsDirectSpaceState2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -28,28 +28,26 @@ Tutorials Methods ------- -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters2D` shape **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters2D` shape, :ref:`int` max_results=32 **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters2D` shape **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point_on_canvas` **(** :ref:`Vector2` point, :ref:`int` canvas_instance_id, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters2D` shape, :ref:`int` max_results=32 **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters2D` parameters **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_PhysicsDirectSpaceState2D_method_cast_motion: -- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters2D` shape **)** +- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** 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. @@ -61,15 +59,17 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. _class_PhysicsDirectSpaceState2D_method_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters2D` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=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. +Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in :ref:`PhysicsShapeQueryParameters2D` object, second one is in the collided shape from the physics space. + ---- .. _class_PhysicsDirectSpaceState2D_method_get_rest_info: -- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters2D` shape **)** +- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** 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. @@ -91,9 +91,9 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara .. _class_PhysicsDirectSpaceState2D_method_intersect_point: -- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** +- :ref:`Array` **intersect_point** **(** :ref:`PhysicsPointQueryParameters2D` parameters, :ref:`int` max_results=32 **)** -Checks whether a point is inside any solid shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: +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: ``collider``: The colliding object. @@ -103,27 +103,7 @@ Checks whether a point is inside any solid shape. The shapes the point is inside ``shape``: The shape index of the colliding shape. -Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with :ref:`PhysicsBody2D`\ s or :ref:`Area2D`\ s, respectively. - -**Note:** :ref:`ConcavePolygonShape2D`\ s and :ref:`CollisionPolygon2D`\ s in ``Segments`` build mode are not solid shapes. Therefore, they will not be detected. - ----- - -.. _class_PhysicsDirectSpaceState2D_method_intersect_point_on_canvas: - -- :ref:`Array` **intersect_point_on_canvas** **(** :ref:`Vector2` point, :ref:`int` canvas_instance_id, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** - -Checks whether a point is inside any solid shape, in a specific canvas layer given by ``canvas_instance_id``. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: - -``collider``: The colliding object. - -``collider_id``: The colliding object's ID. - -``rid``: The intersecting object's :ref:`RID`. - -``shape``: The shape index of the colliding shape. - -Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with :ref:`PhysicsBody2D`\ s or :ref:`Area2D`\ s, respectively. +The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. **Note:** :ref:`ConcavePolygonShape2D`\ s and :ref:`CollisionPolygon2D`\ s in ``Segments`` build mode are not solid shapes. Therefore, they will not be detected. @@ -131,15 +111,15 @@ Additionally, the method can take an ``exclude`` array of objects or :ref:`RID` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`PhysicsRayQueryParameters2D` parameters **)** -Intersects a ray in a given space. The returned object is a dictionary with the following fields: +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: ``collider``: The colliding object. ``collider_id``: The colliding object's ID. -``normal``: The object's surface normal at the intersection point. +``normal``: The object's surface normal at the intersection point, or ``Vector2(0, 0)`` if the ray starts inside the shape and :ref:`PhysicsRayQueryParameters2D.hit_from_inside` is ``true``. ``position``: The intersection point. @@ -149,17 +129,13 @@ Intersects a ray in a given space. The returned object is a dictionary with the If the ray did not intersect anything, then an empty dictionary is returned instead. -Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with :ref:`PhysicsBody2D`\ s or :ref:`Area2D`\ s, respectively. - ---- .. _class_PhysicsDirectSpaceState2D_method_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters2D` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. - -**Note:** This method does not take into account the ``motion`` property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: +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: ``collider``: The colliding object. diff --git a/classes/class_physicsdirectspacestate3d.rst b/classes/class_physicsdirectspacestate3d.rst index 7d2548a32..0f4c18f31 100644 --- a/classes/class_physicsdirectspacestate3d.rst +++ b/classes/class_physicsdirectspacestate3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsDirectSpaceState3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -28,24 +28,26 @@ Tutorials Methods ------- -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters3D` shape, :ref:`Vector3` motion **)** | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters3D` shape, :ref:`int` max_results=32 **)** | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters3D` shape **)** | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters3D` shape, :ref:`int` max_results=32 **)** | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters3D` parameters **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_PhysicsDirectSpaceState3D_method_cast_motion: -- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters3D` shape, :ref:`Vector3` motion **)** +- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** 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. @@ -57,15 +59,19 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. _class_PhysicsDirectSpaceState3D_method_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters3D` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=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. +Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in :ref:`PhysicsShapeQueryParameters3D` object, second one is in the collided shape from the physics space. + +**Note:** This method does not take into account the ``motion`` property of the object. + ---- .. _class_PhysicsDirectSpaceState3D_method_get_rest_info: -- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters3D` shape **)** +- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** 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: @@ -83,19 +89,39 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara If the shape did not intersect anything, then an empty dictionary is returned instead. +**Note:** This method does not take into account the ``motion`` property of the object. + ---- -.. _class_PhysicsDirectSpaceState3D_method_intersect_ray: +.. _class_PhysicsDirectSpaceState3D_method_intersect_point: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[], :ref:`int` collision_mask=4294967295, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** +- :ref:`Array` **intersect_point** **(** :ref:`PhysicsPointQueryParameters3D` parameters, :ref:`int` max_results=32 **)** -Intersects a ray in a given space. The returned object is a dictionary with the following fields: +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: ``collider``: The colliding object. ``collider_id``: The colliding object's ID. -``normal``: The object's surface normal at the intersection point. +``rid``: The intersecting object's :ref:`RID`. + +``shape``: The shape index of the colliding shape. + +The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. + +---- + +.. _class_PhysicsDirectSpaceState3D_method_intersect_ray: + +- :ref:`Dictionary` **intersect_ray** **(** :ref:`PhysicsRayQueryParameters3D` parameters **)** + +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: + +``collider``: The colliding object. + +``collider_id``: The colliding object's ID. + +``normal``: The object's surface normal at the intersection point, or ``Vector3(0, 0, 0)`` if the ray starts inside the shape and :ref:`PhysicsRayQueryParameters3D.hit_from_inside` is ``true``. ``position``: The intersection point. @@ -105,13 +131,11 @@ Intersects a ray in a given space. The returned object is a dictionary with the If the ray did not intersect anything, then an empty dictionary is returned instead. -Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with :ref:`PhysicsBody3D`\ s or :ref:`Area3D`\ s, respectively. - ---- .. _class_PhysicsDirectSpaceState3D_method_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters3D` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=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: @@ -125,6 +149,8 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. +**Note:** This method does not take into account the ``motion`` property of the 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.)` diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index f32a36682..0b0ed1d19 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicspointqueryparameters2d.rst b/classes/class_physicspointqueryparameters2d.rst new file mode 100644 index 000000000..06f0821a9 --- /dev/null +++ b/classes/class_physicspointqueryparameters2d.rst @@ -0,0 +1,140 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PhysicsPointQueryParameters2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PhysicsPointQueryParameters2D: + +PhysicsPointQueryParameters2D +============================= + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Parameters to be sent to a 2D point physics query. + +Description +----------- + +This class contains the position and other parameters to be used for :ref:`PhysicsDirectSpaceState2D.intersect_point`. + +Properties +---------- + ++-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ +| :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:`exclude` | ``[]`` | ++-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | ++-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + +Property Descriptions +--------------------- + +.. _class_PhysicsPointQueryParameters2D_property_canvas_instance_id: + +- :ref:`int` **canvas_instance_id** + ++-----------+-------------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------------+ +| *Setter* | set_canvas_instance_id(value) | ++-----------+-------------------------------+ +| *Getter* | 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`. + +---- + +.. _class_PhysicsPointQueryParameters2D_property_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ + +If ``true``, the query will take :ref:`Area2D`\ s into account. + +---- + +.. _class_PhysicsPointQueryParameters2D_property_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** + ++-----------+----------------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ + +If ``true``, the query will take :ref:`PhysicsBody2D`\ s into account. + +---- + +.. _class_PhysicsPointQueryParameters2D_property_collision_mask: + +- :ref:`int` **collision_mask** + ++-----------+---------------------------+ +| *Default* | ``4294967295`` | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | 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 `__ in the documentation for more information. + +---- + +.. _class_PhysicsPointQueryParameters2D_property_exclude: + +- :ref:`Array` **exclude** + ++-----------+--------------------+ +| *Default* | ``[]`` | ++-----------+--------------------+ +| *Setter* | set_exclude(value) | ++-----------+--------------------+ +| *Getter* | get_exclude() | ++-----------+--------------------+ + +The list of objects or object :ref:`RID`\ s that will be excluded from collisions. + +---- + +.. _class_PhysicsPointQueryParameters2D_property_position: + +- :ref:`Vector2` **position** + ++-----------+---------------------+ +| *Default* | ``Vector2(0, 0)`` | ++-----------+---------------------+ +| *Setter* | set_position(value) | ++-----------+---------------------+ +| *Getter* | get_position() | ++-----------+---------------------+ + +The position being queried for, in global coordinates. + +.. |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.)` diff --git a/classes/class_physicspointqueryparameters3d.rst b/classes/class_physicspointqueryparameters3d.rst new file mode 100644 index 000000000..b75b5fe57 --- /dev/null +++ b/classes/class_physicspointqueryparameters3d.rst @@ -0,0 +1,122 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PhysicsPointQueryParameters3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PhysicsPointQueryParameters3D: + +PhysicsPointQueryParameters3D +============================= + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Parameters to be sent to a 3D point physics query. + +Description +----------- + +This class contains the position and other parameters to be used for :ref:`PhysicsDirectSpaceState3D.intersect_point`. + +Properties +---------- + ++-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ``false`` | ++-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | ++-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`int` | :ref:`collision_mask` | ``4294967295`` | ++-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`Array` | :ref:`exclude` | ``[]`` | ++-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | ++-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + +Property Descriptions +--------------------- + +.. _class_PhysicsPointQueryParameters3D_property_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ + +If ``true``, the query will take :ref:`Area3D`\ s into account. + +---- + +.. _class_PhysicsPointQueryParameters3D_property_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** + ++-----------+----------------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ + +If ``true``, the query will take :ref:`PhysicsBody3D`\ s into account. + +---- + +.. _class_PhysicsPointQueryParameters3D_property_collision_mask: + +- :ref:`int` **collision_mask** + ++-----------+---------------------------+ +| *Default* | ``4294967295`` | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | 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 `__ in the documentation for more information. + +---- + +.. _class_PhysicsPointQueryParameters3D_property_exclude: + +- :ref:`Array` **exclude** + ++-----------+--------------------+ +| *Default* | ``[]`` | ++-----------+--------------------+ +| *Setter* | set_exclude(value) | ++-----------+--------------------+ +| *Getter* | get_exclude() | ++-----------+--------------------+ + +The list of objects or object :ref:`RID`\ s that will be excluded from collisions. + +---- + +.. _class_PhysicsPointQueryParameters3D_property_position: + +- :ref:`Vector3` **position** + ++-----------+----------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+----------------------+ +| *Setter* | set_position(value) | ++-----------+----------------------+ +| *Getter* | get_position() | ++-----------+----------------------+ + +The position being queried for, in global coordinates. + +.. |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.)` diff --git a/classes/class_physicsrayqueryparameters2d.rst b/classes/class_physicsrayqueryparameters2d.rst new file mode 100644 index 000000000..c59cb4710 --- /dev/null +++ b/classes/class_physicsrayqueryparameters2d.rst @@ -0,0 +1,158 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PhysicsRayQueryParameters2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PhysicsRayQueryParameters2D: + +PhysicsRayQueryParameters2D +=========================== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Parameters to be sent to a 2D ray physics query. + +Description +----------- + +This class contains the ray position and other parameters to be used for :ref:`PhysicsDirectSpaceState2D.intersect_ray`. + +Properties +---------- + ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`collision_mask` | ``4294967295`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`Array` | :ref:`exclude` | ``[]`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`from` | ``Vector2(0, 0)`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`hit_from_inside` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`to` | ``Vector2(0, 0)`` | ++-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + +Property Descriptions +--------------------- + +.. _class_PhysicsRayQueryParameters2D_property_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ + +If ``true``, the query will take :ref:`Area2D`\ s into account. + +---- + +.. _class_PhysicsRayQueryParameters2D_property_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** + ++-----------+----------------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ + +If ``true``, the query will take :ref:`PhysicsBody2D`\ s into account. + +---- + +.. _class_PhysicsRayQueryParameters2D_property_collision_mask: + +- :ref:`int` **collision_mask** + ++-----------+---------------------------+ +| *Default* | ``4294967295`` | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | 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 `__ in the documentation for more information. + +---- + +.. _class_PhysicsRayQueryParameters2D_property_exclude: + +- :ref:`Array` **exclude** + ++-----------+--------------------+ +| *Default* | ``[]`` | ++-----------+--------------------+ +| *Setter* | set_exclude(value) | ++-----------+--------------------+ +| *Getter* | get_exclude() | ++-----------+--------------------+ + +The list of objects or object :ref:`RID`\ s that will be excluded from collisions. + +---- + +.. _class_PhysicsRayQueryParameters2D_property_from: + +- :ref:`Vector2` **from** + ++-----------+-------------------+ +| *Default* | ``Vector2(0, 0)`` | ++-----------+-------------------+ +| *Setter* | set_from(value) | ++-----------+-------------------+ +| *Getter* | get_from() | ++-----------+-------------------+ + +The starting point of the ray being queried for, in global coordinates. + +---- + +.. _class_PhysicsRayQueryParameters2D_property_hit_from_inside: + +- :ref:`bool` **hit_from_inside** + ++-----------+------------------------------+ +| *Default* | ``false`` | ++-----------+------------------------------+ +| *Setter* | set_hit_from_inside(value) | ++-----------+------------------------------+ +| *Getter* | 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. + +---- + +.. _class_PhysicsRayQueryParameters2D_property_to: + +- :ref:`Vector2` **to** + ++-----------+-------------------+ +| *Default* | ``Vector2(0, 0)`` | ++-----------+-------------------+ +| *Setter* | set_to(value) | ++-----------+-------------------+ +| *Getter* | get_to() | ++-----------+-------------------+ + +The ending point of the ray being queried for, in global coordinates. + +.. |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.)` diff --git a/classes/class_physicsrayqueryparameters3d.rst b/classes/class_physicsrayqueryparameters3d.rst new file mode 100644 index 000000000..c3da21c9c --- /dev/null +++ b/classes/class_physicsrayqueryparameters3d.rst @@ -0,0 +1,176 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PhysicsRayQueryParameters3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PhysicsRayQueryParameters3D: + +PhysicsRayQueryParameters3D +=========================== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Parameters to be sent to a 3D ray physics query. + +Description +----------- + +This class contains the ray position and other parameters to be used for :ref:`PhysicsDirectSpaceState3D.intersect_ray`. + +Properties +---------- + ++-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | ++-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ +| :ref:`int` | :ref:`collision_mask` | ``4294967295`` | ++-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ +| :ref:`Array` | :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)`` | ++-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + +Property Descriptions +--------------------- + +.. _class_PhysicsRayQueryParameters3D_property_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ + +If ``true``, the query will take :ref:`Area3D`\ s into account. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** + ++-----------+----------------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ + +If ``true``, the query will take :ref:`PhysicsBody3D`\ s into account. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_collision_mask: + +- :ref:`int` **collision_mask** + ++-----------+---------------------------+ +| *Default* | ``4294967295`` | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | 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 `__ in the documentation for more information. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_exclude: + +- :ref:`Array` **exclude** + ++-----------+--------------------+ +| *Default* | ``[]`` | ++-----------+--------------------+ +| *Setter* | set_exclude(value) | ++-----------+--------------------+ +| *Getter* | get_exclude() | ++-----------+--------------------+ + +The list of objects or object :ref:`RID`\ s that will be excluded from collisions. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_from: + +- :ref:`Vector3` **from** + ++-----------+----------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+----------------------+ +| *Setter* | set_from(value) | ++-----------+----------------------+ +| *Getter* | get_from() | ++-----------+----------------------+ + +The starting point of the ray being queried for, in global coordinates. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_hit_back_faces: + +- :ref:`bool` **hit_back_faces** + ++-----------+-----------------------------+ +| *Default* | ``true`` | ++-----------+-----------------------------+ +| *Setter* | set_hit_back_faces(value) | ++-----------+-----------------------------+ +| *Getter* | is_hit_back_faces_enabled() | ++-----------+-----------------------------+ + +If ``true``, the query will hit back faces with concave polygon shapes with back face enabled or heightmap shapes. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_hit_from_inside: + +- :ref:`bool` **hit_from_inside** + ++-----------+------------------------------+ +| *Default* | ``false`` | ++-----------+------------------------------+ +| *Setter* | set_hit_from_inside(value) | ++-----------+------------------------------+ +| *Getter* | 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. + +---- + +.. _class_PhysicsRayQueryParameters3D_property_to: + +- :ref:`Vector3` **to** + ++-----------+----------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+----------------------+ +| *Setter* | set_to(value) | ++-----------+----------------------+ +| *Getter* | get_to() | ++-----------+----------------------+ + +The ending point of the ray being queried for, in global coordinates. + +.. |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.)` diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index 86c0c1a3a..a18446aad 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsServer2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,215 +21,211 @@ PhysicsServer2D is the server responsible for all 2D physics. It can create many Methods ------- -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** |const| | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** |const| | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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_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` **(** **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** |const| | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :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 **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_make_groove` **(** :ref:`RID` joint, :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_make_pin` **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` 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 **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_iterations` **(** :ref:`int` iterations **)** | -+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` **(** :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_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_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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_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` **(** **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JointType` | :ref:`joint_get_type` **(** :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 **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_make_groove` **(** :ref:`RID` joint, :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_make_pin` **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` 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 **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_iterations` **(** :ref:`int` iterations **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -312,6 +308,8 @@ enum **ShapeType**: .. _enum_PhysicsServer2D_AreaParameter: +.. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE: + .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY: .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_VECTOR: @@ -322,29 +320,39 @@ enum **ShapeType**: .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION: +.. _class_PhysicsServer2D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE: + .. _class_PhysicsServer2D_constant_AREA_PARAM_LINEAR_DAMP: +.. _class_PhysicsServer2D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE: + .. _class_PhysicsServer2D_constant_AREA_PARAM_ANGULAR_DAMP: .. _class_PhysicsServer2D_constant_AREA_PARAM_PRIORITY: enum **AreaParameter**: -- **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. +- **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = **0** --- Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode` for possible values. -- **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area. +- **AREA_PARAM_GRAVITY** = **1** --- Constant to set/get gravity strength in an area. -- **AREA_PARAM_GRAVITY_IS_POINT** = **2** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point. +- **AREA_PARAM_GRAVITY_VECTOR** = **2** --- Constant to set/get gravity vector/center in an area. -- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **3** --- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. +- **AREA_PARAM_GRAVITY_IS_POINT** = **3** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point. -- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **4** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE`. +- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **4** --- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. -- **AREA_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get the linear dampening factor of an area. +- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **5** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE`. -- **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area. +- **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = **6** --- Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode` for possible values. -- **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. +- **AREA_PARAM_LINEAR_DAMP** = **7** --- Constant to set/get the linear damping factor of an area. + +- **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = **8** --- Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode` for possible values. + +- **AREA_PARAM_ANGULAR_DAMP** = **9** --- Constant to set/get the angular damping factor of an area. + +- **AREA_PARAM_PRIORITY** = **10** --- Constant to set/get the priority (order of processing) of an area. ---- @@ -410,6 +418,10 @@ enum **BodyMode**: .. _class_PhysicsServer2D_constant_BODY_PARAM_GRAVITY_SCALE: +.. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP_MODE: + +.. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP_MODE: + .. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP: .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP: @@ -426,15 +438,33 @@ enum **BodyParameter**: - **BODY_PARAM_INERTIA** = **3** --- Constant to set/get a body's inertia. -- **BODY_PARAM_CENTER_OF_MASS** = **4** --- Constant to set/get a body's center of mass. +- **BODY_PARAM_CENTER_OF_MASS** = **4** --- Constant to set/get a body's center of mass position in the body's local coordinate system. - **BODY_PARAM_GRAVITY_SCALE** = **5** --- Constant to set/get a body's gravity multiplier. -- **BODY_PARAM_LINEAR_DAMP** = **6** --- Constant to set/get a body's linear dampening factor. +- **BODY_PARAM_LINEAR_DAMP_MODE** = **6** --- Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode` for possible values. -- **BODY_PARAM_ANGULAR_DAMP** = **7** --- Constant to set/get a body's angular dampening factor. +- **BODY_PARAM_ANGULAR_DAMP_MODE** = **7** --- Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode` for possible values. -- **BODY_PARAM_MAX** = **8** --- Represents the size of the :ref:`BodyParameter` enum. +- **BODY_PARAM_LINEAR_DAMP** = **8** --- Constant to set/get a body's linear dampening factor. + +- **BODY_PARAM_ANGULAR_DAMP** = **9** --- Constant to set/get a body's angular dampening factor. + +- **BODY_PARAM_MAX** = **10** --- Represents the size of the :ref:`BodyParameter` enum. + +---- + +.. _enum_PhysicsServer2D_BodyDampMode: + +.. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_COMBINE: + +.. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_REPLACE: + +enum **BodyDampMode**: + +- **BODY_DAMP_MODE_COMBINE** = **0** --- The body's damping value is added to any value set in areas or the default value. + +- **BODY_DAMP_MODE_REPLACE** = **1** --- The body's damping value replaces any value set in areas or the default value. ---- @@ -665,14 +695,6 @@ Returns the space assigned to the area. ---- -.. _class_PhysicsServer2D_method_area_get_space_override_mode: - -- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** |const| - -Returns the space override mode for the area. - ----- - .. _class_PhysicsServer2D_method_area_get_transform: - :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** |const| @@ -691,7 +713,7 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig .. _class_PhysicsServer2D_method_area_set_area_monitor_callback: -- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** +- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** ---- @@ -713,7 +735,7 @@ Sets which physics layers the area will monitor. .. _class_PhysicsServer2D_method_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: @@ -775,14 +797,6 @@ Assigns a space to the area. ---- -.. _class_PhysicsServer2D_method_area_set_space_override_mode: - -- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** - -Sets the space override mode for the area. See :ref:`AreaSpaceOverrideMode` for a list of available modes. - ----- - .. _class_PhysicsServer2D_method_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** @@ -911,7 +925,7 @@ Returns the continuous collision detection mode. - :ref:`PhysicsDirectBodyState2D` **body_get_direct_state** **(** :ref:`RID` body **)** -Returns the :ref:`PhysicsDirectBodyState2D` of the body. +Returns the :ref:`PhysicsDirectBodyState2D` of the body. Returns ``null`` if the body is destroyed or removed from the physics space. ---- diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index 20dd2a2ea..ecf81ce62 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsServer3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,255 +21,251 @@ PhysicsServer3D is the server responsible for all 3D physics. It can create many Methods ------- -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :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:`Object` receiver, :ref:`StringName` method **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform3D` transform **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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_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` **(** **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** |const| | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :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 **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_iterations` **(** :ref:`int` iterations **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`soft_body_get_bounds` **(** :ref:`RID` body **)** |const| | -+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` **(** :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_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_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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_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` **(** **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** |const| | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JointType` | :ref:`joint_get_type` **(** :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 **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_iterations` **(** :ref:`int` iterations **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`soft_body_get_bounds` **(** :ref:`RID` body **)** |const| | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -656,6 +652,8 @@ enum **ShapeType**: .. _enum_PhysicsServer3D_AreaParameter: +.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE: + .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY: .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_VECTOR: @@ -666,8 +664,12 @@ enum **ShapeType**: .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION: +.. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE: + .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP: +.. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE: + .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP: .. _class_PhysicsServer3D_constant_AREA_PARAM_PRIORITY: @@ -682,29 +684,35 @@ enum **ShapeType**: enum **AreaParameter**: -- **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. +- **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = **0** --- Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode` for possible values. -- **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area. +- **AREA_PARAM_GRAVITY** = **1** --- Constant to set/get gravity strength in an area. -- **AREA_PARAM_GRAVITY_IS_POINT** = **2** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point. +- **AREA_PARAM_GRAVITY_VECTOR** = **2** --- Constant to set/get gravity vector/center in an area. -- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **3** --- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. +- **AREA_PARAM_GRAVITY_IS_POINT** = **3** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point. -- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **4** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE`. +- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **4** --- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. -- **AREA_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get the linear dampening factor of an area. +- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **5** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE`. -- **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area. +- **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = **6** --- Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode` for possible values. -- **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. +- **AREA_PARAM_LINEAR_DAMP** = **7** --- Constant to set/get the linear damping factor of an area. -- **AREA_PARAM_WIND_FORCE_MAGNITUDE** = **8** --- Constant to set/get the magnitude of area-specific wind force. +- **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = **8** --- Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode` for possible values. -- **AREA_PARAM_WIND_SOURCE** = **9** --- Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows. +- **AREA_PARAM_ANGULAR_DAMP** = **9** --- Constant to set/get the angular damping factor of an area. -- **AREA_PARAM_WIND_DIRECTION** = **10** --- Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows. +- **AREA_PARAM_PRIORITY** = **10** --- Constant to set/get the priority (order of processing) of an area. -- **AREA_PARAM_WIND_ATTENUATION_FACTOR** = **11** --- Constant to set/get the exponential rate at which wind force decreases with distance from its origin. +- **AREA_PARAM_WIND_FORCE_MAGNITUDE** = **11** --- Constant to set/get the magnitude of area-specific wind force. + +- **AREA_PARAM_WIND_SOURCE** = **12** --- Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows. + +- **AREA_PARAM_WIND_DIRECTION** = **13** --- Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows. + +- **AREA_PARAM_WIND_ATTENUATION_FACTOR** = **14** --- Constant to set/get the exponential rate at which wind force decreases with distance from its origin. ---- @@ -770,6 +778,10 @@ enum **BodyMode**: .. _class_PhysicsServer3D_constant_BODY_PARAM_GRAVITY_SCALE: +.. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP_MODE: + +.. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE: + .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP: .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP: @@ -786,15 +798,33 @@ enum **BodyParameter**: - **BODY_PARAM_INERTIA** = **3** --- Constant to set/get a body's inertia. -- **BODY_PARAM_CENTER_OF_MASS** = **4** --- Constant to set/get a body's center of mass. +- **BODY_PARAM_CENTER_OF_MASS** = **4** --- Constant to set/get a body's center of mass position in the body's local coordinate system. - **BODY_PARAM_GRAVITY_SCALE** = **5** --- Constant to set/get a body's gravity multiplier. -- **BODY_PARAM_LINEAR_DAMP** = **6** --- Constant to set/get a body's linear dampening factor. +- **BODY_PARAM_LINEAR_DAMP_MODE** = **6** --- Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode` for possible values. -- **BODY_PARAM_ANGULAR_DAMP** = **7** --- Constant to set/get a body's angular dampening factor. +- **BODY_PARAM_ANGULAR_DAMP_MODE** = **7** --- Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode` for possible values. -- **BODY_PARAM_MAX** = **8** --- Represents the size of the :ref:`BodyParameter` enum. +- **BODY_PARAM_LINEAR_DAMP** = **8** --- Constant to set/get a body's linear dampening factor. + +- **BODY_PARAM_ANGULAR_DAMP** = **9** --- Constant to set/get a body's angular dampening factor. + +- **BODY_PARAM_MAX** = **10** --- Represents the size of the :ref:`BodyParameter` enum. + +---- + +.. _enum_PhysicsServer3D_BodyDampMode: + +.. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE: + +.. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_REPLACE: + +enum **BodyDampMode**: + +- **BODY_DAMP_MODE_COMBINE** = **0** --- The body's damping value is added to any value set in areas or the default value. + +- **BODY_DAMP_MODE_REPLACE** = **1** --- The body's damping value replaces any value set in areas or the default value. ---- @@ -1005,14 +1035,6 @@ Returns the space assigned to the area. ---- -.. _class_PhysicsServer3D_method_area_get_space_override_mode: - -- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** |const| - -Returns the space override mode for the area. - ----- - .. _class_PhysicsServer3D_method_area_get_transform: - :ref:`Transform3D` **area_get_transform** **(** :ref:`RID` area **)** |const| @@ -1031,7 +1053,7 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig .. _class_PhysicsServer3D_method_area_set_area_monitor_callback: -- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** +- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** ---- @@ -1053,7 +1075,7 @@ Sets which physics layers the area will monitor. .. _class_PhysicsServer3D_method_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: @@ -1121,14 +1143,6 @@ Assigns a space to the area. ---- -.. _class_PhysicsServer3D_method_area_set_space_override_mode: - -- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** - -Sets the space override mode for the area. The modes are described in the :ref:`AreaSpaceOverrideMode` constants. - ----- - .. _class_PhysicsServer3D_method_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform3D` transform **)** @@ -1237,7 +1251,7 @@ Returns the physics layer or layers a body can collide with. - :ref:`PhysicsDirectBodyState3D` **body_get_direct_state** **(** :ref:`RID` body **)** -Returns the :ref:`PhysicsDirectBodyState3D` of the body. +Returns the :ref:`PhysicsDirectBodyState3D` of the body. Returns ``null`` if the body is destroyed or removed from the physics space. ---- diff --git a/classes/class_physicsshapequeryparameters2d.rst b/classes/class_physicsshapequeryparameters2d.rst index 2fd683485..c8244d4bf 100644 --- a/classes/class_physicsshapequeryparameters2d.rst +++ b/classes/class_physicsshapequeryparameters2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsShapeQueryParameters2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,7 @@ Parameters to be sent to a 2D shape physics query. Description ----------- -This class contains the shape and other parameters for 2D intersection/collision queries. +This class contains the shape and other parameters for :ref:`PhysicsDirectSpaceState2D` intersection/collision queries. Properties ---------- diff --git a/classes/class_physicsshapequeryparameters3d.rst b/classes/class_physicsshapequeryparameters3d.rst index 239bea4a0..d154a7d17 100644 --- a/classes/class_physicsshapequeryparameters3d.rst +++ b/classes/class_physicsshapequeryparameters3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsShapeQueryParameters3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,7 @@ Parameters to be sent to a 3D shape physics query. Description ----------- -This class contains the shape and other parameters for 3D intersection/collision queries. +This class contains the shape and other parameters for :ref:`PhysicsDirectSpaceState3D` intersection/collision queries. Properties ---------- @@ -32,6 +32,8 @@ Properties +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`margin` | ``0.0`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`motion` | ``Vector3(0, 0, 0)`` | ++---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Resource` | :ref:`shape` | | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`RID` | :ref:`shape_rid` | | @@ -122,6 +124,22 @@ The collision margin for the shape. ---- +.. _class_PhysicsShapeQueryParameters3D_property_motion: + +- :ref:`Vector3` **motion** + ++-----------+----------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+----------------------+ +| *Setter* | set_motion(value) | ++-----------+----------------------+ +| *Getter* | get_motion() | ++-----------+----------------------+ + +The motion of the shape being queried for. + +---- + .. _class_PhysicsShapeQueryParameters3D_property_shape: - :ref:`Resource` **shape** diff --git a/classes/class_physicstestmotionparameters2d.rst b/classes/class_physicstestmotionparameters2d.rst index 6915a5a4f..d70483a4c 100644 --- a/classes/class_physicstestmotionparameters2d.rst +++ b/classes/class_physicstestmotionparameters2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsTestMotionParameters2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicstestmotionparameters3d.rst b/classes/class_physicstestmotionparameters3d.rst index 8e4d7a9d4..8c89799eb 100644 --- a/classes/class_physicstestmotionparameters3d.rst +++ b/classes/class_physicstestmotionparameters3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsTestMotionParameters3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicstestmotionresult2d.rst b/classes/class_physicstestmotionresult2d.rst index 99352e2ae..f8bb6503e 100644 --- a/classes/class_physicstestmotionresult2d.rst +++ b/classes/class_physicstestmotionresult2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsTestMotionResult2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_physicstestmotionresult3d.rst b/classes/class_physicstestmotionresult3d.rst index fe0545e42..5ada442c4 100644 --- a/classes/class_physicstestmotionresult3d.rst +++ b/classes/class_physicstestmotionresult3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PhysicsTestMotionResult3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index f869494ce..2c0fa79fd 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PinJoint2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pinjoint3d.rst b/classes/class_pinjoint3d.rst index ceb9a4243..c17248b93 100644 --- a/classes/class_pinjoint3d.rst +++ b/classes/class_pinjoint3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PinJoint3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 7f6fab960..3f994dca2 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Plane.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -36,54 +36,66 @@ Properties | :ref:`float` | :ref:`z` | ``0.0`` | +-------------------------------+--------------------------------------------+----------------------+ +Constructors +------------ + ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Plane` from **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` point, :ref:`Vector3` normal **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** |constructor| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`center` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=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_point_over` **(** :ref:`Vector3` plane **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`normalized` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Plane` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Plane` right **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | **operator unary+** **(** **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | **operator unary-** **(** **)** |operator| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center` **(** **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=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_point_over` **(** :ref:`Vector3` plane **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`normalized` **(** **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Plane` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Plane` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`operator unary+` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`operator unary-` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------+ Constants --------- @@ -165,46 +177,53 @@ The Y component of the plane's :ref:`normal` vector The Z component of the plane's :ref:`normal` vector. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Plane_method_Plane: +.. _class_Plane_constructor_Plane: -- :ref:`Plane` **Plane** **(** **)** |constructor| +- :ref:`Plane` **Plane** **(** **)** Constructs a default-initialized ``Plane`` with all components set to ``0``. ---- -- :ref:`Plane` **Plane** **(** :ref:`Plane` from **)** |constructor| +- :ref:`Plane` **Plane** **(** :ref:`Plane` from **)** Constructs a ``Plane`` as a copy of the given ``Plane``. ---- -- :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** |constructor| +- :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** 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. ---- -- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** |constructor| +- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal **)** -Creates a plane from the normal and the plane's distance to the origin. +Creates a plane from the normal vector. The plane will intersect the origin. ---- -- :ref:`Plane` **Plane** **(** :ref:`Vector3` point, :ref:`Vector3` normal **)** |constructor| +- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** -Creates a plane from the given position and a plane normal. +Creates a plane from the normal vector and the plane's distance from the origin. ---- -- :ref:`Plane` **Plane** **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** |constructor| +- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`Vector3` point **)** + +Creates a plane from the normal vector and a point on the plane. + +---- + +- :ref:`Plane` **Plane** **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** Creates a plane from the three points, given in clockwise order. ----- +Method Descriptions +------------------- .. _class_Plane_method_center: @@ -278,44 +297,45 @@ Returns a copy of the plane, normalized. ---- -.. _class_Plane_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Plane` right **)** |operator| - ----- - -.. _class_Plane_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Plane` right **)** |operator| - ----- - -.. _class_Plane_method_operator unary+: - -- :ref:`Plane` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Plane_method_operator unary-: - -- :ref:`Plane` **operator unary-** **(** **)** |operator| - ----- - .. _class_Plane_method_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** |const| Returns the orthogonal projection of ``point`` into a point in the plane. +Operator Descriptions +--------------------- + +.. _class_Plane_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Plane` right **)** + +---- + +.. _class_Plane_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Plane` right **)** + +---- + +.. _class_Plane_operator_unplus_Plane: + +- :ref:`Plane` **operator unary+** **(** **)** + +---- + +.. _class_Plane_operator_unminus_Plane: + +- :ref:`Plane` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 29093adfc..7813589f3 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PlaneMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index 0a8e0a7d8..615c16caa 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PluginScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_pointlight2d.rst b/classes/class_pointlight2d.rst index 6cd42c1ef..14266f8bc 100644 --- a/classes/class_pointlight2d.rst +++ b/classes/class_pointlight2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PointLight2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -41,7 +41,7 @@ Property Descriptions | *Getter* | get_height() | +-----------+-------------------+ -The height of the light. Used with 2D normal mapping. +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. ---- diff --git a/classes/class_pointmesh.rst b/classes/class_pointmesh.rst index 6bce81c1b..c7ec64944 100644 --- a/classes/class_pointmesh.rst +++ b/classes/class_pointmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PointMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index ab4488d70..f46c9c723 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Polygon2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 019b64b24..4a44778e8 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PolygonPathFinder.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 5ffad5d7e..c024921d1 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Popup.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 963c88f6b..7c09f1b15 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PopupMenu.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -34,129 +34,129 @@ Properties +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`hide_on_state_item_selection` | ``false`` | +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`items_count` | ``0`` | ++---------------------------+----------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`submenu_popup_delay` | ``0.3`` | +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ Methods ------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` 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:`int` accel=0 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_radio_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` 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 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_multistate_item` **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` 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 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_item_opentype_features` **(** :ref:`int` idx **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_index` **(** **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`String` | :ref:`get_item_language` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_opentype_feature` **(** :ref:`int` idx, :ref:`String` tag **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shortcut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextDirection` | :ref:`get_item_text_direction` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** |const| | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` icon **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_opentype_feature` **(** :ref:`int` idx, :ref:`String` tag, :ref:`int` value **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`Shortcut` shortcut, :ref:`bool` global=false **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text_direction` **(** :ref:`int` idx, :ref:`TextDirection` direction **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_multistate` **(** :ref:`int` idx **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_item_opentype_features` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_index` **(** **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Key` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`String` | :ref:`get_item_language` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_opentype_feature` **(** :ref:`int` idx, :ref:`String` tag **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shortcut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TextDirection` | :ref:`get_item_text_direction` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** |const| | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`Key` accel **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` icon **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_opentype_feature` **(** :ref:`int` idx, :ref:`String` tag, :ref:`int` value **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`Shortcut` shortcut, :ref:`bool` global=false **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text_direction` **(** :ref:`int` idx, :ref:`TextDirection` direction **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_multistate` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -305,6 +305,22 @@ If ``true``, hides the ``PopupMenu`` when a state item is selected. ---- +.. _class_PopupMenu_property_items_count: + +- :ref:`int` **items_count** + ++-----------+-----------------------+ +| *Default* | ``0`` | ++-----------+-----------------------+ +| *Setter* | set_item_count(value) | ++-----------+-----------------------+ +| *Getter* | get_item_count() | ++-----------+-----------------------+ + +The number of items currently in the list. + +---- + .. _class_PopupMenu_property_submenu_popup_delay: - :ref:`float` **submenu_popup_delay** @@ -324,7 +340,7 @@ Method Descriptions .. _class_PopupMenu_method_add_check_item: -- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Adds a new checkable item with text ``label``. @@ -348,7 +364,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. _class_PopupMenu_method_add_icon_check_item: -- void **add_icon_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Adds a new checkable item with text ``label`` and icon ``texture``. @@ -372,7 +388,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. _class_PopupMenu_method_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Adds a new item with text ``label`` and icon ``texture``. @@ -382,7 +398,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. _class_PopupMenu_method_add_icon_radio_check_item: -- void **add_icon_radio_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_radio_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Same as :ref:`add_icon_check_item`, but uses a radio check button. @@ -408,7 +424,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. _class_PopupMenu_method_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Adds a new item with text ``label``. @@ -418,7 +434,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. _class_PopupMenu_method_add_multistate_item: -- void **add_multistate_item** **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_multistate_item** **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Adds a new multistate item with text ``label``. @@ -430,7 +446,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. _class_PopupMenu_method_add_radio_check_item: -- void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** Adds a new radio check button with text ``label``. @@ -508,20 +524,12 @@ Returns the index of the currently focused item. Returns ``-1`` if no item is fo .. _class_PopupMenu_method_get_item_accelerator: -- :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** |const| +- :ref:`Key` **get_item_accelerator** **(** :ref:`int` idx **)** |const| Returns the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused. ---- -.. _class_PopupMenu_method_get_item_count: - -- :ref:`int` **get_item_count** **(** **)** |const| - -Returns the number of items in the ``PopupMenu``. - ----- - .. _class_PopupMenu_method_get_item_icon: - :ref:`Texture2D` **get_item_icon** **(** :ref:`int` idx **)** |const| @@ -676,7 +684,7 @@ Removes the item at index ``idx`` from the menu. .. _class_PopupMenu_method_set_item_accelerator: -- void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** +- void **set_item_accelerator** **(** :ref:`int` idx, :ref:`Key` accel **)** Sets the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused. diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 7f50280b8..c1cb484d2 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PopupPanel.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index 678243dcf..28883ee75 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Position2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 38c5b1287..2a7989075 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Position3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 361e0b73e..85950c832 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PrimitiveMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 2d92ecb70..e77fd9fa0 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PrismMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_proceduralskymaterial.rst b/classes/class_proceduralskymaterial.rst index 6af4f503b..0a941831a 100644 --- a/classes/class_proceduralskymaterial.rst +++ b/classes/class_proceduralskymaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ProceduralSkyMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,7 +18,7 @@ Description ProceduralSkyMaterial provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly, the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. -The ``ProceduralSkyMaterial`` uses a lightweight shader to draw the sky and is thus suited for real time updates. When you do not need a quick sky that is not realistic, this is a good option. +The ``ProceduralSkyMaterial`` uses a lightweight shader to draw the sky and is thus suited for real time updates. When you do not need a quick sky that is not realistic, this is a good option. If you need a more realistic option, try using :ref:`PhysicalSkyMaterial` instead. The ``ProceduralSkyMaterial`` supports up to 4 suns. Each sun takes its color, energy, and direction from the corresponding :ref:`DirectionalLight3D` in the scene. diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index ebe166410..ef82e9991 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ProgressBar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 8478b9af0..53d59d91c 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ProjectSettings.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -59,6 +59,8 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | @@ -799,9 +801,7 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`mono/profiler/enabled` | ``false`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mono/project/auto_update_project` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mono/unhandled_exception_policy` | ``0`` | +| :ref:`int` | :ref:`mono/runtime/unhandled_exception_policy` | ``0`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`navigation/2d/default_cell_size` | ``10`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ @@ -873,6 +873,18 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`physics/common/physics_ticks_per_second` | ``60`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/batching_send_null` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/batching_stream` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/legacy_orphan_buffers` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/opengl/legacy_stream` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/options/ninepatch_mode` | ``1`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/2d/options/use_software_skinning` | ``true`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/2d/sdf/oversize` | ``1`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/2d/sdf/scale` | ``1`` | @@ -883,7 +895,7 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/2d/snap/snap_2d_vertices_to_pixel` | ``false`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/3d/viewport/scale` | ``0`` | +| :ref:`float` | :ref:`rendering/3d/viewport/scale` | ``1.0`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/anti_aliasing/quality/msaa` | ``0`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ @@ -897,6 +909,32 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/limit` | ``0.18`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/debug/diagnose_frame` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/debug/flash_batching` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/lights/max_join_items` | ``32`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/batching/lights/scissor_area_threshold` | ``1.0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/options/single_rect_fallback` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/options/use_batching` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/options/use_batching_in_editor` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/parameters/batch_buffer_size` | ``16384`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/batching/parameters/colored_vertex_format_threshold` | ``0.25`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/parameters/item_reordering_lookahead` | ``4`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/parameters/max_join_item_commands` | ``16`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/batching/precision/uv_contract` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/batching/precision/uv_contract_amount` | ``100`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/camera/depth_of_field/depth_of_field_bokeh_quality` | ``1`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/camera/depth_of_field/depth_of_field_bokeh_shape` | ``1`` | @@ -907,7 +945,7 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/driver/depth_prepass/enable` | ``true`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/driver/driver_name` | ``"Vulkan"`` | +| :ref:`String` | :ref:`rendering/driver/driver_name` | ``"vulkan"`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/driver/threads/thread_model` | ``1`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ @@ -945,10 +983,14 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/environment/volumetric_fog/use_filter` | ``1`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_depth` | ``128`` | +| :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_depth` | ``64`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_size` | ``64`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/gles2/compatibility/enable_high_float.Android` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/global_illumination/gi/use_half_resolution` | ``false`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/global_illumination/sdfgi/frames_to_converge` | ``4`` | @@ -1049,7 +1091,7 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/shadows/directional_shadow/size.mobile` | ``2048`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/directional_shadow/soft_shadow_quality` | ``2`` | +| :ref:`int` | :ref:`rendering/shadows/directional_shadow/soft_shadow_quality` | ``3`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/shadows/directional_shadow/soft_shadow_quality.mobile` | ``0`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ @@ -1067,7 +1109,7 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/shadows/shadow_atlas/size.mobile` | ``2048`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/shadows/soft_shadow_quality` | ``2`` | +| :ref:`int` | :ref:`rendering/shadows/shadows/soft_shadow_quality` | ``3`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/shadows/shadows/soft_shadow_quality.mobile` | ``0`` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ @@ -1284,6 +1326,24 @@ If ``true``, the project will save user data to its own user directory (see :ref ---- +.. _class_ProjectSettings_property_application/config/use_hidden_project_data_directory: + +- :ref:`bool` **application/config/use_hidden_project_data_directory** + ++-----------+----------+ +| *Default* | ``true`` | ++-----------+----------+ + +If ``true``, the project will use a hidden directory (``.godot``) for storing project-specific data (metadata, shader cache, etc.). + +If ``false``, a non-hidden directory (``godot``) will be used instead. + +**Note:** Restart the application after changing this setting. + +**Note:** Changing this value can help on platforms or with third-party tools where hidden directory patterns are disallowed. Only modify this setting if you know that your environment requires it, as changing the default can impact compatibility with some external tools or plugins which expect the default ``.godot`` folder. + +---- + .. _class_ProjectSettings_property_application/config/windows_native_icon: - :ref:`String` **application/config/windows_native_icon** @@ -1492,7 +1552,11 @@ Safer override for :ref:`audio/driver/mix_rate` to determine the actual audio output latency. + +**Note:** This setting is ignored on all versions of Windows prior to Windows 10. ---- @@ -5372,24 +5436,18 @@ This is used by servers when used in multi-threading mode (servers and visual). ---- -.. _class_ProjectSettings_property_mono/project/auto_update_project: +.. _class_ProjectSettings_property_mono/runtime/unhandled_exception_policy: -- :ref:`bool` **mono/project/auto_update_project** - -+-----------+----------+ -| *Default* | ``true`` | -+-----------+----------+ - ----- - -.. _class_ProjectSettings_property_mono/unhandled_exception_policy: - -- :ref:`int` **mono/unhandled_exception_policy** +- :ref:`int` **mono/runtime/unhandled_exception_policy** +-----------+-------+ | *Default* | ``0`` | +-----------+-------+ +The policy to use for unhandled Mono (C#) exceptions. The default "Terminate Application" exits the project as soon as an unhandled exception is thrown. "Log Error" logs an error message to the console instead, and will not interrupt the project execution when an unhandled exception is thrown. + +**Note:** The unhandled exception policy is always set to "Log Error" in the editor, which also includes C# ``tool`` scripts running within the editor as well as editor plugin code. + ---- .. _class_ProjectSettings_property_navigation/2d/default_cell_size: @@ -5894,6 +5952,66 @@ The number of fixed iterations per second. This controls how often physics simul ---- +.. _class_ProjectSettings_property_rendering/2d/opengl/batching_send_null: + +- :ref:`int` **rendering/2d/opengl/batching_send_null** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/2d/opengl/batching_stream: + +- :ref:`int` **rendering/2d/opengl/batching_stream** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/2d/opengl/legacy_orphan_buffers: + +- :ref:`int` **rendering/2d/opengl/legacy_orphan_buffers** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/2d/opengl/legacy_stream: + +- :ref:`int` **rendering/2d/opengl/legacy_stream** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/2d/options/ninepatch_mode: + +- :ref:`int` **rendering/2d/options/ninepatch_mode** + ++-----------+-------+ +| *Default* | ``1`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/2d/options/use_software_skinning: + +- :ref:`bool` **rendering/2d/options/use_software_skinning** + ++-----------+----------+ +| *Default* | ``true`` | ++-----------+----------+ + +---- + .. _class_ProjectSettings_property_rendering/2d/sdf/oversize: - :ref:`int` **rendering/2d/sdf/oversize** @@ -5946,13 +6064,15 @@ The number of fixed iterations per second. This controls how often physics simul .. _class_ProjectSettings_property_rendering/3d/viewport/scale: -- :ref:`int` **rendering/3d/viewport/scale** +- :ref:`float` **rendering/3d/viewport/scale** -+-----------+-------+ -| *Default* | ``0`` | -+-----------+-------+ ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ -Scale the 3D render buffer based on the viewport size. The smaller the faster 3D rendering is performed but at the cost of quality. +Scales the 3D render buffer based on the viewport size and displays the result with linear filtering. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`rendering/anti_aliasing/quality/msaa` for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + +**Note:** This property is only read when the project starts. To change the 3D rendering resolution scale at runtime, set :ref:`Viewport.scale_3d` instead. ---- @@ -5964,7 +6084,7 @@ Scale the 3D render buffer based on the viewport size. The smaller the faster 3D | *Default* | ``0`` | +-----------+-------+ -Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. +Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. See also :ref:`rendering/3d/viewport/scale` for supersampling, which provides higher quality but is much more expensive. ---- @@ -6022,6 +6142,136 @@ Another way to combat specular aliasing is to enable :ref:`rendering/anti_aliasi ---- +.. _class_ProjectSettings_property_rendering/batching/debug/diagnose_frame: + +- :ref:`bool` **rendering/batching/debug/diagnose_frame** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/debug/flash_batching: + +- :ref:`bool` **rendering/batching/debug/flash_batching** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/lights/max_join_items: + +- :ref:`int` **rendering/batching/lights/max_join_items** + ++-----------+--------+ +| *Default* | ``32`` | ++-----------+--------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/lights/scissor_area_threshold: + +- :ref:`float` **rendering/batching/lights/scissor_area_threshold** + ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/options/single_rect_fallback: + +- :ref:`bool` **rendering/batching/options/single_rect_fallback** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/options/use_batching: + +- :ref:`bool` **rendering/batching/options/use_batching** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/options/use_batching_in_editor: + +- :ref:`bool` **rendering/batching/options/use_batching_in_editor** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/parameters/batch_buffer_size: + +- :ref:`int` **rendering/batching/parameters/batch_buffer_size** + ++-----------+-----------+ +| *Default* | ``16384`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/parameters/colored_vertex_format_threshold: + +- :ref:`float` **rendering/batching/parameters/colored_vertex_format_threshold** + ++-----------+----------+ +| *Default* | ``0.25`` | ++-----------+----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/parameters/item_reordering_lookahead: + +- :ref:`int` **rendering/batching/parameters/item_reordering_lookahead** + ++-----------+-------+ +| *Default* | ``4`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/parameters/max_join_item_commands: + +- :ref:`int` **rendering/batching/parameters/max_join_item_commands** + ++-----------+--------+ +| *Default* | ``16`` | ++-----------+--------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/precision/uv_contract: + +- :ref:`bool` **rendering/batching/precision/uv_contract** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/batching/precision/uv_contract_amount: + +- :ref:`int` **rendering/batching/precision/uv_contract_amount** + ++-----------+---------+ +| *Default* | ``100`` | ++-----------+---------+ + +---- + .. _class_ProjectSettings_property_rendering/camera/depth_of_field/depth_of_field_bokeh_quality: - :ref:`int` **rendering/camera/depth_of_field/depth_of_field_bokeh_quality** @@ -6087,10 +6337,12 @@ If ``true``, performs a previous depth pass before rendering materials. This inc - :ref:`String` **rendering/driver/driver_name** +-----------+--------------+ -| *Default* | ``"Vulkan"`` | +| *Default* | ``"vulkan"`` | +-----------+--------------+ -The video driver to use (currently only "Vulkan" is implemented). +The video driver to use. + +**Note:** OpenGL support is currently incomplete. Only basic 2D rendering is supported, and single-window mode is required for correct operation. **Note:** The backend in use can be overridden at runtime via the ``--rendering-driver`` command line argument. @@ -6312,15 +6564,19 @@ Scales the distance over which samples are taken for subsurface scattering effec | *Default* | ``1`` | +-----------+-------+ +Enables filtering of the volumetric fog effect prior to integration. This substantially blurs the fog which reduces fine details but also smooths out harsh edges and aliasing artifacts. Disable when more detail is required. + ---- .. _class_ProjectSettings_property_rendering/environment/volumetric_fog/volume_depth: - :ref:`int` **rendering/environment/volumetric_fog/volume_depth** -+-----------+---------+ -| *Default* | ``128`` | -+-----------+---------+ ++-----------+--------+ +| *Default* | ``64`` | ++-----------+--------+ + +Number of slices to use along the depth of the froxel buffer for volumetric fog. A lower number will be more efficient but may result in artifacts appearing during camera movement. ---- @@ -6332,6 +6588,28 @@ Scales the distance over which samples are taken for subsurface scattering effec | *Default* | ``64`` | +-----------+--------+ +Base size used to determine size of froxel buffer in the camera X-axis and Y-axis. The final size is scaled by the aspect ratio of the screen, so actual values may differ from what is set. Set a larger size for more detailed fog, set a smaller size for better performance. + +---- + +.. _class_ProjectSettings_property_rendering/gles2/compatibility/disable_half_float: + +- :ref:`bool` **rendering/gles2/compatibility/disable_half_float** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/gles2/compatibility/enable_high_float.Android: + +- :ref:`bool` **rendering/gles2/compatibility/enable_high_float.Android** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + ---- .. _class_ProjectSettings_property_rendering/global_illumination/gi/use_half_resolution: @@ -6873,11 +7151,15 @@ Lower-end override for :ref:`rendering/shadows/directional_shadow/size` **rendering/shadows/directional_shadow/soft_shadow_quality** +-----------+-------+ -| *Default* | ``2`` | +| *Default* | ``3`` | +-----------+-------+ Quality setting for shadows cast by :ref:`DirectionalLight3D`\ s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. +**Note:** The Soft Very Low setting will automatically multiply *constant* shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in :ref:`Light3D.shadow_blur`, not the variable blur performed by :ref:`DirectionalLight3D`\ s' :ref:`Light3D.light_angular_distance`. + +**Note:** The Soft High and Soft Ultra settings will automatically multiply *constant* shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. + ---- .. _class_ProjectSettings_property_rendering/shadows/directional_shadow/soft_shadow_quality.mobile: @@ -6979,11 +7261,15 @@ Lower-end override for :ref:`rendering/shadows/shadow_atlas/size` **rendering/shadows/shadows/soft_shadow_quality** +-----------+-------+ -| *Default* | ``2`` | +| *Default* | ``3`` | +-----------+-------+ Quality setting for shadows cast by :ref:`OmniLight3D`\ s and :ref:`SpotLight3D`\ s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. +**Note:** The Soft Very Low setting will automatically multiply *constant* shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in :ref:`Light3D.shadow_blur`, not the variable blur performed by :ref:`DirectionalLight3D`\ s' :ref:`Light3D.light_angular_distance`. + +**Note:** The Soft High and Soft Ultra settings will automatically multiply shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. + ---- .. _class_ProjectSettings_property_rendering/shadows/shadows/soft_shadow_quality.mobile: @@ -7080,7 +7366,7 @@ The default compression level for lossless WebP. Higher levels result in smaller If ``true``, the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the Vulkan renderer. -**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor. +**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor (see :ref:`application/config/use_hidden_project_data_directory`). ---- @@ -7094,7 +7380,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. -**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor. +**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor (see :ref:`application/config/use_hidden_project_data_directory`). ---- @@ -7108,7 +7394,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the Vulkan renderer. -**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor. +**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor (see :ref:`application/config/use_hidden_project_data_directory`). ---- @@ -7122,7 +7408,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the If ``true``, the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. -**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor. +**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor (see :ref:`application/config/use_hidden_project_data_directory`). ---- @@ -7136,7 +7422,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. -**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor. +**Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor (see :ref:`application/config/use_hidden_project_data_directory`). ---- diff --git a/classes/class_propertytweener.rst b/classes/class_propertytweener.rst index 09c4e0cc0..6f38d15c9 100644 --- a/classes/class_propertytweener.rst +++ b/classes/class_propertytweener.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the PropertyTweener.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_proximitygroup3d.rst b/classes/class_proximitygroup3d.rst index e1fb4b688..13b5c17ea 100644 --- a/classes/class_proximitygroup3d.rst +++ b/classes/class_proximitygroup3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ProximityGroup3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 768829f22..c5beaf2c9 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ProxyTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index 6abf32b17..dd940120b 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the QuadMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 81cf8ea6f..e2fd768b9 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Quaternion.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -40,23 +40,28 @@ Properties | :ref:`float` | :ref:`z` | ``0.0`` | +---------------------------+---------------------------------------+---------+ +Constructors +------------ + ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Vector3` euler_yxz **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Basis` from **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Quaternion` from **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Vector3` axis, :ref:`float` angle **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Vector3` euler **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Basis` from **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** |constructor| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angle_to` **(** :ref:`Quaternion` to **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -64,6 +69,10 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`dot` **(** :ref:`Quaternion` with **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angle` **(** **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_axis` **(** **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_euler` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quaternion` | :ref:`inverse` **(** **)** |const| | @@ -78,41 +87,46 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quaternion` | :ref:`normalized` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator *** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator *** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator *** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator +** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator -** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator /** **(** :ref:`float` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator /** **(** :ref:`int` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator unary+** **(** **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quaternion` | **operator unary-** **(** **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quaternion` | :ref:`slerp` **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quaternion` | :ref:`slerpni` **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Operators +--------- + ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** :ref:`Quaternion` right **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quaternion` | :ref:`operator unary+` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quaternion` | :ref:`operator unary-` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + Constants --------- @@ -177,50 +191,49 @@ Z component of the quaternion (imaginary ``k`` axis part). Quaternion components should usually not be manipulated directly. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Quaternion_method_Quaternion: +.. _class_Quaternion_constructor_Quaternion: -- :ref:`Quaternion` **Quaternion** **(** **)** |constructor| +- :ref:`Quaternion` **Quaternion** **(** **)** Constructs a default-initialized quaternion with all components set to ``0``. ---- -- :ref:`Quaternion` **Quaternion** **(** :ref:`Quaternion` from **)** |constructor| +- :ref:`Quaternion` **Quaternion** **(** :ref:`Quaternion` from **)** Constructs a ``Quaternion`` as a copy of the given ``Quaternion``. ---- -- :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** |constructor| +- :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** ---- -- :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |constructor| +- :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. ---- -- :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` euler **)** |constructor| - -Constructs a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). +- :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` euler_yxz **)** ---- -- :ref:`Quaternion` **Quaternion** **(** :ref:`Basis` from **)** |constructor| +- :ref:`Quaternion` **Quaternion** **(** :ref:`Basis` from **)** Constructs a quaternion from the given :ref:`Basis`. ---- -- :ref:`Quaternion` **Quaternion** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** |constructor| +- :ref:`Quaternion` **Quaternion** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Constructs a quaternion defined by the given values. ----- +Method Descriptions +------------------- .. _class_Quaternion_method_angle_to: @@ -248,6 +261,18 @@ Returns the dot product of two quaternions. ---- +.. _class_Quaternion_method_get_angle: + +- :ref:`float` **get_angle** **(** **)** |const| + +---- + +.. _class_Quaternion_method_get_axis: + +- :ref:`Vector3` **get_axis** **(** **)** |const| + +---- + .. _class_Quaternion_method_get_euler: - :ref:`Vector3` **get_euler** **(** **)** |const| @@ -304,84 +329,6 @@ Returns a copy of the quaternion, normalized to unit length. ---- -.. _class_Quaternion_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Quaternion` right **)** |operator| - ----- - -.. _class_Quaternion_method_operator *: - -- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** |operator| - ----- - -- :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** |operator| - ----- - -- :ref:`Quaternion` **operator *** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Quaternion` **operator *** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Quaternion_method_operator +: - -- :ref:`Quaternion` **operator +** **(** :ref:`Quaternion` right **)** |operator| - ----- - -.. _class_Quaternion_method_operator -: - -- :ref:`Quaternion` **operator -** **(** :ref:`Quaternion` right **)** |operator| - ----- - -.. _class_Quaternion_method_operator /: - -- :ref:`Quaternion` **operator /** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Quaternion` **operator /** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Quaternion_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Quaternion` right **)** |operator| - ----- - -.. _class_Quaternion_method_operator []: - -- :ref:`float` **operator []** **(** :ref:`int` index **)** |operator| - ----- - -.. _class_Quaternion_method_operator unary+: - -- :ref:`Quaternion` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Quaternion_method_operator unary-: - -- :ref:`Quaternion` **operator unary-** **(** **)** |operator| - ----- - .. _class_Quaternion_method_slerp: - :ref:`Quaternion` **slerp** **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| @@ -398,6 +345,85 @@ Returns the result of the spherical linear interpolation between this quaternion 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. +Operator Descriptions +--------------------- + +.. _class_Quaternion_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Quaternion` right **)** + +---- + +.. _class_Quaternion_operator_mul_Quaternion: + +- :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** + +---- + +- :ref:`Quaternion` **operator *** **(** :ref:`float` right **)** + +---- + +- :ref:`Quaternion` **operator *** **(** :ref:`int` right **)** + +---- + +.. _class_Quaternion_operator_sum_Quaternion: + +- :ref:`Quaternion` **operator +** **(** :ref:`Quaternion` right **)** + +---- + +.. _class_Quaternion_operator_dif_Quaternion: + +- :ref:`Quaternion` **operator -** **(** :ref:`Quaternion` right **)** + +---- + +.. _class_Quaternion_operator_div_Quaternion: + +- :ref:`Quaternion` **operator /** **(** :ref:`float` right **)** + +---- + +- :ref:`Quaternion` **operator /** **(** :ref:`int` right **)** + +---- + +.. _class_Quaternion_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Quaternion` right **)** + +---- + +.. _class_Quaternion_operator_idx_float: + +- :ref:`float` **operator []** **(** :ref:`int` index **)** + +---- + +.. _class_Quaternion_operator_unplus_Quaternion: + +- :ref:`Quaternion` **operator unary+** **(** **)** + +---- + +.. _class_Quaternion_operator_unminus_Quaternion: + +- :ref:`Quaternion` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index 93a871bda..ce41479b3 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RandomNumberGenerator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_range.rst b/classes/class_range.rst index 9ea08ba89..86bb3d767 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Range.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index fea9be170..2edaa1f2f 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RayCast2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -45,6 +45,8 @@ Properties +-------------------------------+--------------------------------------------------------------------------+--------------------+ | :ref:`bool` | :ref:`exclude_parent` | ``true`` | +-------------------------------+--------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`hit_from_inside` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------+--------------------+ | :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 50)`` | +-------------------------------+--------------------------------------------------------------------------+--------------------+ @@ -162,6 +164,22 @@ If ``true``, the parent node will be excluded from collision detection. ---- +.. _class_RayCast2D_property_hit_from_inside: + +- :ref:`bool` **hit_from_inside** + ++-----------+------------------------------+ +| *Default* | ``false`` | ++-----------+------------------------------+ +| *Setter* | set_hit_from_inside(value) | ++-----------+------------------------------+ +| *Getter* | 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. + +---- + .. _class_RayCast2D_property_target_position: - :ref:`Vector2` **target_position** @@ -241,7 +259,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal** **(** **)** |const| -Returns the normal of the intersecting object's shape at the collision point. +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``. ---- diff --git a/classes/class_raycast3d.rst b/classes/class_raycast3d.rst index 2c00f927e..48eab2de1 100644 --- a/classes/class_raycast3d.rst +++ b/classes/class_raycast3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RayCast3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -51,6 +51,8 @@ Properties +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`exclude_parent` | ``true`` | +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`hit_from_inside` | ``false`` | ++-------------------------------+------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, -1, 0)`` | +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ @@ -202,6 +204,22 @@ If ``true``, collisions will be ignored for this RayCast3D's immediate parent. ---- +.. _class_RayCast3D_property_hit_from_inside: + +- :ref:`bool` **hit_from_inside** + ++-----------+------------------------------+ +| *Default* | ``false`` | ++-----------+------------------------------+ +| *Setter* | set_hit_from_inside(value) | ++-----------+------------------------------+ +| *Getter* | 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. + +---- + .. _class_RayCast3D_property_target_position: - :ref:`Vector3` **target_position** @@ -283,7 +301,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal** **(** **)** |const| -Returns the normal of the intersecting object's shape at the collision point. +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``. ---- diff --git a/classes/class_rdattachmentformat.rst b/classes/class_rdattachmentformat.rst index 78f6c618b..b4e9e5fb7 100644 --- a/classes/class_rdattachmentformat.rst +++ b/classes/class_rdattachmentformat.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDAttachmentFormat.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdframebufferpass.rst b/classes/class_rdframebufferpass.rst index 7202b6754..2f08003c4 100644 --- a/classes/class_rdframebufferpass.rst +++ b/classes/class_rdframebufferpass.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDFramebufferPass.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdpipelinecolorblendstate.rst b/classes/class_rdpipelinecolorblendstate.rst index 2f72f2ee6..f99ab4890 100644 --- a/classes/class_rdpipelinecolorblendstate.rst +++ b/classes/class_rdpipelinecolorblendstate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDPipelineColorBlendState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdpipelinecolorblendstateattachment.rst b/classes/class_rdpipelinecolorblendstateattachment.rst index 1404dfb07..231268e19 100644 --- a/classes/class_rdpipelinecolorblendstateattachment.rst +++ b/classes/class_rdpipelinecolorblendstateattachment.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDPipelineColorBlendStateAttachment.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdpipelinedepthstencilstate.rst b/classes/class_rdpipelinedepthstencilstate.rst index 70f9eef9a..ae7f05e53 100644 --- a/classes/class_rdpipelinedepthstencilstate.rst +++ b/classes/class_rdpipelinedepthstencilstate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDPipelineDepthStencilState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdpipelinemultisamplestate.rst b/classes/class_rdpipelinemultisamplestate.rst index bf82f271f..8ee6b6189 100644 --- a/classes/class_rdpipelinemultisamplestate.rst +++ b/classes/class_rdpipelinemultisamplestate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDPipelineMultisampleState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdpipelinerasterizationstate.rst b/classes/class_rdpipelinerasterizationstate.rst index c1f695d79..bb31cf333 100644 --- a/classes/class_rdpipelinerasterizationstate.rst +++ b/classes/class_rdpipelinerasterizationstate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDPipelineRasterizationState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdpipelinespecializationconstant.rst b/classes/class_rdpipelinespecializationconstant.rst index eb06e6b28..e7fbe9a76 100644 --- a/classes/class_rdpipelinespecializationconstant.rst +++ b/classes/class_rdpipelinespecializationconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDPipelineSpecializationConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdsamplerstate.rst b/classes/class_rdsamplerstate.rst index 3a6850f42..46c322421 100644 --- a/classes/class_rdsamplerstate.rst +++ b/classes/class_rdsamplerstate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDSamplerState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdshaderfile.rst b/classes/class_rdshaderfile.rst index d3d975ee5..8a2824663 100644 --- a/classes/class_rdshaderfile.rst +++ b/classes/class_rdshaderfile.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDShaderFile.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdshadersource.rst b/classes/class_rdshadersource.rst index 766c84506..3ad113b19 100644 --- a/classes/class_rdshadersource.rst +++ b/classes/class_rdshadersource.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDShaderSource.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdshaderspirv.rst b/classes/class_rdshaderspirv.rst index 5c050b8a6..1fd4f295d 100644 --- a/classes/class_rdshaderspirv.rst +++ b/classes/class_rdshaderspirv.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDShaderSPIRV.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdtextureformat.rst b/classes/class_rdtextureformat.rst index b21e982b9..ccbfc3ac3 100644 --- a/classes/class_rdtextureformat.rst +++ b/classes/class_rdtextureformat.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDTextureFormat.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdtextureview.rst b/classes/class_rdtextureview.rst index eac782e3c..36b388753 100644 --- a/classes/class_rdtextureview.rst +++ b/classes/class_rdtextureview.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDTextureView.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rduniform.rst b/classes/class_rduniform.rst index ef4e0a77e..c87c8b5ba 100644 --- a/classes/class_rduniform.rst +++ b/classes/class_rduniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rdvertexattribute.rst b/classes/class_rdvertexattribute.rst index 0cb5ba671..d5f5ab486 100644 --- a/classes/class_rdvertexattribute.rst +++ b/classes/class_rdvertexattribute.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RDVertexAttribute.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index b927073ce..44d772aef 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Rect2.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -40,19 +40,24 @@ Properties | :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ +Constructors +------------ + ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2` from **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2i` from **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** |constructor| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`abs` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,16 +87,21 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Rect2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | **operator *** **(** :ref:`Transform2D` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Rect2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++---------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Rect2` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Rect2` right **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -132,40 +142,41 @@ Size from :ref:`position` to :ref:`end` to fix it. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Rect2_method_Rect2: +.. _class_Rect2_constructor_Rect2: -- :ref:`Rect2` **Rect2** **(** **)** |constructor| +- :ref:`Rect2` **Rect2** **(** **)** Constructs a default-initialized ``Rect2`` with default (zero) values of :ref:`position` and :ref:`size`. ---- -- :ref:`Rect2` **Rect2** **(** :ref:`Rect2` from **)** |constructor| +- :ref:`Rect2` **Rect2** **(** :ref:`Rect2` from **)** Constructs a ``Rect2`` as a copy of the given ``Rect2``. ---- -- :ref:`Rect2` **Rect2** **(** :ref:`Rect2i` from **)** |constructor| +- :ref:`Rect2` **Rect2** **(** :ref:`Rect2i` from **)** Constructs a ``Rect2`` from a :ref:`Rect2i`. ---- -- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** |constructor| +- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a ``Rect2`` by position and size. ---- -- :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** |constructor| +- :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Constructs a ``Rect2`` by x, y, width, and height. ----- +Method Descriptions +------------------- .. _class_Rect2_method_abs: @@ -187,7 +198,28 @@ Returns ``true`` if this ``Rect2`` completely encloses another one. - :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** |const| -Returns this ``Rect2`` expanded to include a given point. +Returns a copy of this ``Rect2`` expanded to include a given point. + +**Example:** + + +.. tabs:: + + .. code-tab:: gdscript + + # position (-3, 2), size (1, 1) + var rect = Rect2(Vector2(-3, 2), Vector2(1, 1)) + # position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1) + var rect2 = rect.expand(Vector2(0, -1)) + + .. code-tab:: csharp + + # position (-3, 2), size (1, 1) + var rect = new Rect2(new Vector2(-3, 2), new Vector2(1, 1)); + # position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1) + var rect2 = rect.Expand(new Vector2(0, -1)); + + ---- @@ -243,7 +275,9 @@ Returns ``true`` if the ``Rect2`` is flat or empty. - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** |const| -Returns ``true`` if the ``Rect2`` contains a point. +Returns ``true`` if the ``Rect2`` contains a point. By convention, the right and bottom edges of the ``Rect2`` are considered exclusive, so points on these edges are **not** included. + +**Note:** This method is not reliable for ``Rect2`` with a *negative size*. Use :ref:`abs` to get a positive sized equivalent rectangle to check for contained points. ---- @@ -281,31 +315,32 @@ Returns ``true`` if this ``Rect2`` and ``rect`` are approximately equal, by call Returns a larger ``Rect2`` that contains this ``Rect2`` and ``b``. ----- +Operator Descriptions +--------------------- -.. _class_Rect2_method_operator !=: +.. _class_Rect2_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`Rect2` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`Rect2` right **)** ---- -.. _class_Rect2_method_operator *: +.. _class_Rect2_operator_mul_Rect2: -- :ref:`Rect2` **operator *** **(** :ref:`Transform2D` right **)** |operator| +- :ref:`Rect2` **operator *** **(** :ref:`Transform2D` right **)** ---- -.. _class_Rect2_method_operator ==: +.. _class_Rect2_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`Rect2` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`Rect2` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index fe97f6fe3..e45fe48a9 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Rect2i.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -36,19 +36,24 @@ Properties | :ref:`Vector2i` | :ref:`size` | ``Vector2i(0, 0)`` | +---------------------------------+-------------------------------------------------+--------------------+ +Constructors +------------ + ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`Rect2i` **(** **)** |constructor| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Rect2i` from **)** |constructor| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Rect2` from **)** |constructor| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Vector2i` position, :ref:`Vector2i` size **)** |constructor| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** |constructor| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2i` | :ref:`abs` **(** **)** |const| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -76,14 +81,19 @@ Methods +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2i` | :ref:`merge` **(** :ref:`Rect2i` b **)** |const| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Rect2i` right **)** |operator| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Rect2i` right **)** |operator| | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Rect2i` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Rect2i` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -124,40 +134,41 @@ Size from :ref:`position` to :ref:`end` to fix it. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Rect2i_method_Rect2i: +.. _class_Rect2i_constructor_Rect2i: -- :ref:`Rect2i` **Rect2i** **(** **)** |constructor| +- :ref:`Rect2i` **Rect2i** **(** **)** Constructs a default-initialized ``Rect2i`` with default (zero) values of :ref:`position` and :ref:`size`. ---- -- :ref:`Rect2i` **Rect2i** **(** :ref:`Rect2i` from **)** |constructor| +- :ref:`Rect2i` **Rect2i** **(** :ref:`Rect2i` from **)** Constructs a ``Rect2i`` as a copy of the given ``Rect2i``. ---- -- :ref:`Rect2i` **Rect2i** **(** :ref:`Rect2` from **)** |constructor| +- :ref:`Rect2i` **Rect2i** **(** :ref:`Rect2` from **)** Constructs a new ``Rect2i`` from :ref:`Rect2`. The floating point coordinates will be truncated. ---- -- :ref:`Rect2i` **Rect2i** **(** :ref:`Vector2i` position, :ref:`Vector2i` size **)** |constructor| +- :ref:`Rect2i` **Rect2i** **(** :ref:`Vector2i` position, :ref:`Vector2i` size **)** Constructs a ``Rect2i`` by position and size. ---- -- :ref:`Rect2i` **Rect2i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** |constructor| +- :ref:`Rect2i` **Rect2i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** Constructs a ``Rect2i`` by x, y, width, and height. ----- +Method Descriptions +------------------- .. _class_Rect2i_method_abs: @@ -179,7 +190,26 @@ Returns ``true`` if this ``Rect2i`` completely encloses another one. - :ref:`Rect2i` **expand** **(** :ref:`Vector2i` to **)** |const| -Returns this ``Rect2i`` expanded to include a given point. +Returns a copy of this ``Rect2i`` expanded to include a given point. + + +.. tabs:: + + .. code-tab:: gdscript + + # position (-3, 2), size (1, 1) + var rect = Rect2i(Vector2i(-3, 2), Vector2i(1, 1)) + # position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1) + var rect2 = rect.expand(Vector2i(0, -1)) + + .. code-tab:: csharp + + # position (-3, 2), size (1, 1) + var rect = new Rect2i(new Vector2i(-3, 2), new Vector2i(1, 1)); + # position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1) + var rect2 = rect.Expand(new Vector2i(0, -1)); + + ---- @@ -237,7 +267,9 @@ Returns ``true`` if the ``Rect2i`` is flat or empty. - :ref:`bool` **has_point** **(** :ref:`Vector2i` point **)** |const| -Returns ``true`` if the ``Rect2i`` contains a point. +Returns ``true`` if the ``Rect2i`` contains a point. By convention, the right and bottom edges of the ``Rect2i`` are considered exclusive, so points on these edges are **not** included. + +**Note:** This method is not reliable for ``Rect2i`` with a *negative size*. Use :ref:`abs` to get a positive sized equivalent rectangle to check for contained points. ---- @@ -267,25 +299,26 @@ If ``include_borders`` is ``true``, they will also be considered overlapping if Returns a larger ``Rect2i`` that contains this ``Rect2i`` and ``b``. ----- +Operator Descriptions +--------------------- -.. _class_Rect2i_method_operator !=: +.. _class_Rect2i_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`Rect2i` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`Rect2i` right **)** ---- -.. _class_Rect2i_method_operator ==: +.. _class_Rect2i_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`Rect2i` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`Rect2i` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 92a8f9f1f..849f4e5cb 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RectangleShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 0b1c61cc7..92df14e54 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RefCounted.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`Directory`, :ref:`ENetConnection`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`GDNative`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSON`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`Node3DGizmo`, :ref:`OGGPacketSequencePlayback`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :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:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :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:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VelocityTracker3D`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPositionalTracker` +**Inherited By:** :ref:`AESContext`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`Directory`, :ref:`ENetConnection`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`GDNative`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSON`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`Node3DGizmo`, :ref:`OGGPacketSequencePlayback`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :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:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :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:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VelocityTracker3D`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker` Base class for reference-counted objects. @@ -20,11 +20,11 @@ Description Base class for any object that keeps a reference count. :ref:`Resource` and many other helper objects inherit this class. -Unlike other :ref:`Object` types, References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with :ref:`Object.free`. +Unlike other :ref:`Object` types, ``RefCounted``\ s keep an internal reference counter so that they are automatically released when no longer in use, and only then. ``RefCounted``\ s therefore do not need to be freed manually with :ref:`Object.free`. In the vast majority of use cases, instantiating and using ``RefCounted``-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused. -**Note:** In C#, references will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free references that are no longer in use. This means that unused references will linger on for a while before being removed. +**Note:** In C#, reference-counted objects will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free reference-counted objects that are no longer in use. This means that unused ones will linger on for a while before being removed. Tutorials --------- diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 03a95a7f7..d3d56de6b 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ReferenceRect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 69d5d57a2..f569d5307 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ReflectionProbe.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_regex.rst b/classes/class_regex.rst index c31bb2f40..4180446ff 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RegEx.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index bd0d82dba..5d9c1501c 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RegExMatch.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index d0aaaad96..5073072b4 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RemoteTransform2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_remotetransform3d.rst b/classes/class_remotetransform3d.rst index bb01dc9d3..e2e93ef10 100644 --- a/classes/class_remotetransform3d.rst +++ b/classes/class_remotetransform3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RemoteTransform3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index c5e85b59b..44f2c1dab 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RenderingDevice.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -121,7 +121,7 @@ Methods +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame_delay` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_memory_usage` **(** :ref:`MemoryType` arg0 **)** |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 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2555,7 +2555,7 @@ Method Descriptions .. _class_RenderingDevice_method_get_memory_usage: -- :ref:`int` **get_memory_usage** **(** :ref:`MemoryType` arg0 **)** |const| +- :ref:`int` **get_memory_usage** **(** :ref:`MemoryType` type **)** |const| ---- diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index d459a9db5..b575f5ead 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RenderingServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -49,859 +49,871 @@ Properties Methods ------- -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image[]` | :ref:`bake_render_uv2` **(** :ref:`RID` base, :ref:`Array` material_overrides, :ref:`Vector2i` image_size **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_effects_create` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_custom_exposure` **(** :ref:`RID` camera_effects, :ref:`bool` enable, :ref:`float` exposure **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_dof_blur` **(** :ref:`RID` camera_effects, :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_effects_set_dof_blur_bokeh_shape` **(** :ref:`DOFBokehShape` shape **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_dof_blur_quality` **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_camera_effects` **(** :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_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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, :ref:`float` width=1.0 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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, :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_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_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:`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_extents` **(** :ref:`RID` decal, :ref:`Vector3` extents **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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_shadow_quality_set` **(** :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_glow_set_use_high_quality` **(** :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, :ref:`Color` ao_color=Color(0, 0, 0, 1) **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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` energy **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sdfgi` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`EnvironmentSDFGICascades` 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_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, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_volumetric_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` light, :ref:`float` light_energy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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:`RID` | :ref:`get_test_cube` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_variable_add` **(** :ref:`StringName` name, :ref:`GlobalVariableType` type, :ref:`Variant` default_value **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`global_variable_get` **(** :ref:`StringName` name **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`global_variable_get_list` **(** **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GlobalVariableType` | :ref:`global_variable_get_type` **(** :ref:`StringName` name **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_variable_remove` **(** :ref:`StringName` name **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_variable_set` **(** :ref:`StringName` name, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_variable_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:`Array` | :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_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_visibility_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |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_only` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_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={ }, :ref:`int` 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` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_skin_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride` **(** :ref:`int` 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:`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_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` setrngth **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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_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_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 **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_lod_threshold` **(** :ref:`RID` probe, :ref:`float` pixels **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_resolution` **(** :ref:`RID` probe, :ref:`int` resolution **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`StringName` method, :ref:`Variant` userdata **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_camera_effects` **(** :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_param` **(** :ref:`RID` shader, :ref:`StringName` param **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shader_get_param_default` **(** :ref:`RID` shader, :ref:`StringName` param **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary[]` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`RID` texture **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shadows_quality_set` **(** :ref:`ShadowQuality` quality **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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_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_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_measure_render_time` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa` **(** :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_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scale_3d` **(** :ref:`RID` viewport, :ref:`ViewportScale3D` 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_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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_occlusion_culling` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_xr` **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_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:`Image[]` | :ref:`bake_render_uv2` **(** :ref:`RID` base, :ref:`Array` material_overrides, :ref:`Vector2i` image_size **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_create` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_effects_create` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_effects_set_custom_exposure` **(** :ref:`RID` camera_effects, :ref:`bool` enable, :ref:`float` exposure **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_effects_set_dof_blur` **(** :ref:`RID` camera_effects, :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_effects_set_dof_blur_bokeh_shape` **(** :ref:`DOFBokehShape` shape **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_effects_set_dof_blur_quality` **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_camera_effects` **(** :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_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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, :ref:`float` width=1.0 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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, :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_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_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:`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_extents` **(** :ref:`RID` decal, :ref:`Vector3` extents **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_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_shadow_quality_set` **(** :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_glow_set_use_high_quality` **(** :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` energy **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sdfgi` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`EnvironmentSDFGICascades` 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_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, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_extents` **(** :ref:`RID` fog_volume, :ref:`Vector3` extents **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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:`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:`RID` | :ref:`get_test_cube` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_variable_add` **(** :ref:`StringName` name, :ref:`GlobalVariableType` type, :ref:`Variant` default_value **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`global_variable_get` **(** :ref:`StringName` name **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`global_variable_get_list` **(** **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GlobalVariableType` | :ref:`global_variable_get_type` **(** :ref:`StringName` name **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_variable_remove` **(** :ref:`StringName` name **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_variable_set` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_variable_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:`Array` | :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_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_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:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |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_only` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_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={ }, :ref:`int` 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` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_skin_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride` **(** :ref:`int` 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:`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_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` setrngth **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_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_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_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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_lod_threshold` **(** :ref:`RID` probe, :ref:`float` pixels **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_resolution` **(** :ref:`RID` probe, :ref:`int` resolution **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_effects` **(** :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_param` **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`int` index=0 **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shader_get_param_default` **(** :ref:`RID` shader, :ref:`StringName` param **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary[]` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`RID` texture, :ref:`int` index=0 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shadows_quality_set` **(** :ref:`ShadowQuality` quality **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_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_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_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_measure_render_time` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa` **(** :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_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scale_3d` **(** :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_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_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_occlusion_culling` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_xr` **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_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 **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -981,6 +993,8 @@ enum **CubeMapLayer**: .. _class_RenderingServer_constant_SHADER_SKY: +.. _class_RenderingServer_constant_SHADER_FOG: + .. _class_RenderingServer_constant_SHADER_MAX: enum **ShaderMode**: @@ -993,7 +1007,9 @@ enum **ShaderMode**: - **SHADER_SKY** = **3** --- Shader is a sky shader. -- **SHADER_MAX** = **4** --- Represents the size of the :ref:`ShaderMode` enum. +- **SHADER_FOG** = **4** --- Shader is a fog shader. + +- **SHADER_MAX** = **5** --- Represents the size of the :ref:`ShaderMode` enum. ---- @@ -1449,6 +1465,8 @@ enum **LightDirectionalShadowMode**: .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD: +.. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW: + .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW: .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM: @@ -1461,17 +1479,21 @@ enum **LightDirectionalShadowMode**: enum **ShadowQuality**: -- **SHADOW_QUALITY_HARD** = **0** +- **SHADOW_QUALITY_HARD** = **0** --- Lowest shadow filtering quality (fastest). Soft shadows are not available with this quality setting, which means the :ref:`Light3D.shadow_blur` property is ignored if :ref:`Light3D.light_size` and :ref:`Light3D.light_angular_distance` is ``0.0``. -- **SHADOW_QUALITY_SOFT_LOW** = **1** +**Note:** The variable shadow blur performed by :ref:`Light3D.light_size` and :ref:`Light3D.light_angular_distance` is still effective when using hard shadow filtering. In this case, :ref:`Light3D.shadow_blur` *is* taken into account. However, the results will not be blurred, instead the blur amount is treated as a maximum radius for the penumbra. -- **SHADOW_QUALITY_SOFT_MEDIUM** = **2** +- **SHADOW_QUALITY_SOFT_VERY_LOW** = **1** --- Very low shadow filtering quality (faster). When using this quality setting, :ref:`Light3D.shadow_blur` is automatically multiplied by 0.75× to avoid introducing too much noise. This division only applies to lights whose :ref:`Light3D.light_size` or :ref:`Light3D.light_angular_distance` is ``0.0``). -- **SHADOW_QUALITY_SOFT_HIGH** = **3** +- **SHADOW_QUALITY_SOFT_LOW** = **2** --- Low shadow filtering quality (fast). -- **SHADOW_QUALITY_SOFT_ULTRA** = **4** +- **SHADOW_QUALITY_SOFT_MEDIUM** = **3** --- Medium low shadow filtering quality (average). -- **SHADOW_QUALITY_MAX** = **5** +- **SHADOW_QUALITY_SOFT_HIGH** = **4** --- High low shadow filtering quality (slow). When using this quality setting, :ref:`Light3D.shadow_blur` is automatically multiplied by 1.5× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose :ref:`Light3D.light_size` or :ref:`Light3D.light_angular_distance` is ``0.0``). + +- **SHADOW_QUALITY_SOFT_ULTRA** = **5** --- Highest low shadow filtering quality (slowest). When using this quality setting, :ref:`Light3D.shadow_blur` is automatically multiplied by 2× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose :ref:`Light3D.light_size` or :ref:`Light3D.light_angular_distance` is ``0.0``). + +- **SHADOW_QUALITY_MAX** = **6** ---- @@ -1699,6 +1721,24 @@ enum **ParticlesCollisionHeightfieldResolution**: ---- +.. _enum_RenderingServer_FogVolumeShape: + +.. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID: + +.. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX: + +.. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD: + +enum **FogVolumeShape**: + +- **FOG_VOLUME_SHAPE_ELLIPSOID** = **0** --- :ref:`FogVolume` will be shaped like an ellipsoid. + +- **FOG_VOLUME_SHAPE_BOX** = **1** --- :ref:`FogVolume` will be shaped like a box. + +- **FOG_VOLUME_SHAPE_WORLD** = **2** --- :ref:`FogVolume` will have no shape, will cover the whole world and will not be culled. + +---- + .. _enum_RenderingServer_ViewportUpdateMode: .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED: @@ -1997,32 +2037,6 @@ enum **ViewportDebugDraw**: ---- -.. _enum_RenderingServer_ViewportScale3D: - -.. _class_RenderingServer_constant_VIEWPORT_SCALE_3D_DISABLED: - -.. _class_RenderingServer_constant_VIEWPORT_SCALE_3D_75_PERCENT: - -.. _class_RenderingServer_constant_VIEWPORT_SCALE_3D_50_PERCENT: - -.. _class_RenderingServer_constant_VIEWPORT_SCALE_3D_33_PERCENT: - -.. _class_RenderingServer_constant_VIEWPORT_SCALE_3D_25_PERCENT: - -enum **ViewportScale3D**: - -- **VIEWPORT_SCALE_3D_DISABLED** = **0** - -- **VIEWPORT_SCALE_3D_75_PERCENT** = **1** - -- **VIEWPORT_SCALE_3D_50_PERCENT** = **2** - -- **VIEWPORT_SCALE_3D_33_PERCENT** = **3** - -- **VIEWPORT_SCALE_3D_25_PERCENT** = **4** - ----- - .. _enum_RenderingServer_SkyMode: .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC: @@ -2443,6 +2457,8 @@ enum **DOFBlurQuality**: .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER: +.. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME: + .. _class_RenderingServer_constant_INSTANCE_MAX: .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK: @@ -2473,7 +2489,9 @@ enum **InstanceType**: - **INSTANCE_VISIBLITY_NOTIFIER** = **11** -- **INSTANCE_MAX** = **12** --- Represents the size of the :ref:`InstanceType` enum. +- **INSTANCE_FOG_VOLUME** = **12** + +- **INSTANCE_MAX** = **13** --- Represents the size of the :ref:`InstanceType` enum. - **INSTANCE_GEOMETRY_MASK** = **14** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). @@ -2527,6 +2545,24 @@ enum **ShadowCastingSetting**: ---- +.. _enum_RenderingServer_VisibilityRangeFadeMode: + +.. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED: + +.. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF: + +.. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES: + +enum **VisibilityRangeFadeMode**: + +- **VISIBILITY_RANGE_FADE_DISABLED** = **0** --- Disable visibility range fading for the given instance. + +- **VISIBILITY_RANGE_FADE_SELF** = **1** --- Fade-out the given instance when it approaches its visibility range limits. + +- **VISIBILITY_RANGE_FADE_DEPENDENCIES** = **2** --- Fade-in the given instance's dependencies when reaching its visibility range limits. + +---- + .. _enum_RenderingServer_BakeChannels: .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA: @@ -3778,7 +3814,7 @@ Sets the values to be used with the "Adjustment" post-process effect. See :ref:` .. _class_RenderingServer_method_environment_set_ambient_light: -- 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, :ref:`Color` ao_color=Color(0, 0, 0, 1) **)** +- 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 **)** ---- @@ -3912,7 +3948,7 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` .. _class_RenderingServer_method_environment_set_volumetric_fog: -- void **environment_set_volumetric_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` light, :ref:`float` light_energy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount **)** +- 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 **)** ---- @@ -3920,12 +3956,48 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` - void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool` active **)** +Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. + ---- .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size: - void **environment_set_volumetric_fog_volume_size** **(** :ref:`int` size, :ref:`int` depth **)** +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. + +---- + +.. _class_RenderingServer_method_fog_volume_create: + +- :ref:`RID` **fog_volume_create** **(** **)** + +Creates a new fog volume and allocates an RID. + +---- + +.. _class_RenderingServer_method_fog_volume_set_extents: + +- void **fog_volume_set_extents** **(** :ref:`RID` fog_volume, :ref:`Vector3` extents **)** + +Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID` or :ref:`FOG_VOLUME_SHAPE_BOX`. + +---- + +.. _class_RenderingServer_method_fog_volume_set_material: + +- void **fog_volume_set_material** **(** :ref:`RID` fog_volume, :ref:`RID` material **)** + +Sets the :ref:`Material` of the fog volume. Can be either a :ref:`FogMaterial` or a custom :ref:`ShaderMaterial`. + +---- + +.. _class_RenderingServer_method_fog_volume_set_shape: + +- void **fog_volume_set_shape** **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** + +Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_BOX`, or :ref:`FOG_VOLUME_SHAPE_ELLIPSOID` or :ref:`FOG_VOLUME_SHAPE_WORLD`. + ---- .. _class_RenderingServer_method_force_draw: @@ -4174,9 +4246,17 @@ Sets a material that will override the material for all surfaces on the mesh ass ---- +.. _class_RenderingServer_method_instance_geometry_set_transparency: + +- void **instance_geometry_set_transparency** **(** :ref:`RID` instance, :ref:`float` transparency **)** + +Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency`. + +---- + .. _class_RenderingServer_method_instance_geometry_set_visibility_range: -- void **instance_geometry_set_visibility_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** +- 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 **)** Sets the visibility range values for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.visibility_range_begin` and related properties. @@ -4214,6 +4294,12 @@ Sets a margin to increase the size of the AABB when culling objects from the vie ---- +.. _class_RenderingServer_method_instance_set_ignore_culling: + +- void **instance_set_ignore_culling** **(** :ref:`RID` instance, :ref:`bool` enabled **)** + +---- + .. _class_RenderingServer_method_instance_set_layer_mask: - void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** @@ -5282,11 +5368,9 @@ Sets how often the reflection probe updates. Can either be once or every frame. .. _class_RenderingServer_method_request_frame_drawn_callback: -- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`StringName` method, :ref:`Variant` userdata **)** +- void **request_frame_drawn_callback** **(** :ref:`Callable` callable **)** -Schedules a callback to the corresponding named ``method`` on ``where`` after a frame has been drawn. - -The callback method must use only 1 argument which will be called with ``userdata``. +Schedules a callback to the given callable after a frame has been drawn. ---- @@ -5374,10 +5458,12 @@ Returns a shader's code. .. _class_RenderingServer_method_shader_get_default_texture_param: -- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` param **)** |const| +- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`int` index=0 **)** |const| Returns a default texture from a shader searched by name. +**Note:** If the sampler array is used use ``index`` to access the specified texture. + ---- .. _class_RenderingServer_method_shader_get_param_default: @@ -5396,10 +5482,12 @@ Returns the parameters of a shader. .. _class_RenderingServer_method_shader_set_default_texture_param: -- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`RID` texture **)** +- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`RID` texture, :ref:`int` index=0 **)** Sets a shader's default texture. Overwrites the texture given by name. +**Note:** If the sampler array is used use ``index`` to access the specified texture. + ---- .. _class_RenderingServer_method_shadows_quality_set: @@ -5851,7 +5939,7 @@ If ``true``, render the contents of the viewport directly to screen. This allows .. _class_RenderingServer_method_viewport_set_scale_3d: -- void **viewport_set_scale_3d** **(** :ref:`RID` viewport, :ref:`ViewportScale3D` scale **)** +- void **viewport_set_scale_3d** **(** :ref:`RID` viewport, :ref:`float` scale **)** Sets the scale at which we render 3D contents. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 695e7f091..f2972b936 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Resource.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CameraEffects`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`FontData`, :ref:`GDNativeLibrary`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NativeExtension`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OGGPacketSequence`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`Script`, :ref:`Shader`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModification3D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonModificationStack3D`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CameraEffects`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`FontData`, :ref:`GDNativeLibrary`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NativeExtension`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OGGPacketSequence`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`Script`, :ref:`Shader`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModification3D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonModificationStack3D`, :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:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for all resources. diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 2c78514eb..28d89f478 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourceFormatLoader.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index a99ea1b7b..058166ea7 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourceFormatSaver.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index bbb662c43..bf91800ef 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourceImporter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 43cbcc57a..676b0f2f7 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourceLoader.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 7cf0dbead..0e888ad2e 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourcePreloader.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index ce01c2c8a..7b6938832 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourceSaver.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_resourceuid.rst b/classes/class_resourceuid.rst index 8e0390e7a..3ae03da07 100644 --- a/classes/class_resourceuid.rst +++ b/classes/class_resourceuid.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ResourceUID.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_ribbontrailmesh.rst b/classes/class_ribbontrailmesh.rst index 704744896..7720f8676 100644 --- a/classes/class_ribbontrailmesh.rst +++ b/classes/class_ribbontrailmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RibbonTrailMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index 980474a59..d83e95849 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RichTextEffect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 44d1335bb..b0fe4fe7f 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RichTextLabel.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -43,6 +43,8 @@ Properties +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------------------+ | :ref:`Array` | :ref:`custom_effects` | ``[]`` | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------------------+ +| :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------------------+ | :ref:`bool` | :ref:`fit_content_height` | ``false`` | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------------------+ | :ref:`String` | :ref:`language` | ``""`` | @@ -77,107 +79,107 @@ Properties Methods ------- -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlign` inline_align=5 **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_text` **(** :ref:`String` text **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`append_text` **(** :ref:`String` bbcode **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_content_height` **(** **)** |const| | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** |const| | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_paragraph_count` **(** **)** |const| | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_paragraph_count` **(** **)** |const| | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`newline` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PackedStringArray` expressions **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_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 **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font_features` **(** :ref:`Dictionary` opentype_features **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font_size` **(** :ref:`int` font_size **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_indent` **(** :ref:`int` level **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_italics` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`Align` align, :ref:`TextDirection` base_direction=0, :ref:`String` language="", :ref:`StructuredTextParser` st_parser=0 **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_strikethrough` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_table` **(** :ref:`int` columns, :ref:`InlineAlign` inline_align=0 **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_underline` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scroll_to_paragraph` **(** :ref:`int` paragraph **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_image` **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlign` inline_align=5 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_text` **(** :ref:`String` text **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_text` **(** :ref:`String` bbcode **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_content_height` **(** **)** |const| | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** |const| | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_paragraph_count` **(** **)** |const| | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_paragraph_count` **(** **)** |const| | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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_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 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_font_features` **(** :ref:`Dictionary` opentype_features **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_font_size` **(** :ref:`int` font_size **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_indent` **(** :ref:`int` level **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_italics` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`Align` align, :ref:`TextDirection` base_direction=0, :ref:`String` language="", :ref:`StructuredTextParser` st_parser=0 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_strikethrough` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_table` **(** :ref:`int` columns, :ref:`InlineAlign` inline_align=0 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_underline` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scroll_to_paragraph` **(** :ref:`int` paragraph **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -221,12 +223,12 @@ Theme Properties +---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`Color` | :ref:`selection_color` | ``Color(0.1, 0.1, 1, 0.8)`` | +---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ -| :ref:`int` | :ref:`shadow_as_outline` | ``0`` | -+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`int` | :ref:`shadow_offset_x` | ``1`` | +---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`int` | :ref:`shadow_offset_y` | ``1`` | +---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ +| :ref:`int` | :ref:`shadow_outline_size` | ``1`` | ++---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`Color` | :ref:`table_border` | ``Color(0, 0, 0, 0)`` | +---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`Color` | :ref:`table_even_row_bg` | ``Color(0, 0, 0, 0)`` | @@ -455,6 +457,22 @@ To add a custom effect, it's more convenient to use :ref:`install_effect` **deselect_on_focus_loss_enabled** + ++-----------+-------------------------------------------+ +| *Default* | ``true`` | ++-----------+-------------------------------------------+ +| *Setter* | set_deselect_on_focus_loss_enabled(value) | ++-----------+-------------------------------------------+ +| *Getter* | is_deselect_on_focus_loss_enabled() | ++-----------+-------------------------------------------+ + +If ``true``, the selected text will be deselected when focus is lost. + +---- + .. _class_RichTextLabel_property_fit_content_height: - :ref:`bool` **fit_content_height** @@ -708,9 +726,9 @@ Adds raw non-BBCode-parsed text to the tag stack. .. _class_RichTextLabel_method_append_text: -- :ref:`Error` **append_text** **(** :ref:`String` bbcode **)** +- void **append_text** **(** :ref:`String` bbcode **)** -Parses ``bbcode`` and adds tags to the tag stack as needed. Returns the result of the parsing, :ref:`@GlobalScope.OK` if successful. +Parses ``bbcode`` and adds tags to the tag stack as needed. **Note:** Using this method, you can't close a tag that was opened in a previous :ref:`append_text` call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the :ref:`text` instead of using :ref:`append_text`. @@ -794,6 +812,8 @@ Returns the total number of characters from text tags. Does not include BBCodes. Returns the vertical scrollbar. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_RichTextLabel_method_get_visible_line_count: @@ -830,9 +850,9 @@ Adds a newline tag to the tag stack. .. _class_RichTextLabel_method_parse_bbcode: -- :ref:`Error` **parse_bbcode** **(** :ref:`String` bbcode **)** +- void **parse_bbcode** **(** :ref:`String` bbcode **)** -The assignment version of :ref:`append_text`. Clears the tag stack and inserts the new content. Returns :ref:`@GlobalScope.OK` if parses ``bbcode`` successfully. +The assignment version of :ref:`append_text`. Clears the tag stack and inserts the new content. ---- @@ -1279,18 +1299,6 @@ The color of the selection box. ---- -.. _class_RichTextLabel_theme_constant_shadow_as_outline: - -- :ref:`int` **shadow_as_outline** - -+-----------+-------+ -| *Default* | ``0`` | -+-----------+-------+ - -Boolean value. If 1 (``true``), the shadow will be displayed around the whole text as an outline. - ----- - .. _class_RichTextLabel_theme_constant_shadow_offset_x: - :ref:`int` **shadow_offset_x** @@ -1315,6 +1323,18 @@ The vertical offset of the font's shadow. ---- +.. _class_RichTextLabel_theme_constant_shadow_outline_size: + +- :ref:`int` **shadow_outline_size** + ++-----------+-------+ +| *Default* | ``1`` | ++-----------+-------+ + +The size of the shadow outline. + +---- + .. _class_RichTextLabel_theme_color_table_border: - :ref:`Color` **table_border** diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 9a927c3c0..644af0001 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RID.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,49 +16,60 @@ Description The RID type is used to access the unique integer ID of a resource. They are opaque, which means they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as :ref:`RenderingServer`. +Constructors +------------ + ++-----------------------+------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`RID` **(** **)** | ++-----------------------+------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`RID` **(** :ref:`RID` from **)** | ++-----------------------+------------------------------------------------------------------------------+ + Methods ------- -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`RID` **(** **)** |constructor| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`RID` **(** :ref:`RID` from **)** |constructor| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** |const| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`RID` right **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`RID` right **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`RID` right **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`RID` right **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`RID` right **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`RID` right **)** |operator| | -+-------------------------+---------------------------------------------------------------------------------------+ ++-----------------------+------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** |const| | ++-----------------------+------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_RID_method_RID: ++-------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+-----------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator ==` **(** :ref:`RID` right **)** | ++-------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator >` **(** :ref:`RID` right **)** | ++-------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator >=` **(** :ref:`RID` right **)** | ++-------------------------+-----------------------------------------------------------------------------------------+ -- :ref:`RID` **RID** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_RID_constructor_RID: + +- :ref:`RID` **RID** **(** **)** Constructs an empty ``RID`` with the invalid ID ``0``. ---- -- :ref:`RID` **RID** **(** :ref:`RID` from **)** |constructor| +- :ref:`RID` **RID** **(** :ref:`RID` from **)** Constructs a ``RID`` as a copy of the given ``RID``. ----- +Method Descriptions +------------------- .. _class_RID_method_get_id: @@ -66,49 +77,50 @@ Constructs a ``RID`` as a copy of the given ``RID``. Returns the ID of the referenced resource. ----- +Operator Descriptions +--------------------- -.. _class_RID_method_operator !=: +.. _class_RID_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`RID` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`RID` right **)** ---- -.. _class_RID_method_operator <: +.. _class_RID_operator_lt_bool: -- :ref:`bool` **operator <** **(** :ref:`RID` right **)** |operator| +- :ref:`bool` **operator <** **(** :ref:`RID` right **)** ---- -.. _class_RID_method_operator <=: +.. _class_RID_operator_lte_bool: -- :ref:`bool` **operator <=** **(** :ref:`RID` right **)** |operator| +- :ref:`bool` **operator <=** **(** :ref:`RID` right **)** ---- -.. _class_RID_method_operator ==: +.. _class_RID_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`RID` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`RID` right **)** ---- -.. _class_RID_method_operator >: +.. _class_RID_operator_gt_bool: -- :ref:`bool` **operator >** **(** :ref:`RID` right **)** |operator| +- :ref:`bool` **operator >** **(** :ref:`RID` right **)** ---- -.. _class_RID_method_operator >=: +.. _class_RID_operator_gte_bool: -- :ref:`bool` **operator >=** **(** :ref:`RID` right **)** |operator| +- :ref:`bool` **operator >=** **(** :ref:`RID` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_rigiddynamicbody2d.rst b/classes/class_rigiddynamicbody2d.rst index add4a753c..4a158677a 100644 --- a/classes/class_rigiddynamicbody2d.rst +++ b/classes/class_rigiddynamicbody2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RigidDynamicBody2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -39,7 +39,9 @@ Properties ---------- +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`angular_damp` | ``-1.0`` | +| :ref:`float` | :ref:`angular_damp` | ``0.0`` | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ +| :ref:`DampMode` | :ref:`angular_damp_mode` | ``0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`angular_velocity` | ``0.0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ @@ -69,7 +71,9 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`inertia` | ``0.0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`linear_damp` | ``-1.0`` | +| :ref:`float` | :ref:`linear_damp` | ``0.0`` | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ +| :ref:`DampMode` | :ref:`linear_damp_mode` | ``0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`linear_velocity` | ``Vector2(0, 0)`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-------------------+ @@ -130,33 +134,33 @@ Emitted when the collision with another :ref:`PhysicsBody2D .. _class_RigidDynamicBody2D_signal_body_shape_entered: -- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of this RigidDynamicBody2D'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:`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. -``body_id`` the :ref:`RID` of the other :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. +``body_rid`` the :ref:`RID` of the other :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. ``body`` the :ref:`Node`, if it exists in the tree, of the other :ref:`PhysicsBody2D` or :ref:`TileMap`. -``body_shape`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. +``body_shape_index`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this RigidDynamicBody2D used by the :ref:`PhysicsServer2D`. +``local_shape_index`` the index of the :ref:`Shape2D` of this RigidDynamicBody2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_RigidDynamicBody2D_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when the collision between one of this RigidDynamicBody2D'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:`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. -``body_id`` the :ref:`RID` of the other :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. +``body_rid`` the :ref:`RID` of the other :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`PhysicsServer2D`. ``body`` the :ref:`Node`, if it exists in the tree, of the other :ref:`PhysicsBody2D` or :ref:`TileMap`. -``body_shape`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. +``body_shape_index`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this RigidDynamicBody2D used by the :ref:`PhysicsServer2D`. +``local_shape_index`` the index of the :ref:`Shape2D` of this RigidDynamicBody2D used by the :ref:`PhysicsServer2D`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- @@ -199,6 +203,20 @@ enum **CenterOfMassMode**: ---- +.. _enum_RigidDynamicBody2D_DampMode: + +.. _class_RigidDynamicBody2D_constant_DAMP_MODE_COMBINE: + +.. _class_RigidDynamicBody2D_constant_DAMP_MODE_REPLACE: + +enum **DampMode**: + +- **DAMP_MODE_COMBINE** = **0** --- In this mode, the body's damping value is added to any value set in areas or the default value. + +- **DAMP_MODE_REPLACE** = **1** --- In this mode, the body's damping value replaces any value set in areas or the default value. + +---- + .. _enum_RigidDynamicBody2D_CCDMode: .. _class_RigidDynamicBody2D_constant_CCD_MODE_DISABLED: @@ -223,19 +241,35 @@ Property Descriptions - :ref:`float` **angular_damp** +-----------+-------------------------+ -| *Default* | ``-1.0`` | +| *Default* | ``0.0`` | +-----------+-------------------------+ | *Setter* | set_angular_damp(value) | +-----------+-------------------------+ | *Getter* | get_angular_damp() | +-----------+-------------------------+ -Damps the body's :ref:`angular_velocity`. If ``-1``, the body will use the **Default Angular Damp** defined in **Project > Project Settings > Physics > 2d**. +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. See :ref:`ProjectSettings.physics/2d/default_angular_damp` for more details about damping. ---- +.. _class_RigidDynamicBody2D_property_angular_damp_mode: + +- :ref:`DampMode` **angular_damp_mode** + ++-----------+------------------------------+ +| *Default* | ``0`` | ++-----------+------------------------------+ +| *Setter* | set_angular_damp_mode(value) | ++-----------+------------------------------+ +| *Getter* | get_angular_damp_mode() | ++-----------+------------------------------+ + +Defines how :ref:`angular_damp` is applied. See :ref:`DampMode` for possible values. + +---- + .. _class_RigidDynamicBody2D_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -479,19 +513,35 @@ If set to ``0``, inertia is automatically computed (default value). - :ref:`float` **linear_damp** +-----------+------------------------+ -| *Default* | ``-1.0`` | +| *Default* | ``0.0`` | +-----------+------------------------+ | *Setter* | set_linear_damp(value) | +-----------+------------------------+ | *Getter* | get_linear_damp() | +-----------+------------------------+ -Damps the body's :ref:`linear_velocity`. If ``-1``, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 2d**. +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. See :ref:`ProjectSettings.physics/2d/default_linear_damp` for more details about damping. ---- +.. _class_RigidDynamicBody2D_property_linear_damp_mode: + +- :ref:`DampMode` **linear_damp_mode** + ++-----------+-----------------------------+ +| *Default* | ``0`` | ++-----------+-----------------------------+ +| *Setter* | set_linear_damp_mode(value) | ++-----------+-----------------------------+ +| *Getter* | get_linear_damp_mode() | ++-----------+-----------------------------+ + +Defines how :ref:`linear_damp` is applied. See :ref:`DampMode` for possible values. + +---- + .. _class_RigidDynamicBody2D_property_linear_velocity: - :ref:`Vector2` **linear_velocity** diff --git a/classes/class_rigiddynamicbody3d.rst b/classes/class_rigiddynamicbody3d.rst index c4a186218..8c8cf8c0e 100644 --- a/classes/class_rigiddynamicbody3d.rst +++ b/classes/class_rigiddynamicbody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RigidDynamicBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -39,7 +39,9 @@ Properties ---------- +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ -| :ref:`float` | :ref:`angular_damp` | ``-1.0`` | +| :ref:`float` | :ref:`angular_damp` | ``0.0`` | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`DampMode` | :ref:`angular_damp_mode` | ``0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`angular_velocity` | ``Vector3(0, 0, 0)`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ @@ -65,7 +67,9 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`inertia` | ``Vector3(0, 0, 0)`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ -| :ref:`float` | :ref:`linear_damp` | ``-1.0`` | +| :ref:`float` | :ref:`linear_damp` | ``0.0`` | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ +| :ref:`DampMode` | :ref:`linear_damp_mode` | ``0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`linear_velocity` | ``Vector3(0, 0, 0)`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------+ @@ -128,17 +132,17 @@ Emitted when the collision with another :ref:`PhysicsBody3D .. _class_RigidDynamicBody3D_signal_body_shape_entered: -- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of this RigidDynamicBody3D'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:`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. -``body_id`` the :ref:`RID` of the other :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. +``body_rid`` the :ref:`RID` of the other :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. ``body`` the :ref:`Node`, if it exists in the tree, of the other :ref:`PhysicsBody3D` or :ref:`GridMap`. -``body_shape`` the index of the :ref:`Shape3D` of the other :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. +``body_shape_index`` the index of the :ref:`Shape3D` of the other :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape3D` of this RigidDynamicBody3D used by the :ref:`PhysicsServer3D`. +``local_shape_index`` the index of the :ref:`Shape3D` of this RigidDynamicBody3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``self.shape_owner_get_owner(local_shape_index)``. **Note:** Bullet physics cannot identify the shape index when using a :ref:`ConcavePolygonShape3D`. Don't use multiple :ref:`CollisionShape3D`\ s when using a :ref:`ConcavePolygonShape3D` with Bullet physics if you need shape indices. @@ -146,17 +150,17 @@ Emitted when one of this RigidDynamicBody3D's :ref:`Shape3D`\ s c .. _class_RigidDynamicBody3D_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when the collision between one of this RigidDynamicBody3D'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:`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. -``body_id`` the :ref:`RID` of the other :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. :ref:`GridMap`\ s are detected if the Meshes have :ref:`Shape3D`\ s. +``body_rid`` the :ref:`RID` of the other :ref:`PhysicsBody3D` or :ref:`MeshLibrary`'s :ref:`CollisionObject3D` used by the :ref:`PhysicsServer3D`. :ref:`GridMap`\ s are detected if the Meshes have :ref:`Shape3D`\ s. ``body`` the :ref:`Node`, if it exists in the tree, of the other :ref:`PhysicsBody3D` or :ref:`GridMap`. -``body_shape`` the index of the :ref:`Shape3D` of the other :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. +``body_shape_index`` the index of the :ref:`Shape3D` of the other :ref:`PhysicsBody3D` or :ref:`GridMap` used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape3D` of this RigidDynamicBody3D used by the :ref:`PhysicsServer3D`. +``local_shape_index`` the index of the :ref:`Shape3D` of this RigidDynamicBody3D used by the :ref:`PhysicsServer3D`. Get the :ref:`CollisionShape3D` node with ``self.shape_owner_get_owner(local_shape_index)``. **Note:** Bullet physics cannot identify the shape index when using a :ref:`ConcavePolygonShape3D`. Don't use multiple :ref:`CollisionShape3D`\ s when using a :ref:`ConcavePolygonShape3D` with Bullet physics if you need shape indices. @@ -199,6 +203,20 @@ enum **CenterOfMassMode**: - **CENTER_OF_MASS_MODE_CUSTOM** = **1** --- In this mode, the body's center of mass is set through :ref:`center_of_mass`. Defaults to the body's origin position. +---- + +.. _enum_RigidDynamicBody3D_DampMode: + +.. _class_RigidDynamicBody3D_constant_DAMP_MODE_COMBINE: + +.. _class_RigidDynamicBody3D_constant_DAMP_MODE_REPLACE: + +enum **DampMode**: + +- **DAMP_MODE_COMBINE** = **0** --- In this mode, the body's damping value is added to any value set in areas or the default value. + +- **DAMP_MODE_REPLACE** = **1** --- In this mode, the body's damping value replaces any value set in areas or the default value. + Property Descriptions --------------------- @@ -207,19 +225,35 @@ Property Descriptions - :ref:`float` **angular_damp** +-----------+-------------------------+ -| *Default* | ``-1.0`` | +| *Default* | ``0.0`` | +-----------+-------------------------+ | *Setter* | set_angular_damp(value) | +-----------+-------------------------+ | *Getter* | get_angular_damp() | +-----------+-------------------------+ -Damps RigidDynamicBody3D's rotational forces. +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. See :ref:`ProjectSettings.physics/3d/default_angular_damp` for more details about damping. ---- +.. _class_RigidDynamicBody3D_property_angular_damp_mode: + +- :ref:`DampMode` **angular_damp_mode** + ++-----------+------------------------------+ +| *Default* | ``0`` | ++-----------+------------------------------+ +| *Setter* | set_angular_damp_mode(value) | ++-----------+------------------------------+ +| *Getter* | get_angular_damp_mode() | ++-----------+------------------------------+ + +Defines how :ref:`angular_damp` is applied. See :ref:`DampMode` for possible values. + +---- + .. _class_RigidDynamicBody3D_property_angular_velocity: - :ref:`Vector3` **angular_velocity** @@ -431,19 +465,35 @@ If set to ``Vector3.ZERO``, inertia is automatically computed (default value). - :ref:`float` **linear_damp** +-----------+------------------------+ -| *Default* | ``-1.0`` | +| *Default* | ``0.0`` | +-----------+------------------------+ | *Setter* | set_linear_damp(value) | +-----------+------------------------+ | *Getter* | get_linear_damp() | +-----------+------------------------+ -The body's linear damp. Cannot be less than -1.0. If this value is different from -1.0, any linear damp derived from the world or areas will be overridden. +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. See :ref:`ProjectSettings.physics/3d/default_linear_damp` for more details about damping. ---- +.. _class_RigidDynamicBody3D_property_linear_damp_mode: + +- :ref:`DampMode` **linear_damp_mode** + ++-----------+-----------------------------+ +| *Default* | ``0`` | ++-----------+-----------------------------+ +| *Setter* | set_linear_damp_mode(value) | ++-----------+-----------------------------+ +| *Getter* | get_linear_damp_mode() | ++-----------+-----------------------------+ + +Defines how :ref:`linear_damp` is applied. See :ref:`DampMode` for possible values. + +---- + .. _class_RigidDynamicBody3D_property_linear_velocity: - :ref:`Vector3` **linear_velocity** diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index a66613564..a266dfb53 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RootMotionView.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 9ac996dc5..d7acc51bd 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SceneState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -76,6 +76,8 @@ Enumerations .. _class_SceneState_constant_GEN_EDIT_STATE_MAIN: +.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN_INHERITED: + enum **GenEditState**: - **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`PackedScene.instantiate`, blocks edits to the scene state. @@ -88,6 +90,10 @@ enum **GenEditState**: **Note:** Only available in editor builds. +- **GEN_EDIT_STATE_MAIN_INHERITED** = **3** --- If passed to :ref:`PackedScene.instantiate`, it's similar to :ref:`GEN_EDIT_STATE_MAIN`, but for the case where the scene is being instantiated to be the base of another one. + +**Note:** Only available in editor builds. + Method Descriptions ------------------- diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 48d46992f..4b6507ac9 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SceneTree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -327,6 +327,8 @@ Method Descriptions 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. This method is equivalent of calling :ref:`call_group_flags` with :ref:`GROUP_CALL_DEFAULT` flag. +**Note:** Due to design limitations, :ref:`call_group` will fail silently if one of the arguments is ``null``. + **Note:** :ref:`call_group` will always call methods with an one-frame delay, in a way similar to :ref:`Object.call_deferred`. To call methods immediately, use :ref:`call_group_flags` with the :ref:`GROUP_CALL_REALTIME` flag. ---- @@ -337,9 +339,12 @@ Calls ``method`` on each member of the given group. You can pass arguments to `` 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. +**Note:** Due to design limitations, :ref:`call_group_flags` will fail silently if one of the arguments is ``null``. + :: - get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") # Call the method immediately and in reverse order. + # Call the method immediately and in reverse order. + get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") ---- @@ -382,7 +387,7 @@ Commonly used to create a one-shot delay timer as in the following example: func some_function(): print("start") - yield(get_tree().create_timer(1.0), "timeout") + await get_tree().create_timer(1.0).timeout print("end") .. code-tab:: csharp diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index dc832c75d..fc1175021 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SceneTreeTimer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -27,7 +27,7 @@ As opposed to :ref:`Timer`, it does not require the instantiation o func some_function(): print("Timer started.") - yield(get_tree().create_timer(1.0), "timeout") + await get_tree().create_timer(1.0).timeout print("Timer ended.") .. code-tab:: csharp diff --git a/classes/class_script.rst b/classes/class_script.rst index 524c84483..52d24e4e0 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Script.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index a9bc33346..38a9bd147 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ScriptCreateDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 199f8f7db..95ea0be29 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ScriptEditor.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_scripteditorbase.rst b/classes/class_scripteditorbase.rst index c63bd9f70..dcf8d04bd 100644 --- a/classes/class_scripteditorbase.rst +++ b/classes/class_scripteditorbase.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ScriptEditorBase.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,9 +21,11 @@ Base editor for editing scripts in the :ref:`ScriptEditor`, Methods ------- -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_editor` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_syntax_highlighter` **(** :ref:`EditorSyntaxHighlighter` highlighter **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_base_editor` **(** **)** |const| | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -93,6 +95,14 @@ Emitted when the user request to search text in the file system. Not used by vis Method Descriptions ------------------- +.. _class_ScriptEditorBase_method_add_syntax_highlighter: + +- void **add_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter` highlighter **)** + +Adds a :ref:`EditorSyntaxHighlighter` to the open script. + +---- + .. _class_ScriptEditorBase_method_get_base_editor: - :ref:`Control` **get_base_editor** **(** **)** |const| diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 1adf3d7e2..42b7d76c9 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ScrollBar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index d202f19a9..c96ea5f3c 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ScrollContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -226,6 +226,8 @@ Ensures the given ``control`` is visible (must be a direct or indirect child of Returns the horizontal scrollbar :ref:`HScrollBar` of this ``ScrollContainer``. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use :ref:`scroll_horizontal_enabled`. If you want to only hide it instead, use :ref:`scroll_horizontal_visible`. + ---- .. _class_ScrollContainer_method_get_v_scrollbar: @@ -234,6 +236,8 @@ Returns the horizontal scrollbar :ref:`HScrollBar` of this ``S Returns the vertical scrollbar :ref:`VScrollBar` of this ``ScrollContainer``. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use :ref:`scroll_vertical_enabled`. If you want to only hide it instead, use :ref:`scroll_vertical_visible`. + Theme Property Descriptions --------------------------- diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 5449f9f29..717e00a59 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SegmentShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 06ed4a4bd..585d3e7e2 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Semaphore.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_separationrayshape2d.rst b/classes/class_separationrayshape2d.rst index 2ddaebe94..91dd164eb 100644 --- a/classes/class_separationrayshape2d.rst +++ b/classes/class_separationrayshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SeparationRayShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_separationrayshape3d.rst b/classes/class_separationrayshape3d.rst index 67632a1c0..4a0d10009 100644 --- a/classes/class_separationrayshape3d.rst +++ b/classes/class_separationrayshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SeparationRayShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_separator.rst b/classes/class_separator.rst index 4ffa9bb5f..3d0a71a3c 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Separator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 1fb46e9d4..41d5d7f74 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Shader.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -35,15 +35,15 @@ Properties Methods ------- -+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`get_default_texture_param` **(** :ref:`StringName` param **)** |const| | -+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`get_mode` **(** **)** |const| | -+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`StringName` name **)** |const| | -+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`StringName` param, :ref:`Texture2D` texture **)** | -+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_default_texture_param` **(** :ref:`StringName` param, :ref:`int` index=0 **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`get_mode` **(** **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_param` **(** :ref:`StringName` name **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_texture_param` **(** :ref:`StringName` param, :ref:`Texture2D` texture, :ref:`int` index=0 **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -58,6 +58,8 @@ Enumerations .. _class_Shader_constant_MODE_SKY: +.. _class_Shader_constant_MODE_FOG: + enum **Mode**: - **MODE_SPATIAL** = **0** --- Mode used to draw all 3D objects. @@ -68,6 +70,8 @@ enum **Mode**: - **MODE_SKY** = **3** --- Mode used for drawing skies. Only works with shaders attached to :ref:`Sky` objects. +- **MODE_FOG** = **4** --- Mode used for setting the color and density of volumetric fog effect. + Property Descriptions --------------------- @@ -90,12 +94,14 @@ Method Descriptions .. _class_Shader_method_get_default_texture_param: -- :ref:`Texture2D` **get_default_texture_param** **(** :ref:`StringName` param **)** |const| +- :ref:`Texture2D` **get_default_texture_param** **(** :ref:`StringName` param, :ref:`int` index=0 **)** |const| Returns the texture that is set as default for the specified parameter. **Note:** ``param`` must match the name of the uniform in the code exactly. +**Note:** If the sampler array is used use ``index`` to access the specified texture. + ---- .. _class_Shader_method_get_mode: @@ -118,12 +124,14 @@ Returns ``true`` if the shader has this param defined as a uniform in its code. .. _class_Shader_method_set_default_texture_param: -- void **set_default_texture_param** **(** :ref:`StringName` param, :ref:`Texture2D` texture **)** +- void **set_default_texture_param** **(** :ref:`StringName` param, :ref:`Texture2D` texture, :ref:`int` index=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`. **Note:** ``param`` must match the name of the uniform in the code exactly. +**Note:** If the sampler array is used use ``index`` to access the specified texture. + .. |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.)` diff --git a/classes/class_shaderglobalsoverride.rst b/classes/class_shaderglobalsoverride.rst index 30f8b1f85..8ed386331 100644 --- a/classes/class_shaderglobalsoverride.rst +++ b/classes/class_shaderglobalsoverride.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ShaderGlobalsOverride.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 93db774a1..6e9a4cd93 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ShaderMaterial.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 0fa46c2c5..9ab23bcbe 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Shape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_shape3d.rst b/classes/class_shape3d.rst index eefdd0f72..c8461c463 100644 --- a/classes/class_shape3d.rst +++ b/classes/class_shape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Shape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_shapecast2d.rst b/classes/class_shapecast2d.rst new file mode 100644 index 000000000..627324568 --- /dev/null +++ b/classes/class_shapecast2d.rst @@ -0,0 +1,382 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ShapeCast2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ShapeCast2D: + +ShapeCast2D +=========== + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +Node for physics collision sweep and immediate overlap queries. Similar to the :ref:`RayCast2D` node. + +Description +----------- + +Shape casting allows to detect collision objects by sweeping the :ref:`shape` along the cast direction determined by :ref:`target_position` (useful for things like beam weapons). + +Immediate collision overlaps can be done with the :ref:`target_position` set to ``Vector2(0, 0)`` and by calling :ref:`force_shapecast_update` within the same **physics_frame**. This also helps to overcome some limitations of :ref:`Area2D` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area2D` nodes, and when using the signals creates unnecessary complexity. + +The node can detect multiple collision objects, but usually the first detected collision + +**Note:** shape casting is more computationally expensive compared to ray casting. + +Properties +---------- + ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ``false`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`collision_mask` | ``1`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`Array` | :ref:`collision_result` | ``[]`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`exclude_parent` | ``true`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`margin` | ``0.0`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`max_results` | ``32`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`Shape2D` | :ref:`shape` | | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 50)`` | ++-------------------------------+----------------------------------------------------------------------------+--------------------+ + +Methods +------- + ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` 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:`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:`Object` node **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_ShapeCast2D_property_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ + +If ``true``, collision with :ref:`Area2D`\ s will be reported. + +---- + +.. _class_ShapeCast2D_property_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** + ++-----------+----------------------------------+ +| *Default* | ``true`` | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ + +If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. + +---- + +.. _class_ShapeCast2D_property_collision_mask: + +- :ref:`int` **collision_mask** + ++-----------+---------------------------+ +| *Default* | ``1`` | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ + +The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. + +---- + +.. _class_ShapeCast2D_property_collision_result: + +- :ref:`Array` **collision_result** + ++-----------+--------+ +| *Default* | ``[]`` | ++-----------+--------+ + +A complete collision information. The data returned is the same as in the :ref:`PhysicsDirectSpaceState2D.get_rest_info` method. + +---- + +.. _class_ShapeCast2D_property_enabled: + +- :ref:`bool` **enabled** + ++-----------+--------------------+ +| *Default* | ``true`` | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ + +If ``true``, collisions will be reported. + +---- + +.. _class_ShapeCast2D_property_exclude_parent: + +- :ref:`bool` **exclude_parent** + ++-----------+--------------------------------+ +| *Default* | ``true`` | ++-----------+--------------------------------+ +| *Setter* | set_exclude_parent_body(value) | ++-----------+--------------------------------+ +| *Getter* | get_exclude_parent_body() | ++-----------+--------------------------------+ + +If ``true``, the parent node will be excluded from collision detection. + +---- + +.. _class_ShapeCast2D_property_margin: + +- :ref:`float` **margin** + ++-----------+-------------------+ +| *Default* | ``0.0`` | ++-----------+-------------------+ +| *Setter* | set_margin(value) | ++-----------+-------------------+ +| *Getter* | get_margin() | ++-----------+-------------------+ + +The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision. + +---- + +.. _class_ShapeCast2D_property_max_results: + +- :ref:`int` **max_results** + ++-----------+------------------------+ +| *Default* | ``32`` | ++-----------+------------------------+ +| *Setter* | set_max_results(value) | ++-----------+------------------------+ +| *Getter* | get_max_results() | ++-----------+------------------------+ + +The number of intersections can be limited with this parameter, to reduce the processing time. + +---- + +.. _class_ShapeCast2D_property_shape: + +- :ref:`Shape2D` **shape** + ++----------+------------------+ +| *Setter* | set_shape(value) | ++----------+------------------+ +| *Getter* | get_shape() | ++----------+------------------+ + +Any :ref:`Shape2D` derived shape used for collision queries. + +---- + +.. _class_ShapeCast2D_property_target_position: + +- :ref:`Vector2` **target_position** + ++-----------+----------------------------+ +| *Default* | ``Vector2(0, 50)`` | ++-----------+----------------------------+ +| *Setter* | set_target_position(value) | ++-----------+----------------------------+ +| *Getter* | get_target_position() | ++-----------+----------------------------+ + +The shape's destination point, relative to this node's ``position``. + +Method Descriptions +------------------- + +.. _class_ShapeCast2D_method_add_exception: + +- void **add_exception** **(** :ref:`Object` node **)** + +Adds a collision exception so the shape does not report collisions with the specified node. + +---- + +.. _class_ShapeCast2D_method_add_exception_rid: + +- void **add_exception_rid** **(** :ref:`RID` rid **)** + +Adds a collision exception so the shape does not report collisions with the specified :ref:`RID`. + +---- + +.. _class_ShapeCast2D_method_clear_exceptions: + +- void **clear_exceptions** **(** **)** + +Removes all collision exceptions for this shape. + +---- + +.. _class_ShapeCast2D_method_force_shapecast_update: + +- void **force_shapecast_update** **(** **)** + +Updates the collision information for the shape. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the shape or its parent has changed state. + +**Note:** ``enabled == true`` is not required for this to work. + +---- + +.. _class_ShapeCast2D_method_get_closest_collision_safe_fraction: + +- :ref:`float` **get_closest_collision_safe_fraction** **(** **)** |const| + +The fraction of the motion (between 0 and 1) of how far the shape can move without triggering a collision. The motion is determined by :ref:`target_position`. + +---- + +.. _class_ShapeCast2D_method_get_closest_collision_unsafe_fraction: + +- :ref:`float` **get_closest_collision_unsafe_fraction** **(** **)** |const| + +The fraction of the motion (between 0 and 1) when the shape triggers a collision. The motion is determined by :ref:`target_position`. + +---- + +.. _class_ShapeCast2D_method_get_collider: + +- :ref:`Object` **get_collider** **(** :ref:`int` index **)** |const| + +Returns the :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``). + +---- + +.. _class_ShapeCast2D_method_get_collider_shape: + +- :ref:`int` **get_collider_shape** **(** :ref:`int` index **)** |const| + +Returns the shape ID of one of the multiple collisions at ``index`` that the shape intersects, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). + +---- + +.. _class_ShapeCast2D_method_get_collision_count: + +- :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. + +---- + +.. _class_ShapeCast2D_method_get_collision_mask_value: + +- :ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| + +Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. + +---- + +.. _class_ShapeCast2D_method_get_collision_normal: + +- :ref:`Vector2` **get_collision_normal** **(** :ref:`int` index **)** |const| + +Returns the normal containing one of the multiple collisions at ``index`` of the intersecting object. + +---- + +.. _class_ShapeCast2D_method_get_collision_point: + +- :ref:`Vector2` **get_collision_point** **(** :ref:`int` index **)** |const| + +Returns the collision point containing one of the multiple collisions at ``index`` at which the shape intersects the object. + +**Note:** this point is in the **global** coordinate system. + +---- + +.. _class_ShapeCast2D_method_is_colliding: + +- :ref:`bool` **is_colliding** **(** **)** |const| + +Returns whether any object is intersecting with the shape's vector (considering the vector length). + +---- + +.. _class_ShapeCast2D_method_remove_exception: + +- void **remove_exception** **(** :ref:`Object` node **)** + +Removes a collision exception so the shape does report collisions with the specified node. + +---- + +.. _class_ShapeCast2D_method_remove_exception_rid: + +- void **remove_exception_rid** **(** :ref:`RID` rid **)** + +Removes a collision exception so the shape does report collisions with the specified :ref:`RID`. + +---- + +.. _class_ShapeCast2D_method_set_collision_mask_value: + +- void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** + +Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. + +.. |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.)` diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index e1ff7035e..aafd296ad 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Shortcut.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_signal.rst b/classes/class_signal.rst index f628d2225..9f5232f99 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Signal.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,65 +11,76 @@ Signal Class representing a signal defined in an object. +Constructors +------------ + ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Signal` | :ref:`Signal` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Signal` | :ref:`Signal` **(** :ref:`Signal` from **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Signal` | :ref:`Signal` **(** :ref:`Object` object, :ref:`StringName` signal **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Signal` | :ref:`Signal` **(** **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Signal` | :ref:`Signal` **(** :ref:`Signal` from **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Signal` | :ref:`Signal` **(** :ref:`Object` object, :ref:`StringName` signal **)** |constructor| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Signal` right **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Signal` right **)** |operator| | -+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :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| | ++-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_Signal_method_Signal: ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Signal` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Signal` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------+ -- :ref:`Signal` **Signal** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_Signal_constructor_Signal: + +- :ref:`Signal` **Signal** **(** **)** Constructs a null ``Signal`` with no object nor signal name bound. ---- -- :ref:`Signal` **Signal** **(** :ref:`Signal` from **)** |constructor| +- :ref:`Signal` **Signal** **(** :ref:`Signal` from **)** Constructs a ``Signal`` as a copy of the given ``Signal``. ---- -- :ref:`Signal` **Signal** **(** :ref:`Object` object, :ref:`StringName` signal **)** |constructor| +- :ref:`Signal` **Signal** **(** :ref:`Object` object, :ref:`StringName` signal **)** Creates a new ``Signal`` with the name ``signal`` in the specified ``object``. ----- +Method Descriptions +------------------- .. _class_Signal_method_connect: @@ -147,25 +158,26 @@ Returns ``true`` if the specified :ref:`Callable` is connected t - :ref:`bool` **is_null** **(** **)** |const| ----- +Operator Descriptions +--------------------- -.. _class_Signal_method_operator !=: +.. _class_Signal_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`Signal` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`Signal` right **)** ---- -.. _class_Signal_method_operator ==: +.. _class_Signal_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`Signal` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`Signal` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 2e7df81f0..19eb9a7fe 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Skeleton2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index a5215764f..e16a2cae8 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Skeleton3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -32,9 +32,11 @@ Tutorials Properties ---------- -+-------------------------+---------------------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`animate_physical_bones` | ``true`` | -+-------------------------+---------------------------------------------------------------------------------+----------+ ++-------------------------+---------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`animate_physical_bones` | ``true`` | ++-------------------------+---------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`show_rest_only` | ``false`` | ++-------------------------+---------------------------------------------------------------------------------+-----------+ Methods ------- @@ -50,6 +52,8 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_bones_local_pose_override` **(** **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Skin` | :ref:`create_skin_from_rest_transforms` **(** **)** | ++-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`execute_modifications` **(** :ref:`float` delta, :ref:`int` execution_mode **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** |const| | @@ -62,8 +66,6 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** |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| | @@ -78,6 +80,12 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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:`SkeletonModificationStack3D` | :ref:`get_modification_stack` **(** **)** | @@ -90,7 +98,7 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`global_pose_z_forward_to_bone_forward` **(** :ref:`int` bone_idx, :ref:`Basis` basis **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** |const| | +| :ref:`bool` | :ref:`is_bone_enabled` **(** :ref:`int` bone_idx **)** |const| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`local_pose_to_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform3D` local_pose **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -110,9 +118,7 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_children` **(** :ref:`int` bone_idx, :ref:`PackedInt32Array` bone_children **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform3D` custom_pose **)** | -+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | +| 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 **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +128,11 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform3D` pose **)** | +| 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 **)** | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -136,6 +146,12 @@ Methods Signals ------- +.. _class_Skeleton3D_signal_bone_enabled_changed: + +- **bone_enabled_changed** **(** :ref:`int` bone_idx **)** + +---- + .. _class_Skeleton3D_signal_bone_pose_changed: - **bone_pose_changed** **(** :ref:`int` bone_idx **)** @@ -148,6 +164,12 @@ This signal is emitted when one of the bones in the Skeleton3D node have changed - **pose_updated** **(** **)** +---- + +.. _class_Skeleton3D_signal_show_rest_only_changed: + +- **show_rest_only_changed** **(** **)** + Constants --------- @@ -170,6 +192,20 @@ Property Descriptions | *Getter* | get_animate_physical_bones() | +-----------+-----------------------------------+ +---- + +.. _class_Skeleton3D_property_show_rest_only: + +- :ref:`bool` **show_rest_only** + ++-----------+---------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------+ +| *Setter* | set_show_rest_only(value) | ++-----------+---------------------------+ +| *Getter* | is_show_rest_only() | ++-----------+---------------------------+ + Method Descriptions ------------------- @@ -215,6 +251,12 @@ Removes the local pose override on all bones in the skeleton. ---- +.. _class_Skeleton3D_method_create_skin_from_rest_transforms: + +- :ref:`Skin` **create_skin_from_rest_transforms** **(** **)** + +---- + .. _class_Skeleton3D_method_execute_modifications: - void **execute_modifications** **(** :ref:`float` delta, :ref:`int` execution_mode **)** @@ -263,14 +305,6 @@ Returns the amount of bones in the skeleton. ---- -.. _class_Skeleton3D_method_get_bone_custom_pose: - -- :ref:`Transform3D` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** |const| - -Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. - ----- - .. _class_Skeleton3D_method_get_bone_global_pose: - :ref:`Transform3D` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** |const| @@ -327,6 +361,24 @@ Returns the pose transform of the specified bone. Pose is applied on top of the ---- +.. _class_Skeleton3D_method_get_bone_pose_position: + +- :ref:`Vector3` **get_bone_pose_position** **(** :ref:`int` bone_idx **)** |const| + +---- + +.. _class_Skeleton3D_method_get_bone_pose_rotation: + +- :ref:`Quaternion` **get_bone_pose_rotation** **(** :ref:`int` bone_idx **)** |const| + +---- + +.. _class_Skeleton3D_method_get_bone_pose_scale: + +- :ref:`Vector3` **get_bone_pose_scale** **(** :ref:`int` bone_idx **)** |const| + +---- + .. _class_Skeleton3D_method_get_bone_rest: - :ref:`Transform3D` **get_bone_rest** **(** :ref:`int` bone_idx **)** |const| @@ -381,11 +433,11 @@ This is helper function to make using :ref:`Transform3D.looking_at` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** |const| +- :ref:`bool` **is_bone_enabled** **(** :ref:`int` bone_idx **)** |const| -Returns whether the bone rest for the bone at ``bone_idx`` is disabled. +Returns whether the bone pose for the bone at ``bone_idx`` is enabled. ---- @@ -471,21 +523,11 @@ Sets the children for the passed in bone, ``bone_idx``, to the passed-in array o ---- -.. _class_Skeleton3D_method_set_bone_custom_pose: +.. _class_Skeleton3D_method_set_bone_enabled: -- void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform3D` custom_pose **)** +- void **set_bone_enabled** **(** :ref:`int` bone_idx, :ref:`bool` enabled=true **)** -Sets the custom pose transform, ``custom_pose``, for the bone at ``bone_idx``. This pose is an addition to the bone rest pose. - -**Note:** The pose transform needs to be in bone space. Use :ref:`world_transform_to_global_pose` to convert a world transform, like one you can get from a :ref:`Node3D`, to bone space. - ----- - -.. _class_Skeleton3D_method_set_bone_disable_rest: - -- void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** - -Disables the rest pose for the bone at ``bone_idx`` if ``true``, enables the bone rest if ``false``. +Disables the pose for the bone at ``bone_idx`` if ``false``, enables the bone pose if ``true``. ---- @@ -529,13 +571,21 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If ---- -.. _class_Skeleton3D_method_set_bone_pose: +.. _class_Skeleton3D_method_set_bone_pose_position: -- void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform3D` pose **)** +- void **set_bone_pose_position** **(** :ref:`int` bone_idx, :ref:`Vector3` position **)** -Sets the pose transform for bone ``bone_idx``. +---- -**Note:** The pose transform needs to be in bone space. Use :ref:`world_transform_to_global_pose` to convert a world transform, like one you can get from a :ref:`Node3D`, to bone space. +.. _class_Skeleton3D_method_set_bone_pose_rotation: + +- void **set_bone_pose_rotation** **(** :ref:`int` bone_idx, :ref:`Quaternion` rotation **)** + +---- + +.. _class_Skeleton3D_method_set_bone_pose_scale: + +- void **set_bone_pose_scale** **(** :ref:`int` bone_idx, :ref:`Vector3` scale **)** ---- diff --git a/classes/class_skeletonik3d.rst b/classes/class_skeletonik3d.rst index e41d123ea..dc548538f 100644 --- a/classes/class_skeletonik3d.rst +++ b/classes/class_skeletonik3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonIK3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2d.rst b/classes/class_skeletonmodification2d.rst index b7c8e3180..c61de9fe7 100644 --- a/classes/class_skeletonmodification2d.rst +++ b/classes/class_skeletonmodification2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2dccdik.rst b/classes/class_skeletonmodification2dccdik.rst index acadac5bb..66cbc5f5f 100644 --- a/classes/class_skeletonmodification2dccdik.rst +++ b/classes/class_skeletonmodification2dccdik.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DCCDIK.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2dfabrik.rst b/classes/class_skeletonmodification2dfabrik.rst index 44c3b8e86..838417bcf 100644 --- a/classes/class_skeletonmodification2dfabrik.rst +++ b/classes/class_skeletonmodification2dfabrik.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DFABRIK.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2djiggle.rst b/classes/class_skeletonmodification2djiggle.rst index 4c84b520b..10ebb66b6 100644 --- a/classes/class_skeletonmodification2djiggle.rst +++ b/classes/class_skeletonmodification2djiggle.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DJiggle.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2dlookat.rst b/classes/class_skeletonmodification2dlookat.rst index 2913d0fb1..50bccbea7 100644 --- a/classes/class_skeletonmodification2dlookat.rst +++ b/classes/class_skeletonmodification2dlookat.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DLookAt.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2dphysicalbones.rst b/classes/class_skeletonmodification2dphysicalbones.rst index 72dd4fc94..ac70353a3 100644 --- a/classes/class_skeletonmodification2dphysicalbones.rst +++ b/classes/class_skeletonmodification2dphysicalbones.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DPhysicalBones.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2dstackholder.rst b/classes/class_skeletonmodification2dstackholder.rst index 1dc3c73f0..1234e7dc7 100644 --- a/classes/class_skeletonmodification2dstackholder.rst +++ b/classes/class_skeletonmodification2dstackholder.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DStackHolder.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification2dtwoboneik.rst b/classes/class_skeletonmodification2dtwoboneik.rst index 128ee0ef4..94f6a0609 100644 --- a/classes/class_skeletonmodification2dtwoboneik.rst +++ b/classes/class_skeletonmodification2dtwoboneik.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification2DTwoBoneIK.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3d.rst b/classes/class_skeletonmodification3d.rst index 703208c25..181857638 100644 --- a/classes/class_skeletonmodification3d.rst +++ b/classes/class_skeletonmodification3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3dccdik.rst b/classes/class_skeletonmodification3dccdik.rst index 6ba083bd8..bff3ecb82 100644 --- a/classes/class_skeletonmodification3dccdik.rst +++ b/classes/class_skeletonmodification3dccdik.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3DCCDIK.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3dfabrik.rst b/classes/class_skeletonmodification3dfabrik.rst index c8f2c5dbe..dd05aacf8 100644 --- a/classes/class_skeletonmodification3dfabrik.rst +++ b/classes/class_skeletonmodification3dfabrik.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3DFABRIK.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3djiggle.rst b/classes/class_skeletonmodification3djiggle.rst index eeba1a476..a924fa443 100644 --- a/classes/class_skeletonmodification3djiggle.rst +++ b/classes/class_skeletonmodification3djiggle.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3DJiggle.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3dlookat.rst b/classes/class_skeletonmodification3dlookat.rst index a2b641c59..be9f92f64 100644 --- a/classes/class_skeletonmodification3dlookat.rst +++ b/classes/class_skeletonmodification3dlookat.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3DLookAt.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3dstackholder.rst b/classes/class_skeletonmodification3dstackholder.rst index f7f0980d1..4276b2b9e 100644 --- a/classes/class_skeletonmodification3dstackholder.rst +++ b/classes/class_skeletonmodification3dstackholder.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3DStackHolder.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodification3dtwoboneik.rst b/classes/class_skeletonmodification3dtwoboneik.rst index 6126e88cd..8c279325f 100644 --- a/classes/class_skeletonmodification3dtwoboneik.rst +++ b/classes/class_skeletonmodification3dtwoboneik.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModification3DTwoBoneIK.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodificationstack2d.rst b/classes/class_skeletonmodificationstack2d.rst index 592df5642..43d4dbfcf 100644 --- a/classes/class_skeletonmodificationstack2d.rst +++ b/classes/class_skeletonmodificationstack2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModificationStack2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skeletonmodificationstack3d.rst b/classes/class_skeletonmodificationstack3d.rst index d57037b01..db698d78d 100644 --- a/classes/class_skeletonmodificationstack3d.rst +++ b/classes/class_skeletonmodificationstack3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkeletonModificationStack3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 9609f9457..324cea0bd 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Skin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index 48e290214..57fe005dd 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SkinReference.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 17cbd8dc5..279afaac1 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Sky.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 528cdc4db..c50bc9f8d 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Slider.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_sliderjoint3d.rst b/classes/class_sliderjoint3d.rst index 859254b2a..e0fa0f526 100644 --- a/classes/class_sliderjoint3d.rst +++ b/classes/class_sliderjoint3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SliderJoint3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_softdynamicbody3d.rst b/classes/class_softdynamicbody3d.rst index 9adc07638..e6de8df63 100644 --- a/classes/class_softdynamicbody3d.rst +++ b/classes/class_softdynamicbody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SoftDynamicBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index d1fccd08f..e95a2bb85 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SphereMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_sphereshape3d.rst b/classes/class_sphereshape3d.rst index 3f222c5d5..f7a0c82fa 100644 --- a/classes/class_sphereshape3d.rst +++ b/classes/class_sphereshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SphereShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 6ba26ad1b..ee8ecac60 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SpinBox.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -176,6 +176,8 @@ Applies the current value of this ``SpinBox``. Returns the :ref:`LineEdit` instance from this ``SpinBox``. You can use it to access properties and methods of :ref:`LineEdit`. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + Theme Property Descriptions --------------------------- diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index c2e23c32a..fac010cc9 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SplitContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_spotlight3d.rst b/classes/class_spotlight3d.rst index 7303403c8..3ddfe374f 100644 --- a/classes/class_spotlight3d.rst +++ b/classes/class_spotlight3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SpotLight3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_springarm3d.rst b/classes/class_springarm3d.rst index 2f073d404..b72192d0a 100644 --- a/classes/class_springarm3d.rst +++ b/classes/class_springarm3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SpringArm3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_sprite2d.rst b/classes/class_sprite2d.rst index a36520fde..467b7b789 100644 --- a/classes/class_sprite2d.rst +++ b/classes/class_sprite2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Sprite2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index ec0f08016..36850dd1c 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Sprite3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index a4ba7a3e6..afa10e95b 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SpriteBase3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 5e3ea4e0a..ef3ce90a9 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SpriteFrames.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_standardmaterial3d.rst b/classes/class_standardmaterial3d.rst index 9ffe6f3d4..c14791f7f 100644 --- a/classes/class_standardmaterial3d.rst +++ b/classes/class_standardmaterial3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StandardMaterial3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 48ae0d760..3ce375c5a 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StaticBody2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_staticbody3d.rst b/classes/class_staticbody3d.rst index fee3e7368..913269feb 100644 --- a/classes/class_staticbody3d.rst +++ b/classes/class_staticbody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StaticBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streamcubemap.rst b/classes/class_streamcubemap.rst index f376012aa..effcd41c4 100644 --- a/classes/class_streamcubemap.rst +++ b/classes/class_streamcubemap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamCubemap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streamcubemaparray.rst b/classes/class_streamcubemaparray.rst index 99c6d61b1..6349d6a2e 100644 --- a/classes/class_streamcubemaparray.rst +++ b/classes/class_streamcubemaparray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamCubemapArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 1b463bd05..91ab6ab5c 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 16ecb7211..139d1bdc6 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamPeerBuffer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index bde07e194..b3a32ec81 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamPeerExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 2098a695a..92bef7502 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamPeerSSL.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 866deb91e..e33be408b 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamPeerTCP.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streamtexture2d.rst b/classes/class_streamtexture2d.rst index 936d87606..fe40df8a8 100644 --- a/classes/class_streamtexture2d.rst +++ b/classes/class_streamtexture2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamTexture2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streamtexture2darray.rst b/classes/class_streamtexture2darray.rst index 98229e9ed..8542c5bc0 100644 --- a/classes/class_streamtexture2darray.rst +++ b/classes/class_streamtexture2darray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamTexture2DArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streamtexture3d.rst b/classes/class_streamtexture3d.rst index e79a05d5b..9aabfab1f 100644 --- a/classes/class_streamtexture3d.rst +++ b/classes/class_streamtexture3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamTexture3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_streamtexturelayered.rst b/classes/class_streamtexturelayered.rst index 1959babb1..8dd549cd4 100644 --- a/classes/class_streamtexturelayered.rst +++ b/classes/class_streamtexturelayered.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamTextureLayered.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_string.rst b/classes/class_string.rst index 6c1ce9ad6..033c0f4da 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the String.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,17 +21,22 @@ Tutorials - :doc:`../tutorials/scripting/gdscript/gdscript_format_string` +Constructors +------------ + ++-----------------------------+-----------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** **)** |constructor| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`String` from **)** |constructor| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** |constructor| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`StringName` from **)** |constructor| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,6 +76,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_slice` **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** |const| | @@ -131,32 +138,6 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`num_scientific` **(** :ref:`float` number **)** |static| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`StringName` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | **operator %** **(** :ref:`Variant` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | **operator +** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`StringName` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`String` right **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** |const| | @@ -236,34 +217,66 @@ Methods | :ref:`String` | :ref:`xml_unescape` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_String_method_String: ++-----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`operator <` **(** :ref:`String` right **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator <=` **(** :ref:`String` right **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------+ +| :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:`String` **String** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_String_constructor_String: + +- :ref:`String` **String** **(** **)** Constructs an empty ``String`` (``""``). ---- -- :ref:`String` **String** **(** :ref:`String` from **)** |constructor| +- :ref:`String` **String** **(** :ref:`String` from **)** Constructs a ``String`` as a copy of the given ``String``. ---- -- :ref:`String` **String** **(** :ref:`NodePath` from **)** |constructor| +- :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. ---- -- :ref:`String` **String** **(** :ref:`StringName` from **)** |constructor| +- :ref:`String` **String** **(** :ref:`StringName` from **)** Constructs a new String from the given :ref:`StringName`. ----- +Method Descriptions +------------------- .. _class_String_method_begins_with: @@ -292,12 +305,12 @@ Converts a string containing a binary number into an integer. Binary strings can .. code-tab:: gdscript - print("0x101".bin_to_int()) # Prints "5". + print("0b101".bin_to_int()) # Prints "5". print("101".bin_to_int()) # Prints "5". .. code-tab:: csharp - GD.Print("0x101".BinToInt()); // Prints "5". + GD.Print("0b101".BinToInt()); // Prints "5". GD.Print("101".BinToInt()); // Prints "5". @@ -465,6 +478,22 @@ If the string is a valid file path, returns the filename. ---- +.. _class_String_method_get_slice: + +- :ref:`String` **get_slice** **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| + +Splits a string using a ``delimiter`` and returns a substring at index ``slice``. Returns an empty string if the index doesn't exist. + +This is a more performant alternative to :ref:`split` for cases when you need only one element from the array at a fixed index. + +Example: + +:: + + print("i/am/example/string".get_slice("/", 2)) # Prints 'example'. + +---- + .. _class_String_method_hash: - :ref:`int` **hash** **(** **)** |const| @@ -774,76 +803,6 @@ Some examples: ---- -.. _class_String_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`String` right **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** |operator| - ----- - -.. _class_String_method_operator %: - -- :ref:`String` **operator %** **(** :ref:`Variant` right **)** |operator| - ----- - -.. _class_String_method_operator +: - -- :ref:`String` **operator +** **(** :ref:`String` right **)** |operator| - ----- - -.. _class_String_method_operator <: - -- :ref:`bool` **operator <** **(** :ref:`String` right **)** |operator| - ----- - -.. _class_String_method_operator <=: - -- :ref:`bool` **operator <=** **(** :ref:`String` right **)** |operator| - ----- - -.. _class_String_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`String` right **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** |operator| - ----- - -.. _class_String_method_operator >: - -- :ref:`bool` **operator >** **(** :ref:`String` right **)** |operator| - ----- - -.. _class_String_method_operator >=: - -- :ref:`bool` **operator >=** **(** :ref:`String` right **)** |operator| - ----- - -.. _class_String_method_operator []: - -- :ref:`String` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_String_method_pad_decimals: - :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** |const| @@ -1028,6 +987,8 @@ Splits the string by a ``delimiter`` string and returns an array of the substrin If ``maxsplit`` is specified, it defines the number of splits to do from the left up to ``maxsplit``. The default value of ``0`` means that all items are split. +If you need only one element from the array at a specific index, :ref:`get_slice` is a more performant option. + Example: @@ -1240,6 +1201,77 @@ Returns a copy of the string with special characters escaped using the XML stand Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. +Operator Descriptions +--------------------- + +.. _class_String_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`String` right **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** + +---- + +.. _class_String_operator_mod_String: + +- :ref:`String` **operator %** **(** :ref:`Variant` right **)** + +---- + +.. _class_String_operator_sum_String: + +- :ref:`String` **operator +** **(** :ref:`String` right **)** + +---- + +.. _class_String_operator_lt_bool: + +- :ref:`bool` **operator <** **(** :ref:`String` right **)** + +---- + +.. _class_String_operator_lte_bool: + +- :ref:`bool` **operator <=** **(** :ref:`String` right **)** + +---- + +.. _class_String_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`String` right **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** + +---- + +.. _class_String_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`String` right **)** + +---- + +.. _class_String_operator_gte_bool: + +- :ref:`bool` **operator >=** **(** :ref:`String` right **)** + +---- + +.. _class_String_operator_idx_String: + +- :ref:`String` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index a715bfdcf..93ac0560b 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StringName.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,77 +16,83 @@ Description ``StringName``\ s are immutable strings designed for general-purpose representation of unique names. ``StringName`` ensures that only one instance of a given name exists (so two ``StringName``\ s with the same value are the same object). Comparing them is much faster than with regular :ref:`String`\ s, because only the pointers are compared, not the whole strings. -Methods -------- +Constructors +------------ -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringName` | :ref:`StringName` **(** **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringName` | :ref:`StringName` **(** :ref:`StringName` from **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringName` | :ref:`StringName` **(** :ref:`String` from **)** |constructor| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`String` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`StringName` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`String` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`StringName` right **)** |operator| | -+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`StringName` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`StringName` **(** :ref:`StringName` from **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`StringName` **(** :ref:`String` from **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -Method Descriptions -------------------- +Operators +--------- -.. _class_StringName_method_StringName: ++-------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`String` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`StringName` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`String` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`StringName` right **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------+ -- :ref:`StringName` **StringName** **(** **)** |constructor| +Constructor Descriptions +------------------------ + +.. _class_StringName_constructor_StringName: + +- :ref:`StringName` **StringName** **(** **)** Constructs an empty ``StringName``. ---- -- :ref:`StringName` **StringName** **(** :ref:`StringName` from **)** |constructor| +- :ref:`StringName` **StringName** **(** :ref:`StringName` from **)** Constructs a ``StringName`` as a copy of the given ``StringName``. ---- -- :ref:`StringName` **StringName** **(** :ref:`String` from **)** |constructor| +- :ref:`StringName` **StringName** **(** :ref:`String` from **)** Creates a new ``StringName`` from the given :ref:`String`. ----- +Operator Descriptions +--------------------- -.. _class_StringName_method_operator !=: +.. _class_StringName_operator_neq_bool: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`bool` **operator !=** **(** **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`String` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`String` right **)** ---- -- :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** |operator| +- :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** ---- -.. _class_StringName_method_operator ==: +.. _class_StringName_operator_eq_bool: -- :ref:`bool` **operator ==** **(** **)** |operator| +- :ref:`bool` **operator ==** **(** **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`String` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`String` right **)** ---- -- :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** |operator| +- :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index bfbf1a3ec..454877ccb 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StyleBox.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index a407a5751..b4c2f4ee9 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StyleBoxEmpty.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 1e71df80d..0d1f6a48c 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StyleBoxFlat.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 3327db616..7523d2f62 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StyleBoxLine.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index fcb800d1e..48e01fa63 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StyleBoxTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_subviewport.rst b/classes/class_subviewport.rst index 3d9663d15..afd7b58a9 100644 --- a/classes/class_subviewport.rst +++ b/classes/class_subviewport.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SubViewport.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_subviewportcontainer.rst b/classes/class_subviewportcontainer.rst index a116e1f5f..ad21042fc 100644 --- a/classes/class_subviewportcontainer.rst +++ b/classes/class_subviewportcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SubViewportContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index fdce5ee5c..fcf1d67f0 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SurfaceTool.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_syntaxhighlighter.rst b/classes/class_syntaxhighlighter.rst index 6c3db9afc..bb7c3e54d 100644 --- a/classes/class_syntaxhighlighter.rst +++ b/classes/class_syntaxhighlighter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SyntaxHighlighter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_tabs.rst b/classes/class_tabbar.rst similarity index 59% rename from classes/class_tabs.rst rename to classes/class_tabbar.rst index d76c5a5bd..1375219d3 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabbar.rst @@ -1,17 +1,17 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the Tabs.xml source instead. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the TabBar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_Tabs: +.. _class_TabBar: -Tabs -==== +TabBar +====== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Tabs control. +Tab bar control. Description ----------- @@ -21,130 +21,130 @@ Simple tabs control, similar to :ref:`TabContainer` but is o Properties ---------- -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`clip_tabs` | ``true`` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`current_tab` | ``0`` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | ``false`` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`scrolling_enabled` | ``true`` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`TabAlign` | :ref:`tab_align` | ``1`` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | ``0`` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+-----------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`clip_tabs` | ``true`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`current_tab` | ``0`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | ``false`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`scrolling_enabled` | ``true`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`TabAlign` | :ref:`tab_align` | ``1`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | ``0`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ Methods ------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_tab_opentype_features` **(** :ref:`int` tab_idx **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_language` **(** :ref:`int` tab_idx **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_offset` **(** **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_opentype_feature` **(** :ref:`int` tab_idx, :ref:`String` tag **)** |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:`int` | :ref:`get_tabs_rearrange_group` **(** **)** |const| | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_language` **(** :ref:`int` tab_idx, :ref:`String` language **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_opentype_feature` **(** :ref:`int` tab_idx, :ref:`String` tag, :ref:`int` values **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_tab_opentype_features` **(** :ref:`int` tab_idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_language` **(** :ref:`int` tab_idx **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_offset` **(** **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_opentype_feature` **(** :ref:`int` tab_idx, :ref:`String` tag **)** |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:`int` | :ref:`get_tabs_rearrange_group` **(** **)** |const| | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_language` **(** :ref:`int` tab_idx, :ref:`String` language **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_opentype_feature` **(** :ref:`int` tab_idx, :ref:`String` tag, :ref:`int` values **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Texture2D` | :ref:`close` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`close_bg_highlight` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`close_bg_pressed` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Texture2D` | :ref:`decrement` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Texture2D` | :ref:`decrement_highlight` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Font` | :ref:`font` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.2)`` | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Color` | :ref:`font_selected_color` | ``Color(0.94, 0.94, 0.94, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`int` | :ref:`font_size` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Color` | :ref:`font_unselected_color` | ``Color(0.69, 0.69, 0.69, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`int` | :ref:`hseparation` | ``4`` | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Texture2D` | :ref:`increment` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`Texture2D` | :ref:`increment_highlight` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`int` | :ref:`outline_size` | ``0`` | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`tab_disabled` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`tab_selected` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`tab_unselected` | | -+-----------------------------------+----------------------------------------------------------------------------+--------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Texture2D` | :ref:`close` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`close_bg_highlight` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`close_bg_pressed` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Texture2D` | :ref:`decrement` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Texture2D` | :ref:`decrement_highlight` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Font` | :ref:`font` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.2)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_selected_color` | ``Color(0.94, 0.94, 0.94, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`int` | :ref:`font_size` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Color` | :ref:`font_unselected_color` | ``Color(0.69, 0.69, 0.69, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`int` | :ref:`hseparation` | ``4`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Texture2D` | :ref:`increment` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`Texture2D` | :ref:`increment_highlight` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`int` | :ref:`outline_size` | ``0`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`tab_disabled` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`tab_selected` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`tab_unselected` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------------+ Signals ------- -.. _class_Tabs_signal_active_tab_rearranged: +.. _class_TabBar_signal_active_tab_rearranged: - **active_tab_rearranged** **(** :ref:`int` idx_to **)** -Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. +Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. ---- -.. _class_Tabs_signal_tab_changed: +.. _class_TabBar_signal_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** @@ -152,7 +152,7 @@ Emitted when switching to another tab. ---- -.. _class_Tabs_signal_tab_clicked: +.. _class_TabBar_signal_tab_clicked: - **tab_clicked** **(** :ref:`int` tab **)** @@ -160,15 +160,30 @@ Emitted when a tab is clicked, even if it is the current tab. ---- -.. _class_Tabs_signal_tab_closed: +.. _class_TabBar_signal_tab_close_pressed: + +- **tab_close_pressed** **(** :ref:`int` tab **)** + +Emitted when a tab's close button is pressed. + +**Note:** Tabs are not removed automatically once the close button is pressed, this behaviour needs to be programmed manually. For example: + + +.. tabs:: + + .. code-tab:: gdscript + + $TabBar.tab_close_pressed.connect($TabBar.remove_tab) + + .. code-tab:: csharp + + GetNode("TabBar").TabClosePressed += GetNode("TabBar").RemoveTab; -- **tab_closed** **(** :ref:`int` tab **)** -Emitted when a tab is closed. ---- -.. _class_Tabs_signal_tab_hovered: +.. _class_TabBar_signal_tab_hovered: - **tab_hovered** **(** :ref:`int` tab **)** @@ -176,7 +191,7 @@ Emitted when a tab is hovered by the mouse. ---- -.. _class_Tabs_signal_tab_rmb_clicked: +.. _class_TabBar_signal_tab_rmb_clicked: - **tab_rmb_clicked** **(** :ref:`int` tab **)** @@ -185,15 +200,15 @@ Emitted when a tab is right-clicked. Enumerations ------------ -.. _enum_Tabs_TabAlign: +.. _enum_TabBar_TabAlign: -.. _class_Tabs_constant_ALIGN_LEFT: +.. _class_TabBar_constant_ALIGN_LEFT: -.. _class_Tabs_constant_ALIGN_CENTER: +.. _class_TabBar_constant_ALIGN_CENTER: -.. _class_Tabs_constant_ALIGN_RIGHT: +.. _class_TabBar_constant_ALIGN_RIGHT: -.. _class_Tabs_constant_ALIGN_MAX: +.. _class_TabBar_constant_ALIGN_MAX: enum **TabAlign**: @@ -203,19 +218,19 @@ enum **TabAlign**: - **ALIGN_RIGHT** = **2** --- Align the tabs to the right. -- **ALIGN_MAX** = **3** --- Represents the size of the :ref:`TabAlign` enum. +- **ALIGN_MAX** = **3** --- Represents the size of the :ref:`TabAlign` enum. ---- -.. _enum_Tabs_CloseButtonDisplayPolicy: +.. _enum_TabBar_CloseButtonDisplayPolicy: -.. _class_Tabs_constant_CLOSE_BUTTON_SHOW_NEVER: +.. _class_TabBar_constant_CLOSE_BUTTON_SHOW_NEVER: -.. _class_Tabs_constant_CLOSE_BUTTON_SHOW_ACTIVE_ONLY: +.. _class_TabBar_constant_CLOSE_BUTTON_SHOW_ACTIVE_ONLY: -.. _class_Tabs_constant_CLOSE_BUTTON_SHOW_ALWAYS: +.. _class_TabBar_constant_CLOSE_BUTTON_SHOW_ALWAYS: -.. _class_Tabs_constant_CLOSE_BUTTON_MAX: +.. _class_TabBar_constant_CLOSE_BUTTON_MAX: enum **CloseButtonDisplayPolicy**: @@ -225,12 +240,12 @@ enum **CloseButtonDisplayPolicy**: - **CLOSE_BUTTON_SHOW_ALWAYS** = **2** --- Show the close button on all tabs. -- **CLOSE_BUTTON_MAX** = **3** --- Represents the size of the :ref:`CloseButtonDisplayPolicy` enum. +- **CLOSE_BUTTON_MAX** = **3** --- Represents the size of the :ref:`CloseButtonDisplayPolicy` enum. Property Descriptions --------------------- -.. _class_Tabs_property_clip_tabs: +.. _class_TabBar_property_clip_tabs: - :ref:`bool` **clip_tabs** @@ -246,7 +261,7 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n ---- -.. _class_Tabs_property_current_tab: +.. _class_TabBar_property_current_tab: - :ref:`int` **current_tab** @@ -262,7 +277,7 @@ Select tab at index ``tab_idx``. ---- -.. _class_Tabs_property_drag_to_rearrange_enabled: +.. _class_TabBar_property_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -278,7 +293,7 @@ If ``true``, tabs can be rearranged with mouse drag. ---- -.. _class_Tabs_property_scrolling_enabled: +.. _class_TabBar_property_scrolling_enabled: - :ref:`bool` **scrolling_enabled** @@ -294,9 +309,9 @@ if ``true``, the mouse's scroll wheel can be used to navigate the scroll view. ---- -.. _class_Tabs_property_tab_align: +.. _class_TabBar_property_tab_align: -- :ref:`TabAlign` **tab_align** +- :ref:`TabAlign` **tab_align** +-----------+----------------------+ | *Default* | ``1`` | @@ -306,13 +321,13 @@ if ``true``, the mouse's scroll wheel can be used to navigate the scroll view. | *Getter* | get_tab_align() | +-----------+----------------------+ -The alignment of all tabs. See :ref:`TabAlign` for details. +The alignment of all tabs. See :ref:`TabAlign` for details. ---- -.. _class_Tabs_property_tab_close_display_policy: +.. _class_TabBar_property_tab_close_display_policy: -- :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** +- :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** +-----------+-------------------------------------+ | *Default* | ``0`` | @@ -322,12 +337,12 @@ The alignment of all tabs. See :ref:`TabAlign` for details. | *Getter* | get_tab_close_display_policy() | +-----------+-------------------------------------+ -Sets when the close button will appear on the tabs. See :ref:`CloseButtonDisplayPolicy` for details. +Sets when the close button will appear on the tabs. See :ref:`CloseButtonDisplayPolicy` for details. Method Descriptions ------------------- -.. _class_Tabs_method_add_tab: +.. _class_TabBar_method_add_tab: - void **add_tab** **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** @@ -335,7 +350,7 @@ Adds a new tab. ---- -.. _class_Tabs_method_clear_tab_opentype_features: +.. _class_TabBar_method_clear_tab_opentype_features: - void **clear_tab_opentype_features** **(** :ref:`int` tab_idx **)** @@ -343,7 +358,7 @@ Removes all OpenType features from the tab title. ---- -.. _class_Tabs_method_ensure_tab_visible: +.. _class_TabBar_method_ensure_tab_visible: - void **ensure_tab_visible** **(** :ref:`int` idx **)** @@ -351,7 +366,7 @@ Moves the scroll view to make the tab visible. ---- -.. _class_Tabs_method_get_offset_buttons_visible: +.. _class_TabBar_method_get_offset_buttons_visible: - :ref:`bool` **get_offset_buttons_visible** **(** **)** |const| @@ -359,7 +374,7 @@ Returns ``true`` if the offset buttons (the ones that appear when there's not en ---- -.. _class_Tabs_method_get_previous_tab: +.. _class_TabBar_method_get_previous_tab: - :ref:`int` **get_previous_tab** **(** **)** |const| @@ -367,7 +382,7 @@ Returns the previously active tab index. ---- -.. _class_Tabs_method_get_select_with_rmb: +.. _class_TabBar_method_get_select_with_rmb: - :ref:`bool` **get_select_with_rmb** **(** **)** |const| @@ -375,7 +390,7 @@ Returns ``true`` if select with right mouse button is enabled. ---- -.. _class_Tabs_method_get_tab_count: +.. _class_TabBar_method_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** |const| @@ -383,7 +398,7 @@ Returns the number of tabs. ---- -.. _class_Tabs_method_get_tab_disabled: +.. _class_TabBar_method_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** |const| @@ -391,7 +406,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. ---- -.. _class_Tabs_method_get_tab_icon: +.. _class_TabBar_method_get_tab_icon: - :ref:`Texture2D` **get_tab_icon** **(** :ref:`int` tab_idx **)** |const| @@ -399,7 +414,7 @@ Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` o ---- -.. _class_Tabs_method_get_tab_language: +.. _class_TabBar_method_get_tab_language: - :ref:`String` **get_tab_language** **(** :ref:`int` tab_idx **)** |const| @@ -407,7 +422,7 @@ Returns tab title language code. ---- -.. _class_Tabs_method_get_tab_offset: +.. _class_TabBar_method_get_tab_offset: - :ref:`int` **get_tab_offset** **(** **)** |const| @@ -415,7 +430,7 @@ Returns the number of hidden tabs offsetted to the left. ---- -.. _class_Tabs_method_get_tab_opentype_feature: +.. _class_TabBar_method_get_tab_opentype_feature: - :ref:`int` **get_tab_opentype_feature** **(** :ref:`int` tab_idx, :ref:`String` tag **)** |const| @@ -423,7 +438,7 @@ Returns OpenType feature ``tag`` of the tab title. ---- -.. _class_Tabs_method_get_tab_rect: +.. _class_TabBar_method_get_tab_rect: - :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** |const| @@ -431,7 +446,7 @@ Returns tab :ref:`Rect2` with local position and size. ---- -.. _class_Tabs_method_get_tab_text_direction: +.. _class_TabBar_method_get_tab_text_direction: - :ref:`TextDirection` **get_tab_text_direction** **(** :ref:`int` tab_idx **)** |const| @@ -439,7 +454,7 @@ Returns tab title text base writing direction. ---- -.. _class_Tabs_method_get_tab_title: +.. _class_TabBar_method_get_tab_title: - :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** |const| @@ -447,15 +462,15 @@ Returns the title of the tab at index ``tab_idx``. ---- -.. _class_Tabs_method_get_tabs_rearrange_group: +.. _class_TabBar_method_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** |const| -Returns the ``Tabs``' rearrange group ID. +Returns the ``TabBar``'s rearrange group ID. ---- -.. _class_Tabs_method_move_tab: +.. _class_TabBar_method_move_tab: - void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** @@ -463,7 +478,7 @@ Moves a tab from ``from`` to ``to``. ---- -.. _class_Tabs_method_remove_tab: +.. _class_TabBar_method_remove_tab: - void **remove_tab** **(** :ref:`int` tab_idx **)** @@ -471,7 +486,7 @@ Removes the tab at index ``tab_idx``. ---- -.. _class_Tabs_method_set_select_with_rmb: +.. _class_TabBar_method_set_select_with_rmb: - void **set_select_with_rmb** **(** :ref:`bool` enabled **)** @@ -479,7 +494,7 @@ If ``true``, enables selecting a tab with the right mouse button. ---- -.. _class_Tabs_method_set_tab_disabled: +.. _class_TabBar_method_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** @@ -487,7 +502,7 @@ If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it no ---- -.. _class_Tabs_method_set_tab_icon: +.. _class_TabBar_method_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** @@ -495,7 +510,7 @@ Sets an ``icon`` for the tab at index ``tab_idx``. ---- -.. _class_Tabs_method_set_tab_language: +.. _class_TabBar_method_set_tab_language: - void **set_tab_language** **(** :ref:`int` tab_idx, :ref:`String` language **)** @@ -503,7 +518,7 @@ Sets language code of tab title used for line-breaking and text shaping algorith ---- -.. _class_Tabs_method_set_tab_opentype_feature: +.. _class_TabBar_method_set_tab_opentype_feature: - void **set_tab_opentype_feature** **(** :ref:`int` tab_idx, :ref:`String` tag, :ref:`int` values **)** @@ -511,7 +526,7 @@ Sets OpenType feature ``tag`` for the tab title. More info: `OpenType feature ta ---- -.. _class_Tabs_method_set_tab_text_direction: +.. _class_TabBar_method_set_tab_text_direction: - void **set_tab_text_direction** **(** :ref:`int` tab_idx, :ref:`TextDirection` direction **)** @@ -519,7 +534,7 @@ Sets tab title base writing direction. ---- -.. _class_Tabs_method_set_tab_title: +.. _class_TabBar_method_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** @@ -527,24 +542,24 @@ Sets a ``title`` for the tab at index ``tab_idx``. ---- -.. _class_Tabs_method_set_tabs_rearrange_group: +.. _class_TabBar_method_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** -Defines the rearrange group ID. Choose for each ``Tabs`` the same value to dragging tabs between ``Tabs``. Enable drag with :ref:`drag_to_rearrange_enabled`. +Defines the rearrange group ID. Choose for each ``TabBar`` the same value to dragging tabs between ``TabBar``. Enable drag with :ref:`drag_to_rearrange_enabled`. Theme Property Descriptions --------------------------- -.. _class_Tabs_theme_icon_close: +.. _class_TabBar_theme_icon_close: - :ref:`Texture2D` **close** -The icon for the close button (see :ref:`tab_close_display_policy`). +The icon for the close button (see :ref:`tab_close_display_policy`). ---- -.. _class_Tabs_theme_style_close_bg_highlight: +.. _class_TabBar_theme_style_close_bg_highlight: - :ref:`StyleBox` **close_bg_highlight** @@ -552,7 +567,7 @@ Background of the close button when it's being hovered with the cursor. ---- -.. _class_Tabs_theme_style_close_bg_pressed: +.. _class_TabBar_theme_style_close_bg_pressed: - :ref:`StyleBox` **close_bg_pressed** @@ -560,7 +575,7 @@ Background of the close button when it's being pressed. ---- -.. _class_Tabs_theme_icon_decrement: +.. _class_TabBar_theme_icon_decrement: - :ref:`Texture2D` **decrement** @@ -568,7 +583,7 @@ Icon for the left arrow button that appears when there are too many tabs to fit ---- -.. _class_Tabs_theme_icon_decrement_highlight: +.. _class_TabBar_theme_icon_decrement_highlight: - :ref:`Texture2D` **decrement_highlight** @@ -576,7 +591,7 @@ Icon for the left arrow button that appears when there are too many tabs to fit ---- -.. _class_Tabs_theme_font_font: +.. _class_TabBar_theme_font_font: - :ref:`Font` **font** @@ -584,7 +599,7 @@ The font used to draw tab names. ---- -.. _class_Tabs_theme_color_font_disabled_color: +.. _class_TabBar_theme_color_font_disabled_color: - :ref:`Color` **font_disabled_color** @@ -596,7 +611,7 @@ Font color of disabled tabs. ---- -.. _class_Tabs_theme_color_font_outline_color: +.. _class_TabBar_theme_color_font_outline_color: - :ref:`Color` **font_outline_color** @@ -608,7 +623,7 @@ The tint of text outline of the tab name. ---- -.. _class_Tabs_theme_color_font_selected_color: +.. _class_TabBar_theme_color_font_selected_color: - :ref:`Color` **font_selected_color** @@ -620,7 +635,7 @@ Font color of the currently selected tab. ---- -.. _class_Tabs_theme_font_size_font_size: +.. _class_TabBar_theme_font_size_font_size: - :ref:`int` **font_size** @@ -628,7 +643,7 @@ Font size of the tab names. ---- -.. _class_Tabs_theme_color_font_unselected_color: +.. _class_TabBar_theme_color_font_unselected_color: - :ref:`Color` **font_unselected_color** @@ -640,7 +655,7 @@ Font color of the other, unselected tabs. ---- -.. _class_Tabs_theme_constant_hseparation: +.. _class_TabBar_theme_constant_hseparation: - :ref:`int` **hseparation** @@ -652,7 +667,7 @@ The horizontal separation between the elements inside tabs. ---- -.. _class_Tabs_theme_icon_increment: +.. _class_TabBar_theme_icon_increment: - :ref:`Texture2D` **increment** @@ -660,7 +675,7 @@ Icon for the right arrow button that appears when there are too many tabs to fit ---- -.. _class_Tabs_theme_icon_increment_highlight: +.. _class_TabBar_theme_icon_increment_highlight: - :ref:`Texture2D` **increment_highlight** @@ -668,7 +683,7 @@ Icon for the right arrow button that appears when there are too many tabs to fit ---- -.. _class_Tabs_theme_constant_outline_size: +.. _class_TabBar_theme_constant_outline_size: - :ref:`int` **outline_size** @@ -680,7 +695,7 @@ The size of the tab text outline. ---- -.. _class_Tabs_theme_style_tab_disabled: +.. _class_TabBar_theme_style_tab_disabled: - :ref:`StyleBox` **tab_disabled** @@ -688,7 +703,7 @@ The style of disabled tabs. ---- -.. _class_Tabs_theme_style_tab_selected: +.. _class_TabBar_theme_style_tab_selected: - :ref:`StyleBox` **tab_selected** @@ -696,7 +711,7 @@ The style of the currently selected tab. ---- -.. _class_Tabs_theme_style_tab_unselected: +.. _class_TabBar_theme_style_tab_unselected: - :ref:`StyleBox` **tab_unselected** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 14e1835e4..02a832385 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TabContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -277,6 +277,8 @@ Returns the child :ref:`Control` node located at the active tab i Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`Window.visible` property. + ---- .. _class_TabContainer_method_get_previous_tab: diff --git a/classes/class_tcpserver.rst b/classes/class_tcpserver.rst index c4db881c8..581e82718 100644 --- a/classes/class_tcpserver.rst +++ b/classes/class_tcpserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TCPServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index b99a5a17b..2bb247013 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextEdit.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -38,6 +38,8 @@ Properties +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`draw_control_chars` | ``false`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`draw_spaces` | ``false`` | @@ -54,6 +56,8 @@ Properties +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`String` | :ref:`language` | ``""`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`middle_mouse_paste_enabled` | ``true`` | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`minimap_draw` | ``false`` | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`int` | :ref:`minimap_width` | ``80`` | @@ -105,6 +109,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_paste` **(** **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_paste_primary_clipboard` **(** **)** |virtual| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_gutter` **(** :ref:`int` at=-1 **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`adjust_viewport_to_caret` **(** **)** | @@ -764,6 +770,22 @@ If ``true``, a right-click displays the context menu. ---- +.. _class_TextEdit_property_deselect_on_focus_loss_enabled: + +- :ref:`bool` **deselect_on_focus_loss_enabled** + ++-----------+-------------------------------------------+ +| *Default* | ``true`` | ++-----------+-------------------------------------------+ +| *Setter* | set_deselect_on_focus_loss_enabled(value) | ++-----------+-------------------------------------------+ +| *Getter* | is_deselect_on_focus_loss_enabled() | ++-----------+-------------------------------------------+ + +If ``true``, the selected text will be deselected when focus is lost. + +---- + .. _class_TextEdit_property_draw_control_chars: - :ref:`bool` **draw_control_chars** @@ -876,17 +898,35 @@ Language code used for line-breaking and text shaping algorithms, if left empty ---- +.. _class_TextEdit_property_middle_mouse_paste_enabled: + +- :ref:`bool` **middle_mouse_paste_enabled** + ++-----------+---------------------------------------+ +| *Default* | ``true`` | ++-----------+---------------------------------------+ +| *Setter* | set_middle_mouse_paste_enabled(value) | ++-----------+---------------------------------------+ +| *Getter* | is_middle_mouse_paste_enabled() | ++-----------+---------------------------------------+ + +If ``false``, using middle mouse button to paste clipboard will be disabled. + +**Note:** This method is only implemented on Linux. + +---- + .. _class_TextEdit_property_minimap_draw: - :ref:`bool` **minimap_draw** -+-----------+----------------------+ -| *Default* | ``false`` | -+-----------+----------------------+ -| *Setter* | draw_minimap(value) | -+-----------+----------------------+ -| *Getter* | is_drawing_minimap() | -+-----------+----------------------+ ++-----------+-------------------------+ +| *Default* | ``false`` | ++-----------+-------------------------+ +| *Setter* | set_draw_minimap(value) | ++-----------+-------------------------+ +| *Getter* | is_drawing_minimap() | ++-----------+-------------------------+ If ``true``, a minimap is shown, providing an outline of your source code. @@ -1189,6 +1229,16 @@ Override this method to define what happens when the user performs a paste opera ---- +.. _class_TextEdit_method__paste_primary_clipboard: + +- void **_paste_primary_clipboard** **(** **)** |virtual| + +Override this method to define what happens when the user performs a paste operation with middle mouse button. + +**Note:** This method is only implemented on Linux. + +---- + .. _class_TextEdit_method_add_gutter: - void **add_gutter** **(** :ref:`int` at=-1 **)** @@ -1523,6 +1573,8 @@ Returns the local mouse position adjusted for the text direction. Returns the :ref:`PopupMenu` of this ``TextEdit``. By default, this menu is displayed when right-clicking on the ``TextEdit``. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`Window.visible` property. + ---- .. _class_TextEdit_method_get_minimap_line_at_pos: diff --git a/classes/class_textline.rst b/classes/class_textline.rst index 502da1c47..0dec067ab 100644 --- a/classes/class_textline.rst +++ b/classes/class_textline.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextLine.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_textparagraph.rst b/classes/class_textparagraph.rst index a9e7c5d62..db279393e 100644 --- a/classes/class_textparagraph.rst +++ b/classes/class_textparagraph.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextParagraph.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -24,6 +24,8 @@ Properties +------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`HAlign` | :ref:`align` | ``0`` | +------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ +| :ref:`String` | :ref:`custom_punctuation` | ``""`` | ++------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`Direction` | :ref:`direction` | ``0`` | +------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`flags` | ``99`` | @@ -93,7 +95,7 @@ Methods +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_line_width` **(** :ref:`int` line **)** |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_non_wraped_size` **(** **)** |const| | +| :ref:`Vector2` | :ref:`get_non_wrapped_size` **(** **)** |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -160,6 +162,22 @@ Paragraph horizontal alignment. ---- +.. _class_TextParagraph_property_custom_punctuation: + +- :ref:`String` **custom_punctuation** + ++-----------+-------------------------------+ +| *Default* | ``""`` | ++-----------+-------------------------------+ +| *Setter* | set_custom_punctuation(value) | ++-----------+-------------------------------+ +| *Getter* | get_custom_punctuation() | ++-----------+-------------------------------+ + +Custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + +---- + .. _class_TextParagraph_property_direction: - :ref:`Direction` **direction** @@ -481,9 +499,9 @@ Returns width (for horizontal layout) or height (for vertical) of the line of te ---- -.. _class_TextParagraph_method_get_non_wraped_size: +.. _class_TextParagraph_method_get_non_wrapped_size: -- :ref:`Vector2` **get_non_wraped_size** **(** **)** |const| +- :ref:`Vector2` **get_non_wrapped_size** **(** **)** |const| Returns the size of the bounding box of the paragraph, without line breaks. diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 85ddf03b8..f307ded03 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -80,6 +80,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`font_get_msdf_size` **(** :ref:`RID` font_rid **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`font_get_name` **(** :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| | @@ -92,6 +94,10 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`font_get_spacing` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`SpacingType` spacing **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_style` **(** :ref:`RID` font_rid **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`font_get_style_name` **(** :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| | @@ -170,6 +176,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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_oversampling` **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`font_set_scale` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** | @@ -178,6 +186,10 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`font_set_spacing` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`SpacingType` spacing, :ref:`int` value **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_style` **(** :ref:`RID` font_rid, :ref:`int` style **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_style_name` **(** :ref:`RID` font_rid, :ref:`String` name **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | @@ -238,6 +250,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position **)** |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| | @@ -302,6 +316,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shaped_text_set_bidi_override` **(** :ref:`RID` shaped, :ref:`Array` override **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 **)** | @@ -318,6 +334,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`shaped_text_tab_align` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_diacritics` **(** :ref:`String` string **)** |const| | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`tag_to_name` **(** :ref:`int` tag **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -588,6 +606,24 @@ enum **SpacingType**: - **SPACING_BOTTOM** = **3** --- Spacing at the bottom of the line. +---- + +.. _enum_TextServer_FontStyle: + +.. _class_TextServer_constant_FONT_BOLD: + +.. _class_TextServer_constant_FONT_ITALIC: + +.. _class_TextServer_constant_FONT_FIXED_WIDTH: + +enum **FontStyle**: + +- **FONT_BOLD** = **1** --- Font is bold. + +- **FONT_ITALIC** = **2** --- Font is italic or oblique. + +- **FONT_FIXED_WIDTH** = **4** --- Font have fixed-width characters. + Method Descriptions ------------------- @@ -835,6 +871,14 @@ Returns source font size used to generate MSDF textures. ---- +.. _class_TextServer_method_font_get_name: + +- :ref:`String` **font_get_name** **(** :ref:`RID` font_rid **)** |const| + +Returns font family name. + +---- + .. _class_TextServer_method_font_get_oversampling: - :ref:`float` **font_get_oversampling** **(** :ref:`RID` font_rid **)** |const| @@ -883,6 +927,22 @@ Returns extra spacing added between glyphs in pixels. ---- +.. _class_TextServer_method_font_get_style: + +- :ref:`int` **font_get_style** **(** :ref:`RID` font_rid **)** |const| + +Returns font style flags, see :ref:`FontStyle`. + +---- + +.. _class_TextServer_method_font_get_style_name: + +- :ref:`String` **font_get_style_name** **(** :ref:`RID` font_rid **)** |const| + +Returns font style name. + +---- + .. _class_TextServer_method_font_get_supported_chars: - :ref:`String` **font_get_supported_chars** **(** :ref:`RID` font_rid **)** |const| @@ -1205,6 +1265,14 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s ---- +.. _class_TextServer_method_font_set_name: + +- void **font_set_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** + +Sets the font family name. + +---- + .. _class_TextServer_method_font_set_oversampling: - void **font_set_oversampling** **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** @@ -1237,6 +1305,22 @@ Sets extra spacing added between glyphs in pixels. ---- +.. _class_TextServer_method_font_set_style: + +- void **font_set_style** **(** :ref:`RID` font_rid, :ref:`int` style **)** + +Sets the font style flags, see :ref:`FontStyle`. + +---- + +.. _class_TextServer_method_font_set_style_name: + +- void **font_set_style_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** + +Set the font style name. + +---- + .. _class_TextServer_method_font_set_texture_image: - void **font_set_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** @@ -1483,6 +1567,14 @@ Returns shapes of the carets corresponding to the character offset ``position`` ---- +.. _class_TextServer_method_shaped_text_get_custom_punctuation: + +- :ref:`String` **shaped_text_get_custom_punctuation** **(** :ref:`RID` shaped **)** |const| + +Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + +---- + .. _class_TextServer_method_shaped_text_get_descent: - :ref:`float` **shaped_text_get_descent** **(** :ref:`RID` shaped **)** |const| @@ -1745,6 +1837,14 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w ---- +.. _class_TextServer_method_shaped_text_set_custom_punctuation: + +- void **shaped_text_set_custom_punctuation** **(** :ref:`RID` shaped, :ref:`String` punct **)** + +Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + +---- + .. _class_TextServer_method_shaped_text_set_direction: - void **shaped_text_set_direction** **(** :ref:`RID` shaped, :ref:`Direction` direction=0 **)** @@ -1815,6 +1915,14 @@ Aligns shaped text to the given tab-stops. ---- +.. _class_TextServer_method_strip_diacritics: + +- :ref:`String` **strip_diacritics** **(** :ref:`String` string **)** |const| + +Strips diacritics from the string. + +---- + .. _class_TextServer_method_tag_to_name: - :ref:`String` **tag_to_name** **(** :ref:`int` tag **)** |const| diff --git a/classes/class_textserveradvanced.rst b/classes/class_textserveradvanced.rst index 4e97edd99..4998cbc01 100644 --- a/classes/class_textserveradvanced.rst +++ b/classes/class_textserveradvanced.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextServerAdvanced.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 9ca62da7b..036194989 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextServerExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -78,6 +78,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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:`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| | @@ -90,6 +92,10 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_font_get_spacing` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`SpacingType` spacing **)** |virtual| |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_font_get_style` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_font_get_style_name` **(** :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| | @@ -170,6 +176,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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_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| | @@ -178,6 +186,10 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_font_set_spacing` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_font_set_style` **(** :ref:`RID` font_rid, :ref:`int` style **)** |virtual| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_font_set_style_name` **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |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| | @@ -238,6 +250,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |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:`int` | :ref:`_shaped_text_get_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | @@ -302,6 +316,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_set_bidi_override` **(** :ref:`RID` shaped, :ref:`Array` override **)** |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| | @@ -572,6 +588,14 @@ Returns source font size used to generate MSDF textures. ---- +.. _class_TextServerExtension_method__font_get_name: + +- :ref:`String` **_font_get_name** **(** :ref:`RID` font_rid **)** |virtual| |const| + +Returns font family name. + +---- + .. _class_TextServerExtension_method__font_get_oversampling: - :ref:`float` **_font_get_oversampling** **(** :ref:`RID` font_rid **)** |virtual| |const| @@ -620,6 +644,22 @@ Returns extra spacing added between glyphs in pixels. ---- +.. _class_TextServerExtension_method__font_get_style: + +- :ref:`int` **_font_get_style** **(** :ref:`RID` font_rid **)** |virtual| |const| + +Returns font style flags, see :ref:`FontStyle`. + +---- + +.. _class_TextServerExtension_method__font_get_style_name: + +- :ref:`String` **_font_get_style_name** **(** :ref:`RID` font_rid **)** |virtual| |const| + +Returns font style name. + +---- + .. _class_TextServerExtension_method__font_get_supported_chars: - :ref:`String` **_font_get_supported_chars** **(** :ref:`RID` font_rid **)** |virtual| |const| @@ -946,6 +986,14 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s ---- +.. _class_TextServerExtension_method__font_set_name: + +- void **_font_set_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** |virtual| + +Sets the font family name. + +---- + .. _class_TextServerExtension_method__font_set_oversampling: - void **_font_set_oversampling** **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** |virtual| @@ -978,6 +1026,22 @@ Sets extra spacing added between glyphs in pixels. ---- +.. _class_TextServerExtension_method__font_set_style: + +- void **_font_set_style** **(** :ref:`RID` font_rid, :ref:`int` style **)** |virtual| + +Sets the font style flags, see :ref:`FontStyle`. + +---- + +.. _class_TextServerExtension_method__font_set_style_name: + +- void **_font_set_style_name** **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |virtual| + +Sets the font style name. + +---- + .. _class_TextServerExtension_method__font_set_texture_image: - void **_font_set_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** |virtual| @@ -1224,6 +1288,14 @@ Returns shapes of the carets corresponding to the character offset ``position`` ---- +.. _class_TextServerExtension_method__shaped_text_get_custom_punctuation: + +- :ref:`String` **_shaped_text_get_custom_punctuation** **(** :ref:`RID` shaped **)** |virtual| |const| + +Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + +---- + .. _class_TextServerExtension_method__shaped_text_get_descent: - :ref:`float` **_shaped_text_get_descent** **(** :ref:`RID` shaped **)** |virtual| |const| @@ -1486,6 +1558,14 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w ---- +.. _class_TextServerExtension_method__shaped_text_set_custom_punctuation: + +- void **_shaped_text_set_custom_punctuation** **(** :ref:`RID` shaped, :ref:`String` punct **)** |virtual| + +Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + +---- + .. _class_TextServerExtension_method__shaped_text_set_direction: - void **_shaped_text_set_direction** **(** :ref:`RID` shaped, :ref:`Direction` direction **)** |virtual| diff --git a/classes/class_textserverfallback.rst b/classes/class_textserverfallback.rst index 8c13dda1c..87b258ffe 100644 --- a/classes/class_textserverfallback.rst +++ b/classes/class_textserverfallback.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextServerFallback.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_textservermanager.rst b/classes/class_textservermanager.rst index 255ace68a..92cb0dcb6 100644 --- a/classes/class_textservermanager.rst +++ b/classes/class_textservermanager.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextServerManager.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 722a39c8e..eadd9dca4 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Texture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_texture2d.rst b/classes/class_texture2d.rst index 8957afe8a..db3a2bc11 100644 --- a/classes/class_texture2d.rst +++ b/classes/class_texture2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Texture2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ Texture2D **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CameraTexture`, :ref:`CanvasTexture`, :ref:`CurveTexture`, :ref:`CurveXYZTexture`, :ref:`GradientTexture`, :ref:`ImageTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture2D`, :ref:`ViewportTexture` +**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CameraTexture`, :ref:`CanvasTexture`, :ref:`CurveTexture`, :ref:`CurveXYZTexture`, :ref:`GradientTexture1D`, :ref:`GradientTexture2D`, :ref:`ImageTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture2D`, :ref:`ViewportTexture` Texture for 2D and 3D. diff --git a/classes/class_texture2darray.rst b/classes/class_texture2darray.rst index e65f53294..725cede19 100644 --- a/classes/class_texture2darray.rst +++ b/classes/class_texture2darray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Texture2DArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index fa8e64e28..ee84ad7e7 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Texture3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index d281d5726..352ec1635 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextureButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 5ae1108b0..62198da48 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextureLayered.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_textureprogressbar.rst b/classes/class_textureprogressbar.rst index c0fa46955..966ce6c36 100644 --- a/classes/class_textureprogressbar.rst +++ b/classes/class_textureprogressbar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextureProgressBar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 667a6afbf..28a79ecdb 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TextureRect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_theme.rst b/classes/class_theme.rst index f71dca76d..5229ba9c2 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Theme.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 58a2bc65a..0e50a944b 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Thread.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -35,7 +35,9 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_id` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** |const| | +| :ref:`bool` | :ref:`is_alive` **(** **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_started` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`start` **(** :ref:`Callable` callable, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,11 +74,21 @@ Returns the current ``Thread``'s ID, uniquely identifying it among all threads. ---- -.. _class_Thread_method_is_active: +.. _class_Thread_method_is_alive: -- :ref:`bool` **is_active** **(** **)** |const| +- :ref:`bool` **is_alive** **(** **)** |const| -Returns ``true`` if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. +Returns ``true`` if this ``Thread`` is currently running. This is useful for determining if :ref:`wait_to_finish` can be called without blocking the calling thread. + +To check if a ``Thread`` is joinable, use :ref:`is_started`. + +---- + +.. _class_Thread_method_is_started: + +- :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`. ---- @@ -84,7 +96,7 @@ Returns ``true`` if this ``Thread`` is currently active. An active ``Thread`` ca - :ref:`Error` **start** **(** :ref:`Callable` callable, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** -Starts a new ``Thread`` that calls ``callable`` with ``userdata`` passed as an argument. Even if no userdata is passed, ``method`` must accept one argument and it will be null. The ``priority`` of the ``Thread`` can be changed by passing a value from the :ref:`Priority` enum. +Starts a new ``Thread`` that calls ``callable`` with ``userdata`` passed as an argument. Even if no userdata is passed, ``callable`` must accept one argument and it will be null. The ``priority`` of the ``Thread`` can be changed by passing a value from the :ref:`Priority` enum. Returns :ref:`@GlobalScope.OK` on success, or :ref:`@GlobalScope.ERR_CANT_CREATE` on failure. @@ -94,10 +106,12 @@ Returns :ref:`@GlobalScope.OK` on success, or :r - :ref:`Variant` **wait_to_finish** **(** **)** -Joins the ``Thread`` and waits for it to finish. Returns what the method called returned. +Joins the ``Thread`` and waits for it to finish. Returns the output of the :ref:`Callable` passed to :ref:`start`. Should either be used when you want to retrieve the value returned from the method called by the ``Thread`` or before freeing the instance that contains the ``Thread``. +To determine if this can be called without blocking the calling thread, check if :ref:`is_alive` is ``false``. + **Note:** After the ``Thread`` finishes joining it will be disposed. If you want to use it again you will have to create a new instance of it. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` diff --git a/classes/class_tiledata.rst b/classes/class_tiledata.rst index 697866432..a8aaf276f 100644 --- a/classes/class_tiledata.rst +++ b/classes/class_tiledata.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TileData.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 8d7397bb9..5356e9f47 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TileMap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -53,63 +53,81 @@ Properties Methods ------- -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_layer` **(** :ref:`int` to_position **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_layer` **(** :ref:`int` layer **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_invalid_tiles` **(** **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_alternative_tile` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`get_cell_atlas_coords` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_source_id` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`get_coords_for_body_rid` **(** :ref:`RID` body **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_layer_name` **(** :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:`Vector2i` | :ref:`get_neighbor_cell` **(** :ref:`Vector2i` coords, :ref:`CellNeighbor` neighbor **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i[]` | :ref:`get_surrounding_tiles` **(** :ref:`Vector2i` coords **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i[]` | :ref:`get_used_cells` **(** :ref:`int` layer **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_layer_enabled` **(** :ref:`int` layer **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_layer_y_sort_enabled` **(** :ref:`int` layer **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2i` map_position **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_layer` **(** :ref:`int` layer, :ref:`int` to_position **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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=-1 **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_enabled` **(** :ref:`int` layer, :ref:`bool` enabled **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_name` **(** :ref:`int` layer, :ref:`String` name **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** |const| | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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 **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`get_cell_atlas_coords` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_source_id` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`get_coords_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:`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:`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_tiles` **(** :ref:`Vector2i` coords **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i[]` | :ref:`get_used_cells` **(** :ref:`int` layer **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_layer_enabled` **(** :ref:`int` layer **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_layer_y_sort_enabled` **(** :ref:`int` layer **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`map_pattern` **(** :ref:`Vector2i` position_in_tilemap, :ref:`Vector2i` coords_in_pattern, :ref:`TileMapPattern` pattern **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2i` map_position **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_layer` **(** :ref:`int` layer, :ref:`int` to_position **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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=-1 **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cells_from_surrounding_terrains` **(** :ref:`int` layer, :ref:`Vector2i[]` cells, :ref:`int` terrain_set, :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` enabled **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_name` **(** :ref:`int` layer, :ref:`String` name **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_pattern` **(** :ref:`int` layer, :ref:`Vector2i` position, :ref:`TileMapPattern` pattern **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** |const| | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -223,6 +241,30 @@ The assigned :ref:`TileSet`. Method Descriptions ------------------- +.. _class_TileMap_method__tile_data_runtime_update: + +- void **_tile_data_runtime_update** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`TileData` tile_data **)** |virtual| + +Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime. + +This method is only called if :ref:`_use_tile_data_runtime_update` is implemented and returns ``true`` for the given tile ``coords[/coords] and [code]layer``. + +**Warning:** The ``tile_data`` object's sub-resources are the same as the one in the TileSet. Modifying them might impact the whole TileSet. Instead, make sure to duplicate those resources. + +**Note:** If the properties of ``tile_data`` object should change over time, use :ref:`force_update` to trigger a TileMap update. + +---- + +.. _class_TileMap_method__use_tile_data_runtime_update: + +- :ref:`bool` **_use_tile_data_runtime_update** **(** :ref:`int` layer, :ref:`Vector2i` coords **)** |virtual| + +Should return ``true`` if the tile at coordinates ``coords[/coords] on layer [code]layer`` requires a runtime update. + +**Warning:** Make sure this function only return ``true`` when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty. + +---- + .. _class_TileMap_method_add_layer: - void **add_layer** **(** :ref:`int` to_position **)** @@ -255,6 +297,18 @@ Clears cells that do not exist in the tileset. ---- +.. _class_TileMap_method_force_update: + +- void **force_update** **(** :ref:`int` layer=-1 **)** + +Triggers an update of the TileMap. If ``layer`` is provided, only updates the given layer. + +**Note:** The TileMap node updates automatically when one of its properties is modified. A manual update is only needed if runtime modifications (implemented in :ref:`_tile_data_runtime_update`) need to be applied. + +**Warning:** Updating the TileMap is a performance demanding task. Limit occurences of those updates to the minimum and limit the amount tiles they impact (by segregating tiles updated often to a dedicated layer for example). + +---- + .. _class_TileMap_method_get_cell_alternative_tile: - :ref:`int` **get_cell_alternative_tile** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies **)** |const| @@ -287,6 +341,14 @@ Returns the coodinates of the tile for given physics body RID. Such RID can be r ---- +.. _class_TileMap_method_get_layer_modulate: + +- :ref:`Color` **get_layer_modulate** **(** :ref:`int` layer **)** |const| + +Returns a TileMap layer's modulate. + +---- + .. _class_TileMap_method_get_layer_name: - :ref:`String` **get_layer_name** **(** :ref:`int` layer **)** |const| @@ -325,6 +387,14 @@ Returns the neighboring cell to the one at coordinates ``coords``, indentified b ---- +.. _class_TileMap_method_get_pattern: + +- :ref:`TileMapPattern` **get_pattern** **(** :ref:`int` layer, :ref:`Vector2i[]` coords_array **)** + +Creates a new :ref:`TileMapPattern` from the given layer and set of cells. + +---- + .. _class_TileMap_method_get_surrounding_tiles: - :ref:`Vector2i[]` **get_surrounding_tiles** **(** :ref:`Vector2i` coords **)** @@ -365,6 +435,14 @@ Returns if a layer Y-sorts its tiles. ---- +.. _class_TileMap_method_map_pattern: + +- :ref:`Vector2i` **map_pattern** **(** :ref:`Vector2i` position_in_tilemap, :ref:`Vector2i` coords_in_pattern, :ref:`TileMapPattern` pattern **)** + +Returns for the given coodinate ``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`` + +---- + .. _class_TileMap_method_map_to_world: - :ref:`Vector2` **map_to_world** **(** :ref:`Vector2i` map_position **)** |const| @@ -403,6 +481,16 @@ Sets the tile indentifiers for the cell on layer ``layer`` at coordinates ``coor ---- +.. _class_TileMap_method_set_cells_from_surrounding_terrains: + +- void **set_cells_from_surrounding_terrains** **(** :ref:`int` layer, :ref:`Vector2i[]` cells, :ref:`int` terrain_set, :ref:`bool` ignore_empty_terrains=true **)** + +Updates all the cells in the ``cells`` coordinates array and replace them by tiles that matches the surrounding cells terrains. Only cells form the given ``terrain_set`` are considered. + +If ``ignore_empty_terrains`` is true, zones with no terrain defined are ignored to select the tiles. + +---- + .. _class_TileMap_method_set_layer_enabled: - void **set_layer_enabled** **(** :ref:`int` layer, :ref:`bool` enabled **)** @@ -411,6 +499,14 @@ Enables or disables the layer ``layer``. A disabled layer is not processed at al ---- +.. _class_TileMap_method_set_layer_modulate: + +- void **set_layer_modulate** **(** :ref:`int` layer, :ref:`Color` enabled **)** + +Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. + +---- + .. _class_TileMap_method_set_layer_name: - void **set_layer_name** **(** :ref:`int` layer, :ref:`String` name **)** @@ -447,6 +543,14 @@ Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. ---- +.. _class_TileMap_method_set_pattern: + +- void **set_pattern** **(** :ref:`int` layer, :ref:`Vector2i` position, :ref:`TileMapPattern` pattern **)** + +Paste the given :ref:`TileMapPattern` at the given ``position`` and ``layer`` in the tile map. + +---- + .. _class_TileMap_method_world_to_map: - :ref:`Vector2i` **world_to_map** **(** :ref:`Vector2` world_position **)** |const| diff --git a/classes/class_tilemappattern.rst b/classes/class_tilemappattern.rst new file mode 100644 index 000000000..099fbdee3 --- /dev/null +++ b/classes/class_tilemappattern.rst @@ -0,0 +1,134 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the TileMapPattern.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_TileMapPattern: + +TileMapPattern +============== + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Holds a pattern to be copied from or pasted into :ref:`TileMap`\ s. + +Description +----------- + +This resource holds a set of cells to help bulk manipulations of :ref:`TileMap`. + +A pattern always start at the ``(0,0)`` coordinates and cannot have cells with negative coordinates. + +Methods +------- + ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_TileMapPattern_method_get_cell_alternative_tile: + +- :ref:`int` **get_cell_alternative_tile** **(** :ref:`Vector2i` coords **)** |const| + +Returns the tile alternative ID of the cell at ``coords``. + +---- + +.. _class_TileMapPattern_method_get_cell_atlas_coords: + +- :ref:`Vector2i` **get_cell_atlas_coords** **(** :ref:`Vector2i` coords **)** |const| + +Returns the tile atlas coordinates ID of the cell at ``coords``. + +---- + +.. _class_TileMapPattern_method_get_cell_source_id: + +- :ref:`int` **get_cell_source_id** **(** :ref:`Vector2i` coords **)** |const| + +Returns the tile source ID of the cell at ``coords``. + +---- + +.. _class_TileMapPattern_method_get_size: + +- :ref:`Vector2i` **get_size** **(** **)** |const| + +Returns the size, in cells, of the pattern. + +---- + +.. _class_TileMapPattern_method_get_used_cells: + +- :ref:`Vector2i[]` **get_used_cells** **(** **)** |const| + +Returns the list of used cell coordinates in the pattern. + +---- + +.. _class_TileMapPattern_method_has_cell: + +- :ref:`bool` **has_cell** **(** :ref:`Vector2i` coords **)** |const| + +Returns whether the pattern has a tile at the given coordinates. + +---- + +.. _class_TileMapPattern_method_is_empty: + +- :ref:`bool` **is_empty** **(** **)** |const| + +Returns whether the pattern is empty or not. + +---- + +.. _class_TileMapPattern_method_remove_cell: + +- void **remove_cell** **(** :ref:`Vector2i` coords, :ref:`bool` update_size **)** + +Remove the cell at the given coordinates. + +---- + +.. _class_TileMapPattern_method_set_cell: + +- void **set_cell** **(** :ref:`Vector2i` coords, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=-1 **)** + +Sets the tile indentifiers for the cell at coordinates ``coords``. See :ref:`TileMap.set_cell`. + +---- + +.. _class_TileMapPattern_method_set_size: + +- void **set_size** **(** :ref:`Vector2i` size **)** + +Sets the size of the pattern. + +.. |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.)` diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 314cd80e9..7717628a5 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TileSet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -72,6 +72,8 @@ Methods +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | @@ -102,6 +104,10 @@ Methods +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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| | @@ -160,6 +166,8 @@ Methods +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | @@ -466,6 +474,14 @@ Occlusion layers allow assigning occlusion polygons to atlas tiles. ---- +.. _class_TileSet_method_add_pattern: + +- :ref:`int` **add_pattern** **(** :ref:`TileMapPattern` pattern, :ref:`int` index=-1 **)** + +Adds a :ref:`TileMapPattern` to be stored in the TileSet resouce. If provided, insert it at the given ``index``. + +---- + .. _class_TileSet_method_add_physics_layer: - void **add_physics_layer** **(** :ref:`int` to_position=-1 **)** @@ -594,6 +610,22 @@ Returns the occlusion layers count. ---- +.. _class_TileSet_method_get_pattern: + +- :ref:`TileMapPattern` **get_pattern** **(** :ref:`int` index=-1 **)** + +Returns the :ref:`TileMapPattern` at the given ``index``. + +---- + +.. _class_TileSet_method_get_patterns_count: + +- :ref:`int` **get_patterns_count** **(** **)** + +Returns the number of :ref:`TileMapPattern` this tile set handles. + +---- + .. _class_TileSet_method_get_physics_layer_collision_layer: - :ref:`int` **get_physics_layer_collision_layer** **(** :ref:`int` layer_index **)** |const| @@ -832,6 +864,14 @@ Removes the occlusion layer at index ``layer_index``. Also updates the atlas til ---- +.. _class_TileSet_method_remove_pattern: + +- void **remove_pattern** **(** :ref:`int` index **)** + +Remove the :ref:`TileMapPattern` at the given index. + +---- + .. _class_TileSet_method_remove_physics_layer: - void **remove_physics_layer** **(** :ref:`int` layer_index **)** diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index fc19d202c..04b403414 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TileSetAtlasSource.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -42,63 +42,67 @@ Properties +-----------------------------------+-----------------------------------------------------------------------------------+----------------------+ | :ref:`Vector2i` | :ref:`texture_region_size` | ``Vector2i(16, 16)`` | +-----------------------------------+-----------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`use_texture_padding` | ``true`` | ++-----------------------------------+-----------------------------------------------------------------------------------+----------------------+ Methods ------- -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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:`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:`Object` | :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:`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` **(** **)** | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_separation` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` separation **)** | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords, :ref:`float` speed **)** | -+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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:`Object` | :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| | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_separation` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` separation **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords, :ref:`float` speed **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -163,17 +167,27 @@ The atlas texture. The base tile size in the texture (in pixel). This size must be bigger than the TileSet's ``tile_size`` value. +---- + +.. _class_TileSetAtlasSource_property_use_texture_padding: + +- :ref:`bool` **use_texture_padding** + ++-----------+--------------------------------+ +| *Default* | ``true`` | ++-----------+--------------------------------+ +| *Setter* | set_use_texture_padding(value) | ++-----------+--------------------------------+ +| *Getter* | 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. + +Disabling this setting might lead a small performance improvement, as generating the internal texture requires both memory and processing time when the TileSetAtlasSource resource is modified. + Method Descriptions ------------------- -.. _class_TileSetAtlasSource_method_clear_tiles_outside_texture: - -- void **clear_tiles_outside_texture** **(** **)** - -Clears all tiles that are defined outside the texture boundaries. - ----- - .. _class_TileSetAtlasSource_method_create_alternative_tile: - :ref:`int` **create_alternative_tile** **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_id_override=-1 **)** @@ -208,6 +222,24 @@ Returns the alternative ID a following call to :ref:`create_alternative_tile` **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. + +---- + +.. _class_TileSetAtlasSource_method_get_runtime_tile_texture_region: + +- :ref:`Rect2i` **get_runtime_tile_texture_region** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame **)** |const| + +Returns the region of the tile at coordinates ``atlas_coords`` for frame ``frame`` inside the texture returned by :ref:`get_runtime_texture`. + +**Note:** If :ref:`use_texture_padding` is ``false``, returns the same as :ref:`get_tile_texture_region`. + +---- + .. _class_TileSetAtlasSource_method_get_tile_animation_columns: - :ref:`int` **get_tile_animation_columns** **(** :ref:`Vector2i` atlas_coords **)** |const| @@ -288,6 +320,14 @@ Returns a tile's texture region in the atlas texture. For animated tiles, a ``fr ---- +.. _class_TileSetAtlasSource_method_get_tiles_to_be_removed_on_change: + +- :ref:`PackedVector2Array` **get_tiles_to_be_removed_on_change** **(** :ref:`Texture2D` texture, :ref:`Vector2i` margins, :ref:`Vector2i` separation, :ref:`Vector2i` texture_region_size **)** + +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. + +---- + .. _class_TileSetAtlasSource_method_has_room_for_tile: - :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| @@ -296,14 +336,6 @@ Returns whether there is enough room in an atlas to create/modify a tile with th ---- -.. _class_TileSetAtlasSource_method_has_tiles_outside_texture: - -- :ref:`bool` **has_tiles_outside_texture** **(** **)** - -Returns if this atlas has tiles outside of its texture. - ----- - .. _class_TileSetAtlasSource_method_move_tile_in_atlas: - void **move_tile_in_atlas** **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i` new_size=Vector2i(-1, -1) **)** diff --git a/classes/class_tilesetscenescollectionsource.rst b/classes/class_tilesetscenescollectionsource.rst index 8caf4a595..14549efac 100644 --- a/classes/class_tilesetscenescollectionsource.rst +++ b/classes/class_tilesetscenescollectionsource.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TileSetScenesCollectionSource.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_tilesetsource.rst b/classes/class_tilesetsource.rst index 066a686de..63174564b 100644 --- a/classes/class_tilesetsource.rst +++ b/classes/class_tilesetsource.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TileSetSource.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_time.rst b/classes/class_time.rst index d3fee7cbf..77cbada3b 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Time.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -22,6 +22,8 @@ This class conforms with as many of the ISO 8601 standards as possible. All date Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually. +When getting time information from the system, the time can either be in the local timezone or UTC depending on the ``utc`` parameter. However, the :ref:`get_unix_time_from_system` method always returns the time in UTC. + **Important:** The ``_from_system`` methods use the system clock that the user can manually set. **Never use** this method for precise time calculation since its results are subject to automatic adjustments by the user or the operating system. **Always use** :ref:`get_ticks_usec` or :ref:`get_ticks_msec` for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease). Methods @@ -243,7 +245,7 @@ If ``use_space`` is true, use a space instead of the letter T in the middle. - :ref:`String` **get_datetime_string_from_system** **(** :ref:`bool` utc=false, :ref:`bool` use_space=false **)** |const| -Returns the current date and time as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``dst`` (Daylight Savings Time), ``hour``, ``minute``, and ``second``. +Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). The returned values are in the system's local time when ``utc`` is false, otherwise they are in UTC. @@ -267,6 +269,8 @@ If ``use_space`` is true, use a space instead of the letter T in the middle. Returns the amount of time passed in milliseconds since the engine started. +Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly 500 million years). + ---- .. _class_Time_method_get_ticks_usec: @@ -275,6 +279,8 @@ Returns the amount of time passed in milliseconds since the engine started. Returns the amount of time passed in microseconds since the engine started. +Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly half a million years). + ---- .. _class_Time_method_get_time_dict_from_system: @@ -333,6 +339,8 @@ If the dictionary is empty, ``0`` is returned. If some keys are omitted, they de You can pass the output from :ref:`get_datetime_dict_from_unix_time` directly into this function and get the same as what was put in. +**Note:** Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime dictionary. + ---- .. _class_Time_method_get_unix_time_from_datetime_string: @@ -341,13 +349,15 @@ You can pass the output from :ref:`get_datetime_dict_from_unix_time` **get_unix_time_from_system** **(** **)** |const| -Returns the current Unix timestamp in seconds based on the system time. +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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 9b3b29e1a..9e672376d 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Timer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -170,7 +170,9 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive. | *Getter* | get_wait_time() | +-----------+----------------------+ -Wait time in seconds. +The wait time in seconds. + +**Note:** Timers can only emit once per rendered frame at most (or once per physics frame if :ref:`process_callback` is :ref:`TIMER_PROCESS_PHYSICS`). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. Method Descriptions ------------------- diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index dacdeb35c..1363a04af 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TouchScreenButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 5285c1f86..1fec0d777 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Transform2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -40,78 +40,88 @@ Properties | :ref:`Vector2` | :ref:`y` | ``Vector2(0, 1)`` | +-------------------------------+--------------------------------------------------+-------------------+ +Constructors +------------ + ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform2D` from **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` scale, :ref:`float` skew, :ref:`Vector2` position **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** |constructor| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`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_equal_approx` **(** :ref:`Transform2D` xform **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`looking_at` **(** :ref:`Vector2` target=Vector2(0, 0) **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Transform2D` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | **operator *** **(** :ref:`PackedVector2Array` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | **operator *** **(** :ref:`Transform2D` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | **operator *** **(** :ref:`Rect2` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`Vector2` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | **operator *** **(** :ref:`float` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | **operator *** **(** :ref:`int` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Transform2D` right **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator []** **(** :ref:`int` index **)** |operator| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` rotation **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_skew` **(** :ref:`float` skew **)** | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** |const| | -+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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_equal_approx` **(** :ref:`Transform2D` xform **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`looking_at` **(** :ref:`Vector2` target=Vector2(0, 0) **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` rotation **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_skew` **(** :ref:`float` skew **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Transform2D` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`operator *` **(** :ref:`PackedVector2Array` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`operator *` **(** :ref:`Rect2` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`operator *` **(** :ref:`float` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`operator *` **(** :ref:`int` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Transform2D` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`operator []` **(** :ref:`int` index **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -165,40 +175,41 @@ The basis matrix's X vector (column 0). Equivalent to array index ``0``. The basis matrix's Y vector (column 1). Equivalent to array index ``1``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Transform2D_method_Transform2D: +.. _class_Transform2D_constructor_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** **)** |constructor| +- :ref:`Transform2D` **Transform2D** **(** **)** Constructs a default-initialized ``Transform2D`` set to :ref:`IDENTITY`. ---- -- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform2D` from **)** |constructor| +- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform2D` from **)** Constructs a ``Transform2D`` as a copy of the given ``Transform2D``. ---- -- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** |constructor| +- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians) and position. ---- -- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` scale, :ref:`float` skew, :ref:`Vector2` position **)** |constructor| +- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` scale, :ref:`float` skew, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. ---- -- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** |constructor| +- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** Constructs the transform from 3 :ref:`Vector2` values representing :ref:`x`, :ref:`y`, and the :ref:`origin` (the three column vectors). ----- +Method Descriptions +------------------- .. _class_Transform2D_method_affine_inverse: @@ -294,62 +305,6 @@ Operations take place in global space. ---- -.. _class_Transform2D_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Transform2D` right **)** |operator| - ----- - -.. _class_Transform2D_method_operator *: - -- :ref:`PackedVector2Array` **operator *** **(** :ref:`PackedVector2Array` right **)** |operator| - ----- - -- :ref:`Transform2D` **operator *** **(** :ref:`Transform2D` right **)** |operator| - ----- - -- :ref:`Rect2` **operator *** **(** :ref:`Rect2` right **)** |operator| - ----- - -- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** |operator| - ----- - -- :ref:`Transform2D` **operator *** **(** :ref:`float` right **)** |operator| - -This operator multiplies all components of the ``Transform2D``, including the origin vector, which scales it uniformly. - ----- - -- :ref:`Transform2D` **operator *** **(** :ref:`int` right **)** |operator| - -This operator multiplies all components of the ``Transform2D``, including the origin vector, which scales it uniformly. - ----- - -.. _class_Transform2D_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Transform2D` right **)** |operator| - ----- - -.. _class_Transform2D_method_operator []: - -- :ref:`Vector2` **operator []** **(** :ref:`int` index **)** |operator| - ----- - .. _class_Transform2D_method_orthonormalized: - :ref:`Transform2D` **orthonormalized** **(** **)** |const| @@ -406,6 +361,63 @@ Translates the transform by the given offset, relative to the transform's basis Unlike :ref:`rotated` and :ref:`scaled`, this does not use matrix multiplication. +Operator Descriptions +--------------------- + +.. _class_Transform2D_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Transform2D` right **)** + +---- + +.. _class_Transform2D_operator_mul_PackedVector2Array: + +- :ref:`PackedVector2Array` **operator *** **(** :ref:`PackedVector2Array` right **)** + +---- + +- :ref:`Transform2D` **operator *** **(** :ref:`Transform2D` right **)** + +---- + +- :ref:`Rect2` **operator *** **(** :ref:`Rect2` right **)** + +---- + +- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** + +---- + +- :ref:`Transform2D` **operator *** **(** :ref:`float` right **)** + +This operator multiplies all components of the ``Transform2D``, including the origin vector, which scales it uniformly. + +---- + +- :ref:`Transform2D` **operator *** **(** :ref:`int` right **)** + +This operator multiplies all components of the ``Transform2D``, including the origin vector, which scales it uniformly. + +---- + +.. _class_Transform2D_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Transform2D` right **)** + +---- + +.. _class_Transform2D_operator_idx_Vector2: + +- :ref:`Vector2` **operator []** **(** :ref:`int` index **)** + .. |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.)` diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index edb9b04f1..18e3540dc 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Transform3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -42,56 +42,66 @@ Properties | :ref:`Vector3` | :ref:`origin` | ``Vector3(0, 0, 0)`` | +-------------------------------+--------------------------------------------------+--------------------------------------+ +Constructors +------------ + ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`Transform3D` **(** **)** |constructor| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Transform3D` from **)** |constructor| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** |constructor| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** |constructor| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`Transform3D` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0) **)** |const| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Transform3D` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | **operator *** **(** :ref:`PackedVector3Array` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | **operator *** **(** :ref:`Transform3D` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | **operator *** **(** :ref:`AABB` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Vector3` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | **operator *** **(** :ref:`float` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | **operator *** **(** :ref:`int` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Transform3D` right **)** |operator| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`orthonormalized` **(** **)** |const| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** |const| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`scaled` **(** :ref:`Vector3` scale **)** |const| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`translated` **(** :ref:`Vector3` offset **)** |const| | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Transform3D` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0) **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`orthonormalized` **(** **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`scaled` **(** :ref:`Vector3` scale **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`translated` **(** :ref:`Vector3` offset **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Transform3D` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`operator *` **(** :ref:`PackedVector3Array` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`operator *` **(** :ref:`AABB` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`operator *` **(** :ref:`float` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`operator *` **(** :ref:`int` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator ==` **(** :ref:`Transform3D` right **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -137,34 +147,35 @@ The basis is a matrix containing 3 :ref:`Vector3` as its columns: The translation offset of the transform (column 3, the fourth column). Equivalent to array index ``3``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Transform3D_method_Transform3D: +.. _class_Transform3D_constructor_Transform3D: -- :ref:`Transform3D` **Transform3D** **(** **)** |constructor| +- :ref:`Transform3D` **Transform3D** **(** **)** Constructs a default-initialized ``Transform3D`` set to :ref:`IDENTITY`. ---- -- :ref:`Transform3D` **Transform3D** **(** :ref:`Transform3D` from **)** |constructor| +- :ref:`Transform3D` **Transform3D** **(** :ref:`Transform3D` from **)** Constructs a ``Transform3D`` as a copy of the given ``Transform3D``. ---- -- :ref:`Transform3D` **Transform3D** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** |constructor| +- :ref:`Transform3D` **Transform3D** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** Constructs a Transform3D from a :ref:`Basis` and :ref:`Vector3`. ---- -- :ref:`Transform3D` **Transform3D** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** |constructor| +- :ref:`Transform3D` **Transform3D** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** Constructs a Transform3D from four :ref:`Vector3` values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). ----- +Method Descriptions +------------------- .. _class_Transform3D_method_affine_inverse: @@ -208,56 +219,6 @@ The up axis (+Y) points as close to the ``up`` vector as possible while staying ---- -.. _class_Transform3D_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Transform3D` right **)** |operator| - ----- - -.. _class_Transform3D_method_operator *: - -- :ref:`PackedVector3Array` **operator *** **(** :ref:`PackedVector3Array` right **)** |operator| - ----- - -- :ref:`Transform3D` **operator *** **(** :ref:`Transform3D` right **)** |operator| - ----- - -- :ref:`AABB` **operator *** **(** :ref:`AABB` right **)** |operator| - ----- - -- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** |operator| - ----- - -- :ref:`Transform3D` **operator *** **(** :ref:`float` right **)** |operator| - -This operator multiplies all components of the ``Transform3D``, including the origin vector, which scales it uniformly. - ----- - -- :ref:`Transform3D` **operator *** **(** :ref:`int` right **)** |operator| - -This operator multiplies all components of the ``Transform3D``, including the origin vector, which scales it uniformly. - ----- - -.. _class_Transform3D_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Transform3D` right **)** |operator| - ----- - .. _class_Transform3D_method_orthonormalized: - :ref:`Transform3D` **orthonormalized** **(** **)** |const| @@ -290,6 +251,57 @@ Translates the transform by the given offset, relative to the transform's basis Unlike :ref:`rotated` and :ref:`scaled`, this does not use matrix multiplication. +Operator Descriptions +--------------------- + +.. _class_Transform3D_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Transform3D` right **)** + +---- + +.. _class_Transform3D_operator_mul_PackedVector3Array: + +- :ref:`PackedVector3Array` **operator *** **(** :ref:`PackedVector3Array` right **)** + +---- + +- :ref:`Transform3D` **operator *** **(** :ref:`Transform3D` right **)** + +---- + +- :ref:`AABB` **operator *** **(** :ref:`AABB` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** + +---- + +- :ref:`Transform3D` **operator *** **(** :ref:`float` right **)** + +This operator multiplies all components of the ``Transform3D``, including the origin vector, which scales it uniformly. + +---- + +- :ref:`Transform3D` **operator *** **(** :ref:`int` right **)** + +This operator multiplies all components of the ``Transform3D``, including the origin vector, which scales it uniformly. + +---- + +.. _class_Transform3D_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Transform3D` right **)** + .. |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.)` diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 68e780b0b..6840350d7 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Translation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index dd4b8d7d3..eecc1d62a 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TranslationServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 104a84487..417fa9624 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Tree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 1aa893980..aef90a600 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TreeItem.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index 87e774b84..1fd3d0db2 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TriangleMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_tubetrailmesh.rst b/classes/class_tubetrailmesh.rst index 997368b5b..9073efa2c 100644 --- a/classes/class_tubetrailmesh.rst +++ b/classes/class_tubetrailmesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the TubeTrailMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 50e676f8e..d75d3c87d 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Tween.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -77,7 +77,7 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`custom_step` **(** :ref:`float` delta **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`interpolate_value` **(** :ref:`Variant` trans_type, :ref:`Variant` ease_type, :ref:`float` elapsed_time, :ref:`float` initial_value, :ref:`TransitionType` delta_value, :ref:`EaseType` duration **)** | +| :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 **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_running` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -290,16 +290,16 @@ Returns ``true`` if the ``Tween`` still has :ref:`Tweener`\ s tha .. _class_Tween_method_interpolate_value: -- :ref:`Variant` **interpolate_value** **(** :ref:`Variant` trans_type, :ref:`Variant` ease_type, :ref:`float` elapsed_time, :ref:`float` initial_value, :ref:`TransitionType` delta_value, :ref:`EaseType` duration **)** +- :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 **)** 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. -``elapsed_time`` is the time in seconds that passed after the interping started and it's used to control the position of the interpolation. E.g. when it's equal to half of the ``duration``, the interpolated value will be halfway between initial and final values. This value can also be greater than ``duration`` or lower than 0, which will extrapolate the value. - ``initial_value`` is the starting value of the interpolation. ``delta_value`` is the change of the value in the interpolation, i.e. it's equal to ``final_value - initial_value``. +``elapsed_time`` is the time in seconds that passed after the interpolation started and it's used to control the position of the interpolation. E.g. when it's equal to half of the ``duration``, the interpolated value will be halfway between initial and final values. This value can also be greater than ``duration`` or lower than 0, which will extrapolate the value. + ``duration`` is the total time of the interpolation. **Note:** If ``duration`` is equal to ``0``, the method will always return the final value, regardless of ``elapsed_time`` provided. @@ -381,6 +381,8 @@ Sets the number of times the tweening sequence will be repeated, i.e. ``set_loop Calling this method without arguments will make the ``Tween`` run infinitely, until it is either killed by :ref:`kill` or by freeing bound node, or all the animated objects have been freed (which makes further animation impossible). +**Warning:** Make sure to always add some duration/delay when using infinite loops. 0-duration looped animations (e.g. single :ref:`CallbackTweener` with no delay) are equivalent to infinite ``while`` loops and will freeze your game. + ---- .. _class_Tween_method_set_parallel: diff --git a/classes/class_tweener.rst b/classes/class_tweener.rst index 3b77fc5fd..6d00f3667 100644 --- a/classes/class_tweener.rst +++ b/classes/class_tweener.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Tweener.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index e730a12b8..bffbffb31 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the UDPServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 9882d6f5d..10bfa05b0 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the UndoRedo.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -102,6 +102,8 @@ Methods +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`end_force_keep_in_merge_ends` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_action_name` **(** :ref:`int` id **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_current_action` **(** **)** | @@ -120,6 +122,8 @@ Methods +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`redo` **(** **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_force_keep_in_merge_ends` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`undo` **(** **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -147,7 +151,7 @@ enum **MergeMode**: - **MERGE_DISABLE** = **0** --- Makes "do"/"undo" operations stay in separate actions. -- **MERGE_ENDS** = **1** --- Makes so that the action's "do" operation is from the first action created and the "undo" operation is from the last subsequent action with the same name. +- **MERGE_ENDS** = **1** --- Makes so that the action's "undo" operations are from the first action created and the "do" operations are from the last subsequent action with the same name. - **MERGE_ALL** = **2** --- Makes subsequent actions with the same name be merged into one. @@ -230,6 +234,14 @@ The way actions are merged is dictated by the ``merge_mode`` argument. See :ref: ---- +.. _class_UndoRedo_method_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`. + +---- + .. _class_UndoRedo_method_get_action_name: - :ref:`String` **get_action_name** **(** :ref:`int` id **)** @@ -304,6 +316,14 @@ Redo the last action. ---- +.. _class_UndoRedo_method_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`. + +---- + .. _class_UndoRedo_method_undo: - :ref:`bool` **undo** **(** **)** diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 1793a3e69..4c2b536d8 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the UPNP.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index a1e36b4b3..f521d2d29 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the UPNPDevice.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 0599cd9b8..16a0a7010 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Variant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 3c9b7eb1a..fa9732344 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VBoxContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index da1ebdc98..5db29bbc9 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Vector2.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -44,17 +44,22 @@ Properties | :ref:`float` | :ref:`y` | ``0.0`` | +---------------------------+------------------------------------+---------+ +Constructors +------------ + ++-------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`Vector2` from **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`Vector2i` from **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** |constructor| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`abs` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,46 +109,6 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`normalized` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`Transform2D` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`float` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator *** **(** :ref:`int` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator +** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator -** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator /** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator /** **(** :ref:`float` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator /** **(** :ref:`int` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`Vector2` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator unary+** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | **operator unary-** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`orthogonal` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`posmod` **(** :ref:`float` mod **)** |const| | @@ -167,6 +132,51 @@ Methods | :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` step **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Operators +--------- + ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector2` right **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2` right **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`operator *` **(** :ref:`Transform2D` 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:`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-` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ + Constants --------- @@ -231,34 +241,35 @@ The vector's X component. Also accessible by using the index position ``[0]``. The vector's Y component. Also accessible by using the index position ``[1]``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Vector2_method_Vector2: +.. _class_Vector2_constructor_Vector2: -- :ref:`Vector2` **Vector2** **(** **)** |constructor| +- :ref:`Vector2` **Vector2** **(** **)** Constructs a default-initialized ``Vector2`` with all components set to ``0``. ---- -- :ref:`Vector2` **Vector2** **(** :ref:`Vector2` from **)** |constructor| +- :ref:`Vector2` **Vector2** **(** :ref:`Vector2` from **)** Constructs a ``Vector2`` as a copy of the given ``Vector2``. ---- -- :ref:`Vector2` **Vector2** **(** :ref:`Vector2i` from **)** |constructor| +- :ref:`Vector2` **Vector2** **(** :ref:`Vector2i` from **)** Constructs a new ``Vector2`` from :ref:`Vector2i`. ---- -- :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** |constructor| +- :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** Constructs a new ``Vector2`` from the given ``x`` and ``y``. ----- +Method Descriptions +------------------- .. _class_Vector2_method_abs: @@ -298,6 +309,8 @@ Returns the angle to the given vector, in radians. Returns the angle between the line connecting the two points and the X axis, in radians. +``a.angle_to_point(b)`` is equivalent of doing ``(b - a).angle()``. + `Illustration of the returned angle. `__ ---- @@ -478,112 +491,6 @@ Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. ---- -.. _class_Vector2_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator *: - -- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** |operator| - ----- - -- :ref:`Vector2` **operator *** **(** :ref:`Transform2D` right **)** |operator| - ----- - -- :ref:`Vector2` **operator *** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector2` **operator *** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector2_method_operator +: - -- :ref:`Vector2` **operator +** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator -: - -- :ref:`Vector2` **operator -** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator /: - -- :ref:`Vector2` **operator /** **(** :ref:`Vector2` right **)** |operator| - ----- - -- :ref:`Vector2` **operator /** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector2` **operator /** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector2_method_operator <: - -- :ref:`bool` **operator <** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator <=: - -- :ref:`bool` **operator <=** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator >: - -- :ref:`bool` **operator >** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator >=: - -- :ref:`bool` **operator >=** **(** :ref:`Vector2` right **)** |operator| - ----- - -.. _class_Vector2_method_operator []: - -- :ref:`float` **operator []** **(** :ref:`int` index **)** |operator| - ----- - -.. _class_Vector2_method_operator unary+: - -- :ref:`Vector2` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Vector2_method_operator unary-: - -- :ref:`Vector2` **operator unary-** **(** **)** |operator| - ----- - .. _class_Vector2_method_orthogonal: - :ref:`Vector2` **orthogonal** **(** **)** |const| @@ -672,6 +579,113 @@ Returns this vector slid along a plane defined by the given normal. Returns this vector with each component snapped to the nearest multiple of ``step``. This can also be used to round to an arbitrary number of decimals. +Operator Descriptions +--------------------- + +.. _class_Vector2_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_mul_Vector2: + +- :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** + +---- + +- :ref:`Vector2` **operator *** **(** :ref:`Transform2D` right **)** + +---- + +- :ref:`Vector2` **operator *** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector2` **operator *** **(** :ref:`int` right **)** + +---- + +.. _class_Vector2_operator_sum_Vector2: + +- :ref:`Vector2` **operator +** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_dif_Vector2: + +- :ref:`Vector2` **operator -** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_div_Vector2: + +- :ref:`Vector2` **operator /** **(** :ref:`Vector2` right **)** + +---- + +- :ref:`Vector2` **operator /** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector2` **operator /** **(** :ref:`int` right **)** + +---- + +.. _class_Vector2_operator_lt_bool: + +- :ref:`bool` **operator <** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_lte_bool: + +- :ref:`bool` **operator <=** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_gte_bool: + +- :ref:`bool` **operator >=** **(** :ref:`Vector2` right **)** + +---- + +.. _class_Vector2_operator_idx_float: + +- :ref:`float` **operator []** **(** :ref:`int` index **)** + +---- + +.. _class_Vector2_operator_unplus_Vector2: + +- :ref:`Vector2` **operator unary+** **(** **)** + +---- + +.. _class_Vector2_operator_unminus_Vector2: + +- :ref:`Vector2` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index 95b7c0a5a..f60cf64db 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Vector2i.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -38,17 +38,22 @@ Properties | :ref:`int` | :ref:`y` | ``0`` | +-----------------------+-------------------------------------+-------+ +Constructors +------------ + ++---------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`Vector2i` **(** **)** |constructor| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2i` from **)** |constructor| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2` from **)** |constructor| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`int` x, :ref:`int` y **)** |constructor| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`abs` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ @@ -56,51 +61,56 @@ Methods +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`clamp` **(** :ref:`Vector2i` min, :ref:`Vector2i` max **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator %** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator %** **(** :ref:`int` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator *** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator *** **(** :ref:`float` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator *** **(** :ref:`int` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator +** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator -** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator /** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator /** **(** :ref:`float` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator /** **(** :ref:`int` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`Vector2i` right **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator []** **(** :ref:`int` index **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator unary+** **(** **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | **operator unary-** **(** **)** |operator| | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`sign` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +Operators +--------- + ++---------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :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:`Vector2i` | :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:`Vector2i` | :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:`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-` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------+ + Constants --------- @@ -161,34 +171,35 @@ The vector's X component. Also accessible by using the index position ``[0]``. The vector's Y component. Also accessible by using the index position ``[1]``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Vector2i_method_Vector2i: +.. _class_Vector2i_constructor_Vector2i: -- :ref:`Vector2i` **Vector2i** **(** **)** |constructor| +- :ref:`Vector2i` **Vector2i** **(** **)** Constructs a default-initialized ``Vector2i`` with all components set to ``0``. ---- -- :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2i` from **)** |constructor| +- :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2i` from **)** Constructs a ``Vector2i`` as a copy of the given ``Vector2i``. ---- -- :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2` from **)** |constructor| +- :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2` from **)** Constructs a new ``Vector2i`` from :ref:`Vector2`. The floating point coordinates will be truncated. ---- -- :ref:`Vector2i` **Vector2i** **(** :ref:`int` x, :ref:`int` y **)** |constructor| +- :ref:`Vector2i` **Vector2i** **(** :ref:`int` x, :ref:`int` y **)** Constructs a new ``Vector2i`` from the given ``x`` and ``y``. ----- +Method Descriptions +------------------- .. _class_Vector2i_method_abs: @@ -214,124 +225,125 @@ Returns a new vector with all components clamped between the components of ``min ---- -.. _class_Vector2i_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator %: - -- :ref:`Vector2i` **operator %** **(** :ref:`Vector2i` right **)** |operator| - ----- - -- :ref:`Vector2i` **operator %** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator *: - -- :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** |operator| - ----- - -- :ref:`Vector2i` **operator *** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector2i` **operator *** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator +: - -- :ref:`Vector2i` **operator +** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator -: - -- :ref:`Vector2i` **operator -** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator /: - -- :ref:`Vector2i` **operator /** **(** :ref:`Vector2i` right **)** |operator| - ----- - -- :ref:`Vector2i` **operator /** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector2i` **operator /** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator <: - -- :ref:`bool` **operator <** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator <=: - -- :ref:`bool` **operator <=** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator >: - -- :ref:`bool` **operator >** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator >=: - -- :ref:`bool` **operator >=** **(** :ref:`Vector2i` right **)** |operator| - ----- - -.. _class_Vector2i_method_operator []: - -- :ref:`int` **operator []** **(** :ref:`int` index **)** |operator| - ----- - -.. _class_Vector2i_method_operator unary+: - -- :ref:`Vector2i` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Vector2i_method_operator unary-: - -- :ref:`Vector2i` **operator unary-** **(** **)** |operator| - ----- - .. _class_Vector2i_method_sign: - :ref:`Vector2i` **sign** **(** **)** |const| Returns the vector with each component set to one or negative one, depending on the signs of the components. +Operator Descriptions +--------------------- + +.. _class_Vector2i_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_mod_Vector2i: + +- :ref:`Vector2i` **operator %** **(** :ref:`Vector2i` right **)** + +---- + +- :ref:`Vector2i` **operator %** **(** :ref:`int` right **)** + +---- + +.. _class_Vector2i_operator_mul_Vector2i: + +- :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** + +---- + +- :ref:`Vector2i` **operator *** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector2i` **operator *** **(** :ref:`int` right **)** + +---- + +.. _class_Vector2i_operator_sum_Vector2i: + +- :ref:`Vector2i` **operator +** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_dif_Vector2i: + +- :ref:`Vector2i` **operator -** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_div_Vector2i: + +- :ref:`Vector2i` **operator /** **(** :ref:`Vector2i` right **)** + +---- + +- :ref:`Vector2i` **operator /** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector2i` **operator /** **(** :ref:`int` right **)** + +---- + +.. _class_Vector2i_operator_lt_bool: + +- :ref:`bool` **operator <** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_lte_bool: + +- :ref:`bool` **operator <=** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_gte_bool: + +- :ref:`bool` **operator >=** **(** :ref:`Vector2i` right **)** + +---- + +.. _class_Vector2i_operator_idx_int: + +- :ref:`int` **operator []** **(** :ref:`int` index **)** + +---- + +.. _class_Vector2i_operator_unplus_Vector2i: + +- :ref:`Vector2i` **operator unary+** **(** **)** + +---- + +.. _class_Vector2i_operator_unminus_Vector2i: + +- :ref:`Vector2i` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index b3a5189ad..eb589fdaa 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Vector3.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -46,17 +46,22 @@ Properties | :ref:`float` | :ref:`z` | ``0.0`` | +---------------------------+------------------------------------+---------+ +Constructors +------------ + ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`Vector3` from **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`Vector3i` from **)** |constructor| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** |constructor| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`abs` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,49 +109,9 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`normalized` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | +| :ref:`Vector3` | :ref:`octahedron_decode` **(** :ref:`Vector2` uv **)** |static| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Basis` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Quaternion` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`Transform3D` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`float` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator *** **(** :ref:`int` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator +** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator -** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator /** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator /** **(** :ref:`float` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator /** **(** :ref:`int` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`Vector3` right **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | **operator []** **(** :ref:`int` index **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator unary+** **(** **)** |operator| | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | **operator unary-** **(** **)** |operator| | +| :ref:`Vector2` | :ref:`octahedron_encode` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` with **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,6 +138,55 @@ Methods | :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` step **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Operators +--------- + ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector3` right **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :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:`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:`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-` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------+ + Constants --------- @@ -261,34 +275,35 @@ The vector's Y component. Also accessible by using the index position ``[1]``. The vector's Z component. Also accessible by using the index position ``[2]``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Vector3_method_Vector3: +.. _class_Vector3_constructor_Vector3: -- :ref:`Vector3` **Vector3** **(** **)** |constructor| +- :ref:`Vector3` **Vector3** **(** **)** Constructs a default-initialized ``Vector3`` with all components set to ``0``. ---- -- :ref:`Vector3` **Vector3** **(** :ref:`Vector3` from **)** |constructor| +- :ref:`Vector3` **Vector3** **(** :ref:`Vector3` from **)** Constructs a ``Vector3`` as a copy of the given ``Vector3``. ---- -- :ref:`Vector3` **Vector3** **(** :ref:`Vector3i` from **)** |constructor| +- :ref:`Vector3` **Vector3** **(** :ref:`Vector3i` from **)** Constructs a new ``Vector3`` from :ref:`Vector3i`. ---- -- :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** |constructor| +- :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns a ``Vector3`` with the given components. ----- +Method Descriptions +------------------- .. _class_Vector3_method_abs: @@ -484,117 +499,15 @@ Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. ---- -.. _class_Vector3_method_operator !=: +.. _class_Vector3_method_octahedron_decode: -- :ref:`bool` **operator !=** **(** **)** |operator| +- :ref:`Vector3` **octahedron_decode** **(** :ref:`Vector2` uv **)** |static| ---- -- :ref:`bool` **operator !=** **(** :ref:`Vector3` right **)** |operator| +.. _class_Vector3_method_octahedron_encode: ----- - -.. _class_Vector3_method_operator *: - -- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** |operator| - ----- - -- :ref:`Vector3` **operator *** **(** :ref:`Basis` right **)** |operator| - ----- - -- :ref:`Vector3` **operator *** **(** :ref:`Quaternion` right **)** |operator| - ----- - -- :ref:`Vector3` **operator *** **(** :ref:`Transform3D` right **)** |operator| - ----- - -- :ref:`Vector3` **operator *** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector3` **operator *** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector3_method_operator +: - -- :ref:`Vector3` **operator +** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator -: - -- :ref:`Vector3` **operator -** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator /: - -- :ref:`Vector3` **operator /** **(** :ref:`Vector3` right **)** |operator| - ----- - -- :ref:`Vector3` **operator /** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector3` **operator /** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector3_method_operator <: - -- :ref:`bool` **operator <** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator <=: - -- :ref:`bool` **operator <=** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator >: - -- :ref:`bool` **operator >** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator >=: - -- :ref:`bool` **operator >=** **(** :ref:`Vector3` right **)** |operator| - ----- - -.. _class_Vector3_method_operator []: - -- :ref:`float` **operator []** **(** :ref:`int` index **)** |operator| - ----- - -.. _class_Vector3_method_operator unary+: - -- :ref:`Vector3` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Vector3_method_operator unary-: - -- :ref:`Vector3` **operator unary-** **(** **)** |operator| +- :ref:`Vector2` **octahedron_encode** **(** **)** |const| ---- @@ -694,6 +607,121 @@ Returns this vector slid along a plane defined by the given normal. Returns this vector with each component snapped to the nearest multiple of ``step``. This can also be used to round to an arbitrary number of decimals. +Operator Descriptions +--------------------- + +.. _class_Vector3_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_mul_Vector3: + +- :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`Basis` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`Quaternion` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`Transform3D` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector3` **operator *** **(** :ref:`int` right **)** + +---- + +.. _class_Vector3_operator_sum_Vector3: + +- :ref:`Vector3` **operator +** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_dif_Vector3: + +- :ref:`Vector3` **operator -** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_div_Vector3: + +- :ref:`Vector3` **operator /** **(** :ref:`Vector3` right **)** + +---- + +- :ref:`Vector3` **operator /** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector3` **operator /** **(** :ref:`int` right **)** + +---- + +.. _class_Vector3_operator_lt_bool: + +- :ref:`bool` **operator <** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_lte_bool: + +- :ref:`bool` **operator <=** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_gte_bool: + +- :ref:`bool` **operator >=** **(** :ref:`Vector3` right **)** + +---- + +.. _class_Vector3_operator_idx_float: + +- :ref:`float` **operator []** **(** :ref:`int` index **)** + +---- + +.. _class_Vector3_operator_unplus_Vector3: + +- :ref:`Vector3` **operator unary+** **(** **)** + +---- + +.. _class_Vector3_operator_unminus_Vector3: + +- :ref:`Vector3` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index e11a95a02..e3ccfe232 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Vector3i.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -40,70 +40,80 @@ Properties | :ref:`int` | :ref:`z` | ``0`` | +-----------------------+-------------------------------------+-------+ +Constructors +------------ + ++---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + Methods ------- -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`Vector3i` **(** **)** |constructor| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`Vector3i` from **)** |constructor| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`Vector3` from **)** |constructor| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |constructor| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`abs` **(** **)** |const| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`clamp` **(** :ref:`Vector3i` min, :ref:`Vector3i` max **)** |const| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_axis` **(** **)** |const| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`min_axis` **(** **)** |const| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator !=** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator %** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator %** **(** :ref:`int` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator *** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator *** **(** :ref:`float` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator *** **(** :ref:`int` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator +** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator -** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator /** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator /** **(** :ref:`float` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator /** **(** :ref:`int` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator <=** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator ==** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | **operator >=** **(** :ref:`Vector3i` right **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | **operator []** **(** :ref:`int` index **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator unary+** **(** **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | **operator unary-** **(** **)** |operator| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`sign` **(** **)** |const| | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`abs` **(** **)** |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`clamp` **(** :ref:`Vector3i` min, :ref:`Vector3i` max **)** |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_axis` **(** **)** |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`min_axis` **(** **)** |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`sign` **(** **)** |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +Operators +--------- + ++---------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`operator !=` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :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:`Vector3i` | :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:`Vector3i` | :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:`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-` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------+ Constants --------- @@ -189,34 +199,35 @@ The vector's Y component. Also accessible by using the index position ``[1]``. The vector's Z component. Also accessible by using the index position ``[2]``. -Method Descriptions -------------------- +Constructor Descriptions +------------------------ -.. _class_Vector3i_method_Vector3i: +.. _class_Vector3i_constructor_Vector3i: -- :ref:`Vector3i` **Vector3i** **(** **)** |constructor| +- :ref:`Vector3i` **Vector3i** **(** **)** Constructs a default-initialized ``Vector3i`` with all components set to ``0``. ---- -- :ref:`Vector3i` **Vector3i** **(** :ref:`Vector3i` from **)** |constructor| +- :ref:`Vector3i` **Vector3i** **(** :ref:`Vector3i` from **)** Constructs a ``Vector3i`` as a copy of the given ``Vector3i``. ---- -- :ref:`Vector3i` **Vector3i** **(** :ref:`Vector3` from **)** |constructor| +- :ref:`Vector3i` **Vector3i** **(** :ref:`Vector3` from **)** Constructs a new ``Vector3i`` from :ref:`Vector3`. The floating point coordinates will be truncated. ---- -- :ref:`Vector3i` **Vector3i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |constructor| +- :ref:`Vector3i` **Vector3i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** Returns a ``Vector3i`` with the given components. ----- +Method Descriptions +------------------- .. _class_Vector3i_method_abs: @@ -248,124 +259,125 @@ Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. If al ---- -.. _class_Vector3i_method_operator !=: - -- :ref:`bool` **operator !=** **(** **)** |operator| - ----- - -- :ref:`bool` **operator !=** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator %: - -- :ref:`Vector3i` **operator %** **(** :ref:`Vector3i` right **)** |operator| - ----- - -- :ref:`Vector3i` **operator %** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator *: - -- :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** |operator| - ----- - -- :ref:`Vector3i` **operator *** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector3i` **operator *** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator +: - -- :ref:`Vector3i` **operator +** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator -: - -- :ref:`Vector3i` **operator -** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator /: - -- :ref:`Vector3i` **operator /** **(** :ref:`Vector3i` right **)** |operator| - ----- - -- :ref:`Vector3i` **operator /** **(** :ref:`float` right **)** |operator| - ----- - -- :ref:`Vector3i` **operator /** **(** :ref:`int` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator <: - -- :ref:`bool` **operator <** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator <=: - -- :ref:`bool` **operator <=** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator ==: - -- :ref:`bool` **operator ==** **(** **)** |operator| - ----- - -- :ref:`bool` **operator ==** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator >: - -- :ref:`bool` **operator >** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator >=: - -- :ref:`bool` **operator >=** **(** :ref:`Vector3i` right **)** |operator| - ----- - -.. _class_Vector3i_method_operator []: - -- :ref:`int` **operator []** **(** :ref:`int` index **)** |operator| - ----- - -.. _class_Vector3i_method_operator unary+: - -- :ref:`Vector3i` **operator unary+** **(** **)** |operator| - ----- - -.. _class_Vector3i_method_operator unary-: - -- :ref:`Vector3i` **operator unary-** **(** **)** |operator| - ----- - .. _class_Vector3i_method_sign: - :ref:`Vector3i` **sign** **(** **)** |const| Returns the vector with each component set to one or negative one, depending on the signs of the components. +Operator Descriptions +--------------------- + +.. _class_Vector3i_operator_neq_bool: + +- :ref:`bool` **operator !=** **(** **)** + +---- + +- :ref:`bool` **operator !=** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_mod_Vector3i: + +- :ref:`Vector3i` **operator %** **(** :ref:`Vector3i` right **)** + +---- + +- :ref:`Vector3i` **operator %** **(** :ref:`int` right **)** + +---- + +.. _class_Vector3i_operator_mul_Vector3i: + +- :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** + +---- + +- :ref:`Vector3i` **operator *** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector3i` **operator *** **(** :ref:`int` right **)** + +---- + +.. _class_Vector3i_operator_sum_Vector3i: + +- :ref:`Vector3i` **operator +** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_dif_Vector3i: + +- :ref:`Vector3i` **operator -** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_div_Vector3i: + +- :ref:`Vector3i` **operator /** **(** :ref:`Vector3i` right **)** + +---- + +- :ref:`Vector3i` **operator /** **(** :ref:`float` right **)** + +---- + +- :ref:`Vector3i` **operator /** **(** :ref:`int` right **)** + +---- + +.. _class_Vector3i_operator_lt_bool: + +- :ref:`bool` **operator <** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_lte_bool: + +- :ref:`bool` **operator <=** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_eq_bool: + +- :ref:`bool` **operator ==** **(** **)** + +---- + +- :ref:`bool` **operator ==** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_gt_bool: + +- :ref:`bool` **operator >** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_gte_bool: + +- :ref:`bool` **operator >=** **(** :ref:`Vector3i` right **)** + +---- + +.. _class_Vector3i_operator_idx_int: + +- :ref:`int` **operator []** **(** :ref:`int` index **)** + +---- + +.. _class_Vector3i_operator_unplus_Vector3i: + +- :ref:`Vector3i` **operator unary+** **(** **)** + +---- + +.. _class_Vector3i_operator_unminus_Vector3i: + +- :ref:`Vector3i` **operator unary-** **(** **)** + .. |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.)` diff --git a/classes/class_vehiclebody3d.rst b/classes/class_vehiclebody3d.rst index 11d0046d3..71a08f9b4 100644 --- a/classes/class_vehiclebody3d.rst +++ b/classes/class_vehiclebody3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VehicleBody3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vehiclewheel3d.rst b/classes/class_vehiclewheel3d.rst index 900496d0d..bb0777562 100644 --- a/classes/class_vehiclewheel3d.rst +++ b/classes/class_vehiclewheel3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VehicleWheel3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_velocitytracker3d.rst b/classes/class_velocitytracker3d.rst index f3bf00a13..c4470d190 100644 --- a/classes/class_velocitytracker3d.rst +++ b/classes/class_velocitytracker3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VelocityTracker3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index b6e13fcf5..f85ea57b5 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VideoPlayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,11 +18,11 @@ Description Control node for playing video streams using :ref:`VideoStream` resources. -Supported video formats are `WebM `__ (``.webm``, :ref:`VideoStreamWebm`), `Ogg Theora `__ (``.ogv``, :ref:`VideoStreamTheora`), and any format exposed via a GDNative plugin using :ref:`VideoStreamGDNative`. +Supported video formats are `Ogg Theora `__ (``.ogv``, :ref:`VideoStreamTheora`) and any format exposed via a GDNative plugin using :ref:`VideoStreamGDNative`. **Note:** Due to a bug, VideoPlayer does not support localization remapping yet. -**Warning:** On HTML5, video playback *will* perform poorly due to missing architecture-specific assembly optimizations, especially for VP8/VP9. +**Warning:** On HTML5, video playback *will* perform poorly due to missing architecture-specific assembly optimizations. Properties ---------- diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index b836f5332..e19ae6da4 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VideoStream.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ VideoStream **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`VideoStreamGDNative`, :ref:`VideoStreamTheora`, :ref:`VideoStreamWebm` +**Inherited By:** :ref:`VideoStreamGDNative`, :ref:`VideoStreamTheora` Base resource for video streams. diff --git a/classes/class_videostreamgdnative.rst b/classes/class_videostreamgdnative.rst index 2c17f61d9..683989799 100644 --- a/classes/class_videostreamgdnative.rst +++ b/classes/class_videostreamgdnative.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VideoStreamGDNative.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 87abc00eb..3e9244c25 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VideoStreamTheora.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,7 @@ VideoStreamTheora Description ----------- -:ref:`VideoStream` resource handling the `Ogg Theora `__ video format with ``.ogv`` extension. The Theora codec is less efficient than :ref:`VideoStreamWebm`'s VP8 and VP9, but it requires less CPU resources to decode. The Theora codec is decoded on the CPU. +:ref:`VideoStream` resource handling the `Ogg Theora `__ video format with ``.ogv`` extension. The Theora codec is decoded on the CPU. **Note:** While Ogg Theora videos can also have an ``.ogg`` extension, you will have to rename the extension to ``.ogv`` to use those videos within Godot. diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst deleted file mode 100644 index 0f7a2648b..000000000 --- a/classes/class_videostreamwebm.rst +++ /dev/null @@ -1,56 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VideoStreamWebm.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_VideoStreamWebm: - -VideoStreamWebm -=============== - -**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - -:ref:`VideoStream` resource for WebM videos. - -Description ------------ - -:ref:`VideoStream` resource handling the `WebM `__ video format with ``.webm`` extension. Both the VP8 and VP9 codecs are supported. The VP8 and VP9 codecs are more efficient than :ref:`VideoStreamTheora`, but they require more CPU resources to decode (especially VP9). Both the VP8 and VP9 codecs are decoded on the CPU. - -**Note:** Alpha channel (also known as transparency) is not supported. The video will always appear to have a black background, even if it originally contains an alpha channel. - -**Note:** There are known bugs and performance issues with WebM video playback in Godot. If you run into problems, try using the Ogg Theora format instead: :ref:`VideoStreamTheora` - -Methods -------- - -+-----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_file` **(** :ref:`String` file **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_VideoStreamWebm_method_get_file: - -- :ref:`String` **get_file** **(** **)** - -Returns the WebM video file handled by this ``VideoStreamWebm``. - ----- - -.. _class_VideoStreamWebm_method_set_file: - -- void **set_file** **(** :ref:`String` file **)** - -Sets the WebM video file that this ``VideoStreamWebm`` resource handles. The ``file`` name should have the ``.webm`` extension. - -.. |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.)` diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index f116722fc..8c248fb9a 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Viewport.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -85,7 +85,7 @@ Properties +-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`physics_object_picking` | ``false`` | +-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`Scale3D` | :ref:`scale_3d` | ``0`` | +| :ref:`float` | :ref:`scale_3d` | ``1.0`` | +-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`ScreenSpaceAA` | :ref:`screen_space_aa` | ``0`` | +-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ @@ -189,32 +189,6 @@ Emitted when the size of the viewport is changed, whether by resizing of window, Enumerations ------------ -.. _enum_Viewport_Scale3D: - -.. _class_Viewport_constant_SCALE_3D_DISABLED: - -.. _class_Viewport_constant_SCALE_3D_75_PERCENT: - -.. _class_Viewport_constant_SCALE_3D_50_PERCENT: - -.. _class_Viewport_constant_SCALE_3D_33_PERCENT: - -.. _class_Viewport_constant_SCALE_3D_25_PERCENT: - -enum **Scale3D**: - -- **SCALE_3D_DISABLED** = **0** - -- **SCALE_3D_75_PERCENT** = **1** - -- **SCALE_3D_50_PERCENT** = **2** - -- **SCALE_3D_33_PERCENT** = **3** - -- **SCALE_3D_25_PERCENT** = **4** - ----- - .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: .. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED: @@ -746,7 +720,7 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. | *Getter* | get_msaa() | +-----------+-----------------+ -The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems. +The multisample anti-aliasing mode. 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 :ref:`scale_3d` for supersampling, which provides higher quality but is much more expensive. ---- @@ -784,17 +758,19 @@ If ``true``, the objects rendered by viewport become subjects of mouse picking p .. _class_Viewport_property_scale_3d: -- :ref:`Scale3D` **scale_3d** +- :ref:`float` **scale_3d** +-----------+---------------------+ -| *Default* | ``0`` | +| *Default* | ``1.0`` | +-----------+---------------------+ | *Setter* | set_scale_3d(value) | +-----------+---------------------+ | *Getter* | get_scale_3d() | +-----------+---------------------+ -The scale at which 3D content is rendered. +Scales the 3D render buffer based on the viewport size and displays the result with linear filtering. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`msaa` for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + +To control this property on the root viewport, set the :ref:`ProjectSettings.rendering/3d/viewport/scale` project setting. ---- diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 2d704645e..55c32e7c7 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ViewportTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visibleonscreenenabler2d.rst b/classes/class_visibleonscreenenabler2d.rst index 16e305077..c1bd663c1 100644 --- a/classes/class_visibleonscreenenabler2d.rst +++ b/classes/class_visibleonscreenenabler2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisibleOnScreenEnabler2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visibleonscreenenabler3d.rst b/classes/class_visibleonscreenenabler3d.rst index 02e572b38..8f475faef 100644 --- a/classes/class_visibleonscreenenabler3d.rst +++ b/classes/class_visibleonscreenenabler3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisibleOnScreenEnabler3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visibleonscreennotifier2d.rst b/classes/class_visibleonscreennotifier2d.rst index 5534a1081..f0120a32c 100644 --- a/classes/class_visibleonscreennotifier2d.rst +++ b/classes/class_visibleonscreennotifier2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisibleOnScreenNotifier2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visibleonscreennotifier3d.rst b/classes/class_visibleonscreennotifier3d.rst index b38de2581..4955799cf 100644 --- a/classes/class_visibleonscreennotifier3d.rst +++ b/classes/class_visibleonscreennotifier3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisibleOnScreenNotifier3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index c52c6ce75..19517c4dc 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualInstance3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,7 +11,7 @@ VisualInstance3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Decal`, :ref:`GPUParticlesAttractor3D`, :ref:`GPUParticlesCollision3D`, :ref:`GeometryInstance3D`, :ref:`Light3D`, :ref:`LightmapGI`, :ref:`ReflectionProbe`, :ref:`RootMotionView`, :ref:`VisibleOnScreenNotifier3D`, :ref:`VoxelGI` +**Inherited By:** :ref:`Decal`, :ref:`FogVolume`, :ref:`GPUParticlesAttractor3D`, :ref:`GPUParticlesCollision3D`, :ref:`GeometryInstance3D`, :ref:`Light3D`, :ref:`LightmapGI`, :ref:`ReflectionProbe`, :ref:`RootMotionView`, :ref:`VisibleOnScreenNotifier3D`, :ref:`VoxelGI` Parent of all visual 3D nodes. diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index ad54fb68c..a01d9f6b6 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 980209648..e60432b48 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptBasicTypeConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index c8f79171f..d9e7064c2 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptBuiltinFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -118,6 +118,8 @@ Enumerations .. _class_VisualScriptBuiltinFunc_constant_MATH_WRAPF: +.. _class_VisualScriptBuiltinFunc_constant_MATH_PINGPONG: + .. _class_VisualScriptBuiltinFunc_constant_LOGIC_MAX: .. _class_VisualScriptBuiltinFunc_constant_LOGIC_MIN: @@ -252,56 +254,58 @@ enum **BuiltinFunc**: - **MATH_WRAPF** = **42** -- **LOGIC_MAX** = **43** --- Return the greater of the two numbers, also known as their maximum. +- **MATH_PINGPONG** = **43** --- Return the ``value`` wrapped between ``0`` and the ``length``. If the limit is reached, the next value the function returned 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. -- **LOGIC_MIN** = **44** --- Return the lesser of the two numbers, also known as their minimum. +- **LOGIC_MAX** = **44** --- Return the greater of the two numbers, also known as their maximum. -- **LOGIC_CLAMP** = **45** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to ``min(max(input, range_low), range_high)``. +- **LOGIC_MIN** = **45** --- Return the lesser of the two numbers, also known as their minimum. -- **LOGIC_NEAREST_PO2** = **46** --- Return the nearest power of 2 to the input. +- **LOGIC_CLAMP** = **46** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to ``min(max(input, range_low), range_high)``. -- **OBJ_WEAKREF** = **47** --- Create a :ref:`WeakRef` from the input. +- **LOGIC_NEAREST_PO2** = **47** --- Return the nearest power of 2 to the input. -- **TYPE_CONVERT** = **48** --- Convert between types. +- **OBJ_WEAKREF** = **48** --- Create a :ref:`WeakRef` from the input. -- **TYPE_OF** = **49** --- Return the type of the input as an integer. Check :ref:`Variant.Type` for the integers that might be returned. +- **TYPE_CONVERT** = **49** --- Convert between types. -- **TYPE_EXISTS** = **50** --- Checks if a type is registered in the :ref:`ClassDB`. +- **TYPE_OF** = **50** --- Return the type of the input as an integer. Check :ref:`Variant.Type` for the integers that might be returned. -- **TEXT_CHAR** = **51** --- Return a character with the given ascii value. +- **TYPE_EXISTS** = **51** --- Checks if a type is registered in the :ref:`ClassDB`. -- **TEXT_STR** = **52** --- Convert the input to a string. +- **TEXT_CHAR** = **52** --- Return a character with the given ascii value. -- **TEXT_PRINT** = **53** --- Print the given string to the output window. +- **TEXT_STR** = **53** --- Convert the input to a string. -- **TEXT_PRINTERR** = **54** --- Print the given string to the standard error output. +- **TEXT_PRINT** = **54** --- Print the given string to the output window. -- **TEXT_PRINTRAW** = **55** --- Print the given string to the standard output, without adding a newline. +- **TEXT_PRINTERR** = **55** --- Print the given string to the standard error output. -- **TEXT_PRINT_VERBOSE** = **56** +- **TEXT_PRINTRAW** = **56** --- Print the given string to the standard output, without adding a newline. -- **VAR_TO_STR** = **57** --- Serialize a :ref:`Variant` to a string. +- **TEXT_PRINT_VERBOSE** = **57** -- **STR_TO_VAR** = **58** --- Deserialize a :ref:`Variant` from a string serialized using :ref:`VAR_TO_STR`. +- **VAR_TO_STR** = **58** --- Serialize a :ref:`Variant` to a string. -- **VAR_TO_BYTES** = **59** --- Serialize a :ref:`Variant` to a :ref:`PackedByteArray`. +- **STR_TO_VAR** = **59** --- Deserialize a :ref:`Variant` from a string serialized using :ref:`VAR_TO_STR`. -- **BYTES_TO_VAR** = **60** --- Deserialize a :ref:`Variant` from a :ref:`PackedByteArray` serialized using :ref:`VAR_TO_BYTES`. +- **VAR_TO_BYTES** = **60** --- Serialize a :ref:`Variant` to a :ref:`PackedByteArray`. -- **MATH_SMOOTHSTEP** = **61** --- Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to :ref:`MATH_LERP`, but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: +- **BYTES_TO_VAR** = **61** --- Deserialize a :ref:`Variant` from a :ref:`PackedByteArray` serialized using :ref:`VAR_TO_BYTES`. + +- **MATH_SMOOTHSTEP** = **62** --- Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to :ref:`MATH_LERP`, but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: :: var t = clamp((weight - from) / (to - from), 0.0, 1.0) return t * t * (3.0 - 2.0 * t) -- **MATH_POSMOD** = **62** +- **MATH_POSMOD** = **63** -- **MATH_LERP_ANGLE** = **63** +- **MATH_LERP_ANGLE** = **64** -- **TEXT_ORD** = **64** +- **TEXT_ORD** = **65** -- **FUNC_MAX** = **65** --- Represents the size of the :ref:`BuiltinFunc` enum. +- **FUNC_MAX** = **66** --- Represents the size of the :ref:`BuiltinFunc` enum. Property Descriptions --------------------- diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index c7fd9b1eb..fdc214b88 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptClassConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index c7f4dda33..31cb4f091 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptComment.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptcomposearray.rst b/classes/class_visualscriptcomposearray.rst index 077e25a6f..fdb706e4f 100644 --- a/classes/class_visualscriptcomposearray.rst +++ b/classes/class_visualscriptcomposearray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptComposeArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index 68bd6bc57..865327be2 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptCondition.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 7d5f6fd87..82f10978f 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 18e21cb8b..68b9521e4 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptConstructor.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index e1396a72a..8720991da 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptCustomNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptcustomnodes.rst b/classes/class_visualscriptcustomnodes.rst index ac4300df8..a3637f4ca 100644 --- a/classes/class_visualscriptcustomnodes.rst +++ b/classes/class_visualscriptcustomnodes.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptCustomNodes.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index e0fb651c9..e93a62afd 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptDeconstruct.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 1582a5a51..28eaef5e8 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptEmitSignal.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 93911cf7e..70cc1f01a 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptEngineSingleton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptexpression.rst b/classes/class_visualscriptexpression.rst index 64edc92e0..df6080d0d 100644 --- a/classes/class_visualscriptexpression.rst +++ b/classes/class_visualscriptexpression.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptExpression.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptfunction.rst b/classes/class_visualscriptfunction.rst index aceebe155..c01388afd 100644 --- a/classes/class_visualscriptfunction.rst +++ b/classes/class_visualscriptfunction.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptFunction.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index a8807284b..04d591ff7 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptFunctionCall.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index b3916c2f6..cebe3eec0 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptFunctionState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index bcb719a46..01b9de7ca 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptGlobalConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst index 4ee3eb951..7b23b7a9b 100644 --- a/classes/class_visualscriptindexget.rst +++ b/classes/class_visualscriptindexget.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptIndexGet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst index 4ca20384b..e3a0c864b 100644 --- a/classes/class_visualscriptindexset.rst +++ b/classes/class_visualscriptindexset.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptIndexSet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index 2c84d6bbb..b68eaa42c 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptInputAction.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst index 6d9fd6204..e1bcab8b6 100644 --- a/classes/class_visualscriptiterator.rst +++ b/classes/class_visualscriptiterator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptIterator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptlists.rst b/classes/class_visualscriptlists.rst index 69b312aff..fb18b658f 100644 --- a/classes/class_visualscriptlists.rst +++ b/classes/class_visualscriptlists.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptLists.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index f5d7d06eb..3e2bcfdd1 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptLocalVar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 96a9215bb..eecf2c16b 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptLocalVarSet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 3c78681dd..204a8e8f0 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptMathConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index a0360375a..6e831bf08 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 593edcd31..1b7bcd52e 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptOperator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 6df6a81c0..e938e80a9 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptPreload.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 68f73f575..6b05c9437 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptPropertyGet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 258f283dd..ebdde1f85 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptPropertySet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index d1b67edc5..32f6fedd5 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptResourcePath.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 8d3e11e18..15016f293 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptReturn.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index da17f4696..727f5294d 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSceneNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst index 1936e1d85..1f3e14f07 100644 --- a/classes/class_visualscriptscenetree.rst +++ b/classes/class_visualscriptscenetree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSceneTree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index 3a04f8d8b..9cc7489ce 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSelect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst index 5ca8d3040..bf94a9ef3 100644 --- a/classes/class_visualscriptself.rst +++ b/classes/class_visualscriptself.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSelf.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index 4149f7cc2..23a361169 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSequence.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index 7becd7102..81cc4fcb2 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSubCall.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst index d8c3f7739..9fb4a2087 100644 --- a/classes/class_visualscriptswitch.rst +++ b/classes/class_visualscriptswitch.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptSwitch.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 63020b61a..a735be731 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptTypeCast.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 6e7a5f7b3..8c2c917ca 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptVariableGet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 9b54deaa0..7bd83549a 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptVariableSet.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst index a25fb2015..3a3e65fb8 100644 --- a/classes/class_visualscriptwhile.rst +++ b/classes/class_visualscriptwhile.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptWhile.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index d1cbdf794..26b489ecf 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptYield.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 09d1bea38..f52cf3aa7 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualScriptYieldSignal.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index eb32d0c47..73196875c 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShader.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -87,6 +87,8 @@ Enumerations .. _class_VisualShader_constant_TYPE_SKY: +.. _class_VisualShader_constant_TYPE_FOG: + .. _class_VisualShader_constant_TYPE_MAX: enum **Type**: @@ -109,7 +111,9 @@ enum **Type**: - **TYPE_SKY** = **8** -- **TYPE_MAX** = **9** --- Represents the size of the :ref:`Type` enum. +- **TYPE_FOG** = **9** --- A compute shader that runs for each froxel of the volumetric fog map. + +- **TYPE_MAX** = **10** --- Represents the size of the :ref:`Type` enum. Constants --------- diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 3d9f7ef5c..ec3ce871d 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodebillboard.rst b/classes/class_visualshadernodebillboard.rst index 45699e583..3265ea57e 100644 --- a/classes/class_visualshadernodebillboard.rst +++ b/classes/class_visualshadernodebillboard.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeBillboard.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 5daa2caaf..b4b8f8a27 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeBooleanConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodebooleanuniform.rst b/classes/class_visualshadernodebooleanuniform.rst index 2f6479370..7bcfdb810 100644 --- a/classes/class_visualshadernodebooleanuniform.rst +++ b/classes/class_visualshadernodebooleanuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeBooleanUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeclamp.rst b/classes/class_visualshadernodeclamp.rst index d2964fb64..71e8a08b2 100644 --- a/classes/class_visualshadernodeclamp.rst +++ b/classes/class_visualshadernodeclamp.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeClamp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index e08874cdc..d6931f523 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index 92301b958..a0d159e66 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 00ab7552f..d9d619847 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorOp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecoloruniform.rst index fbdf4bc57..c88b5b1d8 100644 --- a/classes/class_visualshadernodecoloruniform.rst +++ b/classes/class_visualshadernodecoloruniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecomment.rst b/classes/class_visualshadernodecomment.rst index 348ee3aad..41b76bef2 100644 --- a/classes/class_visualshadernodecomment.rst +++ b/classes/class_visualshadernodecomment.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeComment.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index 91dcd8322..8db0e93af 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCompare.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeconstant.rst b/classes/class_visualshadernodeconstant.rst index c2b90192e..08df7489d 100644 --- a/classes/class_visualshadernodeconstant.rst +++ b/classes/class_visualshadernodeconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 0e188f648..05391a182 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubemap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index beff942d7..12c39d595 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubemapUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecurvetexture.rst b/classes/class_visualshadernodecurvetexture.rst index 4e9b4f08a..51a014d83 100644 --- a/classes/class_visualshadernodecurvetexture.rst +++ b/classes/class_visualshadernodecurvetexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCurveTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecurvexyztexture.rst b/classes/class_visualshadernodecurvexyztexture.rst index 4fd9dbb6a..f65d0892c 100644 --- a/classes/class_visualshadernodecurvexyztexture.rst +++ b/classes/class_visualshadernodecurvexyztexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCurveXYZTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index a1a7be70f..c657a2789 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCustom.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -34,33 +34,33 @@ Tutorials Methods ------- -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_category` **(** **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_code` **(** :ref:`PackedStringArray` input_vars, :ref:`String[]` output_vars, :ref:`int` mode, :ref:`int` type **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_description` **(** **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_global_code` **(** :ref:`int` mode **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_port_count` **(** **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :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:`int` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_return_icon_type` **(** **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_is_highend` **(** **)** |virtual| |const| | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_category` **(** **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_code` **(** :ref:`PackedStringArray` input_vars, :ref:`String[]` output_vars, :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_description` **(** **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_global_code` **(** :ref:`Mode` mode **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_port_count` **(** **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :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:`int` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_return_icon_type` **(** **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_highend` **(** **)** |virtual| |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -77,7 +77,7 @@ Defining this method is **optional**. If not overridden, the node will be filed .. _class_VisualShaderNodeCustom_method__get_code: -- :ref:`String` **_get_code** **(** :ref:`PackedStringArray` input_vars, :ref:`String[]` output_vars, :ref:`int` mode, :ref:`int` type **)** |virtual| |const| +- :ref:`String` **_get_code** **(** :ref:`PackedStringArray` input_vars, :ref:`String[]` output_vars, :ref:`Mode` mode, :ref:`Type` 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). @@ -103,7 +103,7 @@ Defining this method is **optional**. .. _class_VisualShaderNodeCustom_method__get_global_code: -- :ref:`String` **_get_global_code** **(** :ref:`int` mode **)** |virtual| |const| +- :ref:`String` **_get_global_code** **(** :ref:`Mode` 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). diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst index 039dcc830..2dbb20637 100644 --- a/classes/class_visualshadernodedeterminant.rst +++ b/classes/class_visualshadernodedeterminant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeDeterminant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index 8d789f577..3511b3ccf 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeDotProduct.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 92c85525e..4a31ba80a 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeExpression.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst index bfe92f44b..889aaccc3 100644 --- a/classes/class_visualshadernodefaceforward.rst +++ b/classes/class_visualshadernodefaceforward.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeFaceForward.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodefloatconstant.rst b/classes/class_visualshadernodefloatconstant.rst index f8c774bcb..89065a5db 100644 --- a/classes/class_visualshadernodefloatconstant.rst +++ b/classes/class_visualshadernodefloatconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodefloatfunc.rst b/classes/class_visualshadernodefloatfunc.rst index 7a64cd19f..b10eb4f78 100644 --- a/classes/class_visualshadernodefloatfunc.rst +++ b/classes/class_visualshadernodefloatfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodefloatop.rst b/classes/class_visualshadernodefloatop.rst index d58c57c7c..69b774b3a 100644 --- a/classes/class_visualshadernodefloatop.rst +++ b/classes/class_visualshadernodefloatop.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatOp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodefloatuniform.rst b/classes/class_visualshadernodefloatuniform.rst index 73ae04780..e7607cf79 100644 --- a/classes/class_visualshadernodefloatuniform.rst +++ b/classes/class_visualshadernodefloatuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodefresnel.rst b/classes/class_visualshadernodefresnel.rst index 6bb35041f..9a795cc49 100644 --- a/classes/class_visualshadernodefresnel.rst +++ b/classes/class_visualshadernodefresnel.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeFresnel.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeglobalexpression.rst b/classes/class_visualshadernodeglobalexpression.rst index 2dd116252..1ce1103a9 100644 --- a/classes/class_visualshadernodeglobalexpression.rst +++ b/classes/class_visualshadernodeglobalexpression.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeGlobalExpression.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index 3b37f6576..3ba76b2c4 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeGroupBase.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 4aa26c680..06eb9345e 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeIf.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 3ba6f95b3..27b9b9172 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeInput.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeintconstant.rst b/classes/class_visualshadernodeintconstant.rst index 9f70cb04e..37c2e84db 100644 --- a/classes/class_visualshadernodeintconstant.rst +++ b/classes/class_visualshadernodeintconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeintfunc.rst b/classes/class_visualshadernodeintfunc.rst index 3ac21e677..5fe67b88c 100644 --- a/classes/class_visualshadernodeintfunc.rst +++ b/classes/class_visualshadernodeintfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeintop.rst b/classes/class_visualshadernodeintop.rst index 0407e0869..bbdb57d05 100644 --- a/classes/class_visualshadernodeintop.rst +++ b/classes/class_visualshadernodeintop.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntOp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeintuniform.rst b/classes/class_visualshadernodeintuniform.rst index dd50034e9..240ba993e 100644 --- a/classes/class_visualshadernodeintuniform.rst +++ b/classes/class_visualshadernodeintuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index b8d0aed2a..44a697b7d 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeIs.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodemix.rst b/classes/class_visualshadernodemix.rst index 648a03d7d..cd5f18cb1 100644 --- a/classes/class_visualshadernodemix.rst +++ b/classes/class_visualshadernodemix.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeMix.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodemultiplyadd.rst b/classes/class_visualshadernodemultiplyadd.rst index 61ddc374c..0402eca06 100644 --- a/classes/class_visualshadernodemultiplyadd.rst +++ b/classes/class_visualshadernodemultiplyadd.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeMultiplyAdd.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst index f6f81056d..52de5b24f 100644 --- a/classes/class_visualshadernodeouterproduct.rst +++ b/classes/class_visualshadernodeouterproduct.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeOuterProduct.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index 36b563ef0..ec8e7b7cc 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeOutput.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleaccelerator.rst b/classes/class_visualshadernodeparticleaccelerator.rst index 8f089fcca..ab7c0ff26 100644 --- a/classes/class_visualshadernodeparticleaccelerator.rst +++ b/classes/class_visualshadernodeparticleaccelerator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleAccelerator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleboxemitter.rst b/classes/class_visualshadernodeparticleboxemitter.rst index c6214eedb..d896bfa18 100644 --- a/classes/class_visualshadernodeparticleboxemitter.rst +++ b/classes/class_visualshadernodeparticleboxemitter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleBoxEmitter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleconevelocity.rst b/classes/class_visualshadernodeparticleconevelocity.rst index 25951577b..486972f23 100644 --- a/classes/class_visualshadernodeparticleconevelocity.rst +++ b/classes/class_visualshadernodeparticleconevelocity.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleConeVelocity.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleemit.rst b/classes/class_visualshadernodeparticleemit.rst index 6fb6d6bf7..2a8cf435b 100644 --- a/classes/class_visualshadernodeparticleemit.rst +++ b/classes/class_visualshadernodeparticleemit.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleEmit.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleemitter.rst b/classes/class_visualshadernodeparticleemitter.rst index 9369a8f11..8904907c1 100644 --- a/classes/class_visualshadernodeparticleemitter.rst +++ b/classes/class_visualshadernodeparticleemitter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleEmitter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -11,9 +11,33 @@ VisualShaderNodeParticleEmitter **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeParticleBoxEmitter`, :ref:`VisualShaderNodeParticleRingEmitter`, :ref:`VisualShaderNodeParticleSphereEmitter` +**Inherited By:** :ref:`VisualShaderNodeParticleBoxEmitter`, :ref:`VisualShaderNodeParticleMeshEmitter`, :ref:`VisualShaderNodeParticleRingEmitter`, :ref:`VisualShaderNodeParticleSphereEmitter` +A base class for particle emitters. +Properties +---------- + ++-------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`mode_2d` | ``false`` | ++-------------------------+------------------------------------------------------------------------+-----------+ + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeParticleEmitter_property_mode_2d: + +- :ref:`bool` **mode_2d** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_mode_2d(value) | ++-----------+--------------------+ +| *Getter* | 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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodeparticlemeshemitter.rst b/classes/class_visualshadernodeparticlemeshemitter.rst new file mode 100644 index 000000000..d0e2a76c7 --- /dev/null +++ b/classes/class_visualshadernodeparticlemeshemitter.rst @@ -0,0 +1,73 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleMeshEmitter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeParticleMeshEmitter: + +VisualShaderNodeParticleMeshEmitter +=================================== + +**Inherits:** :ref:`VisualShaderNodeParticleEmitter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + + + +Properties +---------- + ++-------------------------+----------------------------------------------------------------------------------------------+----------+ +| :ref:`Mesh` | :ref:`mesh` | | ++-------------------------+----------------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`surface_index` | ``0`` | ++-------------------------+----------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`use_all_surfaces` | ``true`` | ++-------------------------+----------------------------------------------------------------------------------------------+----------+ + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeParticleMeshEmitter_property_mesh: + +- :ref:`Mesh` **mesh** + ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + +---- + +.. _class_VisualShaderNodeParticleMeshEmitter_property_surface_index: + +- :ref:`int` **surface_index** + ++-----------+--------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------+ +| *Setter* | set_surface_index(value) | ++-----------+--------------------------+ +| *Getter* | get_surface_index() | ++-----------+--------------------------+ + +---- + +.. _class_VisualShaderNodeParticleMeshEmitter_property_use_all_surfaces: + +- :ref:`bool` **use_all_surfaces** + ++-----------+-----------------------------+ +| *Default* | ``true`` | ++-----------+-----------------------------+ +| *Setter* | set_use_all_surfaces(value) | ++-----------+-----------------------------+ +| *Getter* | is_use_all_surfaces() | ++-----------+-----------------------------+ + +.. |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.)` diff --git a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst index 644adb674..196021894 100644 --- a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst +++ b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleMultiplyByAxisAngle.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleoutput.rst b/classes/class_visualshadernodeparticleoutput.rst index 3b0bbd23a..875132228 100644 --- a/classes/class_visualshadernodeparticleoutput.rst +++ b/classes/class_visualshadernodeparticleoutput.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleOutput.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticlerandomness.rst b/classes/class_visualshadernodeparticlerandomness.rst index ad2423230..aa562e4b1 100644 --- a/classes/class_visualshadernodeparticlerandomness.rst +++ b/classes/class_visualshadernodeparticlerandomness.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleRandomness.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticleringemitter.rst b/classes/class_visualshadernodeparticleringemitter.rst index af95b2b62..4b2f5f762 100644 --- a/classes/class_visualshadernodeparticleringemitter.rst +++ b/classes/class_visualshadernodeparticleringemitter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleRingEmitter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeparticlesphereemitter.rst b/classes/class_visualshadernodeparticlesphereemitter.rst index 37dc73e62..38855881b 100644 --- a/classes/class_visualshadernodeparticlesphereemitter.rst +++ b/classes/class_visualshadernodeparticlesphereemitter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeParticleSphereEmitter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernoderesizablebase.rst b/classes/class_visualshadernoderesizablebase.rst index 7fd8c1585..65dfb2852 100644 --- a/classes/class_visualshadernoderesizablebase.rst +++ b/classes/class_visualshadernoderesizablebase.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeResizableBase.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodesample3d.rst b/classes/class_visualshadernodesample3d.rst index 5d5fcdceb..dd29bfe38 100644 --- a/classes/class_visualshadernodesample3d.rst +++ b/classes/class_visualshadernodesample3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeSample3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodescalarderivativefunc.rst b/classes/class_visualshadernodescalarderivativefunc.rst index f8e32cf19..583f44f65 100644 --- a/classes/class_visualshadernodescalarderivativefunc.rst +++ b/classes/class_visualshadernodescalarderivativefunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarDerivativeFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodescreenuvtosdf.rst b/classes/class_visualshadernodescreenuvtosdf.rst index 72978b8a2..b2d9f8e7f 100644 --- a/classes/class_visualshadernodescreenuvtosdf.rst +++ b/classes/class_visualshadernodescreenuvtosdf.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeScreenUVToSDF.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodesdfraymarch.rst b/classes/class_visualshadernodesdfraymarch.rst index 944217beb..4531e67c2 100644 --- a/classes/class_visualshadernodesdfraymarch.rst +++ b/classes/class_visualshadernodesdfraymarch.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeSDFRaymarch.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodesdftoscreenuv.rst b/classes/class_visualshadernodesdftoscreenuv.rst index c12a7ccda..5b0a62b5f 100644 --- a/classes/class_visualshadernodesdftoscreenuv.rst +++ b/classes/class_visualshadernodesdftoscreenuv.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeSDFToScreenUV.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodesmoothstep.rst b/classes/class_visualshadernodesmoothstep.rst index 29ec4ce13..6679b5af4 100644 --- a/classes/class_visualshadernodesmoothstep.rst +++ b/classes/class_visualshadernodesmoothstep.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeSmoothStep.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodestep.rst b/classes/class_visualshadernodestep.rst index 4ede83eb6..4c6d75173 100644 --- a/classes/class_visualshadernodestep.rst +++ b/classes/class_visualshadernodestep.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeStep.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index af23490e8..c8e194647 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeSwitch.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index beaf02836..9dfc74bb4 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexture2darray.rst b/classes/class_visualshadernodetexture2darray.rst index a4527aeea..257a9c79c 100644 --- a/classes/class_visualshadernodetexture2darray.rst +++ b/classes/class_visualshadernodetexture2darray.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTexture2DArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexture2darrayuniform.rst b/classes/class_visualshadernodetexture2darrayuniform.rst index 3c284960c..95427a2c5 100644 --- a/classes/class_visualshadernodetexture2darrayuniform.rst +++ b/classes/class_visualshadernodetexture2darrayuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTexture2DArrayUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexture3d.rst b/classes/class_visualshadernodetexture3d.rst index da491984e..ab8bb0d5b 100644 --- a/classes/class_visualshadernodetexture3d.rst +++ b/classes/class_visualshadernodetexture3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTexture3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexture3duniform.rst b/classes/class_visualshadernodetexture3duniform.rst index 22fa4795c..607917973 100644 --- a/classes/class_visualshadernodetexture3duniform.rst +++ b/classes/class_visualshadernodetexture3duniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTexture3DUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexturesdf.rst b/classes/class_visualshadernodetexturesdf.rst index ca73dd4a4..6ad31a95e 100644 --- a/classes/class_visualshadernodetexturesdf.rst +++ b/classes/class_visualshadernodetexturesdf.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTextureSDF.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetexturesdfnormal.rst b/classes/class_visualshadernodetexturesdfnormal.rst index ac71b8b16..b0e25feb5 100644 --- a/classes/class_visualshadernodetexturesdfnormal.rst +++ b/classes/class_visualshadernodetexturesdfnormal.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTextureSDFNormal.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index a0ee2dad4..2cc1d14f6 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTextureUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetextureuniformtriplanar.rst b/classes/class_visualshadernodetextureuniformtriplanar.rst index 4027d0184..e9872770f 100644 --- a/classes/class_visualshadernodetextureuniformtriplanar.rst +++ b/classes/class_visualshadernodetextureuniformtriplanar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTextureUniformTriplanar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index f5ce58d92..4c8667e8c 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformCompose.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index b4595ac38..62c6f2be1 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 4c4b3cebf..944b82936 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformDecompose.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index c7eb0adae..9e4463695 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformop.rst b/classes/class_visualshadernodetransformop.rst index 45e4e2f2f..e41b87f22 100644 --- a/classes/class_visualshadernodetransformop.rst +++ b/classes/class_visualshadernodetransformop.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformOp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformuniform.rst index 9940c0fd0..fe5e44f70 100644 --- a/classes/class_visualshadernodetransformuniform.rst +++ b/classes/class_visualshadernodetransformuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 3e08014c5..1d385a670 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformVecMult.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index 082c45746..9ef770284 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeuniformref.rst b/classes/class_visualshadernodeuniformref.rst index 9ad5d8985..aebdd981d 100644 --- a/classes/class_visualshadernodeuniformref.rst +++ b/classes/class_visualshadernodeuniformref.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeUniformRef.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodeuvfunc.rst b/classes/class_visualshadernodeuvfunc.rst index decdbc4aa..72fde0328 100644 --- a/classes/class_visualshadernodeuvfunc.rst +++ b/classes/class_visualshadernodeuvfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeUVFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 43bb75195..cd4cb71f5 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVec3Constant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3uniform.rst index cf311e35c..49a66b0b1 100644 --- a/classes/class_visualshadernodevec3uniform.rst +++ b/classes/class_visualshadernodevec3uniform.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVec3Uniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index cd0268899..a417f2812 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorCompose.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 154351ff9..e7dab1030 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorDecompose.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectorderivativefunc.rst b/classes/class_visualshadernodevectorderivativefunc.rst index fbeaf56da..8b863f43e 100644 --- a/classes/class_visualshadernodevectorderivativefunc.rst +++ b/classes/class_visualshadernodevectorderivativefunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorDerivativeFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst index a41c6b678..f49252703 100644 --- a/classes/class_visualshadernodevectordistance.rst +++ b/classes/class_visualshadernodevectordistance.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorDistance.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 6e0fc795f..43be7d1b1 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorFunc.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst index 9b591bfde..425e7400e 100644 --- a/classes/class_visualshadernodevectorlen.rst +++ b/classes/class_visualshadernodevectorlen.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorLen.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index b2940c6f0..4f1cf4f8b 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorOp.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_visualshadernodevectorrefract.rst b/classes/class_visualshadernodevectorrefract.rst index 9ca604356..dad774eab 100644 --- a/classes/class_visualshadernodevectorrefract.rst +++ b/classes/class_visualshadernodevectorrefract.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorRefract.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_voxelgi.rst b/classes/class_voxelgi.rst index 3b7e27367..fce57ced9 100644 --- a/classes/class_voxelgi.rst +++ b/classes/class_voxelgi.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VoxelGI.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,11 +16,13 @@ Real-time global illumination (GI) probe. Description ----------- -``VoxelGI``\ s are used to provide high-quality real-time indirect light to scenes. They precompute the effect of objects that emit light and the effect of static geometry to simulate the behavior of complex light in real-time. ``VoxelGI``\ s need to be baked before using, however, once baked, dynamic objects will receive light from them. Further, lights can be fully dynamic or baked. +``VoxelGI``\ s are used to provide high-quality real-time indirect light and reflections to scenes. They precompute the effect of objects that emit light and the effect of static geometry to simulate the behavior of complex light in real-time. ``VoxelGI``\ s need to be baked before having a visible effect. However, once baked, dynamic objects will receive light from them. Furthermore, lights can be fully dynamic or baked. -Having ``VoxelGI``\ s in a scene can be expensive, the quality of the probe can be turned down in exchange for better performance in the :ref:`ProjectSettings` using :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality`. +**Procedural generation:** ``VoxelGI`` can be baked in an exported project, which makes it suitable for procedurally generated or user-built levels as long as all the geometry is generated in advance. For games where geometry is generated at any time during gameplay, SDFGI is more suitable (see :ref:`Environment.sdfgi_enabled`). -**Note:** Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. +**Performance:** ``VoxelGI`` is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider :ref:`LightmapGI` instead). To improve performance, adjust :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality` and enable :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution` in the Project Settings. To provide a fallback for low-end hardware, consider adding an option to disable ``VoxelGI`` in your project's options menus. A ``VoxelGI`` node can be disabled by hiding it. + +**Note:** Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. To further prevent light leaks, you can also strategically place temporary :ref:`MeshInstance3D` nodes with their :ref:`GeometryInstance3D.gi_mode` set to :ref:`GeometryInstance3D.GI_MODE_BAKED`. These temporary nodes can then be hidden after baking the ``VoxelGI`` node. Tutorials --------- @@ -72,7 +74,7 @@ enum **Subdiv**: - **SUBDIV_256** = **2** --- Use 256 subdivisions. -- **SUBDIV_512** = **3** --- Use 512 subdivisions. This is the highest quality setting, but the slowest. On lower-end hardware this could cause the GPU to stall. +- **SUBDIV_512** = **3** --- Use 512 subdivisions. This is the highest quality setting, but the slowest. On lower-end hardware, this could cause the GPU to stall. - **SUBDIV_MAX** = **4** --- Represents the size of the :ref:`Subdiv` enum. @@ -132,6 +134,8 @@ Method Descriptions Bakes the effect from all :ref:`GeometryInstance3D`\ s marked with :ref:`GeometryInstance3D.GI_MODE_BAKED` and :ref:`Light3D`\ s marked with either :ref:`Light3D.BAKE_DYNAMIC` or :ref:`Light3D.BAKE_STATIC`. 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. +**Note:** :ref:`bake` works from the editor and in exported projects. This makes it suitable for procedurally generated or user-built levels. Baking a ``VoxelGI`` node generally takes from 5 to 20 seconds in most scenes. Reducing :ref:`subdiv` can speed up baking. + ---- .. _class_VoxelGI_method_debug_bake: diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index 69196fe9e..b03448c7e 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VoxelGIData.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index bd75d39ee..d913948f2 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VScrollBar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index d69dcc8dc..657b07f40 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VSeparator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 9bafc5eed..5ac717cd8 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VSlider.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 42d943134..df24784f1 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the VSplitContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 0eca4c5b6..1af02eebf 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WeakRef.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 8603ed2f3..f278a4d5a 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebRTCDataChannel.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 70ddd107f..bf67d143c 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebRTCDataChannelExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_webrtcmultiplayerpeer.rst b/classes/class_webrtcmultiplayerpeer.rst index 2057f36ce..d40656f4e 100644 --- a/classes/class_webrtcmultiplayerpeer.rst +++ b/classes/class_webrtcmultiplayerpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebRTCMultiplayerPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index c15f9f5a9..d76b961fc 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebRTCPeerConnection.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index d0d570ba6..95e9d6b0f 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebRTCPeerConnectionExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index d1fc5d3fb..d7e732639 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebSocketClient.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 422812637..23b8149a2 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebSocketMultiplayerPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 0ee43d710..960aef330 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebSocketPeer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,7 +16,7 @@ A class representing a specific WebSocket connection. Description ----------- -This class represent a specific WebSocket connection, you can do lower level operations with it. +This class represents a specific WebSocket connection, allowing you to do lower level operations with it. You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer. diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index 2e3dedd2d..9a530d684 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebSocketServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index 30535d0da..1bd321867 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WebXRInterface.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -108,7 +108,7 @@ There are several ways to handle "controller" input: - Using :ref:`Node._unhandled_input` and :ref:`InputEventJoypadButton` or :ref:`InputEventJoypadMotion`. This works the same as normal joypads, except the :ref:`InputEvent.device` starts at 100, so the left controller is 100 and the right controller is 101, and the button codes are also defined by `Section 3.3 of the WebXR Gamepads Module `__. -- Using the :ref:`select`, :ref:`squeeze` and related signals. This method will work for both advanced VR controllers, and non-traditional "controllers" like a tap on the screen, a spoken voice command or a button press on the device itself. The ``controller_id`` passed to these signals is the same id as used in :ref:`XRController3D.controller_id`. +- Using the :ref:`select`, :ref:`squeeze` and related signals. This method will work for both advanced VR controllers, and non-traditional "controllers" like a tap on the screen, a spoken voice command or a button press on the device itself. You can use one or all of these methods to allow your game or app to support a wider or narrower set of devices and input methods, or to allow more advanced interactions with more advanced devices. diff --git a/classes/class_window.rst b/classes/class_window.rst index 62940fc3d..d75220573 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Window.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index d61edb110..b25e298e5 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the World2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_world3d.rst b/classes/class_world3d.rst index 42023eafc..9082bf2cd 100644 --- a/classes/class_world3d.rst +++ b/classes/class_world3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the World3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_worldboundaryshape2d.rst b/classes/class_worldboundaryshape2d.rst index aa40d7864..ac4dc71d6 100644 --- a/classes/class_worldboundaryshape2d.rst +++ b/classes/class_worldboundaryshape2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WorldBoundaryShape2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_worldboundaryshape3d.rst b/classes/class_worldboundaryshape3d.rst index 26a41c9ef..06d90d1ae 100644 --- a/classes/class_worldboundaryshape3d.rst +++ b/classes/class_worldboundaryshape3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WorldBoundaryShape3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 98ebbdce5..a43926e55 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the WorldEnvironment.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_x509certificate.rst b/classes/class_x509certificate.rst index 65229f9e9..c4d1c9fb8 100644 --- a/classes/class_x509certificate.rst +++ b/classes/class_x509certificate.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the X509Certificate.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index def81dd37..3513d147f 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XMLParser.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_xranchor3d.rst b/classes/class_xranchor3d.rst index 5688bb751..ad0d0d29f 100644 --- a/classes/class_xranchor3d.rst +++ b/classes/class_xranchor3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRAnchor3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -9,7 +9,7 @@ XRAnchor3D ========== -**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`XRNode3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` An anchor point in AR space. @@ -22,81 +22,18 @@ This node is mapped to one of the anchors through its unique ID. When you receiv Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view. -Properties ----------- - -+-----------------------+-------------------------------------------------------+-------+ -| :ref:`int` | :ref:`anchor_id` | ``1`` | -+-----------------------+-------------------------------------------------------+-------+ - Methods ------- -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_anchor_name` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------+ - -Signals -------- - -.. _class_XRAnchor3D_signal_mesh_updated: - -- **mesh_updated** **(** :ref:`Mesh` mesh **)** - -Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being ``mesh_updated``. - -Property Descriptions ---------------------- - -.. _class_XRAnchor3D_property_anchor_id: - -- :ref:`int` **anchor_id** - -+-----------+----------------------+ -| *Default* | ``1`` | -+-----------+----------------------+ -| *Setter* | set_anchor_id(value) | -+-----------+----------------------+ -| *Getter* | get_anchor_id() | -+-----------+----------------------+ - -The anchor's ID. You can set this before the anchor itself exists. The first anchor gets an ID of ``1``, the second an ID of ``2``, etc. When anchors get removed, the engine can then assign the corresponding ID to new anchors. The most common situation where anchors "disappear" is when the AR server identifies that two anchors represent different parts of the same plane and merges them. ++-------------------------------+-------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_plane` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_XRAnchor3D_method_get_anchor_name: - -- :ref:`String` **get_anchor_name** **(** **)** |const| - -Returns the name given to this anchor. - ----- - -.. _class_XRAnchor3D_method_get_is_active: - -- :ref:`bool` **get_is_active** **(** **)** |const| - -Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with this ID is currently known. - ----- - -.. _class_XRAnchor3D_method_get_mesh: - -- :ref:`Mesh` **get_mesh** **(** **)** |const| - -If provided by the :ref:`XRInterface`, this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. - ----- - .. _class_XRAnchor3D_method_get_plane: - :ref:`Plane` **get_plane** **(** **)** |const| diff --git a/classes/class_xrcamera3d.rst b/classes/class_xrcamera3d.rst index 71129063b..e28216770 100644 --- a/classes/class_xrcamera3d.rst +++ b/classes/class_xrcamera3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRCamera3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_xrcontroller3d.rst b/classes/class_xrcontroller3d.rst index 1ef800350..67b5c20fa 100644 --- a/classes/class_xrcontroller3d.rst +++ b/classes/class_xrcontroller3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRController3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -9,7 +9,7 @@ XRController3D ============== -**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`XRNode3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A spatial node representing a spatially-tracked controller. @@ -22,6 +22,8 @@ Controllers are linked by their ID. You can create controller nodes before the c The position of the controller node is automatically updated by the :ref:`XRServer`. This makes this node ideal to add child nodes to visualize the controller. +As many XR runtimes now use a configurable action map all inputs are named. + Tutorials --------- @@ -30,37 +32,29 @@ Tutorials Properties ---------- -+---------------------------+-------------------------------------------------------------------+---------+ -| :ref:`int` | :ref:`controller_id` | ``1`` | -+---------------------------+-------------------------------------------------------------------+---------+ -| :ref:`float` | :ref:`rumble` | ``0.0`` | -+---------------------------+-------------------------------------------------------------------+---------+ ++---------------------------+-----------------------------------------------------+---------+ +| :ref:`float` | :ref:`rumble` | ``0.0`` | ++---------------------------+-----------------------------------------------------+---------+ Methods ------- -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_controller_name` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joystick_id` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :ref:`get_tracker_hand` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_pressed` **(** :ref:`int` button **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_axis` **(** :ref:`StringName` name **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackerHand` | :ref:`get_tracker_hand` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_value` **(** :ref:`StringName` name **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_pressed` **(** :ref:`StringName` name **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_XRController3D_signal_button_pressed: -- **button_pressed** **(** :ref:`int` button **)** +- **button_pressed** **(** :ref:`String` name **)** Emitted when a button on this controller is pressed. @@ -68,43 +62,29 @@ Emitted when a button on this controller is pressed. .. _class_XRController3D_signal_button_released: -- **button_released** **(** :ref:`int` button **)** +- **button_released** **(** :ref:`String` name **)** Emitted when a button on this controller is released. ---- -.. _class_XRController3D_signal_mesh_updated: +.. _class_XRController3D_signal_input_axis_changed: -- **mesh_updated** **(** :ref:`Mesh` mesh **)** +- **input_axis_changed** **(** :ref:`String` name, :ref:`Vector2` value **)** -Emitted when the mesh associated with the controller changes or when one becomes available. Generally speaking this will be a static mesh after becoming available. +Emitted when a thumbstick or thumbpad on this controller is moved. + +---- + +.. _class_XRController3D_signal_input_value_changed: + +- **input_value_changed** **(** :ref:`String` name, :ref:`float` value **)** + +Emitted when a trigger or similar input on this controller changes value. Property Descriptions --------------------- -.. _class_XRController3D_property_controller_id: - -- :ref:`int` **controller_id** - -+-----------+--------------------------+ -| *Default* | ``1`` | -+-----------+--------------------------+ -| *Setter* | set_controller_id(value) | -+-----------+--------------------------+ -| *Getter* | get_controller_id() | -+-----------+--------------------------+ - -The controller's ID. - -A controller ID of 0 is unbound and will always result in an inactive node. Controller ID 1 is reserved for the first controller that identifies itself as the left-hand controller and ID 2 is reserved for the first controller that identifies itself as the right-hand controller. - -For any other controller that the :ref:`XRServer` detects, we continue with controller ID 3. - -When a controller is turned off, its slot is freed. This ensures controllers will keep the same ID even when controllers with lower IDs are turned off. - ----- - .. _class_XRController3D_property_rumble: - :ref:`float` **rumble** @@ -124,43 +104,11 @@ This is a useful property to animate if you want the controller to vibrate for a Method Descriptions ------------------- -.. _class_XRController3D_method_get_controller_name: +.. _class_XRController3D_method_get_axis: -- :ref:`String` **get_controller_name** **(** **)** |const| +- :ref:`Vector2` **get_axis** **(** :ref:`StringName` name **)** |const| -If active, returns the name of the associated controller if provided by the AR/VR SDK used. - ----- - -.. _class_XRController3D_method_get_is_active: - -- :ref:`bool` **get_is_active** **(** **)** |const| - -Returns ``true`` if the bound controller is active. XR systems attempt to track active controllers. - ----- - -.. _class_XRController3D_method_get_joystick_axis: - -- :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** |const| - -Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. - ----- - -.. _class_XRController3D_method_get_joystick_id: - -- :ref:`int` **get_joystick_id** **(** **)** |const| - -Returns the ID of the joystick object bound to this. Every controller tracked by the :ref:`XRServer` that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. - ----- - -.. _class_XRController3D_method_get_mesh: - -- :ref:`Mesh` **get_mesh** **(** **)** |const| - -If provided by the :ref:`XRInterface`, this returns a mesh associated with the controller. This can be used to visualize the controller. +Returns a :ref:`Vector2` for the input with the given ``name``. This is used for thumbsticks and thumbpads found on many controllers. ---- @@ -172,11 +120,19 @@ Returns the hand holding this controller, if known. See :ref:`TrackerHand` **get_value** **(** :ref:`StringName` name **)** |const| + +Returns a numeric value for the input with the given ``name``. This is used for triggers and grip sensors. + +---- + .. _class_XRController3D_method_is_button_pressed: -- :ref:`bool` **is_button_pressed** **(** :ref:`int` button **)** |const| +- :ref:`bool` **is_button_pressed** **(** :ref:`StringName` name **)** |const| -Returns ``true`` if the button at index ``button`` is pressed. See :ref:`JoyButton`. +Returns ``true`` if the button with the given ``name`` is pressed. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_xrinterface.rst b/classes/class_xrinterface.rst index e8f992e15..a459f63a9 100644 --- a/classes/class_xrinterface.rst +++ b/classes/class_xrinterface.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRInterface.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -30,34 +30,53 @@ Tutorials Properties ---------- -+-------------------------+--------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`ar_is_anchor_detection_enabled` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`interface_is_primary` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------------------------+-----------+ ++----------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`ar_is_anchor_detection_enabled` | ``false`` | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`interface_is_primary` | ``false`` | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ +| :ref:`PlayAreaMode` | :ref:`xr_play_area_mode` | ``0`` | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ Methods ------- -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_camera_feed_id` **(** **)** | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_capabilities` **(** **)** |const| | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`StringName` | :ref:`get_name` **(** **)** |const| | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_render_target_size` **(** **)** | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`TrackingStatus` | :ref:`get_tracking_status` **(** **)** |const| | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_view_count` **(** **)** | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_initialized` **(** **)** |const| | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`uninitialize` **(** **)** | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------+ ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_camera_feed_id` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_capabilities` **(** **)** |const| | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_name` **(** **)** |const| | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_play_area` **(** **)** |const| | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_render_target_size` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackingStatus` | :ref:`get_tracking_status` **(** **)** |const| | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_view_count` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_initialized` **(** **)** |const| | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`set_play_area_mode` **(** :ref:`PlayAreaMode` mode **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`supports_play_area_mode` **(** :ref:`PlayAreaMode` mode **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`trigger_haptic_pulse` **(** :ref:`String` action_name, :ref:`StringName` tracker_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`uninitialize` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_XRInterface_signal_play_area_changed: + +- **play_area_changed** **(** :ref:`int` mode **)** + +Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation. Enumerations ------------ @@ -70,6 +89,10 @@ Enumerations .. _class_XRInterface_constant_XR_STEREO: +.. _class_XRInterface_constant_XR_QUAD: + +.. _class_XRInterface_constant_XR_VR: + .. _class_XRInterface_constant_XR_AR: .. _class_XRInterface_constant_XR_EXTERNAL: @@ -82,27 +105,13 @@ enum **Capabilities**: - **XR_STEREO** = **2** --- This interface supports stereoscopic rendering. -- **XR_AR** = **4** --- This interface supports AR (video background and real world tracking). +- **XR_QUAD** = **4** --- This interface supports quad rendering (not yet supported by Godot). -- **XR_EXTERNAL** = **8** --- This interface outputs to an external device. If the main viewport is used, the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of :ref:`get_render_target_size`). Using a separate viewport node frees up the main viewport for other purposes. +- **XR_VR** = **8** --- this interface supports VR. ----- +- **XR_AR** = **16** --- This interface supports AR (video background and real world tracking). -.. _enum_XRInterface_Eyes: - -.. _class_XRInterface_constant_EYE_MONO: - -.. _class_XRInterface_constant_EYE_LEFT: - -.. _class_XRInterface_constant_EYE_RIGHT: - -enum **Eyes**: - -- **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. - -- **EYE_LEFT** = **1** --- Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. - -- **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. +- **XR_EXTERNAL** = **32** --- This interface outputs to an external device. If the main viewport is used, the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of :ref:`get_render_target_size`). Using a separate viewport node frees up the main viewport for other purposes. ---- @@ -130,6 +139,32 @@ enum **TrackingStatus**: - **XR_NOT_TRACKING** = **4** --- Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.). +---- + +.. _enum_XRInterface_PlayAreaMode: + +.. _class_XRInterface_constant_XR_PLAY_AREA_UNKNOWN: + +.. _class_XRInterface_constant_XR_PLAY_AREA_3DOF: + +.. _class_XRInterface_constant_XR_PLAY_AREA_SITTING: + +.. _class_XRInterface_constant_XR_PLAY_AREA_ROOMSCALE: + +.. _class_XRInterface_constant_XR_PLAY_AREA_STAGE: + +enum **PlayAreaMode**: + +- **XR_PLAY_AREA_UNKNOWN** = **0** --- Play area mode not set or not available. + +- **XR_PLAY_AREA_3DOF** = **1** --- Play area only supports orientation tracking, no positional tracking, area will center around player. + +- **XR_PLAY_AREA_SITTING** = **2** --- Player is in seated position, limited positional tracking, fixed guardian around player. + +- **XR_PLAY_AREA_ROOMSCALE** = **3** --- Player is free to move around, full positional tracking. + +- **XR_PLAY_AREA_STAGE** = **4** --- Same as roomscale but origin point is fixed to the center of the physical space, XRServer.center_on_hmd disabled. + Property Descriptions --------------------- @@ -163,6 +198,22 @@ On an AR interface, ``true`` if anchor detection is enabled. ``true`` if this is the primary interface. +---- + +.. _class_XRInterface_property_xr_play_area_mode: + +- :ref:`PlayAreaMode` **xr_play_area_mode** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_play_area_mode(value) | ++-----------+---------------------------+ +| *Getter* | get_play_area_mode() | ++-----------+---------------------------+ + +The play area mode for this interface. + Method Descriptions ------------------- @@ -190,6 +241,14 @@ Returns the name of this interface (OpenXR, OpenVR, OpenHMD, ARKit, etc). ---- +.. _class_XRInterface_method_get_play_area: + +- :ref:`PackedVector3Array` **get_play_area** **(** **)** |const| + +Returns an array of vectors that denotes the physical play area mapped to the virtual space around the :ref:`XROrigin3D` point. The points form a convex polygon that can be used to react to or visualise the play area. This returns an empty array if this feature is not supported or if the information is not yet available. + +---- + .. _class_XRInterface_method_get_render_target_size: - :ref:`Vector2` **get_render_target_size** **(** **)** @@ -238,6 +297,34 @@ Is ``true`` if this interface has been initialised. ---- +.. _class_XRInterface_method_set_play_area_mode: + +- :ref:`bool` **set_play_area_mode** **(** :ref:`PlayAreaMode` mode **)** + +Sets the active play area mode, will return ``false`` if the mode can't be used with this interface. + +---- + +.. _class_XRInterface_method_supports_play_area_mode: + +- :ref:`bool` **supports_play_area_mode** **(** :ref:`PlayAreaMode` mode **)** + +Call this to find out if a given play area mode is supported by this interface. + +---- + +.. _class_XRInterface_method_trigger_haptic_pulse: + +- void **trigger_haptic_pulse** **(** :ref:`String` action_name, :ref:`StringName` tracker_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** + +Triggers a haptic pulse on a device associated with this interface. + +``action_name`` is the name of the action for this pulse. + +``tracker_name`` is optional and can be used to direct the pulse to a specific device provided that device is bound to this haptic. + +---- + .. _class_XRInterface_method_uninitialize: - void **uninitialize** **(** **)** diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index 9754d4cdb..73140c089 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRInterfaceExtension.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -34,10 +34,18 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`_get_name` **(** **)** |virtual| |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`_get_play_area` **(** **)** |virtual| |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_play_area_mode` **(** **)** |virtual| |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat64Array` | :ref:`_get_projection_for_view` **(** :ref:`int` view, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far **)** |virtual| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_get_render_target_size` **(** **)** |virtual| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`_get_suggested_pose_names` **(** :ref:`StringName` tracker_name **)** |virtual| |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names` **(** **)** |virtual| |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_tracking_status` **(** **)** |virtual| |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`_get_transform_for_view` **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** |virtual| | @@ -54,6 +62,12 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_set_anchor_detection_is_enabled` **(** :ref:`bool` enabled **)** |virtual| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_set_play_area_mode` **(** :ref:`int` mode **)** |virtual| |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_supports_play_area_mode` **(** :ref:`PlayAreaMode` mode **)** |virtual| |const| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_trigger_haptic_pulse` **(** :ref:`String` action_name, :ref:`StringName` tracker_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** |virtual| | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_uninitialize` **(** **)** |virtual| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_blit` **(** :ref:`RID` render_target, :ref:`Rect2` src_rect, :ref:`Rect2i` dst_rect, :ref:`bool` use_layer, :ref:`int` layer, :ref:`bool` apply_lens_distortion, :ref:`Vector2` eye_center, :ref:`float` k1, :ref:`float` k2, :ref:`float` upscale, :ref:`float` aspect_ratio **)** | @@ -100,6 +114,18 @@ Method Descriptions ---- +.. _class_XRInterfaceExtension_method__get_play_area: + +- :ref:`PackedVector3Array` **_get_play_area** **(** **)** |virtual| |const| + +---- + +.. _class_XRInterfaceExtension_method__get_play_area_mode: + +- :ref:`int` **_get_play_area_mode** **(** **)** |virtual| |const| + +---- + .. _class_XRInterfaceExtension_method__get_projection_for_view: - :ref:`PackedFloat64Array` **_get_projection_for_view** **(** :ref:`int` view, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far **)** |virtual| @@ -112,6 +138,18 @@ Method Descriptions ---- +.. _class_XRInterfaceExtension_method__get_suggested_pose_names: + +- :ref:`PackedStringArray` **_get_suggested_pose_names** **(** :ref:`StringName` tracker_name **)** |virtual| |const| + +---- + +.. _class_XRInterfaceExtension_method__get_suggested_tracker_names: + +- :ref:`PackedStringArray` **_get_suggested_tracker_names** **(** **)** |virtual| |const| + +---- + .. _class_XRInterfaceExtension_method__get_tracking_status: - :ref:`int` **_get_tracking_status** **(** **)** |virtual| |const| @@ -160,6 +198,24 @@ Method Descriptions ---- +.. _class_XRInterfaceExtension_method__set_play_area_mode: + +- :ref:`bool` **_set_play_area_mode** **(** :ref:`int` mode **)** |virtual| |const| + +---- + +.. _class_XRInterfaceExtension_method__supports_play_area_mode: + +- :ref:`bool` **_supports_play_area_mode** **(** :ref:`PlayAreaMode` mode **)** |virtual| |const| + +---- + +.. _class_XRInterfaceExtension_method__trigger_haptic_pulse: + +- void **_trigger_haptic_pulse** **(** :ref:`String` action_name, :ref:`StringName` tracker_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** |virtual| + +---- + .. _class_XRInterfaceExtension_method__uninitialize: - void **_uninitialize** **(** **)** |virtual| diff --git a/classes/class_xrnode3d.rst b/classes/class_xrnode3d.rst new file mode 100644 index 000000000..8efeebf91 --- /dev/null +++ b/classes/class_xrnode3d.rst @@ -0,0 +1,122 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the XRNode3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_XRNode3D: + +XRNode3D +======== + +**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`XRAnchor3D`, :ref:`XRController3D` + +A spatial node that has its position automatically updated by the :ref:`XRServer`. + +Description +----------- + +This node can be bound to a specific pose of a :ref:`XRPositionalTracker` and will automatically have its :ref:`Node3D.transform` updated by the :ref:`XRServer`. Nodes of this type must be added as children of the :ref:`XROrigin3D` node. + +Properties +---------- + ++-------------------------------------+-------------------------------------------------+----------------+ +| :ref:`StringName` | :ref:`pose` | ``&"default"`` | ++-------------------------------------+-------------------------------------------------+----------------+ +| :ref:`StringName` | :ref:`tracker` | ``&""`` | ++-------------------------------------+-------------------------------------------------+----------------+ + +Methods +------- + ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_has_tracking_data` **(** **)** |const| | ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** |const| | ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`XRPose` | :ref:`get_pose` **(** **)** | ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`trigger_haptic_pulse` **(** :ref:`String` action_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** | ++-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_XRNode3D_property_pose: + +- :ref:`StringName` **pose** + ++-----------+----------------------+ +| *Default* | ``&"default"`` | ++-----------+----------------------+ +| *Setter* | set_pose_name(value) | ++-----------+----------------------+ +| *Getter* | get_pose_name() | ++-----------+----------------------+ + +The name of the pose we're bound to. Which poses a tracker supports is not known during design time. + +Godot defines number of standard pose names such as ``aim`` and ``grip`` but other may be configured within a given :ref:`XRInterface`. + +---- + +.. _class_XRNode3D_property_tracker: + +- :ref:`StringName` **tracker** + ++-----------+--------------------+ +| *Default* | ``&""`` | ++-----------+--------------------+ +| *Setter* | set_tracker(value) | ++-----------+--------------------+ +| *Getter* | get_tracker() | ++-----------+--------------------+ + +The name of the tracker we're bound to. Which trackers are available is not known during design time. + +Godot defines a number of standard trackers such as ``left_hand`` and ``right_hand`` but others may be configured within a given :ref:`XRInterface`. + +Method Descriptions +------------------- + +.. _class_XRNode3D_method_get_has_tracking_data: + +- :ref:`bool` **get_has_tracking_data** **(** **)** |const| + +Returns ``true`` if the :ref:`tracker` has current tracking data for the :ref:`pose` being tracked. + +---- + +.. _class_XRNode3D_method_get_is_active: + +- :ref:`bool` **get_is_active** **(** **)** |const| + +Returns ``true`` if the :ref:`tracker` has been registered and the :ref:`pose` is being tracked. + +---- + +.. _class_XRNode3D_method_get_pose: + +- :ref:`XRPose` **get_pose** **(** **)** + +Returns the :ref:`XRPose` containing the current state of the pose being tracked. This gives access to additional properties of this pose. + +---- + +.. _class_XRNode3D_method_trigger_haptic_pulse: + +- void **trigger_haptic_pulse** **(** :ref:`String` action_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** + +Triggers a haptic pulse on a device associated with this interface. + +``action_name`` is the name of the action for this pulse. + +.. |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.)` diff --git a/classes/class_xrorigin3d.rst b/classes/class_xrorigin3d.rst index f3713b375..692090c85 100644 --- a/classes/class_xrorigin3d.rst +++ b/classes/class_xrorigin3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XROrigin3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_xrpose.rst b/classes/class_xrpose.rst new file mode 100644 index 000000000..caf14d5bf --- /dev/null +++ b/classes/class_xrpose.rst @@ -0,0 +1,148 @@ +:github_url: hide + +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the XRPose.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_XRPose: + +XRPose +====== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +This object contains all data related to a pose on a tracked object. + +Description +----------- + +XR runtimes often identify multiple locations on devices such as controllers that are spatially tracked. + +Orientation, location, linear velocity and angular velocity are all provided for each pose by the XR runtime. This object contains this state of a pose. + +Properties +---------- + ++---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`angular_velocity` | ``Vector3(0, 0, 0)`` | ++---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`has_tracking_data` | ``false`` | ++---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`linear_velocity` | ``Vector3(0, 0, 0)`` | ++---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`StringName` | :ref:`name` | ``&""`` | ++---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | ++---------------------------------------+-------------------------------------------------------------------+-----------------------------------------------------+ + +Methods +------- + ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`get_adjusted_transform` **(** **)** |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_XRPose_property_angular_velocity: + +- :ref:`Vector3` **angular_velocity** + ++-----------+-----------------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++-----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++-----------+-----------------------------+ + +The angular velocity for this pose. + +---- + +.. _class_XRPose_property_has_tracking_data: + +- :ref:`bool` **has_tracking_data** + ++-----------+------------------------------+ +| *Default* | ``false`` | ++-----------+------------------------------+ +| *Setter* | set_has_tracking_data(value) | ++-----------+------------------------------+ +| *Getter* | get_has_tracking_data() | ++-----------+------------------------------+ + +If ``true`` our tracking data is up to date. If ``false`` we're no longer receiving new tracking data and our state is whatever that last valid state was. + +---- + +.. _class_XRPose_property_linear_velocity: + +- :ref:`Vector3` **linear_velocity** + ++-----------+----------------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++-----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++-----------+----------------------------+ + +The linear velocity of this pose. + +---- + +.. _class_XRPose_property_name: + +- :ref:`StringName` **name** + ++-----------+-----------------+ +| *Default* | ``&""`` | ++-----------+-----------------+ +| *Setter* | set_name(value) | ++-----------+-----------------+ +| *Getter* | get_name() | ++-----------+-----------------+ + +The name of this pose. Pose names are often driven by an action map setup by the user. Godot does suggest a number of pose names that it expects :ref:`XRInterface`\ s to implement: + +- ``root`` defines a root location, often used for tracked objects that do not have further nodes. + +- ``aim`` defines the tip of a controller with the orientation pointing outwards, for instance: add your raycasts to this. + +- ``grip`` defines the location where the user grips the controller + +- ``skeleton`` defines the root location a hand mesh should be placed when using hand tracking and the animated skeleton supplied by the XR runtime. + +---- + +.. _class_XRPose_property_transform: + +- :ref:`Transform3D` **transform** + ++-----------+-----------------------------------------------------+ +| *Default* | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | ++-----------+-----------------------------------------------------+ +| *Setter* | set_transform(value) | ++-----------+-----------------------------------------------------+ +| *Getter* | get_transform() | ++-----------+-----------------------------------------------------+ + +The transform containing the original and transform as reported by the XR runtime. + +Method Descriptions +------------------- + +.. _class_XRPose_method_get_adjusted_transform: + +- :ref:`Transform3D` **get_adjusted_transform** **(** **)** |const| + +Returns the :ref:`transform` with world scale and our reference frame applied. This is the transform used to position :ref:`XRNode3D` objects. + +.. |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.)` diff --git a/classes/class_xrpositionaltracker.rst b/classes/class_xrpositionaltracker.rst index 29b118e04..471ce613c 100644 --- a/classes/class_xrpositionaltracker.rst +++ b/classes/class_xrpositionaltracker.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRPositionalTracker.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,9 +18,9 @@ Description An instance of this object represents a device that is tracked, such as a controller or anchor point. HMDs aren't represented here as they are handled internally. -As controllers are turned on and the AR/VR interface detects them, instances of this object are automatically added to this list of active tracking objects accessible through the :ref:`XRServer`. +As controllers are turned on and the :ref:`XRInterface` detects them, instances of this object are automatically added to this list of active tracking objects accessible through the :ref:`XRServer`. -The :ref:`XRController3D` and :ref:`XRAnchor3D` both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDNative-based interfaces can interact with them. +The :ref:`XRController3D` and :ref:`XRAnchor3D` both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDExtension-based interfaces can interact with them. Tutorials --------- @@ -30,36 +30,75 @@ Tutorials Properties ---------- -+---------------------------+----------------------------------------------------------+---------+ -| :ref:`float` | :ref:`rumble` | ``0.0`` | -+---------------------------+----------------------------------------------------------+---------+ ++----------------------------------------------------------+--------------------------------------------------------------------+----------------+ +| :ref:`String` | :ref:`description` | ``""`` | ++----------------------------------------------------------+--------------------------------------------------------------------+----------------+ +| :ref:`TrackerHand` | :ref:`hand` | ``0`` | ++----------------------------------------------------------+--------------------------------------------------------------------+----------------+ +| :ref:`StringName` | :ref:`name` | ``&"Unknown"`` | ++----------------------------------------------------------+--------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`rumble` | ``0.0`` | ++----------------------------------------------------------+--------------------------------------------------------------------+----------------+ +| :ref:`TrackerType` | :ref:`type` | ``128`` | ++----------------------------------------------------------+--------------------------------------------------------------------+----------------+ Methods ------- -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_id` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_orientation` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :ref:`get_tracker_hand` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracker_id` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringName` | :ref:`get_tracker_name` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerType` | :ref:`get_tracker_type` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tracking_orientation` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tracking_position` **(** **)** |const| | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_input` **(** :ref:`StringName` name **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`XRPose` | :ref:`get_pose` **(** :ref:`StringName` name **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_pose` **(** :ref:`StringName` name **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate_pose` **(** :ref:`StringName` name **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pose` **(** :ref:`StringName` name, :ref:`Transform3D` transform, :ref:`Vector3` linear_velocity, :ref:`Vector3` angular_velocity **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_XRPositionalTracker_signal_button_pressed: + +- **button_pressed** **(** :ref:`String` name **)** + +Emitted when a button on this tracker is pressed. Note that many XR runtimes allow other inputs to be mapped to buttons. + +---- + +.. _class_XRPositionalTracker_signal_button_released: + +- **button_released** **(** :ref:`String` name **)** + +Emitted when a button on this tracker is released. + +---- + +.. _class_XRPositionalTracker_signal_input_axis_changed: + +- **input_axis_changed** **(** :ref:`String` name, :ref:`Vector2` vector **)** + +Emitted when a thumbstick or thumbpad on this tracker moves. + +---- + +.. _class_XRPositionalTracker_signal_input_value_changed: + +- **input_value_changed** **(** :ref:`String` name, :ref:`float` value **)** + +Emitted when a trigger or similar input on this tracker changes value. + +---- + +.. _class_XRPositionalTracker_signal_pose_changed: + +- **pose_changed** **(** :ref:`XRPose` pose **)** + +Emitted when the state of a pose tracked by this tracker changes. Enumerations ------------ @@ -83,6 +122,58 @@ enum **TrackerHand**: Property Descriptions --------------------- +.. _class_XRPositionalTracker_property_description: + +- :ref:`String` **description** + ++-----------+-------------------------+ +| *Default* | ``""`` | ++-----------+-------------------------+ +| *Setter* | set_tracker_desc(value) | ++-----------+-------------------------+ +| *Getter* | get_tracker_desc() | ++-----------+-------------------------+ + +The description of this tracker. + +---- + +.. _class_XRPositionalTracker_property_hand: + +- :ref:`TrackerHand` **hand** + ++-----------+-------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------+ +| *Setter* | set_tracker_hand(value) | ++-----------+-------------------------+ +| *Getter* | get_tracker_hand() | ++-----------+-------------------------+ + +Defines which hand this tracker relates to. + +---- + +.. _class_XRPositionalTracker_property_name: + +- :ref:`StringName` **name** + ++-----------+-------------------------+ +| *Default* | ``&"Unknown"`` | ++-----------+-------------------------+ +| *Setter* | set_tracker_name(value) | ++-----------+-------------------------+ +| *Getter* | get_tracker_name() | ++-----------+-------------------------+ + +The unique name of this tracker. The trackers that are available differ between various XR runtimes and can often be configured by the user. Godot maintains a number of reserved names that it expects the :ref:`XRInterface` to implement if applicable: + +- ``left_hand`` identifies the controller held in the players left hand + +- ``right_hand`` identifies the controller held in the players right hand + +---- + .. _class_XRPositionalTracker_property_rumble: - :ref:`float` **rumble** @@ -97,94 +188,70 @@ Property Descriptions The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. +---- + +.. _class_XRPositionalTracker_property_type: + +- :ref:`TrackerType` **type** + ++-----------+-------------------------+ +| *Default* | ``128`` | ++-----------+-------------------------+ +| *Setter* | set_tracker_type(value) | ++-----------+-------------------------+ +| *Getter* | get_tracker_type() | ++-----------+-------------------------+ + +The type of tracker. + Method Descriptions ------------------- -.. _class_XRPositionalTracker_method_get_joy_id: +.. _class_XRPositionalTracker_method_get_input: -- :ref:`int` **get_joy_id** **(** **)** |const| +- :ref:`Variant` **get_input** **(** :ref:`StringName` name **)** |const| -If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID. +Returns an input for this tracker. It can return a boolean, float or :ref:`Vector2` value depending on whether the input is a button, trigger or thumbstick/thumbpad. ---- -.. _class_XRPositionalTracker_method_get_mesh: +.. _class_XRPositionalTracker_method_get_pose: -- :ref:`Mesh` **get_mesh** **(** **)** |const| +- :ref:`XRPose` **get_pose** **(** :ref:`StringName` name **)** |const| -Returns the mesh related to a controller or anchor point if one is available. +Returns the current :ref:`XRPose` state object for the bound ``pose``. ---- -.. _class_XRPositionalTracker_method_get_orientation: +.. _class_XRPositionalTracker_method_has_pose: -- :ref:`Basis` **get_orientation** **(** **)** |const| +- :ref:`bool` **has_pose** **(** :ref:`StringName` name **)** |const| -Returns the controller's orientation matrix. +Returns ``true`` if the bound ``tracker`` is available and is currently tracking the bound ``pose``. ---- -.. _class_XRPositionalTracker_method_get_position: +.. _class_XRPositionalTracker_method_invalidate_pose: -- :ref:`Vector3` **get_position** **(** **)** |const| +- void **invalidate_pose** **(** :ref:`StringName` name **)** -Returns the world-space controller position. +Marks this pose as invalid, we don't clear the last reported state but it allows users to decide if trackers need to be hidden if we loose tracking or just remain at their last known position. ---- -.. _class_XRPositionalTracker_method_get_tracker_hand: +.. _class_XRPositionalTracker_method_set_input: -- :ref:`TrackerHand` **get_tracker_hand** **(** **)** |const| +- void **set_input** **(** :ref:`StringName` name, :ref:`Variant` value **)** -Returns the hand holding this tracker, if known. See :ref:`TrackerHand` constants. +Changes the value for the given input. This method is called by a :ref:`XRInterface` implementation and should not be used directly. ---- -.. _class_XRPositionalTracker_method_get_tracker_id: +.. _class_XRPositionalTracker_method_set_pose: -- :ref:`int` **get_tracker_id** **(** **)** |const| +- void **set_pose** **(** :ref:`StringName` name, :ref:`Transform3D` transform, :ref:`Vector3` linear_velocity, :ref:`Vector3` angular_velocity **)** -Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the :ref:`XRController3D` and :ref:`XRAnchor3D` nodes. - ----- - -.. _class_XRPositionalTracker_method_get_tracker_name: - -- :ref:`StringName` **get_tracker_name** **(** **)** |const| - -Returns the controller or anchor point's name, if applicable. - ----- - -.. _class_XRPositionalTracker_method_get_tracker_type: - -- :ref:`TrackerType` **get_tracker_type** **(** **)** |const| - -Returns the tracker's type, which will be one of the values from the :ref:`TrackerType` enum. - ----- - -.. _class_XRPositionalTracker_method_get_transform: - -- :ref:`Transform3D` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** |const| - -Returns the transform combining this device's orientation and position. - ----- - -.. _class_XRPositionalTracker_method_is_tracking_orientation: - -- :ref:`bool` **is_tracking_orientation** **(** **)** |const| - -Returns ``true`` if this device is tracking orientation. - ----- - -.. _class_XRPositionalTracker_method_is_tracking_position: - -- :ref:`bool` **is_tracking_position** **(** **)** |const| - -Returns ``true`` if this device is tracking position. +Sets the transform, linear velocity and angular velocity for the given pose. This method is called by a :ref:`XRInterface` implementation and should not be used directly. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_xrserver.rst b/classes/class_xrserver.rst index c77c0447a..bc0482ca3 100644 --- a/classes/class_xrserver.rst +++ b/classes/class_xrserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the XRServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -60,9 +60,9 @@ Methods +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_reference_frame` **(** **)** |const| | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`XRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** |const| | +| :ref:`XRPositionalTracker` | :ref:`get_tracker` **(** :ref:`StringName` tracker_name **)** |const| | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracker_count` **(** **)** |const| | +| :ref:`Dictionary` | :ref:`get_trackers` **(** :ref:`int` tracker_types **)** | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_interface` **(** :ref:`XRInterface` interface **)** | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,7 +90,7 @@ Emitted when an interface is removed. .. _class_XRServer_signal_tracker_added: -- **tracker_added** **(** :ref:`StringName` tracker_name, :ref:`int` type, :ref:`int` id **)** +- **tracker_added** **(** :ref:`StringName` tracker_name, :ref:`int` type **)** Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using :ref:`XRAnchor3D`\ s for an AR solution, it is important to react to this signal to add the appropriate :ref:`XRController3D` or :ref:`XRAnchor3D` nodes related to this new tracker. @@ -98,15 +98,25 @@ Emitted when a new tracker has been added. If you don't use a fixed number of co .. _class_XRServer_signal_tracker_removed: -- **tracker_removed** **(** :ref:`StringName` tracker_name, :ref:`int` type, :ref:`int` id **)** +- **tracker_removed** **(** :ref:`StringName` tracker_name, :ref:`int` type **)** Emitted when a tracker is removed. You should remove any :ref:`XRController3D` or :ref:`XRAnchor3D` points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). +---- + +.. _class_XRServer_signal_tracker_updated: + +- **tracker_updated** **(** :ref:`StringName` tracker_name, :ref:`int` type **)** + +Emitted when an existing tracker has been updated. This can happen if the user switches controllers. + Enumerations ------------ .. _enum_XRServer_TrackerType: +.. _class_XRServer_constant_TRACKER_HEAD: + .. _class_XRServer_constant_TRACKER_CONTROLLER: .. _class_XRServer_constant_TRACKER_BASESTATION: @@ -121,11 +131,13 @@ Enumerations enum **TrackerType**: -- **TRACKER_CONTROLLER** = **1** --- The tracker tracks the location of a controller. +- **TRACKER_HEAD** = **1** --- The tracker tracks the location of the players head. This is usually a location centered between the players eyes. Note that for handheld AR devices this can be the current location of the device. -- **TRACKER_BASESTATION** = **2** --- The tracker tracks the location of a base station. +- **TRACKER_CONTROLLER** = **2** --- The tracker tracks the location of a controller. -- **TRACKER_ANCHOR** = **4** --- The tracker tracks the location and size of an AR anchor. +- **TRACKER_BASESTATION** = **4** --- The tracker tracks the location of a base station. + +- **TRACKER_ANCHOR** = **8** --- The tracker tracks the location and size of an AR anchor. - **TRACKER_ANY_KNOWN** = **127** --- Used internally to filter trackers of any known type. @@ -287,23 +299,23 @@ Returns the absolute timestamp (in μs) of the last ``XRServer`` process callbac - :ref:`Transform3D` **get_reference_frame** **(** **)** |const| -Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces. +Returns the reference frame transform. Mostly used internally and exposed for GDExtension build interfaces. ---- .. _class_XRServer_method_get_tracker: -- :ref:`XRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** |const| +- :ref:`XRPositionalTracker` **get_tracker** **(** :ref:`StringName` tracker_name **)** |const| -Returns the positional tracker at the given ID. +Returns the positional tracker with this name. ---- -.. _class_XRServer_method_get_tracker_count: +.. _class_XRServer_method_get_trackers: -- :ref:`int` **get_tracker_count** **(** **)** |const| +- :ref:`Dictionary` **get_trackers** **(** :ref:`int` tracker_types **)** -Returns the number of trackers currently registered. +Returns a dictionary of trackers for this type. ----