From e3b062b7cb2fa4e9bdb11d22c0f990294b84a40a Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 1 Jun 2024 03:28:57 +0000 Subject: [PATCH] classref: Sync with current master branch (705b7a0) --- classes/class_@gdscript.rst | 104 +- classes/class_@globalscope.rst | 360 ++-- classes/class_aabb.rst | 64 +- classes/class_acceptdialog.rst | 36 +- classes/class_aescontext.rst | 10 +- classes/class_animatablebody2d.rst | 2 +- classes/class_animatablebody3d.rst | 2 +- classes/class_animatedsprite2d.rst | 44 +- classes/class_animatedsprite3d.rst | 36 +- classes/class_animatedtexture.rst | 20 +- classes/class_animation.rst | 154 +- classes/class_animationlibrary.rst | 20 +- classes/class_animationmixer.rst | 90 +- classes/class_animationnode.rst | 52 +- classes/class_animationnodeanimation.rst | 16 +- classes/class_animationnodeblendspace1d.rst | 28 +- classes/class_animationnodeblendspace2d.rst | 42 +- classes/class_animationnodeblendtree.rst | 34 +- classes/class_animationnodeoneshot.rst | 22 +- classes/class_animationnodestatemachine.rst | 46 +- ...lass_animationnodestatemachineplayback.rst | 20 +- ...ss_animationnodestatemachinetransition.rst | 24 +- classes/class_animationnodesync.rst | 2 +- classes/class_animationnodetransition.rst | 20 +- classes/class_animationplayer.rst | 74 +- classes/class_animationtree.rst | 14 +- classes/class_area2d.rst | 60 +- classes/class_area3d.rst | 74 +- classes/class_array.rst | 110 +- classes/class_arraymesh.rst | 44 +- classes/class_arrayoccluder3d.rst | 6 +- classes/class_aspectratiocontainer.rst | 12 +- classes/class_astar2d.rst | 50 +- classes/class_astar3d.rst | 50 +- classes/class_astargrid2d.rst | 56 +- classes/class_atlastexture.rst | 8 +- classes/class_audioeffect.rst | 2 +- classes/class_audioeffectamplify.rst | 2 +- classes/class_audioeffectcapture.rst | 16 +- classes/class_audioeffectchorus.rst | 78 +- classes/class_audioeffectcompressor.rst | 14 +- classes/class_audioeffectdelay.rst | 26 +- classes/class_audioeffectdistortion.rst | 12 +- classes/class_audioeffecteq.rst | 6 +- classes/class_audioeffectfilter.rst | 10 +- classes/class_audioeffecthardlimiter.rst | 6 +- classes/class_audioeffectinstance.rst | 4 +- classes/class_audioeffectlimiter.rst | 8 +- classes/class_audioeffectpanner.rst | 2 +- classes/class_audioeffectphaser.rst | 10 +- classes/class_audioeffectpitchshift.rst | 8 +- classes/class_audioeffectrecord.rst | 8 +- classes/class_audioeffectreverb.rst | 16 +- classes/class_audioeffectspectrumanalyzer.rst | 8 +- ...ss_audioeffectspectrumanalyzerinstance.rst | 4 +- classes/class_audioeffectstereoenhance.rst | 6 +- classes/class_audiolistener2d.rst | 6 +- classes/class_audiolistener3d.rst | 8 +- classes/class_audioserver.rst | 92 +- classes/class_audiostream.rst | 22 +- classes/class_audiostreamgenerator.rst | 4 +- .../class_audiostreamgeneratorplayback.rst | 12 +- classes/class_audiostreaminteractive.rst | 52 +- classes/class_audiostreammp3.rst | 12 +- classes/class_audiostreamoggvorbis.rst | 16 +- classes/class_audiostreamplayback.rst | 20 +- .../class_audiostreamplaybackinteractive.rst | 4 +- .../class_audiostreamplaybackpolyphonic.rst | 12 +- .../class_audiostreamplaybackresampled.rst | 6 +- classes/class_audiostreamplayer.rst | 34 +- classes/class_audiostreamplayer2d.rst | 38 +- classes/class_audiostreamplayer3d.rst | 58 +- classes/class_audiostreamplaylist.rst | 16 +- classes/class_audiostreampolyphonic.rst | 2 +- classes/class_audiostreamrandomizer.rst | 24 +- classes/class_audiostreamsynchronized.rst | 12 +- classes/class_audiostreamwav.rst | 20 +- classes/class_backbuffercopy.rst | 6 +- classes/class_basebutton.rst | 42 +- classes/class_basematerial3d.rst | 280 +-- classes/class_basis.rst | 72 +- classes/class_bitmap.rst | 26 +- classes/class_bone2d.rst | 20 +- classes/class_boneattachment3d.rst | 16 +- classes/class_bonemap.rst | 12 +- classes/class_bool.rst | 10 +- classes/class_boxcontainer.rst | 10 +- classes/class_boxmesh.rst | 8 +- classes/class_boxoccluder3d.rst | 2 +- classes/class_boxshape3d.rst | 2 +- classes/class_button.rst | 86 +- classes/class_buttongroup.rst | 8 +- classes/class_callable.rst | 46 +- classes/class_callbacktweener.rst | 2 +- classes/class_camera2d.rst | 80 +- classes/class_camera3d.rst | 74 +- classes/class_cameraattributes.rst | 10 +- classes/class_cameraattributesphysical.rst | 18 +- classes/class_cameraattributespractical.rst | 18 +- classes/class_camerafeed.rst | 16 +- classes/class_cameraserver.rst | 16 +- classes/class_cameratexture.rst | 6 +- classes/class_canvasgroup.rst | 6 +- classes/class_canvasitem.rst | 174 +- classes/class_canvasitemmaterial.rst | 16 +- classes/class_canvaslayer.rst | 28 +- classes/class_canvasmodulate.rst | 2 +- classes/class_canvastexture.rst | 14 +- classes/class_capsulemesh.rst | 8 +- classes/class_capsuleshape2d.rst | 4 +- classes/class_capsuleshape3d.rst | 4 +- classes/class_centercontainer.rst | 2 +- classes/class_characterbody2d.rst | 70 +- classes/class_characterbody3d.rst | 72 +- classes/class_charfxtransform.rst | 26 +- classes/class_checkbox.rst | 18 +- classes/class_checkbutton.rst | 18 +- classes/class_circleshape2d.rst | 2 +- classes/class_classdb.rst | 52 +- classes/class_codeedit.rst | 246 +-- classes/class_codehighlighter.rst | 42 +- classes/class_collisionobject2d.rst | 80 +- classes/class_collisionobject3d.rst | 66 +- classes/class_collisionpolygon2d.rst | 12 +- classes/class_collisionpolygon3d.rst | 8 +- classes/class_collisionshape2d.rst | 10 +- classes/class_collisionshape3d.rst | 8 +- classes/class_color.rst | 392 ++-- classes/class_colorpicker.rst | 84 +- classes/class_colorpickerbutton.rst | 16 +- classes/class_colorrect.rst | 2 +- classes/class_compositor.rst | 2 +- classes/class_compositoreffect.rst | 18 +- classes/class_compressedtexture2d.rst | 4 +- classes/class_compressedtexture3d.rst | 4 +- classes/class_compressedtexturelayered.rst | 4 +- classes/class_concavepolygonshape2d.rst | 2 +- classes/class_concavepolygonshape3d.rst | 6 +- classes/class_conetwistjoint3d.rst | 16 +- classes/class_configfile.rst | 34 +- classes/class_confirmationdialog.rst | 8 +- classes/class_container.rst | 16 +- classes/class_control.rst | 310 ++-- classes/class_convexpolygonshape2d.rst | 4 +- classes/class_convexpolygonshape3d.rst | 2 +- classes/class_cpuparticles2d.rst | 160 +- classes/class_cpuparticles3d.rst | 178 +- classes/class_crypto.rst | 18 +- classes/class_cryptokey.rst | 10 +- classes/class_csgbox3d.rst | 4 +- classes/class_csgcylinder3d.rst | 12 +- classes/class_csgmesh3d.rst | 4 +- classes/class_csgpolygon3d.rst | 38 +- classes/class_csgprimitive3d.rst | 2 +- classes/class_csgshape3d.rst | 28 +- classes/class_csgsphere3d.rst | 10 +- classes/class_csgtorus3d.rst | 12 +- classes/class_csharpscript.rst | 4 +- classes/class_cubemap.rst | 2 +- classes/class_cubemaparray.rst | 2 +- classes/class_curve.rst | 48 +- classes/class_curve2d.rst | 42 +- classes/class_curve3d.rst | 54 +- classes/class_curvetexture.rst | 8 +- classes/class_curvexyztexture.rst | 8 +- classes/class_cylindermesh.rst | 14 +- classes/class_cylindershape3d.rst | 4 +- classes/class_dampedspringjoint2d.rst | 8 +- classes/class_decal.rst | 36 +- classes/class_dictionary.rst | 42 +- classes/class_diraccess.rst | 70 +- classes/class_directionallight2d.rst | 4 +- classes/class_directionallight3d.rst | 22 +- classes/class_displayserver.rst | 422 ++--- classes/class_dtlsserver.rst | 4 +- classes/class_editorcommandpalette.rst | 4 +- classes/class_editordebuggerplugin.rst | 10 +- classes/class_editordebuggersession.rst | 22 +- classes/class_editorexportplatform.rst | 2 +- classes/class_editorexportplatformandroid.rst | 386 ++-- classes/class_editorexportplatformios.rst | 392 ++-- .../class_editorexportplatformlinuxbsd.rst | 28 +- classes/class_editorexportplatformmacos.rst | 466 ++--- classes/class_editorexportplatformweb.rst | 42 +- classes/class_editorexportplatformwindows.rst | 74 +- classes/class_editorexportplugin.rst | 72 +- classes/class_editorfeatureprofile.rst | 24 +- classes/class_editorfiledialog.rst | 62 +- classes/class_editorfilesystem.rst | 28 +- classes/class_editorfilesystemdirectory.rst | 28 +- ...itorfilesystemimportformatsupportquery.rst | 6 +- classes/class_editorimportplugin.rst | 28 +- classes/class_editorinspector.rst | 24 +- classes/class_editorinspectorplugin.rst | 24 +- classes/class_editorinterface.rst | 106 +- classes/class_editornode3dgizmo.rst | 50 +- classes/class_editornode3dgizmoplugin.rst | 46 +- classes/class_editorpaths.rst | 12 +- classes/class_editorplugin.rst | 156 +- classes/class_editorproperty.rst | 52 +- .../class_editorresourceconversionplugin.rst | 6 +- classes/class_editorresourcepicker.rst | 20 +- classes/class_editorresourcepreview.rst | 12 +- .../class_editorresourcepreviewgenerator.rst | 10 +- classes/class_editorresourcetooltipplugin.rst | 6 +- classes/class_editorsceneformatimporter.rst | 24 +- ...lass_editorsceneformatimporterfbx2gltf.rst | 2 +- classes/class_editorscenepostimport.rst | 4 +- classes/class_editorscenepostimportplugin.rst | 24 +- classes/class_editorscript.rst | 8 +- classes/class_editorscriptpicker.rst | 2 +- classes/class_editorselection.rst | 12 +- classes/class_editorsettings.rst | 708 ++++---- classes/class_editorspinslider.rst | 18 +- classes/class_editorsyntaxhighlighter.rst | 4 +- .../class_editortranslationparserplugin.rst | 4 +- classes/class_editorundoredomanager.rst | 28 +- classes/class_editorvcsinterface.rst | 66 +- classes/class_encodedobjectasid.rst | 2 +- classes/class_enetconnection.rst | 42 +- classes/class_enetmultiplayerpeer.rst | 14 +- classes/class_enetpacketpeer.rst | 44 +- classes/class_engine.rst | 62 +- classes/class_enginedebugger.rst | 22 +- classes/class_engineprofiler.rst | 6 +- classes/class_environment.rst | 214 +-- classes/class_expression.rst | 8 +- classes/class_fastnoiselite.rst | 54 +- classes/class_fbxstate.rst | 2 +- classes/class_fileaccess.rst | 122 +- classes/class_filedialog.rst | 82 +- classes/class_filesystemdock.rst | 24 +- classes/class_float.rst | 66 +- classes/class_flowcontainer.rst | 18 +- classes/class_fogmaterial.rst | 12 +- classes/class_fogvolume.rst | 6 +- classes/class_font.rst | 66 +- classes/class_fontfile.rst | 174 +- classes/class_fontvariation.rst | 24 +- classes/class_framebuffercacherd.rst | 2 +- classes/class_gdextension.rst | 6 +- classes/class_gdextensionmanager.rst | 16 +- classes/class_gdscript.rst | 2 +- classes/class_generic6dofjoint3d.rst | 196 +- classes/class_geometry2d.rst | 54 +- classes/class_geometry3d.rst | 30 +- classes/class_geometryinstance3d.rst | 42 +- classes/class_gltfaccessor.rst | 99 +- classes/class_gltfanimation.rst | 8 +- classes/class_gltfbufferview.rst | 14 +- classes/class_gltfcamera.rst | 18 +- classes/class_gltfdocument.rst | 26 +- classes/class_gltfdocumentextension.rst | 38 +- classes/class_gltflight.rst | 24 +- classes/class_gltfmesh.rst | 12 +- classes/class_gltfnode.rst | 30 +- classes/class_gltfphysicsbody.rst | 24 +- classes/class_gltfphysicsshape.rst | 26 +- classes/class_gltfskeleton.rst | 18 +- classes/class_gltfskin.rst | 26 +- classes/class_gltfspecgloss.rst | 10 +- classes/class_gltfstate.rst | 133 +- classes/class_gltftexture.rst | 4 +- classes/class_gltftexturesampler.rst | 8 +- classes/class_godotsharp.rst | 62 - classes/class_gpuparticles2d.rst | 62 +- classes/class_gpuparticles3d.rst | 78 +- classes/class_gpuparticlesattractor3d.rst | 8 +- classes/class_gpuparticlesattractorbox3d.rst | 2 +- .../class_gpuparticlesattractorsphere3d.rst | 2 +- ...ass_gpuparticlesattractorvectorfield3d.rst | 4 +- classes/class_gpuparticlescollision3d.rst | 2 +- classes/class_gpuparticlescollisionbox3d.rst | 2 +- ...ass_gpuparticlescollisionheightfield3d.rst | 12 +- classes/class_gpuparticlescollisionsdf3d.rst | 16 +- .../class_gpuparticlescollisionsphere3d.rst | 2 +- classes/class_gradient.rst | 30 +- classes/class_gradienttexture1d.rst | 6 +- classes/class_gradienttexture2d.rst | 20 +- classes/class_graphedit.rst | 180 +- classes/class_graphelement.rst | 28 +- classes/class_graphframe.rst | 26 +- classes/class_graphnode.rst | 90 +- classes/class_gridcontainer.rst | 6 +- classes/class_gridmap.rst | 76 +- classes/class_groovejoint2d.rst | 4 +- classes/class_hashingcontext.rst | 8 +- classes/class_heightmapshape3d.rst | 12 +- classes/class_hingejoint3d.rst | 32 +- classes/class_hmaccontext.rst | 6 +- classes/class_httpclient.rst | 44 +- classes/class_httprequest.rst | 36 +- classes/class_image.rst | 158 +- classes/class_imageformatloader.rst | 2 +- classes/class_imageformatloaderextension.rst | 8 +- classes/class_imagetexture.rst | 10 +- classes/class_imagetexture3d.rst | 4 +- classes/class_imagetexturelayered.rst | 4 +- classes/class_immediatemesh.rst | 20 +- classes/class_importermesh.rst | 48 +- classes/class_importermeshinstance3d.rst | 20 +- classes/class_input.rst | 106 +- classes/class_inputevent.rst | 30 +- classes/class_inputeventaction.rst | 39 +- classes/class_inputeventfromwindow.rst | 2 +- classes/class_inputeventgesture.rst | 2 +- classes/class_inputeventjoypadbutton.rst | 6 +- classes/class_inputeventjoypadmotion.rst | 4 +- classes/class_inputeventkey.rst | 28 +- classes/class_inputeventmagnifygesture.rst | 2 +- classes/class_inputeventmidi.rst | 16 +- classes/class_inputeventmouse.rst | 6 +- classes/class_inputeventmousebutton.rst | 10 +- classes/class_inputeventmousemotion.rst | 14 +- classes/class_inputeventpangesture.rst | 2 +- classes/class_inputeventscreendrag.rst | 18 +- classes/class_inputeventscreentouch.rst | 10 +- classes/class_inputeventshortcut.rst | 2 +- classes/class_inputeventwithmodifiers.rst | 14 +- classes/class_inputmap.rst | 26 +- classes/class_instanceplaceholder.rst | 6 +- classes/class_int.rst | 80 +- classes/class_ip.rst | 28 +- classes/class_itemlist.rst | 170 +- classes/class_javaclasswrapper.rst | 2 +- classes/class_javascriptbridge.rst | 18 +- classes/class_joint2d.rst | 20 +- classes/class_joint3d.rst | 24 +- classes/class_json.rst | 14 +- classes/class_jsonrpc.rst | 16 +- classes/class_kinematiccollision2d.rst | 26 +- classes/class_kinematiccollision3d.rst | 28 +- classes/class_label.rst | 72 +- classes/class_label3d.rst | 74 +- classes/class_labelsettings.rst | 18 +- classes/class_light2d.rst | 38 +- classes/class_light3d.rst | 64 +- classes/class_lightmapgi.rst | 46 +- classes/class_lightmapgidata.rst | 16 +- classes/class_lightoccluder2d.rst | 6 +- classes/class_line2d.rst | 46 +- classes/class_lineedit.rst | 136 +- classes/class_linkbutton.rst | 40 +- classes/class_mainloop.rst | 30 +- classes/class_margincontainer.rst | 8 +- classes/class_marker2d.rst | 2 +- classes/class_marker3d.rst | 2 +- classes/class_marshalls.rst | 12 +- classes/class_material.rst | 22 +- classes/class_menubar.rst | 78 +- classes/class_menubutton.rst | 12 +- classes/class_mesh.rst | 66 +- .../class_meshconvexdecompositionsettings.rst | 28 +- classes/class_meshdatatool.rst | 76 +- classes/class_meshinstance2d.rst | 6 +- classes/class_meshinstance3d.rst | 34 +- classes/class_meshlibrary.rst | 46 +- classes/class_meshtexture.rst | 6 +- classes/class_methodtweener.rst | 6 +- classes/class_missingnode.rst | 6 +- classes/class_missingresource.rst | 4 +- classes/class_mobilevrinterface.rst | 20 +- classes/class_moviewriter.rst | 14 +- classes/class_multimesh.rst | 44 +- classes/class_multimeshinstance2d.rst | 6 +- classes/class_multimeshinstance3d.rst | 2 +- classes/class_multiplayerapi.rst | 38 +- classes/class_multiplayerapiextension.rst | 18 +- classes/class_multiplayerpeer.rst | 40 +- classes/class_multiplayerpeerextension.rst | 46 +- classes/class_multiplayerspawner.rst | 20 +- classes/class_multiplayersynchronizer.rst | 30 +- classes/class_mutex.rst | 6 +- classes/class_nativemenu.rst | 134 +- classes/class_navigationagent2d.rst | 104 +- classes/class_navigationagent3d.rst | 110 +- classes/class_navigationlink2d.rst | 28 +- classes/class_navigationlink3d.rst | 28 +- classes/class_navigationmesh.rst | 74 +- classes/class_navigationmeshgenerator.rst | 8 +- ...ass_navigationmeshsourcegeometrydata2d.rst | 30 +- ...ass_navigationmeshsourcegeometrydata3d.rst | 30 +- classes/class_navigationobstacle2d.rst | 24 +- classes/class_navigationobstacle3d.rst | 28 +- .../class_navigationpathqueryparameters2d.rst | 24 +- .../class_navigationpathqueryparameters3d.rst | 24 +- classes/class_navigationpathqueryresult2d.rst | 12 +- classes/class_navigationpathqueryresult3d.rst | 12 +- classes/class_navigationpolygon.rst | 58 +- classes/class_navigationregion2d.rst | 32 +- classes/class_navigationregion3d.rst | 32 +- classes/class_navigationserver2d.rst | 254 +-- classes/class_navigationserver3d.rst | 296 +-- classes/class_ninepatchrect.rst | 26 +- classes/class_node.rst | 346 ++-- classes/class_node2d.rst | 46 +- classes/class_node3d.rst | 120 +- classes/class_nodepath.rst | 28 +- classes/class_noise.rst | 18 +- classes/class_noisetexture2d.rst | 24 +- classes/class_noisetexture3d.rst | 18 +- classes/class_object.rst | 126 +- classes/class_occluder3d.rst | 4 +- classes/class_occluderinstance3d.rst | 10 +- classes/class_occluderpolygon2d.rst | 8 +- classes/class_oggpacketsequence.rst | 8 +- classes/class_omnilight3d.rst | 8 +- classes/class_openxraction.rst | 8 +- classes/class_openxractionmap.rst | 26 +- classes/class_openxractionset.rst | 12 +- classes/class_openxrapiextension.rst | 42 +- classes/class_openxrcompositionlayer.rst | 12 +- .../class_openxrcompositionlayercylinder.rst | 8 +- .../class_openxrcompositionlayerequirect.rst | 10 +- classes/class_openxrcompositionlayerquad.rst | 2 +- .../class_openxrextensionwrapperextension.rst | 80 +- classes/class_openxrhand.rst | 18 +- classes/class_openxrinteractionprofile.rst | 8 +- ...class_openxrinteractionprofilemetadata.rst | 8 +- classes/class_openxrinterface.rst | 72 +- classes/class_openxripbinding.rst | 12 +- classes/class_optimizedtranslation.rst | 2 +- classes/class_optionbutton.rst | 72 +- classes/class_os.rst | 142 +- classes/class_packedbytearray.rst | 128 +- classes/class_packedcolorarray.rst | 52 +- classes/class_packeddatacontainer.rst | 4 +- classes/class_packeddatacontainerref.rst | 2 +- classes/class_packedfloat32array.rst | 52 +- classes/class_packedfloat64array.rst | 52 +- classes/class_packedint32array.rst | 52 +- classes/class_packedint64array.rst | 52 +- classes/class_packedscene.rst | 12 +- classes/class_packedstringarray.rst | 52 +- classes/class_packedvector2array.rst | 54 +- classes/class_packedvector3array.rst | 54 +- classes/class_packedvector4array.rst | 52 +- classes/class_packetpeer.rst | 14 +- classes/class_packetpeerdtls.rst | 10 +- classes/class_packetpeerextension.rst | 8 +- classes/class_packetpeerstream.rst | 6 +- classes/class_packetpeerudp.rst | 26 +- classes/class_panel.rst | 2 +- classes/class_panelcontainer.rst | 2 +- classes/class_panoramaskymaterial.rst | 6 +- classes/class_parallax2d.rst | 20 +- classes/class_parallaxbackground.rst | 12 +- classes/class_parallaxlayer.rst | 6 +- classes/class_particleprocessmaterial.rst | 218 +-- classes/class_path2d.rst | 2 +- classes/class_path3d.rst | 4 +- classes/class_pathfollow2d.rst | 14 +- classes/class_pathfollow3d.rst | 22 +- classes/class_pckpacker.rst | 6 +- classes/class_performance.rst | 16 +- classes/class_physicalbone2d.rst | 14 +- classes/class_physicalbone3d.rst | 48 +- classes/class_physicalbonesimulator3d.rst | 10 +- classes/class_physicalskymaterial.rst | 22 +- classes/class_physicsbody2d.rst | 12 +- classes/class_physicsbody3d.rst | 28 +- classes/class_physicsdirectbodystate2d.rst | 80 +- ...lass_physicsdirectbodystate2dextension.rst | 88 +- classes/class_physicsdirectbodystate3d.rst | 84 +- ...lass_physicsdirectbodystate3dextension.rst | 92 +- classes/class_physicsdirectspacestate2d.rst | 12 +- ...ass_physicsdirectspacestate2dextension.rst | 14 +- classes/class_physicsdirectspacestate3d.rst | 12 +- ...ass_physicsdirectspacestate3dextension.rst | 16 +- classes/class_physicsmaterial.rst | 10 +- .../class_physicspointqueryparameters2d.rst | 12 +- .../class_physicspointqueryparameters3d.rst | 10 +- classes/class_physicsrayqueryparameters2d.rst | 16 +- classes/class_physicsrayqueryparameters3d.rst | 18 +- classes/class_physicsserver2d.rst | 268 +-- classes/class_physicsserver2dextension.rst | 280 +-- classes/class_physicsserver2dmanager.rst | 4 +- classes/class_physicsserver3d.rst | 402 ++-- classes/class_physicsserver3dextension.rst | 380 ++-- classes/class_physicsserver3dmanager.rst | 4 +- ..._physicsserver3drenderingserverhandler.rst | 12 +- .../class_physicsshapequeryparameters2d.rst | 18 +- .../class_physicsshapequeryparameters3d.rst | 18 +- .../class_physicstestmotionparameters2d.rst | 14 +- .../class_physicstestmotionparameters3d.rst | 16 +- classes/class_physicstestmotionresult2d.rst | 26 +- classes/class_physicstestmotionresult3d.rst | 28 +- classes/class_pinjoint2d.rst | 12 +- classes/class_pinjoint3d.rst | 12 +- classes/class_placeholdermesh.rst | 2 +- classes/class_placeholdertexture2d.rst | 2 +- classes/class_placeholdertexture3d.rst | 2 +- classes/class_placeholdertexturelayered.rst | 4 +- classes/class_plane.rst | 50 +- classes/class_planemesh.rst | 12 +- classes/class_pointlight2d.rst | 8 +- classes/class_polygon2d.rst | 48 +- classes/class_polygonoccluder3d.rst | 2 +- classes/class_polygonpathfinder.rst | 16 +- classes/class_popup.rst | 2 +- classes/class_popupmenu.rst | 232 +-- classes/class_popuppanel.rst | 2 +- classes/class_portablecompressedtexture2d.rst | 18 +- classes/class_primitivemesh.rst | 16 +- classes/class_prismmesh.rst | 10 +- classes/class_proceduralskymaterial.rst | 28 +- classes/class_progressbar.rst | 24 +- classes/class_projection.rst | 88 +- classes/class_projectsettings.rst | 1618 +++++++++-------- classes/class_propertytweener.rst | 14 +- classes/class_quadoccluder3d.rst | 2 +- classes/class_quaternion.rst | 76 +- classes/class_randomnumbergenerator.rst | 18 +- classes/class_range.rst | 32 +- classes/class_raycast2d.rst | 42 +- classes/class_raycast3d.rst | 50 +- classes/class_rdattachmentformat.rst | 6 +- classes/class_rdframebufferpass.rst | 12 +- classes/class_rdpipelinecolorblendstate.rst | 8 +- ...ss_rdpipelinecolorblendstateattachment.rst | 24 +- classes/class_rdpipelinedepthstencilstate.rst | 42 +- classes/class_rdpipelinemultisamplestate.rst | 12 +- .../class_rdpipelinerasterizationstate.rst | 22 +- ...class_rdpipelinespecializationconstant.rst | 4 +- classes/class_rdsamplerstate.rst | 30 +- classes/class_rdshaderfile.rst | 8 +- classes/class_rdshadersource.rst | 16 +- classes/class_rdshaderspirv.rst | 28 +- classes/class_rdtextureformat.rst | 22 +- classes/class_rdtextureview.rst | 10 +- classes/class_rduniform.rst | 10 +- classes/class_rdvertexattribute.rst | 10 +- classes/class_rect2.rst | 44 +- classes/class_rect2i.rst | 38 +- classes/class_rectangleshape2d.rst | 2 +- classes/class_refcounted.rst | 8 +- classes/class_referencerect.rst | 6 +- classes/class_reflectionprobe.rst | 32 +- classes/class_regex.rst | 20 +- classes/class_regexmatch.rst | 14 +- classes/class_remotetransform2d.rst | 12 +- classes/class_remotetransform3d.rst | 12 +- classes/class_renderdata.rst | 8 +- classes/class_renderdataextension.rst | 8 +- classes/class_renderingdevice.rst | 264 +-- classes/class_renderingserver.rst | 1184 ++++++------ classes/class_renderscenebuffers.rst | 2 +- .../class_renderscenebuffersconfiguration.rst | 18 +- classes/class_renderscenebuffersextension.rst | 8 +- classes/class_renderscenebuffersrd.rst | 42 +- classes/class_renderscenedata.rst | 12 +- classes/class_renderscenedataextension.rst | 12 +- classes/class_resource.rst | 30 +- classes/class_resourceformatloader.rst | 24 +- classes/class_resourceformatsaver.rst | 10 +- classes/class_resourceimporter.rst | 2 +- classes/class_resourceimporterbitmap.rst | 4 +- classes/class_resourceimporterbmfont.rst | 6 +- .../class_resourceimportercsvtranslation.rst | 4 +- classes/class_resourceimporterdynamicfont.rst | 34 +- classes/class_resourceimporterimagefont.rst | 22 +- .../class_resourceimporterlayeredtexture.rst | 16 +- classes/class_resourceimportermp3.rst | 10 +- classes/class_resourceimporterobj.rst | 10 +- classes/class_resourceimporteroggvorbis.rst | 14 +- classes/class_resourceimporterscene.rst | 38 +- classes/class_resourceimportertexture.rst | 40 +- .../class_resourceimportertextureatlas.rst | 8 +- classes/class_resourceimporterwav.rst | 20 +- classes/class_resourceloader.rst | 28 +- classes/class_resourcepreloader.rst | 12 +- classes/class_resourcesaver.rst | 10 +- classes/class_resourceuid.rst | 18 +- classes/class_ribbontrailmesh.rst | 14 +- classes/class_richtexteffect.rst | 2 +- classes/class_richtextlabel.rst | 264 +-- classes/class_rid.rst | 18 +- classes/class_rigidbody2d.rst | 90 +- classes/class_rigidbody3d.rst | 90 +- classes/class_rootmotionview.rst | 10 +- classes/class_scenemultiplayer.rst | 34 +- classes/class_scenereplicationconfig.rst | 28 +- classes/class_scenestate.rst | 44 +- classes/class_scenetree.rst | 86 +- classes/class_scenetreetimer.rst | 4 +- classes/class_script.rst | 32 +- classes/class_scriptcreatedialog.rst | 4 +- classes/class_scripteditor.rst | 22 +- classes/class_scripteditorbase.rst | 24 +- classes/class_scriptextension.rst | 72 +- classes/class_scriptlanguage.rst | 2 +- classes/class_scriptlanguageextension.rst | 122 +- classes/class_scrollbar.rst | 26 +- classes/class_scrollcontainer.rst | 30 +- classes/class_segmentshape2d.rst | 4 +- classes/class_semaphore.rst | 6 +- classes/class_separationrayshape2d.rst | 4 +- classes/class_separationrayshape3d.rst | 4 +- classes/class_separator.rst | 4 +- classes/class_shader.rst | 12 +- classes/class_shaderinclude.rst | 2 +- classes/class_shadermaterial.rst | 6 +- classes/class_shape2d.rst | 14 +- classes/class_shape3d.rst | 6 +- classes/class_shapecast2d.rst | 54 +- classes/class_shapecast3d.rst | 58 +- classes/class_shortcut.rst | 8 +- classes/class_signal.rst | 24 +- classes/class_skeleton2d.rst | 18 +- classes/class_skeleton3d.rst | 108 +- classes/class_skeletonik3d.rst | 28 +- classes/class_skeletonmodification2d.rst | 22 +- classes/class_skeletonmodification2dccdik.rst | 34 +- .../class_skeletonmodification2dfabrik.rst | 20 +- .../class_skeletonmodification2djiggle.rst | 54 +- .../class_skeletonmodification2dlookat.rst | 26 +- ...ss_skeletonmodification2dphysicalbones.rst | 12 +- ...lass_skeletonmodification2dstackholder.rst | 4 +- .../class_skeletonmodification2dtwoboneik.rst | 24 +- classes/class_skeletonmodificationstack2d.rst | 24 +- classes/class_skeletonmodifier3d.rst | 8 +- classes/class_skeletonprofile.rst | 54 +- classes/class_skin.rst | 22 +- classes/class_skinreference.rst | 4 +- classes/class_sky.rst | 10 +- classes/class_slider.rst | 30 +- classes/class_sliderjoint3d.rst | 50 +- classes/class_softbody3d.rst | 46 +- classes/class_spheremesh.rst | 10 +- classes/class_sphereoccluder3d.rst | 2 +- classes/class_sphereshape3d.rst | 2 +- classes/class_spinbox.rst | 20 +- classes/class_splitcontainer.rst | 26 +- classes/class_spotlight3d.rst | 8 +- classes/class_springarm3d.rst | 16 +- classes/class_sprite2d.rst | 32 +- classes/class_sprite3d.rst | 18 +- classes/class_spritebase3d.rst | 52 +- classes/class_spriteframes.rst | 34 +- classes/class_staticbody2d.rst | 6 +- classes/class_staticbody3d.rst | 6 +- classes/class_statusindicator.rst | 12 +- classes/class_streampeer.rst | 64 +- classes/class_streampeerbuffer.rst | 14 +- classes/class_streampeerextension.rst | 10 +- classes/class_streampeergzip.rst | 8 +- classes/class_streampeertcp.rst | 20 +- classes/class_streampeertls.rst | 14 +- classes/class_string.rst | 240 +-- classes/class_stringname.rst | 226 +-- classes/class_stylebox.rst | 34 +- classes/class_styleboxflat.rst | 66 +- classes/class_styleboxline.rst | 10 +- classes/class_styleboxtexture.rst | 42 +- classes/class_subviewport.rst | 14 +- classes/class_subviewportcontainer.rst | 6 +- classes/class_surfacetool.rst | 70 +- classes/class_syntaxhighlighter.rst | 14 +- classes/class_systemfont.rst | 30 +- classes/class_tabbar.rst | 156 +- classes/class_tabcontainer.rst | 144 +- classes/class_tcpserver.rst | 12 +- classes/class_textedit.rst | 464 ++--- classes/class_textline.rst | 54 +- classes/class_textmesh.rst | 36 +- classes/class_textparagraph.rst | 88 +- classes/class_textserver.rst | 464 ++--- classes/class_textserverextension.rst | 432 ++--- classes/class_textservermanager.rst | 20 +- classes/class_texture2d.rst | 32 +- classes/class_texture2darray.rst | 2 +- classes/class_texture2drd.rst | 2 +- classes/class_texture3d.rst | 26 +- classes/class_texture3drd.rst | 2 +- classes/class_texturebutton.rst | 22 +- classes/class_texturelayered.rst | 30 +- classes/class_texturelayeredrd.rst | 2 +- classes/class_textureprogressbar.rst | 38 +- classes/class_texturerect.rst | 14 +- classes/class_theme.rst | 132 +- classes/class_themedb.rst | 16 +- classes/class_thread.rst | 14 +- classes/class_tiledata.rst | 74 +- classes/class_tilemap.rst | 114 +- classes/class_tilemaplayer.rst | 80 +- classes/class_tilemappattern.rst | 20 +- classes/class_tileset.rst | 172 +- classes/class_tilesetatlassource.rst | 80 +- .../class_tilesetscenescollectionsource.rst | 22 +- classes/class_tilesetsource.rst | 12 +- classes/class_time.rst | 46 +- classes/class_timer.rst | 22 +- classes/class_tlsoptions.rst | 6 +- classes/class_torusmesh.rst | 8 +- classes/class_touchscreenbutton.rst | 26 +- classes/class_transform2d.rst | 78 +- classes/class_transform3d.rst | 62 +- classes/class_translation.rst | 22 +- classes/class_translationserver.rst | 44 +- classes/class_tree.rst | 264 +-- classes/class_treeitem.rst | 262 ++- classes/class_tubetrailmesh.rst | 16 +- classes/class_tween.rst | 62 +- classes/class_tweener.rst | 2 +- classes/class_udpserver.rst | 16 +- classes/class_undoredo.rst | 48 +- classes/class_uniformsetcacherd.rst | 2 +- classes/class_upnp.rst | 30 +- classes/class_upnpdevice.rst | 22 +- classes/class_vector2.rst | 156 +- classes/class_vector2i.rst | 98 +- classes/class_vector3.rst | 180 +- classes/class_vector3i.rst | 104 +- classes/class_vector4.rst | 124 +- classes/class_vector4i.rst | 96 +- classes/class_vehiclebody3d.rst | 6 +- classes/class_vehiclewheel3d.rst | 36 +- classes/class_videostream.rst | 4 +- classes/class_videostreamplayback.rst | 28 +- classes/class_videostreamplayer.rst | 36 +- classes/class_viewport.rst | 180 +- classes/class_viewporttexture.rst | 2 +- classes/class_visibleonscreenenabler2d.rst | 6 +- classes/class_visibleonscreenenabler3d.rst | 6 +- classes/class_visibleonscreennotifier2d.rst | 8 +- classes/class_visibleonscreennotifier3d.rst | 8 +- classes/class_visualinstance3d.rst | 20 +- classes/class_visualshader.rst | 52 +- classes/class_visualshadernode.rst | 20 +- classes/class_visualshadernodebillboard.rst | 6 +- .../class_visualshadernodebooleanconstant.rst | 2 +- ...class_visualshadernodebooleanparameter.rst | 4 +- classes/class_visualshadernodeclamp.rst | 4 +- .../class_visualshadernodecolorconstant.rst | 2 +- classes/class_visualshadernodecolorfunc.rst | 4 +- classes/class_visualshadernodecolorop.rst | 4 +- .../class_visualshadernodecolorparameter.rst | 4 +- classes/class_visualshadernodecomment.rst | 2 +- classes/class_visualshadernodecompare.rst | 12 +- classes/class_visualshadernodecubemap.rst | 10 +- .../class_visualshadernodecurvetexture.rst | 2 +- .../class_visualshadernodecurvexyztexture.rst | 2 +- classes/class_visualshadernodecustom.rst | 44 +- .../class_visualshadernodederivativefunc.rst | 12 +- classes/class_visualshadernodeexpression.rst | 2 +- .../class_visualshadernodefloatconstant.rst | 2 +- classes/class_visualshadernodefloatfunc.rst | 4 +- classes/class_visualshadernodefloatop.rst | 4 +- .../class_visualshadernodefloatparameter.rst | 14 +- classes/class_visualshadernodeframe.rst | 14 +- classes/class_visualshadernodegroupbase.rst | 42 +- classes/class_visualshadernodeinput.rst | 6 +- classes/class_visualshadernodeintconstant.rst | 2 +- classes/class_visualshadernodeintfunc.rst | 4 +- classes/class_visualshadernodeintop.rst | 4 +- .../class_visualshadernodeintparameter.rst | 14 +- classes/class_visualshadernodeis.rst | 4 +- classes/class_visualshadernodemix.rst | 4 +- classes/class_visualshadernodemultiplyadd.rst | 4 +- classes/class_visualshadernodeparameter.rst | 6 +- .../class_visualshadernodeparameterref.rst | 2 +- ...ss_visualshadernodeparticleaccelerator.rst | 4 +- .../class_visualshadernodeparticleemit.rst | 4 +- .../class_visualshadernodeparticleemitter.rst | 2 +- ...ss_visualshadernodeparticlemeshemitter.rst | 6 +- ...lshadernodeparticlemultiplybyaxisangle.rst | 2 +- ...ass_visualshadernodeparticlerandomness.rst | 4 +- classes/class_visualshadernodereroute.rst | 2 +- .../class_visualshadernoderesizablebase.rst | 2 +- classes/class_visualshadernodesample3d.rst | 4 +- classes/class_visualshadernodesmoothstep.rst | 4 +- classes/class_visualshadernodestep.rst | 4 +- classes/class_visualshadernodeswitch.rst | 4 +- classes/class_visualshadernodetexture.rst | 10 +- .../class_visualshadernodetexture2darray.rst | 2 +- classes/class_visualshadernodetexture3d.rst | 2 +- ...class_visualshadernodetextureparameter.rst | 20 +- ...lass_visualshadernodetransformconstant.rst | 2 +- .../class_visualshadernodetransformfunc.rst | 4 +- classes/class_visualshadernodetransformop.rst | 4 +- ...ass_visualshadernodetransformparameter.rst | 4 +- ...class_visualshadernodetransformvecmult.rst | 4 +- .../class_visualshadernodeuintconstant.rst | 2 +- classes/class_visualshadernodeuintfunc.rst | 4 +- classes/class_visualshadernodeuintop.rst | 4 +- .../class_visualshadernodeuintparameter.rst | 4 +- classes/class_visualshadernodeuvfunc.rst | 4 +- classes/class_visualshadernodevarying.rst | 4 +- .../class_visualshadernodevec2constant.rst | 2 +- .../class_visualshadernodevec2parameter.rst | 4 +- .../class_visualshadernodevec3constant.rst | 2 +- .../class_visualshadernodevec3parameter.rst | 4 +- .../class_visualshadernodevec4constant.rst | 2 +- .../class_visualshadernodevec4parameter.rst | 4 +- classes/class_visualshadernodevectorbase.rst | 4 +- classes/class_visualshadernodevectorfunc.rst | 4 +- classes/class_visualshadernodevectorop.rst | 4 +- classes/class_voxelgi.rst | 14 +- classes/class_voxelgidata.rst | 28 +- classes/class_weakref.rst | 2 +- classes/class_webrtcdatachannel.rst | 30 +- classes/class_webrtcdatachannelextension.rst | 36 +- classes/class_webrtcmultiplayerpeer.rst | 16 +- classes/class_webrtcpeerconnection.rst | 36 +- .../class_webrtcpeerconnectionextension.rst | 22 +- classes/class_websocketmultiplayerpeer.rst | 22 +- classes/class_websocketpeer.rst | 46 +- classes/class_webxrinterface.rst | 56 +- classes/class_window.rst | 282 +-- classes/class_workerthreadpool.rst | 14 +- classes/class_world2d.rst | 8 +- classes/class_world3d.rst | 14 +- classes/class_worldboundaryshape2d.rst | 4 +- classes/class_worldboundaryshape3d.rst | 2 +- classes/class_worldenvironment.rst | 6 +- classes/class_x509certificate.rst | 8 +- classes/class_xmlparser.rst | 36 +- classes/class_xranchor3d.rst | 4 +- classes/class_xrbodymodifier3d.rst | 10 +- classes/class_xrbodytracker.rst | 18 +- classes/class_xrcontroller3d.rst | 20 +- classes/class_xrfacemodifier3d.rst | 4 +- classes/class_xrfacetracker.rst | 8 +- classes/class_xrhandmodifier3d.rst | 6 +- classes/class_xrhandtracker.rst | 30 +- classes/class_xrinterface.rst | 62 +- classes/class_xrinterfaceextension.rst | 72 +- classes/class_xrnode3d.rst | 16 +- classes/class_xrorigin3d.rst | 4 +- classes/class_xrpose.rst | 16 +- classes/class_xrpositionaltracker.rst | 32 +- classes/class_xrserver.rst | 60 +- classes/class_xrtracker.rst | 6 +- classes/class_xrvrs.rst | 6 +- classes/class_zippacker.rst | 12 +- classes/class_zipreader.rst | 10 +- classes/index.rst | 1 - 837 files changed, 17411 insertions(+), 17355 deletions(-) delete mode 100644 classes/class_godotsharp.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index efd80ae5fde..32f3134da71 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -81,7 +81,7 @@ Constants .. rst-class:: classref-constant -**PI** = ``3.14159265358979`` +**PI** = ``3.14159265358979`` :ref:`🔗` Constant that represents how many times the diameter of a circle fits around its perimeter. This is equivalent to ``TAU / 2``, or 180 degrees in rotations. @@ -89,7 +89,7 @@ Constant that represents how many times the diameter of a circle fits around its .. rst-class:: classref-constant -**TAU** = ``6.28318530717959`` +**TAU** = ``6.28318530717959`` :ref:`🔗` The circle constant, the circumference of the unit circle in radians. This is equivalent to ``PI * 2``, or 360 degrees in rotations. @@ -97,7 +97,7 @@ The circle constant, the circumference of the unit circle in radians. This is eq .. rst-class:: classref-constant -**INF** = ``inf`` +**INF** = ``inf`` :ref:`🔗` Positive floating-point infinity. This is the result of floating-point division when the divisor is ``0.0``. For negative infinity, use ``-INF``. Dividing by ``-0.0`` will result in negative infinity if the numerator is positive, so dividing by ``0.0`` is not the same as dividing by ``-0.0`` (despite ``0.0 == -0.0`` returning ``true``). @@ -107,7 +107,7 @@ Positive floating-point infinity. This is the result of floating-point division .. rst-class:: classref-constant -**NAN** = ``nan`` +**NAN** = ``nan`` :ref:`🔗` "Not a Number", an invalid floating-point value. :ref:`NAN` has special properties, including that ``!=`` always returns ``true``, while other comparison operators always return ``false``. This is true even when comparing with itself (``NAN == NAN`` returns ``false`` and ``NAN != NAN`` returns ``true``). It is returned by some invalid operations, such as dividing floating-point ``0.0`` by ``0.0``. @@ -124,7 +124,7 @@ Annotations .. rst-class:: classref-annotation -**@export**\ (\ ) +**@export**\ (\ ) :ref:`🔗` Mark the following property as exported (editable in the Inspector dock and saved to disk). To control the type of the exported property, use the type hint notation. @@ -170,7 +170,7 @@ Mark the following property as exported (editable in the Inspector dock and save .. rst-class:: classref-annotation -**@export_category**\ (\ name\: :ref:`String`\ ) +**@export_category**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Define a new category for the following exported properties. This helps to organize properties in the Inspector dock. @@ -192,7 +192,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_CATEGORY` Export a :ref:`Color`, :ref:`Array`\ \[:ref:`Color`\ \], or :ref:`PackedColorArray` property without allowing its transparency (:ref:`Color.a`) to be edited. @@ -211,14 +211,16 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_COLOR_NO_ALPHA`, hint_string\: :ref:`String`, usage\: |bitfield|\[:ref:`PropertyUsageFlags`\] = 6\ ) +**@export_custom**\ (\ hint\: :ref:`PropertyHint`, hint_string\: :ref:`String`, usage\: |bitfield|\[:ref:`PropertyUsageFlags`\] = 6\ ) :ref:`🔗` -Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the hint along to the editor. +Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the parameters to the editor. :: @export_custom(PROPERTY_HINT_NONE, "suffix:m") var suffix: Vector3 +\ **Note:** Regardless of the ``usage`` value, the :ref:`@GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE` flag is always added, as with any explicitly declared script variable. + .. rst-class:: classref-item-separator ---- @@ -227,7 +229,7 @@ Allows you to set a custom hint, hint string, and usage flags for the exported p .. rst-class:: classref-annotation -**@export_dir**\ (\ ) +**@export_dir**\ (\ ) :ref:`🔗` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], or :ref:`PackedStringArray` property as a path to a directory. The path will be limited to the project folder and its subfolders. See :ref:`@export_global_dir` to allow picking from the entire filesystem. @@ -246,7 +248,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_DIR`, ...\ ) |vararg| +**@export_enum**\ (\ names\: :ref:`String`, ...\ ) |vararg| :ref:`🔗` Export an :ref:`int`, :ref:`String`, :ref:`Array`\ \[:ref:`int`\ \], :ref:`Array`\ \[:ref:`String`\ \], :ref:`PackedByteArray`, :ref:`PackedInt32Array`, :ref:`PackedInt64Array`, or :ref:`PackedStringArray` property as an enumerated list of options (or an array of options). If the property is an :ref:`int`, then the index of the value is stored, in the same order the values are provided. You can add explicit values using a colon. If the property is a :ref:`String`, then the value is stored. @@ -285,7 +287,7 @@ If you want to use named GDScript enums, then use :ref:`@export` = "", ...\ ) |vararg| +**@export_exp_easing**\ (\ hints\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` Export a floating-point property with an easing editor widget. Additional hints can be provided to adjust the behavior of the widget. ``"attenuation"`` flips the curve, which makes it more intuitive for editing attenuation properties. ``"positive_only"`` limits values to only be greater than or equal to zero. @@ -306,7 +308,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_EXP_EASING` = "", ...\ ) |vararg| +**@export_file**\ (\ filter\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], or :ref:`PackedStringArray` property as a path to a file. The path will be limited to the project folder and its subfolders. See :ref:`@export_global_file` to allow picking from the entire filesystem. @@ -328,7 +330,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_FILE`, ...\ ) |vararg| +**@export_flags**\ (\ names\: :ref:`String`, ...\ ) |vararg| :ref:`🔗` Export an integer property as a bit flag field. This allows to store several "checked" or ``true`` values with one property, and comfortably select them from the Inspector dock. @@ -373,7 +375,7 @@ You can also use the annotation on :ref:`Array`\ \[:ref:`int` Export an integer property as a bit flag field for 2D navigation layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/2d_navigation/layer_1`. @@ -392,7 +394,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_2D_NAVIGATION` Export an integer property as a bit flag field for 2D physics layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/2d_physics/layer_1`. @@ -411,7 +413,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_2D_PHYSICS` Export an integer property as a bit flag field for 2D render layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/2d_render/layer_1`. @@ -430,7 +432,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_2D_RENDER` Export an integer property as a bit flag field for 3D navigation layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/3d_navigation/layer_1`. @@ -449,7 +451,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_3D_NAVIGATION` Export an integer property as a bit flag field for 3D physics layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/3d_physics/layer_1`. @@ -468,7 +470,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_3D_PHYSICS` Export an integer property as a bit flag field for 3D render layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/3d_render/layer_1`. @@ -487,7 +489,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_3D_RENDER` Export an integer property as a bit flag field for navigation avoidance layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/avoidance/layer_1`. @@ -506,7 +508,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_AVOIDANCE` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], or :ref:`PackedStringArray` property as an absolute path to a directory. The path can be picked from the entire filesystem. See :ref:`@export_dir` to limit it to the project folder and its subfolders. @@ -525,7 +527,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_GLOBAL_DIR` = "", ...\ ) |vararg| +**@export_global_file**\ (\ filter\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], or :ref:`PackedStringArray` property as an absolute path to a file. The path can be picked from the entire filesystem. See :ref:`@export_file` to limit it to the project folder and its subfolders. @@ -547,7 +549,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_GLOBAL_FILE`, prefix\: :ref:`String` = ""\ ) +**@export_group**\ (\ name\: :ref:`String`, prefix\: :ref:`String` = ""\ ) :ref:`🔗` Define a new group for the following exported properties. This helps to organize properties in the Inspector dock. Groups can be added with an optional ``prefix``, which would make group to only consider properties that have this prefix. The grouping will break on the first property that doesn't have a prefix. The prefix is also removed from the property's name in the Inspector dock. @@ -578,7 +580,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_GROUP` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], :ref:`PackedStringArray`, :ref:`Dictionary` or :ref:`Array`\ \[:ref:`Dictionary`\ \] property with a large :ref:`TextEdit` widget instead of a :ref:`LineEdit`. This adds support for multiline content and makes it easier to edit large amount of text stored in the property. @@ -597,7 +599,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_MULTILINE_TEXT` = "", ...\ ) |vararg| +**@export_node_path**\ (\ type\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` Export a :ref:`NodePath` or :ref:`Array`\ \[:ref:`NodePath`\ \] property with a filter for allowed node types. @@ -618,7 +620,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_NODE_PATH_VALID_TYPES`\ ) +**@export_placeholder**\ (\ placeholder\: :ref:`String`\ ) :ref:`🔗` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], or :ref:`PackedStringArray` property with a placeholder text displayed in the editor widget when no value is present. @@ -637,7 +639,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_PLACEHOLDER_TEXT`, max\: :ref:`float`, step\: :ref:`float` = 1.0, extra_hints\: :ref:`String` = "", ...\ ) |vararg| +**@export_range**\ (\ min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float` = 1.0, extra_hints\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` Export an :ref:`int`, :ref:`float`, :ref:`Array`\ \[:ref:`int`\ \], :ref:`Array`\ \[:ref:`float`\ \], :ref:`PackedByteArray`, :ref:`PackedInt32Array`, :ref:`PackedInt64Array`, :ref:`PackedFloat32Array`, or :ref:`PackedFloat64Array` property as a range value. The range must be defined by ``min`` and ``max``, as well as an optional ``step`` and a variety of extra hints. The ``step`` defaults to ``1`` for integer properties. For floating-point numbers this value depends on your :ref:`EditorSettings.interface/inspector/default_float_step` setting. @@ -669,7 +671,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_RANGE` Export a property with :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` flag. The property is not displayed in the editor, but it is serialized and stored in the scene or resource file. This can be useful for :ref:`@tool` scripts. Also the property value is copied when :ref:`Resource.duplicate` or :ref:`Node.duplicate` is called, unlike non-exported variables. @@ -687,7 +689,7 @@ Export a property with :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE`, prefix\: :ref:`String` = ""\ ) +**@export_subgroup**\ (\ name\: :ref:`String`, prefix\: :ref:`String` = ""\ ) :ref:`🔗` Define a new subgroup for the following exported properties. This helps to organize properties in the Inspector dock. Subgroups work exactly like groups, except they need a parent group to exist. See :ref:`@export_group`. @@ -713,7 +715,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_SUBGROUP`\ ) +**@icon**\ (\ icon_path\: :ref:`String`\ ) :ref:`🔗` Add a custom icon to the current script. The icon specified at ``icon_path`` is displayed in the Scene dock for every node of that class, as well as in various editor dialogs. @@ -735,7 +737,7 @@ Add a custom icon to the current script. The icon specified at ``icon_path`` is .. rst-class:: classref-annotation -**@onready**\ (\ ) +**@onready**\ (\ ) :ref:`🔗` Mark the following property as assigned when the :ref:`Node` is ready. Values for these properties are not assigned immediately when the node is initialized (:ref:`Object._init`), and instead are computed and stored right before :ref:`Node._ready`. @@ -751,7 +753,7 @@ Mark the following property as assigned when the :ref:`Node` is read .. rst-class:: classref-annotation -**@rpc**\ (\ mode\: :ref:`String` = "authority", sync\: :ref:`String` = "call_remote", transfer_mode\: :ref:`String` = "unreliable", transfer_channel\: :ref:`int` = 0\ ) +**@rpc**\ (\ mode\: :ref:`String` = "authority", sync\: :ref:`String` = "call_remote", transfer_mode\: :ref:`String` = "unreliable", transfer_channel\: :ref:`int` = 0\ ) :ref:`🔗` Mark the following method for remote procedure calls. See :doc:`High-level multiplayer <../tutorials/networking/high_level_multiplayer>`. @@ -784,7 +786,7 @@ The order of ``mode``, ``sync`` and ``transfer_mode`` does not matter, but value .. rst-class:: classref-annotation -**@static_unload**\ (\ ) +**@static_unload**\ (\ ) :ref:`🔗` Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values. @@ -800,7 +802,7 @@ Make a script with static variables to not persist after all references are lost .. rst-class:: classref-annotation -**@tool**\ (\ ) +**@tool**\ (\ ) :ref:`🔗` Mark the current script as a tool script, allowing it to be loaded and executed by the editor. See :doc:`Running code in the editor <../tutorials/plugins/running_code_in_the_editor>`. @@ -819,7 +821,7 @@ Mark the current script as a tool script, allowing it to be loaded and executed .. rst-class:: classref-annotation -**@warning_ignore**\ (\ warning\: :ref:`String`, ...\ ) |vararg| +**@warning_ignore**\ (\ warning\: :ref:`String`, ...\ ) |vararg| :ref:`🔗` Mark the following statement to ignore the specified ``warning``. See :doc:`GDScript warning system <../tutorials/scripting/gdscript/warning_system>`. @@ -844,7 +846,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Color` **Color8**\ (\ r8\: :ref:`int`, g8\: :ref:`int`, b8\: :ref:`int`, a8\: :ref:`int` = 255\ ) +:ref:`Color` **Color8**\ (\ r8\: :ref:`int`, g8\: :ref:`int`, b8\: :ref:`int`, a8\: :ref:`int` = 255\ ) :ref:`🔗` Returns a :ref:`Color` constructed from red (``r8``), green (``g8``), blue (``b8``), and optionally alpha (``a8``) integer channels, each divided by ``255.0`` for their final value. Using :ref:`Color8` instead of the standard :ref:`Color` constructor is useful when you need to match exact color values in an :ref:`Image`. @@ -864,7 +866,7 @@ Returns a :ref:`Color` constructed from red (``r8``), green (``g8`` .. rst-class:: classref-method -|void| **assert**\ (\ condition\: :ref:`bool`, message\: :ref:`String` = ""\ ) +|void| **assert**\ (\ condition\: :ref:`bool`, message\: :ref:`String` = ""\ ) :ref:`🔗` Asserts that the ``condition`` is ``true``. If the ``condition`` is ``false``, an error is generated. When running from the editor, the running project will also be paused until you resume it. This can be used as a stronger form of :ref:`@GlobalScope.push_error` for reporting errors to project developers or add-on users. @@ -891,7 +893,7 @@ An optional ``message`` can be shown in addition to the generic "Assertion faile .. rst-class:: classref-method -:ref:`String` **char**\ (\ char\: :ref:`int`\ ) +:ref:`String` **char**\ (\ char\: :ref:`int`\ ) :ref:`🔗` Returns a single character (as a :ref:`String`) of the given Unicode code point (which is compatible with ASCII code). @@ -909,7 +911,7 @@ Returns a single character (as a :ref:`String`) of the given Unico .. rst-class:: classref-method -:ref:`Variant` **convert**\ (\ what\: :ref:`Variant`, type\: :ref:`int`\ ) +:ref:`Variant` **convert**\ (\ what\: :ref:`Variant`, type\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Use :ref:`@GlobalScope.type_convert` instead. @@ -932,7 +934,7 @@ Converts ``what`` to ``type`` in the best way possible. The ``type`` uses the :r .. rst-class:: classref-method -:ref:`Object` **dict_to_inst**\ (\ dictionary\: :ref:`Dictionary`\ ) +:ref:`Object` **dict_to_inst**\ (\ dictionary\: :ref:`Dictionary`\ ) :ref:`🔗` Converts a ``dictionary`` (created with :ref:`inst_to_dict`) back to an Object instance. Can be useful for deserializing. @@ -944,7 +946,7 @@ Converts a ``dictionary`` (created with :ref:`inst_to_dict` **get_stack**\ (\ ) +:ref:`Array` **get_stack**\ (\ ) :ref:`🔗` Returns an array of dictionaries representing the current call stack. See also :ref:`print_stack`. @@ -977,7 +979,7 @@ Starting from ``_ready()``, ``bar()`` would print: .. rst-class:: classref-method -:ref:`Dictionary` **inst_to_dict**\ (\ instance\: :ref:`Object`\ ) +:ref:`Dictionary` **inst_to_dict**\ (\ instance\: :ref:`Object`\ ) :ref:`🔗` Returns the passed ``instance`` converted to a Dictionary. Can be useful for serializing. @@ -1006,7 +1008,7 @@ Prints out: .. rst-class:: classref-method -:ref:`bool` **is_instance_of**\ (\ value\: :ref:`Variant`, type\: :ref:`Variant`\ ) +:ref:`bool` **is_instance_of**\ (\ value\: :ref:`Variant`, type\: :ref:`Variant`\ ) :ref:`🔗` Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value must be one of the following: @@ -1039,7 +1041,7 @@ See also :ref:`@GlobalScope.typeof`, :ref:`typ .. rst-class:: classref-method -:ref:`int` **len**\ (\ var\: :ref:`Variant`\ ) +:ref:`int` **len**\ (\ var\: :ref:`Variant`\ ) :ref:`🔗` Returns the length of the given Variant ``var``. The length can be the character count of a :ref:`String` or :ref:`StringName`, the element count of any array type, or the size of a :ref:`Dictionary`. For every other Variant type, a run-time error is generated and execution is stopped. @@ -1059,7 +1061,7 @@ Returns the length of the given Variant ``var``. The length can be the character .. rst-class:: classref-method -:ref:`Resource` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Resource` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns a :ref:`Resource` from the filesystem located at the absolute ``path``. Unless it's already referenced elsewhere (such as in another script or in the scene), the resource is loaded from disk on function call, which might cause a slight delay, especially when loading large scenes. To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use :ref:`preload`. This method is equivalent of using :ref:`ResourceLoader.load` with :ref:`ResourceLoader.CACHE_MODE_REUSE`. @@ -1086,7 +1088,7 @@ This function is a simplified version of :ref:`ResourceLoader.load` **preload**\ (\ path\: :ref:`String`\ ) +:ref:`Resource` **preload**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns a :ref:`Resource` from the filesystem located at ``path``. During run-time, the resource is loaded when the script is being parsed. This function effectively acts as a reference to that resource. Note that this function requires ``path`` to be a constant :ref:`String`. If you want to load a resource from a dynamic/variable path, use :ref:`load`. @@ -1107,7 +1109,7 @@ Returns a :ref:`Resource` from the filesystem located at ``path` .. rst-class:: classref-method -|void| **print_debug**\ (\ ...\ ) |vararg| +|void| **print_debug**\ (\ ...\ ) |vararg| :ref:`🔗` Like :ref:`@GlobalScope.print`, but includes the current stack frame when running with the debugger turned on. @@ -1128,7 +1130,7 @@ The output in the console may look like the following: .. rst-class:: classref-method -|void| **print_stack**\ (\ ) +|void| **print_stack**\ (\ ) :ref:`🔗` Prints a stack trace at the current code location. See also :ref:`get_stack`. @@ -1150,7 +1152,7 @@ The output in the console may look like the following: .. rst-class:: classref-method -:ref:`Array` **range**\ (\ ...\ ) |vararg| +:ref:`Array` **range**\ (\ ...\ ) |vararg| :ref:`🔗` Returns an array with the given range. :ref:`range` can be called in three ways: @@ -1212,7 +1214,7 @@ Output: .. rst-class:: classref-method -:ref:`bool` **type_exists**\ (\ type\: :ref:`StringName`\ ) +:ref:`bool` **type_exists**\ (\ type\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the given :ref:`Object`-derived class exists in :ref:`ClassDB`. Note that :ref:`Variant` data types are not registered in :ref:`ClassDB`. diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 8426cd3bfba..a1308bea25e 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -63,8 +63,6 @@ Properties +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Geometry3D` | :ref:`Geometry3D` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`GodotSharp` | :ref:`GodotSharp` | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`IP` | :ref:`IP` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Input` | :ref:`Input` | @@ -371,7 +369,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Side**: +enum **Side**: :ref:`🔗` .. _class_@GlobalScope_constant_SIDE_LEFT: @@ -413,7 +411,7 @@ Bottom side, usually used for :ref:`Control` or :ref:`StyleBox` .. _class_@GlobalScope_constant_CORNER_TOP_LEFT: @@ -455,7 +453,7 @@ Bottom-left corner. .. rst-class:: classref-enumeration -enum **Orientation**: +enum **Orientation**: :ref:`🔗` .. _class_@GlobalScope_constant_VERTICAL: @@ -481,7 +479,7 @@ General horizontal alignment, usually used for :ref:`Separator` .. rst-class:: classref-enumeration -enum **ClockDirection**: +enum **ClockDirection**: :ref:`🔗` .. _class_@GlobalScope_constant_CLOCKWISE: @@ -507,7 +505,7 @@ Counter-clockwise rotation. Used by some methods (e.g. :ref:`Image.rotate_90` .. _class_@GlobalScope_constant_HORIZONTAL_ALIGNMENT_LEFT: @@ -549,7 +547,7 @@ Expand row to fit width, usually for text-derived classes. .. rst-class:: classref-enumeration -enum **VerticalAlignment**: +enum **VerticalAlignment**: :ref:`🔗` .. _class_@GlobalScope_constant_VERTICAL_ALIGNMENT_TOP: @@ -591,7 +589,7 @@ Expand rows to fit height, usually for text-derived classes. .. rst-class:: classref-enumeration -enum **InlineAlignment**: +enum **InlineAlignment**: :ref:`🔗` .. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TOP_TO: @@ -705,7 +703,7 @@ A bit mask for ``INLINE_ALIGNMENT_TO_*`` alignment constants. .. rst-class:: classref-enumeration -enum **EulerOrder**: +enum **EulerOrder**: :ref:`🔗` .. _class_@GlobalScope_constant_EULER_ORDER_XYZ: @@ -763,7 +761,7 @@ Specifies that Euler angles should be in ZYX order. When composing, the order is .. rst-class:: classref-enumeration -enum **Key**: +enum **Key**: :ref:`🔗` .. _class_@GlobalScope_constant_KEY_NONE: @@ -2317,7 +2315,7 @@ Z key. .. rst-class:: classref-enumeration -flags **KeyModifierMask**: +flags **KeyModifierMask**: :ref:`🔗` .. _class_@GlobalScope_constant_KEY_CODE_MASK: @@ -2399,7 +2397,7 @@ Group Switch key mask. .. rst-class:: classref-enumeration -enum **KeyLocation**: +enum **KeyLocation**: :ref:`🔗` .. _class_@GlobalScope_constant_KEY_LOCATION_UNSPECIFIED: @@ -2435,7 +2433,7 @@ A key which is to the right of its twin. .. rst-class:: classref-enumeration -enum **MouseButton**: +enum **MouseButton**: :ref:`🔗` .. _class_@GlobalScope_constant_MOUSE_BUTTON_NONE: @@ -2525,7 +2523,7 @@ Extra mouse button 2. This is sometimes present, usually to the sides of the mou .. rst-class:: classref-enumeration -flags **MouseButtonMask**: +flags **MouseButtonMask**: :ref:`🔗` .. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_LEFT: @@ -2575,7 +2573,7 @@ Extra mouse button 2 mask. .. rst-class:: classref-enumeration -enum **JoyButton**: +enum **JoyButton**: :ref:`🔗` .. _class_@GlobalScope_constant_JOY_BUTTON_INVALID: @@ -2783,7 +2781,7 @@ The maximum number of game controller buttons supported by the engine. The actua .. rst-class:: classref-enumeration -enum **JoyAxis**: +enum **JoyAxis**: :ref:`🔗` .. _class_@GlobalScope_constant_JOY_AXIS_INVALID: @@ -2865,7 +2863,7 @@ The maximum number of game controller axes: OpenVR supports up to 5 Joysticks ma .. rst-class:: classref-enumeration -enum **MIDIMessage**: +enum **MIDIMessage**: :ref:`🔗` .. _class_@GlobalScope_constant_MIDI_MESSAGE_NONE: @@ -3037,7 +3035,7 @@ MIDI message sent to reset a MIDI device to its default state, as if it was just .. rst-class:: classref-enumeration -enum **Error**: +enum **Error**: :ref:`🔗` .. _class_@GlobalScope_constant_OK: @@ -3457,7 +3455,7 @@ Printer on fire error (This is an easter egg, no built-in methods return this er .. rst-class:: classref-enumeration -enum **PropertyHint**: +enum **PropertyHint**: :ref:`🔗` .. _class_@GlobalScope_constant_PROPERTY_HINT_NONE: @@ -3864,7 +3862,7 @@ Represents the size of the :ref:`PropertyHint` e .. rst-class:: classref-enumeration -flags **PropertyUsageFlags**: +flags **PropertyUsageFlags**: :ref:`🔗` .. _class_@GlobalScope_constant_PROPERTY_USAGE_NONE: @@ -4134,7 +4132,7 @@ Default usage but without showing the property in the editor (storage). .. rst-class:: classref-enumeration -flags **MethodFlags**: +flags **MethodFlags**: :ref:`🔗` .. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL: @@ -4208,7 +4206,7 @@ Default method flags (normal). .. rst-class:: classref-enumeration -enum **Variant.Type**: +enum **Variant.Type**: :ref:`🔗` .. _class_@GlobalScope_constant_TYPE_NIL: @@ -4538,7 +4536,7 @@ Represents the size of the :ref:`Variant.Type` e .. rst-class:: classref-enumeration -enum **Variant.Operator**: +enum **Variant.Operator**: :ref:`🔗` .. _class_@GlobalScope_constant_OP_EQUAL: @@ -4761,7 +4759,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AudioServer` **AudioServer** +:ref:`AudioServer` **AudioServer** :ref:`🔗` The :ref:`AudioServer` singleton. @@ -4773,7 +4771,7 @@ The :ref:`AudioServer` singleton. .. rst-class:: classref-property -:ref:`CameraServer` **CameraServer** +:ref:`CameraServer` **CameraServer** :ref:`🔗` The :ref:`CameraServer` singleton. @@ -4785,7 +4783,7 @@ The :ref:`CameraServer` singleton. .. rst-class:: classref-property -:ref:`ClassDB` **ClassDB** +:ref:`ClassDB` **ClassDB** :ref:`🔗` The :ref:`ClassDB` singleton. @@ -4797,7 +4795,7 @@ The :ref:`ClassDB` singleton. .. rst-class:: classref-property -:ref:`DisplayServer` **DisplayServer** +:ref:`DisplayServer` **DisplayServer** :ref:`🔗` The :ref:`DisplayServer` singleton. @@ -4809,7 +4807,7 @@ The :ref:`DisplayServer` singleton. .. rst-class:: classref-property -:ref:`EditorInterface` **EditorInterface** +:ref:`EditorInterface` **EditorInterface** :ref:`🔗` The :ref:`EditorInterface` singleton. @@ -4823,7 +4821,7 @@ The :ref:`EditorInterface` singleton. .. rst-class:: classref-property -:ref:`Engine` **Engine** +:ref:`Engine` **Engine** :ref:`🔗` The :ref:`Engine` singleton. @@ -4835,7 +4833,7 @@ The :ref:`Engine` singleton. .. rst-class:: classref-property -:ref:`EngineDebugger` **EngineDebugger** +:ref:`EngineDebugger` **EngineDebugger** :ref:`🔗` The :ref:`EngineDebugger` singleton. @@ -4847,7 +4845,7 @@ The :ref:`EngineDebugger` singleton. .. rst-class:: classref-property -:ref:`GDExtensionManager` **GDExtensionManager** +:ref:`GDExtensionManager` **GDExtensionManager** :ref:`🔗` The :ref:`GDExtensionManager` singleton. @@ -4859,7 +4857,7 @@ The :ref:`GDExtensionManager` singleton. .. rst-class:: classref-property -:ref:`Geometry2D` **Geometry2D** +:ref:`Geometry2D` **Geometry2D** :ref:`🔗` The :ref:`Geometry2D` singleton. @@ -4871,7 +4869,7 @@ The :ref:`Geometry2D` singleton. .. rst-class:: classref-property -:ref:`Geometry3D` **Geometry3D** +:ref:`Geometry3D` **Geometry3D** :ref:`🔗` The :ref:`Geometry3D` singleton. @@ -4879,23 +4877,11 @@ The :ref:`Geometry3D` singleton. ---- -.. _class_@GlobalScope_property_GodotSharp: - -.. rst-class:: classref-property - -:ref:`GodotSharp` **GodotSharp** - -The :ref:`GodotSharp` singleton. - -.. rst-class:: classref-item-separator - ----- - .. _class_@GlobalScope_property_IP: .. rst-class:: classref-property -:ref:`IP` **IP** +:ref:`IP` **IP** :ref:`🔗` The :ref:`IP` singleton. @@ -4907,7 +4893,7 @@ The :ref:`IP` singleton. .. rst-class:: classref-property -:ref:`Input` **Input** +:ref:`Input` **Input** :ref:`🔗` The :ref:`Input` singleton. @@ -4919,7 +4905,7 @@ The :ref:`Input` singleton. .. rst-class:: classref-property -:ref:`InputMap` **InputMap** +:ref:`InputMap` **InputMap** :ref:`🔗` The :ref:`InputMap` singleton. @@ -4931,7 +4917,7 @@ The :ref:`InputMap` singleton. .. rst-class:: classref-property -:ref:`JavaClassWrapper` **JavaClassWrapper** +:ref:`JavaClassWrapper` **JavaClassWrapper** :ref:`🔗` The :ref:`JavaClassWrapper` singleton. @@ -4945,7 +4931,7 @@ The :ref:`JavaClassWrapper` singleton. .. rst-class:: classref-property -:ref:`JavaScriptBridge` **JavaScriptBridge** +:ref:`JavaScriptBridge` **JavaScriptBridge** :ref:`🔗` The :ref:`JavaScriptBridge` singleton. @@ -4959,7 +4945,7 @@ The :ref:`JavaScriptBridge` singleton. .. rst-class:: classref-property -:ref:`Marshalls` **Marshalls** +:ref:`Marshalls` **Marshalls** :ref:`🔗` The :ref:`Marshalls` singleton. @@ -4971,7 +4957,7 @@ The :ref:`Marshalls` singleton. .. rst-class:: classref-property -:ref:`NativeMenu` **NativeMenu** +:ref:`NativeMenu` **NativeMenu** :ref:`🔗` The :ref:`NativeMenu` singleton. @@ -4985,7 +4971,7 @@ The :ref:`NativeMenu` singleton. .. rst-class:: classref-property -:ref:`NavigationMeshGenerator` **NavigationMeshGenerator** +:ref:`NavigationMeshGenerator` **NavigationMeshGenerator** :ref:`🔗` The :ref:`NavigationMeshGenerator` singleton. @@ -4997,7 +4983,7 @@ The :ref:`NavigationMeshGenerator` singleton. .. rst-class:: classref-property -:ref:`NavigationServer2D` **NavigationServer2D** +:ref:`NavigationServer2D` **NavigationServer2D** :ref:`🔗` The :ref:`NavigationServer2D` singleton. @@ -5009,7 +4995,7 @@ The :ref:`NavigationServer2D` singleton. .. rst-class:: classref-property -:ref:`NavigationServer3D` **NavigationServer3D** +:ref:`NavigationServer3D` **NavigationServer3D** :ref:`🔗` The :ref:`NavigationServer3D` singleton. @@ -5021,7 +5007,7 @@ The :ref:`NavigationServer3D` singleton. .. rst-class:: classref-property -:ref:`OS` **OS** +:ref:`OS` **OS** :ref:`🔗` The :ref:`OS` singleton. @@ -5033,7 +5019,7 @@ The :ref:`OS` singleton. .. rst-class:: classref-property -:ref:`Performance` **Performance** +:ref:`Performance` **Performance** :ref:`🔗` The :ref:`Performance` singleton. @@ -5045,7 +5031,7 @@ The :ref:`Performance` singleton. .. rst-class:: classref-property -:ref:`PhysicsServer2D` **PhysicsServer2D** +:ref:`PhysicsServer2D` **PhysicsServer2D** :ref:`🔗` The :ref:`PhysicsServer2D` singleton. @@ -5057,7 +5043,7 @@ The :ref:`PhysicsServer2D` singleton. .. rst-class:: classref-property -:ref:`PhysicsServer2DManager` **PhysicsServer2DManager** +:ref:`PhysicsServer2DManager` **PhysicsServer2DManager** :ref:`🔗` The :ref:`PhysicsServer2DManager` singleton. @@ -5069,7 +5055,7 @@ The :ref:`PhysicsServer2DManager` singleton. .. rst-class:: classref-property -:ref:`PhysicsServer3D` **PhysicsServer3D** +:ref:`PhysicsServer3D` **PhysicsServer3D** :ref:`🔗` The :ref:`PhysicsServer3D` singleton. @@ -5081,7 +5067,7 @@ The :ref:`PhysicsServer3D` singleton. .. rst-class:: classref-property -:ref:`PhysicsServer3DManager` **PhysicsServer3DManager** +:ref:`PhysicsServer3DManager` **PhysicsServer3DManager** :ref:`🔗` The :ref:`PhysicsServer3DManager` singleton. @@ -5093,7 +5079,7 @@ The :ref:`PhysicsServer3DManager` singleton. .. rst-class:: classref-property -:ref:`ProjectSettings` **ProjectSettings** +:ref:`ProjectSettings` **ProjectSettings** :ref:`🔗` The :ref:`ProjectSettings` singleton. @@ -5105,7 +5091,7 @@ The :ref:`ProjectSettings` singleton. .. rst-class:: classref-property -:ref:`RenderingServer` **RenderingServer** +:ref:`RenderingServer` **RenderingServer** :ref:`🔗` The :ref:`RenderingServer` singleton. @@ -5117,7 +5103,7 @@ The :ref:`RenderingServer` singleton. .. rst-class:: classref-property -:ref:`ResourceLoader` **ResourceLoader** +:ref:`ResourceLoader` **ResourceLoader** :ref:`🔗` The :ref:`ResourceLoader` singleton. @@ -5129,7 +5115,7 @@ The :ref:`ResourceLoader` singleton. .. rst-class:: classref-property -:ref:`ResourceSaver` **ResourceSaver** +:ref:`ResourceSaver` **ResourceSaver** :ref:`🔗` The :ref:`ResourceSaver` singleton. @@ -5141,7 +5127,7 @@ The :ref:`ResourceSaver` singleton. .. rst-class:: classref-property -:ref:`ResourceUID` **ResourceUID** +:ref:`ResourceUID` **ResourceUID** :ref:`🔗` The :ref:`ResourceUID` singleton. @@ -5153,7 +5139,7 @@ The :ref:`ResourceUID` singleton. .. rst-class:: classref-property -:ref:`TextServerManager` **TextServerManager** +:ref:`TextServerManager` **TextServerManager** :ref:`🔗` The :ref:`TextServerManager` singleton. @@ -5165,7 +5151,7 @@ The :ref:`TextServerManager` singleton. .. rst-class:: classref-property -:ref:`ThemeDB` **ThemeDB** +:ref:`ThemeDB` **ThemeDB** :ref:`🔗` The :ref:`ThemeDB` singleton. @@ -5177,7 +5163,7 @@ The :ref:`ThemeDB` singleton. .. rst-class:: classref-property -:ref:`Time` **Time** +:ref:`Time` **Time** :ref:`🔗` The :ref:`Time` singleton. @@ -5189,7 +5175,7 @@ The :ref:`Time` singleton. .. rst-class:: classref-property -:ref:`TranslationServer` **TranslationServer** +:ref:`TranslationServer` **TranslationServer** :ref:`🔗` The :ref:`TranslationServer` singleton. @@ -5201,7 +5187,7 @@ The :ref:`TranslationServer` singleton. .. rst-class:: classref-property -:ref:`WorkerThreadPool` **WorkerThreadPool** +:ref:`WorkerThreadPool` **WorkerThreadPool** :ref:`🔗` The :ref:`WorkerThreadPool` singleton. @@ -5213,7 +5199,7 @@ The :ref:`WorkerThreadPool` singleton. .. rst-class:: classref-property -:ref:`XRServer` **XRServer** +:ref:`XRServer` **XRServer** :ref:`🔗` The :ref:`XRServer` singleton. @@ -5230,7 +5216,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **abs**\ (\ x\: :ref:`Variant`\ ) +:ref:`Variant` **abs**\ (\ x\: :ref:`Variant`\ ) :ref:`🔗` Returns the absolute value of a :ref:`Variant` parameter ``x`` (i.e. non-negative value). Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -5264,7 +5250,7 @@ Returns the absolute value of a :ref:`Variant` parameter ``x`` (i .. rst-class:: classref-method -:ref:`float` **absf**\ (\ x\: :ref:`float`\ ) +:ref:`float` **absf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the absolute value of float parameter ``x`` (i.e. positive value). @@ -5281,7 +5267,7 @@ Returns the absolute value of float parameter ``x`` (i.e. positive value). .. rst-class:: classref-method -:ref:`int` **absi**\ (\ x\: :ref:`int`\ ) +:ref:`int` **absi**\ (\ x\: :ref:`int`\ ) :ref:`🔗` Returns the absolute value of int parameter ``x`` (i.e. positive value). @@ -5298,7 +5284,7 @@ Returns the absolute value of int parameter ``x`` (i.e. positive value). .. rst-class:: classref-method -:ref:`float` **acos**\ (\ x\: :ref:`float`\ ) +:ref:`float` **acos**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the arc cosine of ``x`` in radians. Use to get the angle of cosine ``x``. ``x`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`acos` from returning :ref:`@GDScript.NAN`. @@ -5315,7 +5301,7 @@ Returns the arc cosine of ``x`` in radians. Use to get the angle of cosine ``x`` .. rst-class:: classref-method -:ref:`float` **acosh**\ (\ x\: :ref:`float`\ ) +:ref:`float` **acosh**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the hyperbolic arc (also called inverse) cosine of ``x``, returning a value in radians. Use it to get the angle from an angle's cosine in hyperbolic space if ``x`` is larger or equal to 1. For values of ``x`` lower than 1, it will return 0, in order to prevent :ref:`acosh` from returning :ref:`@GDScript.NAN`. @@ -5334,7 +5320,7 @@ Returns the hyperbolic arc (also called inverse) cosine of ``x``, returning a va .. rst-class:: classref-method -:ref:`float` **angle_difference**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) +:ref:`float` **angle_difference**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) :ref:`🔗` Returns the difference between the two angles, in the range of ``[-PI, +PI]``. When ``from`` and ``to`` are opposite, returns ``-PI`` if ``from`` is smaller than ``to``, or ``PI`` otherwise. @@ -5346,7 +5332,7 @@ Returns the difference between the two angles, in the range of ``[-PI, +PI]``. W .. rst-class:: classref-method -:ref:`float` **asin**\ (\ x\: :ref:`float`\ ) +:ref:`float` **asin**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the arc sine of ``x`` in radians. Use to get the angle of sine ``x``. ``x`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`asin` from returning :ref:`@GDScript.NAN`. @@ -5363,7 +5349,7 @@ Returns the arc sine of ``x`` in radians. Use to get the angle of sine ``x``. `` .. rst-class:: classref-method -:ref:`float` **asinh**\ (\ x\: :ref:`float`\ ) +:ref:`float` **asinh**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the hyperbolic arc (also called inverse) sine of ``x``, returning a value in radians. Use it to get the angle from an angle's sine in hyperbolic space. @@ -5380,7 +5366,7 @@ Returns the hyperbolic arc (also called inverse) sine of ``x``, returning a valu .. rst-class:: classref-method -:ref:`float` **atan**\ (\ x\: :ref:`float`\ ) +:ref:`float` **atan**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the arc tangent of ``x`` in radians. Use it to get the angle from an angle's tangent in trigonometry. @@ -5400,7 +5386,7 @@ If ``x`` is between ``-PI / 2`` and ``PI / 2`` (inclusive), ``atan(tan(x))`` is .. rst-class:: classref-method -:ref:`float` **atan2**\ (\ y\: :ref:`float`, x\: :ref:`float`\ ) +:ref:`float` **atan2**\ (\ y\: :ref:`float`, x\: :ref:`float`\ ) :ref:`🔗` Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ``y/x``. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. @@ -5418,7 +5404,7 @@ Important note: The Y coordinate comes first, by convention. .. rst-class:: classref-method -:ref:`float` **atanh**\ (\ x\: :ref:`float`\ ) +:ref:`float` **atanh**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the hyperbolic arc (also called inverse) tangent of ``x``, returning a value in radians. Use it to get the angle from an angle's tangent in hyperbolic space if ``x`` is between -1 and 1 (non-inclusive). @@ -5440,7 +5426,7 @@ In mathematics, the inverse hyperbolic tangent is only defined for -1 < ``x`` < .. rst-class:: classref-method -:ref:`float` **bezier_derivative**\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) +:ref:`float` **bezier_derivative**\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) :ref:`🔗` Returns the derivative at the given ``t`` on a one-dimensional `Bézier curve `__ defined by the given ``control_1``, ``control_2``, and ``end`` points. @@ -5452,7 +5438,7 @@ Returns the derivative at the given ``t`` on a one-dimensional `Bézier curve ` **bezier_interpolate**\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) +:ref:`float` **bezier_interpolate**\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) :ref:`🔗` Returns the point at the given ``t`` on a one-dimensional `Bézier curve `__ defined by the given ``control_1``, ``control_2``, and ``end`` points. @@ -5464,7 +5450,7 @@ Returns the point at the given ``t`` on a one-dimensional `Bézier curve ` **bytes_to_var**\ (\ bytes\: :ref:`PackedByteArray`\ ) +:ref:`Variant` **bytes_to_var**\ (\ bytes\: :ref:`PackedByteArray`\ ) :ref:`🔗` Decodes a byte array back to a :ref:`Variant` value, without decoding objects. @@ -5478,7 +5464,7 @@ Decodes a byte array back to a :ref:`Variant` value, without deco .. rst-class:: classref-method -:ref:`Variant` **bytes_to_var_with_objects**\ (\ bytes\: :ref:`PackedByteArray`\ ) +:ref:`Variant` **bytes_to_var_with_objects**\ (\ bytes\: :ref:`PackedByteArray`\ ) :ref:`🔗` Decodes a byte array back to a :ref:`Variant` value. Decoding objects is allowed. @@ -5492,7 +5478,7 @@ Decodes a byte array back to a :ref:`Variant` value. Decoding obj .. rst-class:: classref-method -:ref:`Variant` **ceil**\ (\ x\: :ref:`Variant`\ ) +:ref:`Variant` **ceil**\ (\ x\: :ref:`Variant`\ ) :ref:`🔗` Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -5513,7 +5499,7 @@ See also :ref:`floor`, :ref:`round` **ceilf**\ (\ x\: :ref:`float`\ ) +:ref:`float` **ceilf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. @@ -5527,7 +5513,7 @@ A type-safe version of :ref:`ceil`, returning a .. rst-class:: classref-method -:ref:`int` **ceili**\ (\ x\: :ref:`float`\ ) +:ref:`int` **ceili**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. @@ -5541,7 +5527,7 @@ A type-safe version of :ref:`ceil`, returning an .. rst-class:: classref-method -:ref:`Variant` **clamp**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) +:ref:`Variant` **clamp**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) :ref:`🔗` Clamps the ``value``, returning a :ref:`Variant` not less than ``min`` and not more than ``max``. Any values that can be compared with the less than and greater than operators will work. @@ -5565,7 +5551,7 @@ Clamps the ``value``, returning a :ref:`Variant` not less than `` .. rst-class:: classref-method -:ref:`float` **clampf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) +:ref:`float` **clampf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` Clamps the ``value``, returning a :ref:`float` not less than ``min`` and not more than ``max``. @@ -5585,7 +5571,7 @@ Clamps the ``value``, returning a :ref:`float` not less than ``min` .. rst-class:: classref-method -:ref:`int` **clampi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) +:ref:`int` **clampi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) :ref:`🔗` Clamps the ``value``, returning an :ref:`int` not less than ``min`` and not more than ``max``. @@ -5605,7 +5591,7 @@ Clamps the ``value``, returning an :ref:`int` not less than ``min`` a .. rst-class:: classref-method -:ref:`float` **cos**\ (\ angle_rad\: :ref:`float`\ ) +:ref:`float` **cos**\ (\ angle_rad\: :ref:`float`\ ) :ref:`🔗` Returns the cosine of angle ``angle_rad`` in radians. @@ -5623,7 +5609,7 @@ Returns the cosine of angle ``angle_rad`` in radians. .. rst-class:: classref-method -:ref:`float` **cosh**\ (\ x\: :ref:`float`\ ) +:ref:`float` **cosh**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the hyperbolic cosine of ``x`` in radians. @@ -5639,7 +5625,7 @@ Returns the hyperbolic cosine of ``x`` in radians. .. rst-class:: classref-method -:ref:`float` **cubic_interpolate**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) +:ref:`float` **cubic_interpolate**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` Cubic interpolates between two values by the factor defined in ``weight`` with ``pre`` and ``post`` values. @@ -5651,7 +5637,7 @@ Cubic interpolates between two values by the factor defined in ``weight`` with ` .. rst-class:: classref-method -:ref:`float` **cubic_interpolate_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) +:ref:`float` **cubic_interpolate_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` Cubic interpolates between two rotation values with shortest path by the factor defined in ``weight`` with ``pre`` and ``post`` values. See also :ref:`lerp_angle`. @@ -5663,7 +5649,7 @@ Cubic interpolates between two rotation values with shortest path by the factor .. rst-class:: classref-method -:ref:`float` **cubic_interpolate_angle_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) +:ref:`float` **cubic_interpolate_angle_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) :ref:`🔗` Cubic interpolates between two rotation values with shortest path by the factor defined in ``weight`` with ``pre`` and ``post`` values. See also :ref:`lerp_angle`. @@ -5677,7 +5663,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **cubic_interpolate_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) +:ref:`float` **cubic_interpolate_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) :ref:`🔗` Cubic interpolates between two values by the factor defined in ``weight`` with ``pre`` and ``post`` values. @@ -5691,7 +5677,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **db_to_linear**\ (\ db\: :ref:`float`\ ) +:ref:`float` **db_to_linear**\ (\ db\: :ref:`float`\ ) :ref:`🔗` Converts from decibels to linear energy (audio). @@ -5703,7 +5689,7 @@ Converts from decibels to linear energy (audio). .. rst-class:: classref-method -:ref:`float` **deg_to_rad**\ (\ deg\: :ref:`float`\ ) +:ref:`float` **deg_to_rad**\ (\ deg\: :ref:`float`\ ) :ref:`🔗` Converts an angle expressed in degrees to radians. @@ -5719,7 +5705,7 @@ Converts an angle expressed in degrees to radians. .. rst-class:: classref-method -:ref:`float` **ease**\ (\ x\: :ref:`float`, curve\: :ref:`float`\ ) +:ref:`float` **ease**\ (\ x\: :ref:`float`, curve\: :ref:`float`\ ) :ref:`🔗` Returns an "eased" value of ``x`` based on an easing function defined with ``curve``. This easing function is based on an exponent. The ``curve`` can be any floating-point number, with specific values leading to the following behaviors: @@ -5745,7 +5731,7 @@ See also :ref:`smoothstep`. If you need to .. rst-class:: classref-method -:ref:`String` **error_string**\ (\ error\: :ref:`int`\ ) +:ref:`String` **error_string**\ (\ error\: :ref:`int`\ ) :ref:`🔗` Returns a human-readable name for the given :ref:`Error` code. @@ -5764,7 +5750,7 @@ Returns a human-readable name for the given :ref:`Error .. rst-class:: classref-method -:ref:`float` **exp**\ (\ x\: :ref:`float`\ ) +:ref:`float` **exp**\ (\ x\: :ref:`float`\ ) :ref:`🔗` The natural exponential function. It raises the mathematical constant *e* to the power of ``x`` and returns it. @@ -5784,7 +5770,7 @@ For exponents to other bases use the method :ref:`pow` **floor**\ (\ x\: :ref:`Variant`\ ) +:ref:`Variant` **floor**\ (\ x\: :ref:`Variant`\ ) :ref:`🔗` Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -5805,7 +5791,7 @@ See also :ref:`ceil`, :ref:`round` **floorf**\ (\ x\: :ref:`float`\ ) +:ref:`float` **floorf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. @@ -5819,7 +5805,7 @@ A type-safe version of :ref:`floor`, returning .. rst-class:: classref-method -:ref:`int` **floori**\ (\ x\: :ref:`float`\ ) +:ref:`int` **floori**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. @@ -5835,7 +5821,7 @@ A type-safe version of :ref:`floor`, returning .. rst-class:: classref-method -:ref:`float` **fmod**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) +:ref:`float` **fmod**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) :ref:`🔗` Returns the floating-point remainder of ``x`` divided by ``y``, keeping the sign of ``x``. @@ -5853,7 +5839,7 @@ For the integer remainder operation, use the ``%`` operator. .. rst-class:: classref-method -:ref:`float` **fposmod**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) +:ref:`float` **fposmod**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) :ref:`🔗` Returns the floating-point modulus of ``x`` divided by ``y``, wrapping equally in positive and negative. @@ -5885,7 +5871,7 @@ Prints: .. rst-class:: classref-method -:ref:`int` **hash**\ (\ variable\: :ref:`Variant`\ ) +:ref:`int` **hash**\ (\ variable\: :ref:`Variant`\ ) :ref:`🔗` Returns the integer hash of the passed ``variable``. @@ -5910,7 +5896,7 @@ Returns the integer hash of the passed ``variable``. .. rst-class:: classref-method -:ref:`Object` **instance_from_id**\ (\ instance_id\: :ref:`int`\ ) +:ref:`Object` **instance_from_id**\ (\ instance_id\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Object` that corresponds to ``instance_id``. All Objects have a unique instance ID. See also :ref:`Object.get_instance_id`. @@ -5950,7 +5936,7 @@ Returns the :ref:`Object` that corresponds to ``instance_id``. All .. rst-class:: classref-method -:ref:`float` **inverse_lerp**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) +:ref:`float` **inverse_lerp**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` Returns an interpolation or extrapolation factor considering the range specified in ``from`` and ``to``, and the interpolated value specified in ``weight``. The returned value will be between ``0.0`` and ``1.0`` if ``weight`` is between ``from`` and ``to`` (inclusive). If ``weight`` is located outside this range, then an extrapolation factor will be returned (return value lower than ``0.0`` or greater than ``1.0``). Use :ref:`clamp` on the result of :ref:`inverse_lerp` if this is not desired. @@ -5974,7 +5960,7 @@ See also :ref:`lerp`, which performs the reverse .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) +:ref:`bool` **is_equal_approx**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if ``a`` and ``b`` are approximately equal to each other. @@ -5990,7 +5976,7 @@ Infinity values of the same sign are considered equal. .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ x\: :ref:`float`\ ) +:ref:`bool` **is_finite**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns whether ``x`` is a finite value, i.e. it is not :ref:`@GDScript.NAN`, positive infinity, or negative infinity. @@ -6002,7 +5988,7 @@ Returns whether ``x`` is a finite value, i.e. it is not :ref:`@GDScript.NAN` **is_inf**\ (\ x\: :ref:`float`\ ) +:ref:`bool` **is_inf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if ``x`` is either positive infinity or negative infinity. @@ -6014,7 +6000,7 @@ Returns ``true`` if ``x`` is either positive infinity or negative infinity. .. rst-class:: classref-method -:ref:`bool` **is_instance_id_valid**\ (\ id\: :ref:`int`\ ) +:ref:`bool` **is_instance_id_valid**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the Object that corresponds to ``id`` is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID. @@ -6026,7 +6012,7 @@ Returns ``true`` if the Object that corresponds to ``id`` is a valid object (e.g .. rst-class:: classref-method -:ref:`bool` **is_instance_valid**\ (\ instance\: :ref:`Variant`\ ) +:ref:`bool` **is_instance_valid**\ (\ instance\: :ref:`Variant`\ ) :ref:`🔗` Returns ``true`` if ``instance`` is a valid Object (e.g. has not been deleted from memory). @@ -6038,7 +6024,7 @@ Returns ``true`` if ``instance`` is a valid Object (e.g. has not been deleted fr .. rst-class:: classref-method -:ref:`bool` **is_nan**\ (\ x\: :ref:`float`\ ) +:ref:`bool` **is_nan**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if ``x`` is a NaN ("Not a Number" or invalid) value. @@ -6050,7 +6036,7 @@ Returns ``true`` if ``x`` is a NaN ("Not a Number" or invalid) value. .. rst-class:: classref-method -:ref:`bool` **is_same**\ (\ a\: :ref:`Variant`, b\: :ref:`Variant`\ ) +:ref:`bool` **is_same**\ (\ a\: :ref:`Variant`, b\: :ref:`Variant`\ ) :ref:`🔗` Returns ``true``, for value types, if ``a`` and ``b`` share the same value. Returns ``true``, for reference types, if the references of ``a`` and ``b`` are the same. @@ -6082,7 +6068,7 @@ These are :ref:`Variant` reference types: :ref:`Object` **is_zero_approx**\ (\ x\: :ref:`float`\ ) +:ref:`bool` **is_zero_approx**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if ``x`` is zero or almost zero. The comparison is done using a tolerance calculation with a small internal epsilon. @@ -6096,7 +6082,7 @@ This function is faster than using :ref:`is_equal_approx` **lerp**\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`Variant`\ ) +:ref:`Variant` **lerp**\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`Variant`\ ) :ref:`🔗` Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clamp` on the result of this function. @@ -6118,7 +6104,7 @@ See also :ref:`inverse_lerp` which perfo .. rst-class:: classref-method -:ref:`float` **lerp_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) +:ref:`float` **lerp_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` Linearly interpolates between two angles (in radians) by a ``weight`` value between 0.0 and 1.0. @@ -6144,7 +6130,7 @@ Similar to :ref:`lerp`, but interpolates correct .. rst-class:: classref-method -:ref:`float` **lerpf**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) +:ref:`float` **lerpf**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clampf` on the result of this function. @@ -6162,7 +6148,7 @@ See also :ref:`inverse_lerp` which perfo .. rst-class:: classref-method -:ref:`float` **linear_to_db**\ (\ lin\: :ref:`float`\ ) +:ref:`float` **linear_to_db**\ (\ lin\: :ref:`float`\ ) :ref:`🔗` Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). @@ -6183,7 +6169,7 @@ Converts from linear energy to decibels (audio). This can be used to implement v .. rst-class:: classref-method -:ref:`float` **log**\ (\ x\: :ref:`float`\ ) +:ref:`float` **log**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the `natural logarithm `__ of ``x`` (base `[i]e[/i] `__, with *e* being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth. @@ -6203,7 +6189,7 @@ Returns the `natural logarithm .. rst-class:: classref-method -:ref:`Variant` **max**\ (\ ...\ ) |vararg| +:ref:`Variant` **max**\ (\ ...\ ) |vararg| :ref:`🔗` Returns the maximum of the given numeric values. This function can take any number of arguments. @@ -6221,7 +6207,7 @@ Returns the maximum of the given numeric values. This function can take any numb .. rst-class:: classref-method -:ref:`float` **maxf**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) +:ref:`float` **maxf**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) :ref:`🔗` Returns the maximum of two :ref:`float` values. @@ -6238,7 +6224,7 @@ Returns the maximum of two :ref:`float` values. .. rst-class:: classref-method -:ref:`int` **maxi**\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) +:ref:`int` **maxi**\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) :ref:`🔗` Returns the maximum of two :ref:`int` values. @@ -6255,7 +6241,7 @@ Returns the maximum of two :ref:`int` values. .. rst-class:: classref-method -:ref:`Variant` **min**\ (\ ...\ ) |vararg| +:ref:`Variant` **min**\ (\ ...\ ) |vararg| :ref:`🔗` Returns the minimum of the given numeric values. This function can take any number of arguments. @@ -6273,7 +6259,7 @@ Returns the minimum of the given numeric values. This function can take any numb .. rst-class:: classref-method -:ref:`float` **minf**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) +:ref:`float` **minf**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) :ref:`🔗` Returns the minimum of two :ref:`float` values. @@ -6290,7 +6276,7 @@ Returns the minimum of two :ref:`float` values. .. rst-class:: classref-method -:ref:`int` **mini**\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) +:ref:`int` **mini**\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) :ref:`🔗` Returns the minimum of two :ref:`int` values. @@ -6307,7 +6293,7 @@ Returns the minimum of two :ref:`int` values. .. rst-class:: classref-method -:ref:`float` **move_toward**\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) +:ref:`float` **move_toward**\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) :ref:`🔗` Moves ``from`` toward ``to`` by the ``delta`` amount. Will not go past ``to``. @@ -6328,7 +6314,7 @@ Use a negative ``delta`` value to move away. .. rst-class:: classref-method -:ref:`int` **nearest_po2**\ (\ value\: :ref:`int`\ ) +:ref:`int` **nearest_po2**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Returns the smallest integer power of 2 that is greater than or equal to ``value``. @@ -6351,7 +6337,7 @@ Returns the smallest integer power of 2 that is greater than or equal to ``value .. rst-class:: classref-method -:ref:`float` **pingpong**\ (\ value\: :ref:`float`, length\: :ref:`float`\ ) +:ref:`float` **pingpong**\ (\ value\: :ref:`float`, length\: :ref:`float`\ ) :ref:`🔗` Wraps ``value`` between ``0`` and the ``length``. If the limit is reached, the next value the function returns is decreased to the ``0`` side or increased to the ``length`` side (like a triangle wave). If ``length`` is less than zero, it becomes positive. @@ -6376,7 +6362,7 @@ Wraps ``value`` between ``0`` and the ``length``. If the limit is reached, the n .. rst-class:: classref-method -:ref:`int` **posmod**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) +:ref:`int` **posmod**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) :ref:`🔗` Returns the integer modulus of ``x`` divided by ``y`` that wraps equally in positive and negative. @@ -6407,7 +6393,7 @@ Prints: .. rst-class:: classref-method -:ref:`float` **pow**\ (\ base\: :ref:`float`, exp\: :ref:`float`\ ) +:ref:`float` **pow**\ (\ base\: :ref:`float`, exp\: :ref:`float`\ ) :ref:`🔗` Returns the result of ``base`` raised to the power of ``exp``. @@ -6426,7 +6412,7 @@ In GDScript, this is the equivalent of the ``**`` operator. .. rst-class:: classref-method -|void| **print**\ (\ ...\ ) |vararg| +|void| **print**\ (\ ...\ ) |vararg| :ref:`🔗` Converts one or more arguments of any type to string in the best way possible and prints them to the console. @@ -6455,7 +6441,7 @@ Converts one or more arguments of any type to string in the best way possible an .. rst-class:: classref-method -|void| **print_rich**\ (\ ...\ ) |vararg| +|void| **print_rich**\ (\ ...\ ) |vararg| :ref:`🔗` Converts one or more arguments of any type to string in the best way possible and prints them to the console. @@ -6494,7 +6480,7 @@ When printing to standard output, the supported subset of BBCode is converted to .. rst-class:: classref-method -|void| **print_verbose**\ (\ ...\ ) |vararg| +|void| **print_verbose**\ (\ ...\ ) |vararg| :ref:`🔗` If verbose mode is enabled (:ref:`OS.is_stdout_verbose` returning ``true``), converts one or more arguments of any type to string in the best way possible and prints them to the console. @@ -6506,7 +6492,7 @@ If verbose mode is enabled (:ref:`OS.is_stdout_verbose` Prints one or more arguments to strings in the best way possible to standard error line. @@ -6531,7 +6517,7 @@ Prints one or more arguments to strings in the best way possible to standard err .. rst-class:: classref-method -|void| **printraw**\ (\ ...\ ) |vararg| +|void| **printraw**\ (\ ...\ ) |vararg| :ref:`🔗` Prints one or more arguments to strings in the best way possible to the OS terminal. Unlike :ref:`print`, no newline is automatically added at the end. @@ -6564,7 +6550,7 @@ Prints one or more arguments to strings in the best way possible to the OS termi .. rst-class:: classref-method -|void| **prints**\ (\ ...\ ) |vararg| +|void| **prints**\ (\ ...\ ) |vararg| :ref:`🔗` Prints one or more arguments to the console with a space between each argument. @@ -6589,7 +6575,7 @@ Prints one or more arguments to the console with a space between each argument. .. rst-class:: classref-method -|void| **printt**\ (\ ...\ ) |vararg| +|void| **printt**\ (\ ...\ ) |vararg| :ref:`🔗` Prints one or more arguments to the console with a tab between each argument. @@ -6614,7 +6600,7 @@ Prints one or more arguments to the console with a tab between each argument. .. rst-class:: classref-method -|void| **push_error**\ (\ ...\ ) |vararg| +|void| **push_error**\ (\ ...\ ) |vararg| :ref:`🔗` Pushes an error message to Godot's built-in debugger and to the OS terminal. @@ -6641,7 +6627,7 @@ Pushes an error message to Godot's built-in debugger and to the OS terminal. .. rst-class:: classref-method -|void| **push_warning**\ (\ ...\ ) |vararg| +|void| **push_warning**\ (\ ...\ ) |vararg| :ref:`🔗` Pushes a warning message to Godot's built-in debugger and to the OS terminal. @@ -6666,7 +6652,7 @@ Pushes a warning message to Godot's built-in debugger and to the OS terminal. .. rst-class:: classref-method -:ref:`float` **rad_to_deg**\ (\ rad\: :ref:`float`\ ) +:ref:`float` **rad_to_deg**\ (\ rad\: :ref:`float`\ ) :ref:`🔗` Converts an angle expressed in radians to degrees. @@ -6684,7 +6670,7 @@ Converts an angle expressed in radians to degrees. .. rst-class:: classref-method -:ref:`PackedInt64Array` **rand_from_seed**\ (\ seed\: :ref:`int`\ ) +:ref:`PackedInt64Array` **rand_from_seed**\ (\ seed\: :ref:`int`\ ) :ref:`🔗` Given a ``seed``, returns a :ref:`PackedInt64Array` of size ``2``, where its first element is the randomized :ref:`int` value, and the second element is the same as ``seed``. Passing the same ``seed`` consistently returns the same array. @@ -6705,7 +6691,7 @@ Given a ``seed``, returns a :ref:`PackedInt64Array` of s .. rst-class:: classref-method -:ref:`float` **randf**\ (\ ) +:ref:`float` **randf**\ (\ ) :ref:`🔗` Returns a random floating-point value between ``0.0`` and ``1.0`` (inclusive). @@ -6730,7 +6716,7 @@ Returns a random floating-point value between ``0.0`` and ``1.0`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randf_range**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) +:ref:`float` **randf_range**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) :ref:`🔗` Returns a random floating-point value between ``from`` and ``to`` (inclusive). @@ -6757,7 +6743,7 @@ Returns a random floating-point value between ``from`` and ``to`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randfn**\ (\ mean\: :ref:`float`, deviation\: :ref:`float`\ ) +:ref:`float` **randfn**\ (\ mean\: :ref:`float`, deviation\: :ref:`float`\ ) :ref:`🔗` Returns a `normally-distributed `__, pseudo-random floating-point value from the specified ``mean`` and a standard ``deviation``. This is also known as a Gaussian distribution. @@ -6771,7 +6757,7 @@ Returns a `normally-distributed ` **randi**\ (\ ) +:ref:`int` **randi**\ (\ ) :ref:`🔗` Returns a random unsigned 32-bit integer. Use remainder to obtain a random value in the interval ``[0, N - 1]`` (where N is smaller than 2^32). @@ -6802,7 +6788,7 @@ Returns a random unsigned 32-bit integer. Use remainder to obtain a random value .. rst-class:: classref-method -:ref:`int` **randi_range**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) +:ref:`int` **randi_range**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) :ref:`🔗` Returns a random signed 32-bit integer between ``from`` and ``to`` (inclusive). If ``to`` is lesser than ``from``, they are swapped. @@ -6829,7 +6815,7 @@ Returns a random signed 32-bit integer between ``from`` and ``to`` (inclusive). .. rst-class:: classref-method -|void| **randomize**\ (\ ) +|void| **randomize**\ (\ ) :ref:`🔗` Randomizes the seed (or the internal state) of the random number generator. The current implementation uses a number based on the device's time. @@ -6843,7 +6829,7 @@ Randomizes the seed (or the internal state) of the random number generator. The .. rst-class:: classref-method -:ref:`float` **remap**\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`\ ) +:ref:`float` **remap**\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`\ ) :ref:`🔗` Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. See also :ref:`lerp` and :ref:`inverse_lerp`. If ``value`` is outside ``[istart, istop]``, then the resulting value will also be outside ``[ostart, ostop]``. If this is not desired, use :ref:`clamp` on the result of this function. @@ -6863,7 +6849,7 @@ For complex use cases where multiple ranges are needed, consider using :ref:`Cur .. rst-class:: classref-method -:ref:`int` **rid_allocate_id**\ (\ ) +:ref:`int` **rid_allocate_id**\ (\ ) :ref:`🔗` Allocates a unique ID which can be used by the implementation to construct an RID. This is used mainly from native extensions to implement servers. @@ -6875,7 +6861,7 @@ Allocates a unique ID which can be used by the implementation to construct an RI .. rst-class:: classref-method -:ref:`RID` **rid_from_int64**\ (\ base\: :ref:`int`\ ) +:ref:`RID` **rid_from_int64**\ (\ base\: :ref:`int`\ ) :ref:`🔗` Creates an RID from a ``base``. This is used mainly from native extensions to build servers. @@ -6887,7 +6873,7 @@ Creates an RID from a ``base``. This is used mainly from native extensions to bu .. rst-class:: classref-method -:ref:`float` **rotate_toward**\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) +:ref:`float` **rotate_toward**\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) :ref:`🔗` Rotates ``from`` toward ``to`` by the ``delta`` amount. Will not go past ``to``. @@ -6903,7 +6889,7 @@ If ``delta`` is negative, this function will rotate away from ``to``, toward the .. rst-class:: classref-method -:ref:`Variant` **round**\ (\ x\: :ref:`Variant`\ ) +:ref:`Variant` **round**\ (\ x\: :ref:`Variant`\ ) :ref:`🔗` Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -6925,7 +6911,7 @@ See also :ref:`floor`, :ref:`ceil` **roundf**\ (\ x\: :ref:`float`\ ) +:ref:`float` **roundf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. @@ -6939,7 +6925,7 @@ A type-safe version of :ref:`round`, returning .. rst-class:: classref-method -:ref:`int` **roundi**\ (\ x\: :ref:`float`\ ) +:ref:`int` **roundi**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. @@ -6953,7 +6939,7 @@ A type-safe version of :ref:`round`, returning .. rst-class:: classref-method -|void| **seed**\ (\ base\: :ref:`int`\ ) +|void| **seed**\ (\ base\: :ref:`int`\ ) :ref:`🔗` Sets the seed for the random number generator to ``base``. Setting the seed manually can ensure consistent, repeatable results for most random functions. @@ -6988,7 +6974,7 @@ Sets the seed for the random number generator to ``base``. Setting the seed manu .. rst-class:: classref-method -:ref:`Variant` **sign**\ (\ x\: :ref:`Variant`\ ) +:ref:`Variant` **sign**\ (\ x\: :ref:`Variant`\ ) :ref:`🔗` Returns the same type of :ref:`Variant` as ``x``, with ``-1`` for negative values, ``1`` for positive values, and ``0`` for zeros. For ``nan`` values it returns 0. @@ -7013,7 +6999,7 @@ Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2 .. rst-class:: classref-method -:ref:`float` **signf**\ (\ x\: :ref:`float`\ ) +:ref:`float` **signf**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` if ``x`` is zero. For ``nan`` values of ``x`` it returns 0.0. @@ -7032,7 +7018,7 @@ Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` .. rst-class:: classref-method -:ref:`int` **signi**\ (\ x\: :ref:`int`\ ) +:ref:`int` **signi**\ (\ x\: :ref:`int`\ ) :ref:`🔗` Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if ``x`` is zero. @@ -7050,7 +7036,7 @@ Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if .. rst-class:: classref-method -:ref:`float` **sin**\ (\ angle_rad\: :ref:`float`\ ) +:ref:`float` **sin**\ (\ angle_rad\: :ref:`float`\ ) :ref:`🔗` Returns the sine of angle ``angle_rad`` in radians. @@ -7067,7 +7053,7 @@ Returns the sine of angle ``angle_rad`` in radians. .. rst-class:: classref-method -:ref:`float` **sinh**\ (\ x\: :ref:`float`\ ) +:ref:`float` **sinh**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the hyperbolic sine of ``x``. @@ -7084,7 +7070,7 @@ Returns the hyperbolic sine of ``x``. .. rst-class:: classref-method -:ref:`float` **smoothstep**\ (\ from\: :ref:`float`, to\: :ref:`float`, x\: :ref:`float`\ ) +:ref:`float` **smoothstep**\ (\ from\: :ref:`float`, to\: :ref:`float`, x\: :ref:`float`\ ) :ref:`🔗` Returns the result of smoothly interpolating the value of ``x`` between ``0`` and ``1``, based on the where ``x`` lies with respect to the edges ``from`` and ``to``. @@ -7111,7 +7097,7 @@ Compared to :ref:`ease` with a curve value of `` .. rst-class:: classref-method -:ref:`Variant` **snapped**\ (\ x\: :ref:`Variant`, step\: :ref:`Variant`\ ) +:ref:`Variant` **snapped**\ (\ x\: :ref:`Variant`, step\: :ref:`Variant`\ ) :ref:`🔗` Returns the multiple of ``step`` that is the closest to ``x``. This can also be used to round a floating-point number to an arbitrary number of decimals. @@ -7136,7 +7122,7 @@ See also :ref:`ceil`, :ref:`floor` **snappedf**\ (\ x\: :ref:`float`, step\: :ref:`float`\ ) +:ref:`float` **snappedf**\ (\ x\: :ref:`float`, step\: :ref:`float`\ ) :ref:`🔗` Returns the multiple of ``step`` that is the closest to ``x``. This can also be used to round a floating-point number to an arbitrary number of decimals. @@ -7155,7 +7141,7 @@ A type-safe version of :ref:`snapped`, return .. rst-class:: classref-method -:ref:`int` **snappedi**\ (\ x\: :ref:`float`, step\: :ref:`int`\ ) +:ref:`int` **snappedi**\ (\ x\: :ref:`float`, step\: :ref:`int`\ ) :ref:`🔗` Returns the multiple of ``step`` that is the closest to ``x``. @@ -7174,7 +7160,7 @@ A type-safe version of :ref:`snapped`, return .. rst-class:: classref-method -:ref:`float` **sqrt**\ (\ x\: :ref:`float`\ ) +:ref:`float` **sqrt**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the square root of ``x``, where ``x`` is a non-negative number. @@ -7194,7 +7180,7 @@ Returns the square root of ``x``, where ``x`` is a non-negative number. .. rst-class:: classref-method -:ref:`int` **step_decimals**\ (\ x\: :ref:`float`\ ) +:ref:`int` **step_decimals**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation. @@ -7212,7 +7198,7 @@ Returns the position of the first non-zero digit, after the decimal point. Note .. rst-class:: classref-method -:ref:`String` **str**\ (\ ...\ ) |vararg| +:ref:`String` **str**\ (\ ...\ ) |vararg| :ref:`🔗` Converts one or more arguments of any :ref:`Variant` type to a :ref:`String` in the best way possible. @@ -7231,7 +7217,7 @@ Converts one or more arguments of any :ref:`Variant` type to a :r .. rst-class:: classref-method -:ref:`Variant` **str_to_var**\ (\ string\: :ref:`String`\ ) +:ref:`Variant` **str_to_var**\ (\ string\: :ref:`String`\ ) :ref:`🔗` Converts a formatted ``string`` that was returned by :ref:`var_to_str` to the original :ref:`Variant`. @@ -7260,7 +7246,7 @@ Converts a formatted ``string`` that was returned by :ref:`var_to_str` **tan**\ (\ angle_rad\: :ref:`float`\ ) +:ref:`float` **tan**\ (\ angle_rad\: :ref:`float`\ ) :ref:`🔗` Returns the tangent of angle ``angle_rad`` in radians. @@ -7276,7 +7262,7 @@ Returns the tangent of angle ``angle_rad`` in radians. .. rst-class:: classref-method -:ref:`float` **tanh**\ (\ x\: :ref:`float`\ ) +:ref:`float` **tanh**\ (\ x\: :ref:`float`\ ) :ref:`🔗` Returns the hyperbolic tangent of ``x``. @@ -7293,7 +7279,7 @@ Returns the hyperbolic tangent of ``x``. .. rst-class:: classref-method -:ref:`Variant` **type_convert**\ (\ variant\: :ref:`Variant`, type\: :ref:`int`\ ) +:ref:`Variant` **type_convert**\ (\ variant\: :ref:`Variant`, type\: :ref:`int`\ ) :ref:`🔗` Converts the given ``variant`` to the given ``type``, using the :ref:`Variant.Type` values. This method is generous with how it handles types, it can automatically convert between array types, convert numeric :ref:`String`\ s to :ref:`int`, and converting most things to :ref:`String`. @@ -7317,7 +7303,7 @@ The returned value is a :ref:`Variant`, but the data inside and i .. rst-class:: classref-method -:ref:`String` **type_string**\ (\ type\: :ref:`int`\ ) +:ref:`String` **type_string**\ (\ type\: :ref:`int`\ ) :ref:`🔗` Returns a human-readable name of the given ``type``, using the :ref:`Variant.Type` values. @@ -7337,7 +7323,7 @@ See also :ref:`typeof`. .. rst-class:: classref-method -:ref:`int` **typeof**\ (\ variable\: :ref:`Variant`\ ) +:ref:`int` **typeof**\ (\ variable\: :ref:`Variant`\ ) :ref:`🔗` Returns the internal type of the given ``variable``, using the :ref:`Variant.Type` values. @@ -7361,7 +7347,7 @@ See also :ref:`type_string`. .. rst-class:: classref-method -:ref:`PackedByteArray` **var_to_bytes**\ (\ variable\: :ref:`Variant`\ ) +:ref:`PackedByteArray` **var_to_bytes**\ (\ variable\: :ref:`Variant`\ ) :ref:`🔗` Encodes a :ref:`Variant` value to a byte array, without encoding objects. Deserialization can be done with :ref:`bytes_to_var`. @@ -7377,7 +7363,7 @@ Encodes a :ref:`Variant` value to a byte array, without encoding .. rst-class:: classref-method -:ref:`PackedByteArray` **var_to_bytes_with_objects**\ (\ variable\: :ref:`Variant`\ ) +:ref:`PackedByteArray` **var_to_bytes_with_objects**\ (\ variable\: :ref:`Variant`\ ) :ref:`🔗` Encodes a :ref:`Variant` value to a byte array. Encoding objects is allowed (and can potentially include executable code). Deserialization can be done with :ref:`bytes_to_var_with_objects`. @@ -7391,7 +7377,7 @@ Encodes a :ref:`Variant` value to a byte array. Encoding objects .. rst-class:: classref-method -:ref:`String` **var_to_str**\ (\ variable\: :ref:`Variant`\ ) +:ref:`String` **var_to_str**\ (\ variable\: :ref:`Variant`\ ) :ref:`🔗` Converts a :ref:`Variant` ``variable`` to a formatted :ref:`String` that can then be parsed using :ref:`str_to_var`. @@ -7429,7 +7415,7 @@ Prints: .. rst-class:: classref-method -:ref:`Variant` **weakref**\ (\ obj\: :ref:`Variant`\ ) +:ref:`Variant` **weakref**\ (\ obj\: :ref:`Variant`\ ) :ref:`🔗` Returns a :ref:`WeakRef` instance holding a weak reference to ``obj``. Returns an empty :ref:`WeakRef` instance if ``obj`` is ``null``. Prints an error and returns ``null`` if ``obj`` is neither :ref:`Object`-derived nor ``null``. @@ -7443,7 +7429,7 @@ A weak reference to an object is not enough to keep the object alive: when the o .. rst-class:: classref-method -:ref:`Variant` **wrap**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) +:ref:`Variant` **wrap**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) :ref:`🔗` Wraps the :ref:`Variant` ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces. @@ -7468,7 +7454,7 @@ Variant types :ref:`int` and :ref:`float` are supported. .. rst-class:: classref-method -:ref:`float` **wrapf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) +:ref:`float` **wrapf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` Wraps the float ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces. @@ -7499,7 +7485,7 @@ Wraps the float ``value`` between ``min`` and ``max``. Can be used for creating .. rst-class:: classref-method -:ref:`int` **wrapi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) +:ref:`int` **wrapi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) :ref:`🔗` Wraps the integer ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 804c80004c8..9a6fc2a5519 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -161,7 +161,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **end** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **end** = ``Vector3(0, 0, 0)`` :ref:`🔗` The ending point. This is usually the corner on the top-right and forward of the bounding box, and is equivalent to ``position + size``. Setting this point affects the :ref:`size`. @@ -173,7 +173,7 @@ The ending point. This is usually the corner on the top-right and forward of the .. rst-class:: classref-property -:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` :ref:`🔗` The origin point. This is usually the corner on the bottom-left and back of the bounding box. @@ -185,7 +185,7 @@ The origin point. This is usually the corner on the bottom-left and back of the .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **size** = ``Vector3(0, 0, 0)`` :ref:`🔗` The bounding box's width, height, and depth starting from :ref:`position`. Setting this value also affects the :ref:`end` point. @@ -204,7 +204,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`AABB` **AABB**\ (\ ) +:ref:`AABB` **AABB**\ (\ ) :ref:`🔗` Constructs an **AABB** with its :ref:`position` and :ref:`size` set to :ref:`Vector3.ZERO`. @@ -241,7 +241,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **abs**\ (\ ) |const| +:ref:`AABB` **abs**\ (\ ) |const| :ref:`🔗` Returns an **AABB** equivalent to this bounding box, with its width, height, and depth modified to be non-negative values. @@ -274,7 +274,7 @@ Returns an **AABB** equivalent to this bounding box, with its width, height, and .. rst-class:: classref-method -:ref:`bool` **encloses**\ (\ with\: :ref:`AABB`\ ) |const| +:ref:`bool` **encloses**\ (\ with\: :ref:`AABB`\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box *completely* encloses the ``with`` box. The edges of both boxes are included. @@ -311,7 +311,7 @@ Returns ``true`` if this bounding box *completely* encloses the ``with`` box. Th .. rst-class:: classref-method -:ref:`AABB` **expand**\ (\ to_point\: :ref:`Vector3`\ ) |const| +:ref:`AABB` **expand**\ (\ to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a copy of this bounding box expanded to align the edges with the given ``to_point``, if necessary. @@ -352,7 +352,7 @@ Returns a copy of this bounding box expanded to align the edges with the given ` .. rst-class:: classref-method -:ref:`Vector3` **get_center**\ (\ ) |const| +:ref:`Vector3` **get_center**\ (\ ) |const| :ref:`🔗` Returns the center point of the bounding box. This is the same as ``position + (size / 2.0)``. @@ -364,7 +364,7 @@ Returns the center point of the bounding box. This is the same as ``position + ( .. rst-class:: classref-method -:ref:`Vector3` **get_endpoint**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_endpoint**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of one of the 8 vertices that compose this bounding box. With a ``idx`` of ``0`` this is the same as :ref:`position`, and a ``idx`` of ``7`` is the same as :ref:`end`. @@ -376,7 +376,7 @@ Returns the position of one of the 8 vertices that compose this bounding box. Wi .. rst-class:: classref-method -:ref:`Vector3` **get_longest_axis**\ (\ ) |const| +:ref:`Vector3` **get_longest_axis**\ (\ ) |const| :ref:`🔗` Returns the longest normalized axis of this bounding box's :ref:`size`, as a :ref:`Vector3` (:ref:`Vector3.RIGHT`, :ref:`Vector3.UP`, or :ref:`Vector3.BACK`). @@ -411,7 +411,7 @@ See also :ref:`get_longest_axis_index` .. rst-class:: classref-method -:ref:`int` **get_longest_axis_index**\ (\ ) |const| +:ref:`int` **get_longest_axis_index**\ (\ ) |const| :ref:`🔗` Returns the index to the longest axis of this bounding box's :ref:`size` (see :ref:`Vector3.AXIS_X`, :ref:`Vector3.AXIS_Y`, and :ref:`Vector3.AXIS_Z`). @@ -425,7 +425,7 @@ For an example, see :ref:`get_longest_axis`. .. rst-class:: classref-method -:ref:`float` **get_longest_axis_size**\ (\ ) |const| +:ref:`float` **get_longest_axis_size**\ (\ ) |const| :ref:`🔗` Returns the longest dimension of this bounding box's :ref:`size`. @@ -439,7 +439,7 @@ For an example, see :ref:`get_longest_axis`. .. rst-class:: classref-method -:ref:`Vector3` **get_shortest_axis**\ (\ ) |const| +:ref:`Vector3` **get_shortest_axis**\ (\ ) |const| :ref:`🔗` Returns the shortest normaalized axis of this bounding box's :ref:`size`, as a :ref:`Vector3` (:ref:`Vector3.RIGHT`, :ref:`Vector3.UP`, or :ref:`Vector3.BACK`). @@ -474,7 +474,7 @@ See also :ref:`get_shortest_axis_index` **get_shortest_axis_index**\ (\ ) |const| +:ref:`int` **get_shortest_axis_index**\ (\ ) |const| :ref:`🔗` Returns the index to the shortest axis of this bounding box's :ref:`size` (see :ref:`Vector3.AXIS_X`, :ref:`Vector3.AXIS_Y`, and :ref:`Vector3.AXIS_Z`). @@ -488,7 +488,7 @@ For an example, see :ref:`get_shortest_axis .. rst-class:: classref-method -:ref:`float` **get_shortest_axis_size**\ (\ ) |const| +:ref:`float` **get_shortest_axis_size**\ (\ ) |const| :ref:`🔗` Returns the shortest dimension of this bounding box's :ref:`size`. @@ -502,7 +502,7 @@ For an example, see :ref:`get_shortest_axis .. rst-class:: classref-method -:ref:`Vector3` **get_support**\ (\ dir\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **get_support**\ (\ dir\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the vertex's position of this bounding box that's the farthest in the given direction. This point is commonly known as the support point in collision detection algorithms. @@ -514,7 +514,7 @@ Returns the vertex's position of this bounding box that's the farthest in the gi .. rst-class:: classref-method -:ref:`float` **get_volume**\ (\ ) |const| +:ref:`float` **get_volume**\ (\ ) |const| :ref:`🔗` Returns the bounding box's volume. This is equivalent to ``size.x * size.y * size.z``. See also :ref:`has_volume`. @@ -526,7 +526,7 @@ Returns the bounding box's volume. This is equivalent to ``size.x * size.y * siz .. rst-class:: classref-method -:ref:`AABB` **grow**\ (\ by\: :ref:`float`\ ) |const| +:ref:`AABB` **grow**\ (\ by\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this bounding box extended on all sides by the given amount ``by``. A negative amount shrinks the box instead. @@ -563,7 +563,7 @@ Returns a copy of this bounding box extended on all sides by the given amount `` .. rst-class:: classref-method -:ref:`bool` **has_point**\ (\ point\: :ref:`Vector3`\ ) |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if the bounding box contains the given ``point``. By convention, points exactly on the right, top, and front sides are **not** included. @@ -577,7 +577,7 @@ Returns ``true`` if the bounding box contains the given ``point``. By convention .. rst-class:: classref-method -:ref:`bool` **has_surface**\ (\ ) |const| +:ref:`bool` **has_surface**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box has a surface or a length, that is, at least one component of :ref:`size` is greater than ``0``. Otherwise, returns ``false``. @@ -589,7 +589,7 @@ Returns ``true`` if this bounding box has a surface or a length, that is, at lea .. rst-class:: classref-method -:ref:`bool` **has_volume**\ (\ ) |const| +:ref:`bool` **has_volume**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box's width, height, and depth are all positive. See also :ref:`get_volume`. @@ -601,7 +601,7 @@ Returns ``true`` if this bounding box's width, height, and depth are all positiv .. rst-class:: classref-method -:ref:`AABB` **intersection**\ (\ with\: :ref:`AABB`\ ) |const| +:ref:`AABB` **intersection**\ (\ with\: :ref:`AABB`\ ) |const| :ref:`🔗` Returns the intersection between this bounding box and ``with``. If the boxes do not intersect, returns an empty **AABB**. If the boxes intersect at the edge, returns a flat **AABB** with no volume (see :ref:`has_surface` and :ref:`has_volume`). @@ -638,7 +638,7 @@ Returns the intersection between this bounding box and ``with``. If the boxes do .. rst-class:: classref-method -:ref:`bool` **intersects**\ (\ with\: :ref:`AABB`\ ) |const| +:ref:`bool` **intersects**\ (\ with\: :ref:`AABB`\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box overlaps with the box ``with``. The edges of both boxes are *always* excluded. @@ -650,7 +650,7 @@ Returns ``true`` if this bounding box overlaps with the box ``with``. The edges .. rst-class:: classref-method -:ref:`bool` **intersects_plane**\ (\ plane\: :ref:`Plane`\ ) |const| +:ref:`bool` **intersects_plane**\ (\ plane\: :ref:`Plane`\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box is on both sides of the given ``plane``. @@ -662,7 +662,7 @@ Returns ``true`` if this bounding box is on both sides of the given ``plane``. .. rst-class:: classref-method -:ref:`Variant` **intersects_ray**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| +:ref:`Variant` **intersects_ray**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the first point where this bounding box and the given ray intersect, as a :ref:`Vector3`. If no intersection occurs, returns ``null``. @@ -676,7 +676,7 @@ The ray begin at ``from``, faces ``dir`` and extends towards infinity. .. rst-class:: classref-method -:ref:`Variant` **intersects_segment**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| +:ref:`Variant` **intersects_segment**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the first point where this bounding box and the given segment intersect, as a :ref:`Vector3`. If no intersection occurs, returns ``null``. @@ -690,7 +690,7 @@ The segment begins at ``from`` and ends at ``to``. .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ aabb\: :ref:`AABB`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ aabb\: :ref:`AABB`\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by calling :ref:`Vector2.is_equal_approx` on the :ref:`position` and the :ref:`size`. @@ -702,7 +702,7 @@ Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by c .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vector2.is_finite` on the :ref:`position` and the :ref:`size`. @@ -714,7 +714,7 @@ Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vect .. rst-class:: classref-method -:ref:`AABB` **merge**\ (\ with\: :ref:`AABB`\ ) |const| +:ref:`AABB` **merge**\ (\ with\: :ref:`AABB`\ ) |const| :ref:`🔗` Returns an **AABB** that encloses both this bounding box and ``with`` around the edges. See also :ref:`encloses`. @@ -731,7 +731,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`AABB`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`AABB`\ ) :ref:`🔗` Returns ``true`` if the :ref:`position` or :ref:`size` of both bounding boxes are not equal. @@ -745,7 +745,7 @@ Returns ``true`` if the :ref:`position` or :ref:`s .. rst-class:: classref-operator -:ref:`AABB` **operator ***\ (\ right\: :ref:`Transform3D`\ ) +:ref:`AABB` **operator ***\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Inversely transforms (multiplies) the **AABB** by the given :ref:`Transform3D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -761,7 +761,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`AABB`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`AABB`\ ) :ref:`🔗` Returns ``true`` if both :ref:`position` and :ref:`size` of the bounding boxes are exactly equal, respectively. diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 4fcad6c6a24..2b2c4273d7f 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -108,7 +108,7 @@ Signals .. rst-class:: classref-signal -**canceled**\ (\ ) +**canceled**\ (\ ) :ref:`🔗` Emitted when the dialog is closed or the button created with :ref:`add_cancel_button` is pressed. @@ -120,7 +120,7 @@ Emitted when the dialog is closed or the button created with :ref:`add_cancel_bu .. rst-class:: classref-signal -**confirmed**\ (\ ) +**confirmed**\ (\ ) :ref:`🔗` Emitted when the dialog is accepted, i.e. the OK button is pressed. @@ -132,7 +132,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed. .. rst-class:: classref-signal -**custom_action**\ (\ action\: :ref:`StringName`\ ) +**custom_action**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` Emitted when a custom button is pressed. See :ref:`add_button`. @@ -149,7 +149,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **dialog_autowrap** = ``false`` +:ref:`bool` **dialog_autowrap** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ Sets autowrapping for the text in the dialog. .. rst-class:: classref-property -:ref:`bool` **dialog_close_on_escape** = ``true`` +:ref:`bool` **dialog_close_on_escape** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ If ``true``, the dialog will be hidden when the escape key (:ref:`@GlobalScope.K .. rst-class:: classref-property -:ref:`bool` **dialog_hide_on_ok** = ``true`` +:ref:`bool` **dialog_hide_on_ok** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it .. rst-class:: classref-property -:ref:`String` **dialog_text** = ``""`` +:ref:`String` **dialog_text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ The text displayed by the dialog. .. rst-class:: classref-property -:ref:`String` **ok_button_text** = ``"OK"`` +:ref:`String` **ok_button_text** = ``"OK"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Button` **add_button**\ (\ text\: :ref:`String`, right\: :ref:`bool` = false, action\: :ref:`String` = ""\ ) +:ref:`Button` **add_button**\ (\ text\: :ref:`String`, right\: :ref:`bool` = false, action\: :ref:`String` = ""\ ) :ref:`🔗` Adds a button with label ``text`` and a custom ``action`` to the dialog and returns the created button. ``action`` will be passed to the :ref:`custom_action` signal when pressed. @@ -257,7 +257,7 @@ You can use :ref:`remove_button` method .. rst-class:: classref-method -:ref:`Button` **add_cancel_button**\ (\ name\: :ref:`String`\ ) +:ref:`Button` **add_cancel_button**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Adds a button with label ``name`` and a cancel action to the dialog and returns the created button. @@ -271,7 +271,7 @@ You can use :ref:`remove_button` method .. rst-class:: classref-method -:ref:`Label` **get_label**\ (\ ) +:ref:`Label` **get_label**\ (\ ) :ref:`🔗` Returns the label used for built-in text. @@ -285,7 +285,7 @@ Returns the label used for built-in text. .. rst-class:: classref-method -:ref:`Button` **get_ok_button**\ (\ ) +:ref:`Button` **get_ok_button**\ (\ ) :ref:`🔗` Returns the OK :ref:`Button` instance. @@ -299,7 +299,7 @@ Returns the OK :ref:`Button` instance. .. rst-class:: classref-method -|void| **register_text_enter**\ (\ line_edit\: :ref:`LineEdit`\ ) +|void| **register_text_enter**\ (\ line_edit\: :ref:`LineEdit`\ ) :ref:`🔗` Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. @@ -311,7 +311,7 @@ Registers a :ref:`LineEdit` in the dialog. When the enter key is .. rst-class:: classref-method -|void| **remove_button**\ (\ button\: :ref:`Button`\ ) +|void| **remove_button**\ (\ button\: :ref:`Button`\ ) :ref:`🔗` Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``button`` must be a :ref:`Button` added with :ref:`add_button` or :ref:`add_cancel_button` method. After removal, pressing the ``button`` will no longer emit this dialog's :ref:`custom_action` or :ref:`canceled` signals. @@ -328,7 +328,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **buttons_min_height** = ``0`` +:ref:`int` **buttons_min_height** = ``0`` :ref:`🔗` The minimum height of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap. @@ -340,7 +340,7 @@ The minimum height of each button in the bottom row (such as OK/Cancel) in pixel .. rst-class:: classref-themeproperty -:ref:`int` **buttons_min_width** = ``0`` +:ref:`int` **buttons_min_width** = ``0`` :ref:`🔗` The minimum width of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap. @@ -352,7 +352,7 @@ The minimum width of each button in the bottom row (such as OK/Cancel) in pixels .. rst-class:: classref-themeproperty -:ref:`int` **buttons_separation** = ``10`` +:ref:`int` **buttons_separation** = ``10`` :ref:`🔗` The size of the vertical space between the dialog's content and the button row. @@ -364,7 +364,7 @@ The size of the vertical space between the dialog's content and the button row. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The panel that fills the background of the window. diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index d5c0a64d5ee..064fc6b0b32 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -127,7 +127,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_AESContext_constant_MODE_ECB_ENCRYPT: @@ -182,7 +182,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **finish**\ (\ ) +|void| **finish**\ (\ ) :ref:`🔗` Close this AES context so it can be started again. See :ref:`start`. @@ -194,7 +194,7 @@ Close this AES context so it can be started again. See :ref:`start` **get_iv_state**\ (\ ) +:ref:`PackedByteArray` **get_iv_state**\ (\ ) :ref:`🔗` Get the current IV state for this context (IV gets updated when calling :ref:`update`). You normally don't need this function. @@ -208,7 +208,7 @@ Get the current IV state for this context (IV gets updated when calling :ref:`up .. rst-class:: classref-method -:ref:`Error` **start**\ (\ mode\: :ref:`Mode`, key\: :ref:`PackedByteArray`, iv\: :ref:`PackedByteArray` = PackedByteArray()\ ) +:ref:`Error` **start**\ (\ mode\: :ref:`Mode`, key\: :ref:`PackedByteArray`, iv\: :ref:`PackedByteArray` = PackedByteArray()\ ) :ref:`🔗` Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes must always be provided, while an ``iv`` (initialization vector) of exactly 16 bytes, is only needed when ``mode`` is either :ref:`MODE_CBC_ENCRYPT` or :ref:`MODE_CBC_DECRYPT`. @@ -220,7 +220,7 @@ Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes .. rst-class:: classref-method -:ref:`PackedByteArray` **update**\ (\ src\: :ref:`PackedByteArray`\ ) +:ref:`PackedByteArray` **update**\ (\ src\: :ref:`PackedByteArray`\ ) :ref:`🔗` Run the desired operation for this AES context. Will return a :ref:`PackedByteArray` containing the result of encrypting (or decrypting) the given ``src``. See :ref:`start` for mode of operation. diff --git a/classes/class_animatablebody2d.rst b/classes/class_animatablebody2d.rst index 91ff2f98c28..98c5ae61472 100644 --- a/classes/class_animatablebody2d.rst +++ b/classes/class_animatablebody2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **sync_to_physics** = ``true`` +:ref:`bool` **sync_to_physics** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_animatablebody3d.rst b/classes/class_animatablebody3d.rst index a49d1d64180..9d1cd5e624b 100644 --- a/classes/class_animatablebody3d.rst +++ b/classes/class_animatablebody3d.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **sync_to_physics** = ``true`` +:ref:`bool` **sync_to_physics** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_animatedsprite2d.rst b/classes/class_animatedsprite2d.rst index ddaf8317fb5..8c909164789 100644 --- a/classes/class_animatedsprite2d.rst +++ b/classes/class_animatedsprite2d.rst @@ -97,7 +97,7 @@ Signals .. rst-class:: classref-signal -**animation_changed**\ (\ ) +**animation_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`animation` changes. @@ -109,7 +109,7 @@ Emitted when :ref:`animation` changes .. rst-class:: classref-signal -**animation_finished**\ (\ ) +**animation_finished**\ (\ ) :ref:`🔗` Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback. @@ -123,7 +123,7 @@ Emitted when the animation reaches the end, or the start if it is played in reve .. rst-class:: classref-signal -**animation_looped**\ (\ ) +**animation_looped**\ (\ ) :ref:`🔗` Emitted when the animation loops. @@ -135,7 +135,7 @@ Emitted when the animation loops. .. rst-class:: classref-signal -**frame_changed**\ (\ ) +**frame_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`frame` changes. @@ -147,7 +147,7 @@ Emitted when :ref:`frame` changes. .. rst-class:: classref-signal -**sprite_frames_changed**\ (\ ) +**sprite_frames_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`sprite_frames` changes. @@ -164,7 +164,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **animation** = ``&"default"`` +:ref:`StringName` **animation** = ``&"default"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ The current animation from the :ref:`sprite_frames` **autoplay** = ``""`` +:ref:`String` **autoplay** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ The key of the animation to play when the scene loads. .. rst-class:: classref-property -:ref:`bool` **centered** = ``true`` +:ref:`bool` **centered** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If ``true``, texture will be centered. .. rst-class:: classref-property -:ref:`bool` **flip_h** = ``false`` +:ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -234,7 +234,7 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property -:ref:`bool` **flip_v** = ``false`` +:ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -251,7 +251,7 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property -:ref:`int` **frame** = ``0`` +:ref:`int` **frame** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -268,7 +268,7 @@ The displayed animation frame's index. Setting this property also resets :ref:`f .. rst-class:: classref-property -:ref:`float` **frame_progress** = ``0.0`` +:ref:`float` **frame_progress** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -285,7 +285,7 @@ The progress value between ``0.0`` and ``1.0`` until the current frame transitio .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -302,7 +302,7 @@ The texture's drawing offset. .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -321,7 +321,7 @@ If set to a negative value, the animation is played in reverse. If set to ``0``, .. rst-class:: classref-property -:ref:`SpriteFrames` **sprite_frames** +:ref:`SpriteFrames` **sprite_frames** :ref:`🔗` .. rst-class:: classref-property-setget @@ -343,7 +343,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playing_speed**\ (\ ) |const| +:ref:`float` **get_playing_speed**\ (\ ) |const| :ref:`🔗` Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -357,7 +357,7 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`bool` **is_playing**\ (\ ) |const| +:ref:`bool` **is_playing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale` and/or ``custom_speed`` are ``0``). @@ -369,7 +369,7 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale .. rst-class:: classref-method -|void| **pause**\ (\ ) +|void| **pause**\ (\ ) :ref:`🔗` Pauses the currently playing animation. The :ref:`frame` and :ref:`frame_progress` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments will resume the animation from the current playback position. @@ -383,7 +383,7 @@ See also :ref:`stop`. .. rst-class:: classref-method -|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) +|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) :ref:`🔗` Plays the animation with key ``name``. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards`). @@ -397,7 +397,7 @@ If this method is called with that same animation ``name``, or with no ``name`` .. rst-class:: classref-method -|void| **play_backwards**\ (\ name\: :ref:`StringName` = &""\ ) +|void| **play_backwards**\ (\ name\: :ref:`StringName` = &""\ ) :ref:`🔗` Plays the animation with key ``name`` in reverse. @@ -411,7 +411,7 @@ This method is a shorthand for :ref:`play` w .. rst-class:: classref-method -|void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) +|void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) :ref:`🔗` The setter of :ref:`frame` resets the :ref:`frame_progress` to ``0.0`` implicitly, but this method avoids that. @@ -440,7 +440,7 @@ This is useful when you want to carry over the current :ref:`frame_progress` Stops the currently playing animation. The animation position is reset to ``0`` and the ``custom_speed`` is reset to ``1.0``. See also :ref:`pause`. diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 2611ed6cf24..46feb6c7589 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -87,7 +87,7 @@ Signals .. rst-class:: classref-signal -**animation_changed**\ (\ ) +**animation_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`animation` changes. @@ -99,7 +99,7 @@ Emitted when :ref:`animation` changes .. rst-class:: classref-signal -**animation_finished**\ (\ ) +**animation_finished**\ (\ ) :ref:`🔗` Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback. @@ -113,7 +113,7 @@ Emitted when the animation reaches the end, or the start if it is played in reve .. rst-class:: classref-signal -**animation_looped**\ (\ ) +**animation_looped**\ (\ ) :ref:`🔗` Emitted when the animation loops. @@ -125,7 +125,7 @@ Emitted when the animation loops. .. rst-class:: classref-signal -**frame_changed**\ (\ ) +**frame_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`frame` changes. @@ -137,7 +137,7 @@ Emitted when :ref:`frame` changes. .. rst-class:: classref-signal -**sprite_frames_changed**\ (\ ) +**sprite_frames_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`sprite_frames` changes. @@ -154,7 +154,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **animation** = ``&"default"`` +:ref:`StringName` **animation** = ``&"default"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ The current animation from the :ref:`sprite_frames` **autoplay** = ``""`` +:ref:`String` **autoplay** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ The key of the animation to play when the scene loads. .. rst-class:: classref-property -:ref:`int` **frame** = ``0`` +:ref:`int` **frame** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ The displayed animation frame's index. Setting this property also resets :ref:`f .. rst-class:: classref-property -:ref:`float` **frame_progress** = ``0.0`` +:ref:`float` **frame_progress** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ The progress value between ``0.0`` and ``1.0`` until the current frame transitio .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ If set to a negative value, the animation is played in reverse. If set to ``0``, .. rst-class:: classref-property -:ref:`SpriteFrames` **sprite_frames** +:ref:`SpriteFrames` **sprite_frames** :ref:`🔗` .. rst-class:: classref-property-setget @@ -263,7 +263,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playing_speed**\ (\ ) |const| +:ref:`float` **get_playing_speed**\ (\ ) |const| :ref:`🔗` Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -277,7 +277,7 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`bool` **is_playing**\ (\ ) |const| +:ref:`bool` **is_playing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale` and/or ``custom_speed`` are ``0``). @@ -289,7 +289,7 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale .. rst-class:: classref-method -|void| **pause**\ (\ ) +|void| **pause**\ (\ ) :ref:`🔗` Pauses the currently playing animation. The :ref:`frame` and :ref:`frame_progress` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments will resume the animation from the current playback position. @@ -303,7 +303,7 @@ See also :ref:`stop`. .. rst-class:: classref-method -|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) +|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) :ref:`🔗` Plays the animation with key ``name``. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards`). @@ -317,7 +317,7 @@ If this method is called with that same animation ``name``, or with no ``name`` .. rst-class:: classref-method -|void| **play_backwards**\ (\ name\: :ref:`StringName` = &""\ ) +|void| **play_backwards**\ (\ name\: :ref:`StringName` = &""\ ) :ref:`🔗` Plays the animation with key ``name`` in reverse. @@ -331,7 +331,7 @@ This method is a shorthand for :ref:`play` w .. rst-class:: classref-method -|void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) +|void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) :ref:`🔗` The setter of :ref:`frame` resets the :ref:`frame_progress` to ``0.0`` implicitly, but this method avoids that. @@ -360,7 +360,7 @@ This is useful when you want to carry over the current :ref:`frame_progress` Stops the currently playing animation. The animation position is reset to ``0`` and the ``custom_speed`` is reset to ``1.0``. See also :ref:`pause`. diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 61d15057e2f..da38191a1f6 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -84,7 +84,7 @@ Constants .. rst-class:: classref-constant -**MAX_FRAMES** = ``256`` +**MAX_FRAMES** = ``256`` :ref:`🔗` The maximum number of frames supported by **AnimatedTexture**. If you need more frames in your animation, use :ref:`AnimationPlayer` or :ref:`AnimatedSprite2D`. @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **current_frame** +:ref:`int` **current_frame** :ref:`🔗` .. rst-class:: classref-property-setget @@ -118,7 +118,7 @@ Sets the currently visible frame of the texture. Setting this frame while playin .. rst-class:: classref-property -:ref:`int` **frames** = ``1`` +:ref:`int` **frames** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -135,7 +135,7 @@ Number of frames to use in the animation. While you can create the frames indepe .. rst-class:: classref-property -:ref:`bool` **one_shot** = ``false`` +:ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ If ``true``, the animation will only play once and will not loop back to the fir .. rst-class:: classref-property -:ref:`bool` **pause** = ``false`` +:ref:`bool` **pause** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ If ``true``, the animation will pause where it currently is (i.e. at :ref:`curre .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_frame_duration**\ (\ frame\: :ref:`int`\ ) |const| +:ref:`float` **get_frame_duration**\ (\ frame\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given ``frame``'s duration, in seconds. @@ -203,7 +203,7 @@ Returns the given ``frame``'s duration, in seconds. .. rst-class:: classref-method -:ref:`Texture2D` **get_frame_texture**\ (\ frame\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_frame_texture**\ (\ frame\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given frame's :ref:`Texture2D`. @@ -215,7 +215,7 @@ Returns the given frame's :ref:`Texture2D`. .. rst-class:: classref-method -|void| **set_frame_duration**\ (\ frame\: :ref:`int`, duration\: :ref:`float`\ ) +|void| **set_frame_duration**\ (\ frame\: :ref:`int`, duration\: :ref:`float`\ ) :ref:`🔗` Sets the duration of any given ``frame``. The final duration is affected by the :ref:`speed_scale`. If set to ``0``, the frame is skipped during playback. @@ -227,7 +227,7 @@ Sets the duration of any given ``frame``. The final duration is affected by the .. rst-class:: classref-method -|void| **set_frame_texture**\ (\ frame\: :ref:`int`, texture\: :ref:`Texture2D`\ ) +|void| **set_frame_texture**\ (\ frame\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Assigns a :ref:`Texture2D` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames` - 1. diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 2a9cdeebcfe..4f1852b7c16 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -234,7 +234,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TrackType**: +enum **TrackType**: :ref:`🔗` .. _class_Animation_constant_TYPE_VALUE: @@ -316,7 +316,7 @@ Animation tracks play animations in other :ref:`AnimationPlayer` .. _class_Animation_constant_INTERPOLATION_NEAREST: @@ -370,7 +370,7 @@ Cubic interpolation with shortest path rotation. .. rst-class:: classref-enumeration -enum **UpdateMode**: +enum **UpdateMode**: :ref:`🔗` .. _class_Animation_constant_UPDATE_CONTINUOUS: @@ -404,7 +404,7 @@ Same as :ref:`UPDATE_CONTINUOUS` but .. rst-class:: classref-enumeration -enum **LoopMode**: +enum **LoopMode**: :ref:`🔗` .. _class_Animation_constant_LOOP_NONE: @@ -438,7 +438,7 @@ Repeats playback and reverse playback at both ends of the animation. .. rst-class:: classref-enumeration -enum **LoopedFlag**: +enum **LoopedFlag**: :ref:`🔗` .. _class_Animation_constant_LOOPED_FLAG_NONE: @@ -472,7 +472,7 @@ This flag indicates that the animation has reached the start of the animation an .. rst-class:: classref-enumeration -enum **FindMode**: +enum **FindMode**: :ref:`🔗` .. _class_Animation_constant_FIND_MODE_NEAREST: @@ -511,7 +511,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **capture_included** = ``false`` +:ref:`bool` **capture_included** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -527,7 +527,7 @@ Returns ``true`` if the capture track is included. This is a cached readonly val .. rst-class:: classref-property -:ref:`float` **length** = ``1.0`` +:ref:`float` **length** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -546,7 +546,7 @@ The total length of the animation (in seconds). .. rst-class:: classref-property -:ref:`LoopMode` **loop_mode** = ``0`` +:ref:`LoopMode` **loop_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -563,7 +563,7 @@ Determines the behavior of both ends of the animation timeline during animation .. rst-class:: classref-property -:ref:`float` **step** = ``0.0333333`` +:ref:`float` **step** = ``0.0333333`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -585,7 +585,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_track**\ (\ type\: :ref:`TrackType`, at_position\: :ref:`int` = -1\ ) +:ref:`int` **add_track**\ (\ type\: :ref:`TrackType`, at_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a track to the Animation. @@ -597,7 +597,7 @@ Adds a track to the Animation. .. rst-class:: classref-method -:ref:`StringName` **animation_track_get_key_animation**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **animation_track_get_key_animation**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the animation name at the key identified by ``key_idx``. The ``track_idx`` must be the index of an Animation Track. @@ -609,7 +609,7 @@ Returns the animation name at the key identified by ``key_idx``. The ``track_idx .. rst-class:: classref-method -:ref:`int` **animation_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, animation\: :ref:`StringName`\ ) +:ref:`int` **animation_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, animation\: :ref:`StringName`\ ) :ref:`🔗` Inserts a key with value ``animation`` at the given ``time`` (in seconds). The ``track_idx`` must be the index of an Animation Track. @@ -621,7 +621,7 @@ Inserts a key with value ``animation`` at the given ``time`` (in seconds). The ` .. rst-class:: classref-method -|void| **animation_track_set_key_animation**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, animation\: :ref:`StringName`\ ) +|void| **animation_track_set_key_animation**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, animation\: :ref:`StringName`\ ) :ref:`🔗` Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` must be the index of an Animation Track. @@ -633,7 +633,7 @@ Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` .. rst-class:: classref-method -:ref:`float` **audio_track_get_key_end_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`float` **audio_track_get_key_end_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the end offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -647,7 +647,7 @@ End offset is the number of seconds cut off at the ending of the audio stream. .. rst-class:: classref-method -:ref:`float` **audio_track_get_key_start_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`float` **audio_track_get_key_start_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the start offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -661,7 +661,7 @@ Start offset is the number of seconds cut off at the beginning of the audio stre .. rst-class:: classref-method -:ref:`Resource` **audio_track_get_key_stream**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`Resource` **audio_track_get_key_stream**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -673,7 +673,7 @@ Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` .. rst-class:: classref-method -:ref:`int` **audio_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, stream\: :ref:`Resource`, start_offset\: :ref:`float` = 0, end_offset\: :ref:`float` = 0\ ) +:ref:`int` **audio_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, stream\: :ref:`Resource`, start_offset\: :ref:`float` = 0, end_offset\: :ref:`float` = 0\ ) :ref:`🔗` Inserts an Audio Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of an Audio Track. @@ -687,7 +687,7 @@ Inserts an Audio Track key at the given ``time`` in seconds. The ``track_idx`` m .. rst-class:: classref-method -:ref:`bool` **audio_track_is_use_blend**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`bool` **audio_track_is_use_blend**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the track at ``track_idx`` will be blended with other animations. @@ -699,7 +699,7 @@ Returns ``true`` if the track at ``track_idx`` will be blended with other animat .. rst-class:: classref-method -|void| **audio_track_set_key_end_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) +|void| **audio_track_set_key_end_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the end offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. @@ -711,7 +711,7 @@ Sets the end offset of the key identified by ``key_idx`` to value ``offset``. Th .. rst-class:: classref-method -|void| **audio_track_set_key_start_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) +|void| **audio_track_set_key_start_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the start offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. @@ -723,7 +723,7 @@ Sets the start offset of the key identified by ``key_idx`` to value ``offset``. .. rst-class:: classref-method -|void| **audio_track_set_key_stream**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, stream\: :ref:`Resource`\ ) +|void| **audio_track_set_key_stream**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, stream\: :ref:`Resource`\ ) :ref:`🔗` Sets the stream of the key identified by ``key_idx`` to value ``stream``. The ``track_idx`` must be the index of an Audio Track. @@ -735,7 +735,7 @@ Sets the stream of the key identified by ``key_idx`` to value ``stream``. The `` .. rst-class:: classref-method -|void| **audio_track_set_use_blend**\ (\ track_idx\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **audio_track_set_use_blend**\ (\ track_idx\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the track will be blended with other animations. If ``true``, the audio playback volume changes depending on the blend value. @@ -747,7 +747,7 @@ Sets whether the track will be blended with other animations. If ``true``, the a .. rst-class:: classref-method -:ref:`Vector2` **bezier_track_get_key_in_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **bezier_track_get_key_in_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -759,7 +759,7 @@ Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` mu .. rst-class:: classref-method -:ref:`Vector2` **bezier_track_get_key_out_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **bezier_track_get_key_out_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -771,7 +771,7 @@ Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` m .. rst-class:: classref-method -:ref:`float` **bezier_track_get_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`float` **bezier_track_get_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -783,7 +783,7 @@ Returns the value of the key identified by ``key_idx``. The ``track_idx`` must b .. rst-class:: classref-method -:ref:`int` **bezier_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, value\: :ref:`float`, in_handle\: :ref:`Vector2` = Vector2(0, 0), out_handle\: :ref:`Vector2` = Vector2(0, 0)\ ) +:ref:`int` **bezier_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, value\: :ref:`float`, in_handle\: :ref:`Vector2` = Vector2(0, 0), out_handle\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of a Bezier Track. @@ -797,7 +797,7 @@ Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` m .. rst-class:: classref-method -:ref:`float` **bezier_track_interpolate**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) |const| +:ref:`float` **bezier_track_interpolate**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) |const| :ref:`🔗` Returns the interpolated value at the given ``time`` (in seconds). The ``track_idx`` must be the index of a Bezier Track. @@ -809,7 +809,7 @@ Returns the interpolated value at the given ``time`` (in seconds). The ``track_i .. rst-class:: classref-method -|void| **bezier_track_set_key_in_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, in_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) +|void| **bezier_track_set_key_in_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, in_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) :ref:`🔗` Sets the in handle of the key identified by ``key_idx`` to value ``in_handle``. The ``track_idx`` must be the index of a Bezier Track. @@ -821,7 +821,7 @@ Sets the in handle of the key identified by ``key_idx`` to value ``in_handle``. .. rst-class:: classref-method -|void| **bezier_track_set_key_out_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, out_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) +|void| **bezier_track_set_key_out_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, out_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) :ref:`🔗` Sets the out handle of the key identified by ``key_idx`` to value ``out_handle``. The ``track_idx`` must be the index of a Bezier Track. @@ -833,7 +833,7 @@ Sets the out handle of the key identified by ``key_idx`` to value ``out_handle`` .. rst-class:: classref-method -|void| **bezier_track_set_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, value\: :ref:`float`\ ) +|void| **bezier_track_set_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the key identified by ``key_idx`` to the given value. The ``track_idx`` must be the index of a Bezier Track. @@ -845,7 +845,7 @@ Sets the value of the key identified by ``key_idx`` to the given value. The ``tr .. rst-class:: classref-method -:ref:`int` **blend_shape_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, amount\: :ref:`float`\ ) +:ref:`int` **blend_shape_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, amount\: :ref:`float`\ ) :ref:`🔗` Inserts a key in a given blend shape track. Returns the key index. @@ -857,7 +857,7 @@ Inserts a key in a given blend shape track. Returns the key index. .. rst-class:: classref-method -:ref:`float` **blend_shape_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| +:ref:`float` **blend_shape_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the interpolated blend shape value at the given time (in seconds). The ``track_idx`` must be the index of a blend shape track. @@ -869,7 +869,7 @@ Returns the interpolated blend shape value at the given time (in seconds). The ` .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clear the animation (clear all tracks and reset all). @@ -881,7 +881,7 @@ Clear the animation (clear all tracks and reset all). .. rst-class:: classref-method -|void| **compress**\ (\ page_size\: :ref:`int` = 8192, fps\: :ref:`int` = 120, split_tolerance\: :ref:`float` = 4.0\ ) +|void| **compress**\ (\ page_size\: :ref:`int` = 8192, fps\: :ref:`int` = 120, split_tolerance\: :ref:`float` = 4.0\ ) :ref:`🔗` Compress the animation and all its tracks in-place. This will make :ref:`track_is_compressed` return ``true`` once called on this **Animation**. Compressed tracks require less memory to be played, and are designed to be used for complex 3D animations (such as cutscenes) imported from external 3D software. Compression is lossy, but the difference is usually not noticeable in real world conditions. @@ -895,7 +895,7 @@ Compress the animation and all its tracks in-place. This will make :ref:`track_i .. rst-class:: classref-method -|void| **copy_track**\ (\ track_idx\: :ref:`int`, to_animation\: :ref:`Animation`\ ) +|void| **copy_track**\ (\ track_idx\: :ref:`int`, to_animation\: :ref:`Animation`\ ) :ref:`🔗` Adds a new track to ``to_animation`` that is a copy of the given track from this animation. @@ -907,7 +907,7 @@ Adds a new track to ``to_animation`` that is a copy of the given track from this .. rst-class:: classref-method -:ref:`int` **find_track**\ (\ path\: :ref:`NodePath`, type\: :ref:`TrackType`\ ) |const| +:ref:`int` **find_track**\ (\ path\: :ref:`NodePath`, type\: :ref:`TrackType`\ ) |const| :ref:`🔗` Returns the index of the specified track. If the track is not found, return -1. @@ -919,7 +919,7 @@ Returns the index of the specified track. If the track is not found, return -1. .. rst-class:: classref-method -:ref:`int` **get_track_count**\ (\ ) |const| +:ref:`int` **get_track_count**\ (\ ) |const| :ref:`🔗` Returns the amount of tracks in the animation. @@ -931,7 +931,7 @@ Returns the amount of tracks in the animation. .. rst-class:: classref-method -:ref:`StringName` **method_track_get_name**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **method_track_get_name**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the method name of a method track. @@ -943,7 +943,7 @@ Returns the method name of a method track. .. rst-class:: classref-method -:ref:`Array` **method_track_get_params**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`Array` **method_track_get_params**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the arguments values to be called on a method track for a given key in a given track. @@ -955,7 +955,7 @@ Returns the arguments values to be called on a method track for a given key in a .. rst-class:: classref-method -:ref:`int` **position_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, position\: :ref:`Vector3`\ ) +:ref:`int` **position_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, position\: :ref:`Vector3`\ ) :ref:`🔗` Inserts a key in a given 3D position track. Returns the key index. @@ -967,7 +967,7 @@ Inserts a key in a given 3D position track. Returns the key index. .. rst-class:: classref-method -:ref:`Vector3` **position_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| +:ref:`Vector3` **position_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the interpolated position value at the given time (in seconds). The ``track_idx`` must be the index of a 3D position track. @@ -979,7 +979,7 @@ Returns the interpolated position value at the given time (in seconds). The ``tr .. rst-class:: classref-method -|void| **remove_track**\ (\ track_idx\: :ref:`int`\ ) +|void| **remove_track**\ (\ track_idx\: :ref:`int`\ ) :ref:`🔗` Removes a track by specifying the track index. @@ -991,7 +991,7 @@ Removes a track by specifying the track index. .. rst-class:: classref-method -:ref:`int` **rotation_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, rotation\: :ref:`Quaternion`\ ) +:ref:`int` **rotation_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, rotation\: :ref:`Quaternion`\ ) :ref:`🔗` Inserts a key in a given 3D rotation track. Returns the key index. @@ -1003,7 +1003,7 @@ Inserts a key in a given 3D rotation track. Returns the key index. .. rst-class:: classref-method -:ref:`Quaternion` **rotation_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| +:ref:`Quaternion` **rotation_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the interpolated rotation value at the given time (in seconds). The ``track_idx`` must be the index of a 3D rotation track. @@ -1015,7 +1015,7 @@ Returns the interpolated rotation value at the given time (in seconds). The ``tr .. rst-class:: classref-method -:ref:`int` **scale_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, scale\: :ref:`Vector3`\ ) +:ref:`int` **scale_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, scale\: :ref:`Vector3`\ ) :ref:`🔗` Inserts a key in a given 3D scale track. Returns the key index. @@ -1027,7 +1027,7 @@ Inserts a key in a given 3D scale track. Returns the key index. .. rst-class:: classref-method -:ref:`Vector3` **scale_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| +:ref:`Vector3` **scale_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the interpolated scale value at the given time (in seconds). The ``track_idx`` must be the index of a 3D scale track. @@ -1039,7 +1039,7 @@ Returns the interpolated scale value at the given time (in seconds). The ``track .. rst-class:: classref-method -:ref:`int` **track_find_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false\ ) |const| +:ref:`int` **track_find_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false\ ) |const| :ref:`🔗` Finds the key index by time in a given track. Optionally, only find it if the approx/exact time is given. @@ -1053,7 +1053,7 @@ If ``limit`` is ``true``, it does not return keys outside the animation range. .. rst-class:: classref-method -:ref:`bool` **track_get_interpolation_loop_wrap**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`bool` **track_get_interpolation_loop_wrap**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the track at ``track_idx`` wraps the interpolation loop. New tracks wrap the interpolation loop by default. @@ -1065,7 +1065,7 @@ Returns ``true`` if the track at ``track_idx`` wraps the interpolation loop. New .. rst-class:: classref-method -:ref:`InterpolationType` **track_get_interpolation_type**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`InterpolationType` **track_get_interpolation_type**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the interpolation type of a given track. @@ -1077,7 +1077,7 @@ Returns the interpolation type of a given track. .. rst-class:: classref-method -:ref:`int` **track_get_key_count**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`int` **track_get_key_count**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of keys in a given track. @@ -1089,7 +1089,7 @@ Returns the number of keys in a given track. .. rst-class:: classref-method -:ref:`float` **track_get_key_time**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`float` **track_get_key_time**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the time at which the key is located. @@ -1101,7 +1101,7 @@ Returns the time at which the key is located. .. rst-class:: classref-method -:ref:`float` **track_get_key_transition**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`float` **track_get_key_transition**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transition curve (easing) for a specific key (see the built-in math function :ref:`@GlobalScope.ease`). @@ -1113,7 +1113,7 @@ Returns the transition curve (easing) for a specific key (see the built-in math .. rst-class:: classref-method -:ref:`Variant` **track_get_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| +:ref:`Variant` **track_get_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of a given key in a given track. @@ -1125,7 +1125,7 @@ Returns the value of a given key in a given track. .. rst-class:: classref-method -:ref:`NodePath` **track_get_path**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **track_get_path**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Gets the path of a track. For more information on the path format, see :ref:`track_set_path`. @@ -1137,7 +1137,7 @@ Gets the path of a track. For more information on the path format, see :ref:`tra .. rst-class:: classref-method -:ref:`TrackType` **track_get_type**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`TrackType` **track_get_type**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Gets the type of a track. @@ -1149,7 +1149,7 @@ Gets the type of a track. .. rst-class:: classref-method -:ref:`int` **track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, key\: :ref:`Variant`, transition\: :ref:`float` = 1\ ) +:ref:`int` **track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, key\: :ref:`Variant`, transition\: :ref:`float` = 1\ ) :ref:`🔗` Inserts a generic key in a given track. Returns the key index. @@ -1161,7 +1161,7 @@ Inserts a generic key in a given track. Returns the key index. .. rst-class:: classref-method -:ref:`bool` **track_is_compressed**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`bool` **track_is_compressed**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the track is compressed, ``false`` otherwise. See also :ref:`compress`. @@ -1173,7 +1173,7 @@ Returns ``true`` if the track is compressed, ``false`` otherwise. See also :ref: .. rst-class:: classref-method -:ref:`bool` **track_is_enabled**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`bool` **track_is_enabled**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the track at index ``track_idx`` is enabled. @@ -1185,7 +1185,7 @@ Returns ``true`` if the track at index ``track_idx`` is enabled. .. rst-class:: classref-method -:ref:`bool` **track_is_imported**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`bool` **track_is_imported**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given track is imported. Else, return ``false``. @@ -1197,7 +1197,7 @@ Returns ``true`` if the given track is imported. Else, return ``false``. .. rst-class:: classref-method -|void| **track_move_down**\ (\ track_idx\: :ref:`int`\ ) +|void| **track_move_down**\ (\ track_idx\: :ref:`int`\ ) :ref:`🔗` Moves a track down. @@ -1209,7 +1209,7 @@ Moves a track down. .. rst-class:: classref-method -|void| **track_move_to**\ (\ track_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) +|void| **track_move_to**\ (\ track_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) :ref:`🔗` Changes the index position of track ``track_idx`` to the one defined in ``to_idx``. @@ -1221,7 +1221,7 @@ Changes the index position of track ``track_idx`` to the one defined in ``to_idx .. rst-class:: classref-method -|void| **track_move_up**\ (\ track_idx\: :ref:`int`\ ) +|void| **track_move_up**\ (\ track_idx\: :ref:`int`\ ) :ref:`🔗` Moves a track up. @@ -1233,7 +1233,7 @@ Moves a track up. .. rst-class:: classref-method -|void| **track_remove_key**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) +|void| **track_remove_key**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) :ref:`🔗` Removes a key by index in a given track. @@ -1245,7 +1245,7 @@ Removes a key by index in a given track. .. rst-class:: classref-method -|void| **track_remove_key_at_time**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) +|void| **track_remove_key_at_time**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) :ref:`🔗` Removes a key at ``time`` in a given track. @@ -1257,7 +1257,7 @@ Removes a key at ``time`` in a given track. .. rst-class:: classref-method -|void| **track_set_enabled**\ (\ track_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) +|void| **track_set_enabled**\ (\ track_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables/disables the given track. Tracks are enabled by default. @@ -1269,7 +1269,7 @@ Enables/disables the given track. Tracks are enabled by default. .. rst-class:: classref-method -|void| **track_set_imported**\ (\ track_idx\: :ref:`int`, imported\: :ref:`bool`\ ) +|void| **track_set_imported**\ (\ track_idx\: :ref:`int`, imported\: :ref:`bool`\ ) :ref:`🔗` Sets the given track as imported or not. @@ -1281,7 +1281,7 @@ Sets the given track as imported or not. .. rst-class:: classref-method -|void| **track_set_interpolation_loop_wrap**\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`bool`\ ) +|void| **track_set_interpolation_loop_wrap**\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the track at ``track_idx`` wraps the interpolation loop. @@ -1293,7 +1293,7 @@ If ``true``, the track at ``track_idx`` wraps the interpolation loop. .. rst-class:: classref-method -|void| **track_set_interpolation_type**\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`InterpolationType`\ ) +|void| **track_set_interpolation_type**\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`InterpolationType`\ ) :ref:`🔗` Sets the interpolation type of a given track. @@ -1305,7 +1305,7 @@ Sets the interpolation type of a given track. .. rst-class:: classref-method -|void| **track_set_key_time**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, time\: :ref:`float`\ ) +|void| **track_set_key_time**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, time\: :ref:`float`\ ) :ref:`🔗` Sets the time of an existing key. @@ -1317,7 +1317,7 @@ Sets the time of an existing key. .. rst-class:: classref-method -|void| **track_set_key_transition**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, transition\: :ref:`float`\ ) +|void| **track_set_key_transition**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, transition\: :ref:`float`\ ) :ref:`🔗` Sets the transition curve (easing) for a specific key (see the built-in math function :ref:`@GlobalScope.ease`). @@ -1329,7 +1329,7 @@ Sets the transition curve (easing) for a specific key (see the built-in math fun .. rst-class:: classref-method -|void| **track_set_key_value**\ (\ track_idx\: :ref:`int`, key\: :ref:`int`, value\: :ref:`Variant`\ ) +|void| **track_set_key_value**\ (\ track_idx\: :ref:`int`, key\: :ref:`int`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the value of an existing key. @@ -1341,7 +1341,7 @@ Sets the value of an existing key. .. rst-class:: classref-method -|void| **track_set_path**\ (\ track_idx\: :ref:`int`, path\: :ref:`NodePath`\ ) +|void| **track_set_path**\ (\ track_idx\: :ref:`int`, path\: :ref:`NodePath`\ ) :ref:`🔗` Sets the path of a track. Paths must be valid scene-tree paths to a node and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ``":"``. @@ -1355,7 +1355,7 @@ For example, ``"character/skeleton:ankle"`` or ``"character/mesh:transform/local .. rst-class:: classref-method -|void| **track_swap**\ (\ track_idx\: :ref:`int`, with_idx\: :ref:`int`\ ) +|void| **track_swap**\ (\ track_idx\: :ref:`int`, with_idx\: :ref:`int`\ ) :ref:`🔗` Swaps the track ``track_idx``'s index position with the track ``with_idx``. @@ -1367,7 +1367,7 @@ Swaps the track ``track_idx``'s index position with the track ``with_idx``. .. rst-class:: classref-method -:ref:`UpdateMode` **value_track_get_update_mode**\ (\ track_idx\: :ref:`int`\ ) |const| +:ref:`UpdateMode` **value_track_get_update_mode**\ (\ track_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the update mode of a value track. @@ -1379,7 +1379,7 @@ Returns the update mode of a value track. .. rst-class:: classref-method -:ref:`Variant` **value_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| +:ref:`Variant` **value_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the interpolated value at the given time (in seconds). The ``track_idx`` must be the index of a value track. @@ -1391,7 +1391,7 @@ Returns the interpolated value at the given time (in seconds). The ``track_idx`` .. rst-class:: classref-method -|void| **value_track_set_update_mode**\ (\ track_idx\: :ref:`int`, mode\: :ref:`UpdateMode`\ ) +|void| **value_track_set_update_mode**\ (\ track_idx\: :ref:`int`, mode\: :ref:`UpdateMode`\ ) :ref:`🔗` Sets the update mode (see :ref:`UpdateMode`) of a value track. diff --git a/classes/class_animationlibrary.rst b/classes/class_animationlibrary.rst index 6a2d6d212ba..458c410a0a3 100644 --- a/classes/class_animationlibrary.rst +++ b/classes/class_animationlibrary.rst @@ -63,7 +63,7 @@ Signals .. rst-class:: classref-signal -**animation_added**\ (\ name\: :ref:`StringName`\ ) +**animation_added**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when an :ref:`Animation` is added, under the key ``name``. @@ -75,7 +75,7 @@ Emitted when an :ref:`Animation` is added, under the key ``name .. rst-class:: classref-signal -**animation_changed**\ (\ name\: :ref:`StringName`\ ) +**animation_changed**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when there's a change in one of the animations, e.g. tracks are added, moved or have changed paths. ``name`` is the key of the animation that was changed. @@ -89,7 +89,7 @@ See also :ref:`Resource.changed`, which this acts .. rst-class:: classref-signal -**animation_removed**\ (\ name\: :ref:`StringName`\ ) +**animation_removed**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when an :ref:`Animation` stored with the key ``name`` is removed. @@ -101,7 +101,7 @@ Emitted when an :ref:`Animation` stored with the key ``name`` i .. rst-class:: classref-signal -**animation_renamed**\ (\ name\: :ref:`StringName`, to_name\: :ref:`StringName`\ ) +**animation_renamed**\ (\ name\: :ref:`StringName`, to_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when the key for an :ref:`Animation` is changed, from ``name`` to ``to_name``. @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_animation**\ (\ name\: :ref:`StringName`, animation\: :ref:`Animation`\ ) +:ref:`Error` **add_animation**\ (\ name\: :ref:`StringName`, animation\: :ref:`Animation`\ ) :ref:`🔗` Adds the ``animation`` to the library, accessible by the key ``name``. @@ -130,7 +130,7 @@ Adds the ``animation`` to the library, accessible by the key ``name``. .. rst-class:: classref-method -:ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`Animation` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged. @@ -142,7 +142,7 @@ Returns the :ref:`Animation` with the key ``name``. If the anim .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_animation_list**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **get_animation_list**\ (\ ) |const| :ref:`🔗` Returns the keys for the :ref:`Animation`\ s stored in the library. @@ -154,7 +154,7 @@ Returns the keys for the :ref:`Animation`\ s stored in the libr .. rst-class:: classref-method -:ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the library stores an :ref:`Animation` with ``name`` as the key. @@ -166,7 +166,7 @@ Returns ``true`` if the library stores an :ref:`Animation` with .. rst-class:: classref-method -|void| **remove_animation**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_animation**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the :ref:`Animation` with the key ``name``. @@ -178,7 +178,7 @@ Removes the :ref:`Animation` with the key ``name``. .. rst-class:: classref-method -|void| **rename_animation**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) +|void| **rename_animation**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) :ref:`🔗` Changes the key of the :ref:`Animation` associated with the key ``name`` to ``newname``. diff --git a/classes/class_animationmixer.rst b/classes/class_animationmixer.rst index 8db5dde5034..f452889138d 100644 --- a/classes/class_animationmixer.rst +++ b/classes/class_animationmixer.rst @@ -38,7 +38,7 @@ Properties +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ | :ref:`int` | :ref:`audio_max_polyphony` | ``32`` | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ - | :ref:`AnimationCallbackModeDiscrete` | :ref:`callback_mode_discrete` | ``0`` | + | :ref:`AnimationCallbackModeDiscrete` | :ref:`callback_mode_discrete` | ``1`` | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ | :ref:`AnimationCallbackModeMethod` | :ref:`callback_mode_method` | ``0`` | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ @@ -118,7 +118,7 @@ Signals .. rst-class:: classref-signal -**animation_finished**\ (\ anim_name\: :ref:`StringName`\ ) +**animation_finished**\ (\ anim_name\: :ref:`StringName`\ ) :ref:`🔗` Notifies when an animation finished playing. @@ -132,7 +132,7 @@ Notifies when an animation finished playing. .. rst-class:: classref-signal -**animation_libraries_updated**\ (\ ) +**animation_libraries_updated**\ (\ ) :ref:`🔗` Notifies when the animation libraries have changed. @@ -144,7 +144,7 @@ Notifies when the animation libraries have changed. .. rst-class:: classref-signal -**animation_list_changed**\ (\ ) +**animation_list_changed**\ (\ ) :ref:`🔗` Notifies when an animation list is changed. @@ -156,7 +156,7 @@ Notifies when an animation list is changed. .. rst-class:: classref-signal -**animation_started**\ (\ anim_name\: :ref:`StringName`\ ) +**animation_started**\ (\ anim_name\: :ref:`StringName`\ ) :ref:`🔗` Notifies when an animation starts playing. @@ -168,7 +168,7 @@ Notifies when an animation starts playing. .. rst-class:: classref-signal -**caches_cleared**\ (\ ) +**caches_cleared**\ (\ ) :ref:`🔗` Notifies when the caches have been cleared, either automatically, or manually via :ref:`clear_caches`. @@ -180,7 +180,7 @@ Notifies when the caches have been cleared, either automatically, or manually vi .. rst-class:: classref-signal -**mixer_applied**\ (\ ) +**mixer_applied**\ (\ ) :ref:`🔗` Notifies when the blending result related have been applied to the target objects. @@ -192,7 +192,7 @@ Notifies when the blending result related have been applied to the target object .. rst-class:: classref-signal -**mixer_updated**\ (\ ) +**mixer_updated**\ (\ ) :ref:`🔗` Notifies when the property related process have been updated. @@ -209,7 +209,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AnimationCallbackModeProcess**: +enum **AnimationCallbackModeProcess**: :ref:`🔗` .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS: @@ -243,7 +243,7 @@ Do not process animation. Use :ref:`advance .. rst-class:: classref-enumeration -enum **AnimationCallbackModeMethod**: +enum **AnimationCallbackModeMethod**: :ref:`🔗` .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_METHOD_DEFERRED: @@ -269,7 +269,7 @@ Make method calls immediately when reached in the animation. .. rst-class:: classref-enumeration -enum **AnimationCallbackModeDiscrete**: +enum **AnimationCallbackModeDiscrete**: :ref:`🔗` .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT: @@ -277,9 +277,7 @@ enum **AnimationCallbackModeDiscrete**: :ref:`AnimationCallbackModeDiscrete` **ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT** = ``0`` -An :ref:`Animation.UPDATE_DISCRETE` track value takes precedence when blending :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track values and :ref:`Animation.UPDATE_DISCRETE` track values. This is the default behavior for :ref:`AnimationPlayer`. - -\ **Note:** If a value track has non-numeric type key values, it is internally converted to use :ref:`ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT` with :ref:`Animation.UPDATE_DISCRETE`. +An :ref:`Animation.UPDATE_DISCRETE` track value takes precedence when blending :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track values and :ref:`Animation.UPDATE_DISCRETE` track values. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE: @@ -287,7 +285,7 @@ An :ref:`Animation.UPDATE_DISCRETE` tr :ref:`AnimationCallbackModeDiscrete` **ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE** = ``1`` -An :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track value takes precedence when blending the :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track values and the :ref:`Animation.UPDATE_DISCRETE` track values. +An :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track value takes precedence when blending the :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track values and the :ref:`Animation.UPDATE_DISCRETE` track values. This is the default behavior for :ref:`AnimationPlayer`. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS: @@ -297,6 +295,8 @@ An :ref:`Animation.UPDATE_CONTINUOUS Always treat the :ref:`Animation.UPDATE_DISCRETE` track value as :ref:`Animation.UPDATE_CONTINUOUS` with :ref:`Animation.INTERPOLATION_NEAREST`. This is the default behavior for :ref:`AnimationTree`. +If a value track has non-numeric type key values, it is internally converted to use :ref:`ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE` with :ref:`Animation.UPDATE_DISCRETE`. + .. rst-class:: classref-section-separator ---- @@ -310,7 +310,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **active** = ``true`` +:ref:`bool` **active** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -327,7 +327,7 @@ If ``true``, the **AnimationMixer** will be processing. .. rst-class:: classref-property -:ref:`int` **audio_max_polyphony** = ``32`` +:ref:`int` **audio_max_polyphony** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -346,7 +346,7 @@ For example, if this value is ``32`` and the animation has two audio tracks, the .. rst-class:: classref-property -:ref:`AnimationCallbackModeDiscrete` **callback_mode_discrete** = ``0`` +:ref:`AnimationCallbackModeDiscrete` **callback_mode_discrete** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -367,7 +367,7 @@ To make the blended results look good, it is recommended to set this to :ref:`AN .. rst-class:: classref-property -:ref:`AnimationCallbackModeMethod` **callback_mode_method** = ``0`` +:ref:`AnimationCallbackModeMethod` **callback_mode_method** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -384,7 +384,7 @@ The call mode used for "Call Method" tracks. .. rst-class:: classref-property -:ref:`AnimationCallbackModeProcess` **callback_mode_process** = ``1`` +:ref:`AnimationCallbackModeProcess` **callback_mode_process** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -401,7 +401,7 @@ The process notification in which to update animations. .. rst-class:: classref-property -:ref:`bool` **deterministic** = ``false`` +:ref:`bool` **deterministic** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -428,7 +428,7 @@ For example, if :ref:`AnimationNodeAdd2` blends two nod .. rst-class:: classref-property -:ref:`bool` **reset_on_save** = ``true`` +:ref:`bool` **reset_on_save** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -447,7 +447,7 @@ This makes it more convenient to preview and edit animations in the editor, as c .. rst-class:: classref-property -:ref:`NodePath` **root_motion_track** = ``NodePath("")`` +:ref:`NodePath` **root_motion_track** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -466,7 +466,7 @@ If the track has type :ref:`Animation.TYPE_POSITION_3D` **root_node** = ``NodePath("..")`` +:ref:`NodePath` **root_node** = ``NodePath("..")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -488,7 +488,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_post_process_key_value**\ (\ animation\: :ref:`Animation`, track\: :ref:`int`, value\: :ref:`Variant`, object_id\: :ref:`int`, object_sub_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Variant` **_post_process_key_value**\ (\ animation\: :ref:`Animation`, track\: :ref:`int`, value\: :ref:`Variant`, object_id\: :ref:`int`, object_sub_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` A virtual function for processing after getting a key during playback. @@ -500,7 +500,7 @@ A virtual function for processing after getting a key during playback. .. rst-class:: classref-method -:ref:`Error` **add_animation_library**\ (\ name\: :ref:`StringName`, library\: :ref:`AnimationLibrary`\ ) +:ref:`Error` **add_animation_library**\ (\ name\: :ref:`StringName`, library\: :ref:`AnimationLibrary`\ ) :ref:`🔗` Adds ``library`` to the animation player, under the key ``name``. @@ -512,7 +512,7 @@ Adds ``library`` to the animation player, under the key ``name``. .. rst-class:: classref-method -|void| **advance**\ (\ delta\: :ref:`float`\ ) +|void| **advance**\ (\ delta\: :ref:`float`\ ) :ref:`🔗` Manually advance the animations by the specified time (in seconds). @@ -524,7 +524,7 @@ Manually advance the animations by the specified time (in seconds). .. rst-class:: classref-method -|void| **capture**\ (\ name\: :ref:`StringName`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) +|void| **capture**\ (\ name\: :ref:`StringName`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) :ref:`🔗` If the animation track specified by ``name`` has an option :ref:`Animation.UPDATE_CAPTURE`, stores current values of the objects indicated by the track path as a cache. If there is already a captured cache, the old cache is discarded. @@ -540,7 +540,7 @@ You can specify ``trans_type`` as the curve for the interpolation. For better re .. rst-class:: classref-method -|void| **clear_caches**\ (\ ) +|void| **clear_caches**\ (\ ) :ref:`🔗` **AnimationMixer** caches animated nodes. It may not notice if a node disappears; :ref:`clear_caches` forces it to update the cache again. @@ -552,7 +552,7 @@ You can specify ``trans_type`` as the curve for the interpolation. For better re .. rst-class:: classref-method -:ref:`StringName` **find_animation**\ (\ animation\: :ref:`Animation`\ ) |const| +:ref:`StringName` **find_animation**\ (\ animation\: :ref:`Animation`\ ) |const| :ref:`🔗` Returns the key of ``animation`` or an empty :ref:`StringName` if not found. @@ -564,7 +564,7 @@ Returns the key of ``animation`` or an empty :ref:`StringName` .. rst-class:: classref-method -:ref:`StringName` **find_animation_library**\ (\ animation\: :ref:`Animation`\ ) |const| +:ref:`StringName` **find_animation_library**\ (\ animation\: :ref:`Animation`\ ) |const| :ref:`🔗` Returns the key for the :ref:`AnimationLibrary` that contains ``animation`` or an empty :ref:`StringName` if not found. @@ -576,7 +576,7 @@ Returns the key for the :ref:`AnimationLibrary` that con .. rst-class:: classref-method -:ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`Animation` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged. @@ -588,7 +588,7 @@ Returns the :ref:`Animation` with the key ``name``. If the anim .. rst-class:: classref-method -:ref:`AnimationLibrary` **get_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`AnimationLibrary` **get_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the first :ref:`AnimationLibrary` with key ``name`` or ``null`` if not found. @@ -602,7 +602,7 @@ To get the **AnimationMixer**'s global animation library, use ``get_animation_li .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_animation_library_list**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **get_animation_library_list**\ (\ ) |const| :ref:`🔗` Returns the list of stored library keys. @@ -614,7 +614,7 @@ Returns the list of stored library keys. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_animation_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_animation_list**\ (\ ) |const| :ref:`🔗` Returns the list of stored animation keys. @@ -626,7 +626,7 @@ Returns the list of stored animation keys. .. rst-class:: classref-method -:ref:`Vector3` **get_root_motion_position**\ (\ ) |const| +:ref:`Vector3` **get_root_motion_position**\ (\ ) |const| :ref:`🔗` Retrieve the motion delta of position with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -678,7 +678,7 @@ By using this in combination with :ref:`get_root_motion_position_accumulator` **get_root_motion_position_accumulator**\ (\ ) |const| +:ref:`Vector3` **get_root_motion_position_accumulator**\ (\ ) |const| :ref:`🔗` Retrieve the blended value of the position tracks with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -713,7 +713,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi .. rst-class:: classref-method -:ref:`Quaternion` **get_root_motion_rotation**\ (\ ) |const| +:ref:`Quaternion` **get_root_motion_rotation**\ (\ ) |const| :ref:`🔗` Retrieve the motion delta of rotation with the :ref:`root_motion_track` as a :ref:`Quaternion` that can be used elsewhere. @@ -743,7 +743,7 @@ The most basic example is applying rotation to :ref:`CharacterBody3D` **get_root_motion_rotation_accumulator**\ (\ ) |const| +:ref:`Quaternion` **get_root_motion_rotation_accumulator**\ (\ ) |const| :ref:`🔗` Retrieve the blended value of the rotation tracks with the :ref:`root_motion_track` as a :ref:`Quaternion` that can be used elsewhere. @@ -780,7 +780,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi .. rst-class:: classref-method -:ref:`Vector3` **get_root_motion_scale**\ (\ ) |const| +:ref:`Vector3` **get_root_motion_scale**\ (\ ) |const| :ref:`🔗` Retrieve the motion delta of scale with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -816,7 +816,7 @@ The most basic example is applying scale to :ref:`CharacterBody3D` **get_root_motion_scale_accumulator**\ (\ ) |const| +:ref:`Vector3` **get_root_motion_scale_accumulator**\ (\ ) |const| :ref:`🔗` Retrieve the blended value of the scale tracks with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -849,7 +849,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi .. rst-class:: classref-method -:ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the **AnimationMixer** stores an :ref:`Animation` with key ``name``. @@ -861,7 +861,7 @@ Returns ``true`` if the **AnimationMixer** stores an :ref:`Animation` **has_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the **AnimationMixer** stores an :ref:`AnimationLibrary` with key ``name``. @@ -873,7 +873,7 @@ Returns ``true`` if the **AnimationMixer** stores an :ref:`AnimationLibrary`\ ) +|void| **remove_animation_library**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the :ref:`AnimationLibrary` associated with the key ``name``. @@ -885,7 +885,7 @@ Removes the :ref:`AnimationLibrary` associated with the .. rst-class:: classref-method -|void| **rename_animation_library**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) +|void| **rename_animation_library**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) :ref:`🔗` Moves the :ref:`AnimationLibrary` associated with the key ``name`` to the key ``newname``. diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 425b3873193..4131ee692e4 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -119,7 +119,7 @@ Signals .. rst-class:: classref-signal -**animation_node_removed**\ (\ object_id\: :ref:`int`, name\: :ref:`String`\ ) +**animation_node_removed**\ (\ object_id\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Emitted by nodes that inherit from this class and that have an internal tree when one of their animation nodes removes. The animation nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, and :ref:`AnimationNodeBlendTree`. @@ -131,7 +131,7 @@ Emitted by nodes that inherit from this class and that have an internal tree whe .. rst-class:: classref-signal -**animation_node_renamed**\ (\ object_id\: :ref:`int`, old_name\: :ref:`String`, new_name\: :ref:`String`\ ) +**animation_node_renamed**\ (\ object_id\: :ref:`int`, old_name\: :ref:`String`, new_name\: :ref:`String`\ ) :ref:`🔗` Emitted by nodes that inherit from this class and that have an internal tree when one of their animation node names changes. The animation nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, and :ref:`AnimationNodeBlendTree`. @@ -143,7 +143,7 @@ Emitted by nodes that inherit from this class and that have an internal tree whe .. rst-class:: classref-signal -**tree_changed**\ (\ ) +**tree_changed**\ (\ ) :ref:`🔗` Emitted by nodes that inherit from this class and that have an internal tree when one of their animation nodes changes. The animation nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendTree` and :ref:`AnimationNodeTransition`. @@ -160,7 +160,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FilterAction**: +enum **FilterAction**: :ref:`🔗` .. _class_AnimationNode_constant_FILTER_IGNORE: @@ -207,7 +207,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **filter_enabled** +:ref:`bool` **filter_enabled** :ref:`🔗` .. rst-class:: classref-property-setget @@ -229,7 +229,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_caption**\ (\ ) |virtual| |const| +:ref:`String` **_get_caption**\ (\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to override the text caption for this animation node. @@ -241,7 +241,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`AnimationNode` **_get_child_by_name**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| +:ref:`AnimationNode` **_get_child_by_name**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return a child animation node by its ``name``. @@ -253,7 +253,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`Dictionary` **_get_child_nodes**\ (\ ) |virtual| |const| +:ref:`Dictionary` **_get_child_nodes**\ (\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return all child animation nodes in order as a ``name: node`` dictionary. @@ -265,7 +265,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`Variant` **_get_parameter_default_value**\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| +:ref:`Variant` **_get_parameter_default_value**\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return the default value of a ``parameter``. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. @@ -277,7 +277,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`Array` **_get_parameter_list**\ (\ ) |virtual| |const| +:ref:`Array` **_get_parameter_list**\ (\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return a list of the properties on this animation node. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list`. @@ -289,7 +289,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`bool` **_has_filter**\ (\ ) |virtual| |const| +:ref:`bool` **_has_filter**\ (\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return whether the blend tree editor should display filter editing on this animation node. @@ -301,7 +301,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`bool` **_is_parameter_read_only**\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_is_parameter_read_only**\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return whether the ``parameter`` is read-only. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. @@ -313,7 +313,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`float` **_process**\ (\ time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, test_only\: :ref:`bool`\ ) |virtual| |const| +:ref:`float` **_process**\ (\ time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, test_only\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` **Deprecated:** Currently this is mostly useless as there is a lack of many APIs to extend AnimationNode by GDScript. It is planned that a more flexible API using structures will be provided in the future. @@ -331,7 +331,7 @@ This function should return the delta. .. rst-class:: classref-method -:ref:`bool` **add_input**\ (\ name\: :ref:`String`\ ) +:ref:`bool` **add_input**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Adds an input to the animation node. This is only useful for animation nodes created for use in an :ref:`AnimationNodeBlendTree`. If the addition fails, returns ``false``. @@ -343,7 +343,7 @@ Adds an input to the animation node. This is only useful for animation nodes cre .. rst-class:: classref-method -|void| **blend_animation**\ (\ animation\: :ref:`StringName`, time\: :ref:`float`, delta\: :ref:`float`, seeked\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, looped_flag\: :ref:`LoopedFlag` = 0\ ) +|void| **blend_animation**\ (\ animation\: :ref:`StringName`, time\: :ref:`float`, delta\: :ref:`float`, seeked\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, looped_flag\: :ref:`LoopedFlag` = 0\ ) :ref:`🔗` Blend an animation by ``blend`` amount (name must be valid in the linked :ref:`AnimationPlayer`). A ``time`` and ``delta`` may be passed, as well as whether ``seeked`` happened. @@ -357,7 +357,7 @@ A ``looped_flag`` is used by internal processing immediately after the loop. See .. rst-class:: classref-method -:ref:`float` **blend_input**\ (\ input_index\: :ref:`int`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) +:ref:`float` **blend_input**\ (\ input_index\: :ref:`int`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) :ref:`🔗` Blend an input. This is only useful for animation nodes created for an :ref:`AnimationNodeBlendTree`. The ``time`` parameter is a relative delta, unless ``seek`` is ``true``, in which case it is absolute. A filter mode may be optionally passed (see :ref:`FilterAction` for options). @@ -369,7 +369,7 @@ Blend an input. This is only useful for animation nodes created for an :ref:`Ani .. rst-class:: classref-method -:ref:`float` **blend_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) +:ref:`float` **blend_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) :ref:`🔗` Blend another animation node (in case this animation node contains child animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, otherwise editors will not display your animation node for addition. @@ -381,7 +381,7 @@ Blend another animation node (in case this animation node contains child animati .. rst-class:: classref-method -:ref:`int` **find_input**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **find_input**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the input index which corresponds to ``name``. If not found, returns ``-1``. @@ -393,7 +393,7 @@ Returns the input index which corresponds to ``name``. If not found, returns ``- .. rst-class:: classref-method -:ref:`int` **get_input_count**\ (\ ) |const| +:ref:`int` **get_input_count**\ (\ ) |const| :ref:`🔗` Amount of inputs in this animation node, only useful for animation nodes that go into :ref:`AnimationNodeBlendTree`. @@ -405,7 +405,7 @@ Amount of inputs in this animation node, only useful for animation nodes that go .. rst-class:: classref-method -:ref:`String` **get_input_name**\ (\ input\: :ref:`int`\ ) |const| +:ref:`String` **get_input_name**\ (\ input\: :ref:`int`\ ) |const| :ref:`🔗` Gets the name of an input by index. @@ -417,7 +417,7 @@ Gets the name of an input by index. .. rst-class:: classref-method -:ref:`Variant` **get_parameter**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_parameter**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Gets the value of a parameter. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. @@ -429,7 +429,7 @@ Gets the value of a parameter. Parameters are custom local memory used for your .. rst-class:: classref-method -:ref:`bool` **is_path_filtered**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`bool` **is_path_filtered**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Returns whether the given path is filtered. @@ -441,7 +441,7 @@ Returns whether the given path is filtered. .. rst-class:: classref-method -|void| **remove_input**\ (\ index\: :ref:`int`\ ) +|void| **remove_input**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an input, call this only when inactive. @@ -453,7 +453,7 @@ Removes an input, call this only when inactive. .. rst-class:: classref-method -|void| **set_filter_path**\ (\ path\: :ref:`NodePath`, enable\: :ref:`bool`\ ) +|void| **set_filter_path**\ (\ path\: :ref:`NodePath`, enable\: :ref:`bool`\ ) :ref:`🔗` Adds or removes a path for the filter. @@ -465,7 +465,7 @@ Adds or removes a path for the filter. .. rst-class:: classref-method -:ref:`bool` **set_input_name**\ (\ input\: :ref:`int`, name\: :ref:`String`\ ) +:ref:`bool` **set_input_name**\ (\ input\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the input at the given ``input`` index. If the setting fails, returns ``false``. @@ -477,7 +477,7 @@ Sets the name of the input at the given ``input`` index. If the setting fails, r .. rst-class:: classref-method -|void| **set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes. diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index 56d188d0c4f..734212e8862 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -69,7 +69,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PlayMode**: +enum **PlayMode**: :ref:`🔗` .. _class_AnimationNodeAnimation_constant_PLAY_MODE_FORWARD: @@ -100,7 +100,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **animation** = ``&""`` +:ref:`StringName` **animation** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -117,7 +117,7 @@ Animation to use as an output. It is one of the animations provided by :ref:`Ani .. rst-class:: classref-property -:ref:`LoopMode` **loop_mode** +:ref:`LoopMode` **loop_mode** :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,7 +134,7 @@ If :ref:`use_custom_timeline` **play_mode** = ``0`` +:ref:`PlayMode` **play_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ Determines the playback direction of the animation. .. rst-class:: classref-property -:ref:`float` **start_offset** +:ref:`float` **start_offset** :ref:`🔗` .. rst-class:: classref-property-setget @@ -170,7 +170,7 @@ This is useful for adjusting which foot steps first in 3D walking animations. .. rst-class:: classref-property -:ref:`bool` **stretch_time_scale** +:ref:`bool` **stretch_time_scale** :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ If ``false``, the original animation length is respected. If you set the loop to .. rst-class:: classref-property -:ref:`float` **timeline_length** +:ref:`float` **timeline_length** :ref:`🔗` .. rst-class:: classref-property-setget @@ -208,7 +208,7 @@ If :ref:`use_custom_timeline` **use_custom_timeline** = ``false`` +:ref:`bool` **use_custom_timeline** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 186eb60bd6c..a2647c28662 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -91,7 +91,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BlendMode**: +enum **BlendMode**: :ref:`🔗` .. _class_AnimationNodeBlendSpace1D_constant_BLEND_MODE_INTERPOLATED: @@ -130,7 +130,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BlendMode` **blend_mode** = ``0`` +:ref:`BlendMode` **blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ Controls the interpolation between animations. See :ref:`BlendMode` **max_space** = ``1.0`` +:ref:`float` **max_space** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble .. rst-class:: classref-property -:ref:`float` **min_space** = ``-1.0`` +:ref:`float` **min_space** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble .. rst-class:: classref-property -:ref:`float` **snap** = ``0.1`` +:ref:`float` **snap** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ Position increment to snap to when moving a point on the axis. .. rst-class:: classref-property -:ref:`bool` **sync** = ``false`` +:ref:`bool` **sync** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If ``true``, forcing the blended animations to advance frame. .. rst-class:: classref-property -:ref:`String` **value_label** = ``"value"`` +:ref:`String` **value_label** = ``"value"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_blend_point**\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`float`, at_index\: :ref:`int` = -1\ ) +|void| **add_blend_point**\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`float`, at_index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index``, the point is inserted at the end of the blend points array. @@ -251,7 +251,7 @@ Adds a new point that represents a ``node`` on the virtual axis at a given posit .. rst-class:: classref-method -:ref:`int` **get_blend_point_count**\ (\ ) |const| +:ref:`int` **get_blend_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of points on the blend axis. @@ -263,7 +263,7 @@ Returns the number of points on the blend axis. .. rst-class:: classref-method -:ref:`AnimationRootNode` **get_blend_point_node**\ (\ point\: :ref:`int`\ ) |const| +:ref:`AnimationRootNode` **get_blend_point_node**\ (\ point\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -275,7 +275,7 @@ Returns the :ref:`AnimationNode` referenced by the point at .. rst-class:: classref-method -:ref:`float` **get_blend_point_position**\ (\ point\: :ref:`int`\ ) |const| +:ref:`float` **get_blend_point_position**\ (\ point\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the point at index ``point``. @@ -287,7 +287,7 @@ Returns the position of the point at index ``point``. .. rst-class:: classref-method -|void| **remove_blend_point**\ (\ point\: :ref:`int`\ ) +|void| **remove_blend_point**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Removes the point at index ``point`` from the blend axis. @@ -299,7 +299,7 @@ Removes the point at index ``point`` from the blend axis. .. rst-class:: classref-method -|void| **set_blend_point_node**\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) +|void| **set_blend_point_node**\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) :ref:`🔗` Changes the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -311,7 +311,7 @@ Changes the :ref:`AnimationNode` referenced by the point at .. rst-class:: classref-method -|void| **set_blend_point_position**\ (\ point\: :ref:`int`, pos\: :ref:`float`\ ) +|void| **set_blend_point_position**\ (\ point\: :ref:`int`, pos\: :ref:`float`\ ) :ref:`🔗` Updates the position of the point at index ``point`` on the blend axis. diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 96bcb0e2b0a..506b47bff25 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -105,7 +105,7 @@ Signals .. rst-class:: classref-signal -**triangles_updated**\ (\ ) +**triangles_updated**\ (\ ) :ref:`🔗` Emitted every time the blend space's triangles are created, removed, or when one of their vertices changes position. @@ -122,7 +122,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BlendMode**: +enum **BlendMode**: :ref:`🔗` .. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_INTERPOLATED: @@ -161,7 +161,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **auto_triangles** = ``true`` +:ref:`bool` **auto_triangles** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ If ``true``, the blend space is triangulated automatically. The mesh updates eve .. rst-class:: classref-property -:ref:`BlendMode` **blend_mode** = ``0`` +:ref:`BlendMode` **blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ Controls the interpolation between animations. See :ref:`BlendMode` **max_space** = ``Vector2(1, 1)`` +:ref:`Vector2` **max_space** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:` .. rst-class:: classref-property -:ref:`Vector2` **min_space** = ``Vector2(-1, -1)`` +:ref:`Vector2` **min_space** = ``Vector2(-1, -1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -229,7 +229,7 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:` .. rst-class:: classref-property -:ref:`Vector2` **snap** = ``Vector2(0.1, 0.1)`` +:ref:`Vector2` **snap** = ``Vector2(0.1, 0.1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -246,7 +246,7 @@ Position increment to snap to when moving a point. .. rst-class:: classref-property -:ref:`bool` **sync** = ``false`` +:ref:`bool` **sync** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -265,7 +265,7 @@ If ``true``, forcing the blended animations to advance frame. .. rst-class:: classref-property -:ref:`String` **x_label** = ``"x"`` +:ref:`String` **x_label** = ``"x"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -282,7 +282,7 @@ Name of the blend space's X axis. .. rst-class:: classref-property -:ref:`String` **y_label** = ``"y"`` +:ref:`String` **y_label** = ``"y"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_blend_point**\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`Vector2`, at_index\: :ref:`int` = -1\ ) +|void| **add_blend_point**\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`Vector2`, at_index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new point that represents a ``node`` at the position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index``, the point is inserted at the end of the blend points array. @@ -316,7 +316,7 @@ Adds a new point that represents a ``node`` at the position set by ``pos``. You .. rst-class:: classref-method -|void| **add_triangle**\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`, at_index\: :ref:`int` = -1\ ) +|void| **add_triangle**\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`, at_index\: :ref:`int` = -1\ ) :ref:`🔗` Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can overlap. You can insert the triangle at a specific index using the ``at_index`` argument. If you use the default value for ``at_index``, the point is inserted at the end of the blend points array. @@ -328,7 +328,7 @@ Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can .. rst-class:: classref-method -:ref:`int` **get_blend_point_count**\ (\ ) |const| +:ref:`int` **get_blend_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of points in the blend space. @@ -340,7 +340,7 @@ Returns the number of points in the blend space. .. rst-class:: classref-method -:ref:`AnimationRootNode` **get_blend_point_node**\ (\ point\: :ref:`int`\ ) |const| +:ref:`AnimationRootNode` **get_blend_point_node**\ (\ point\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`AnimationRootNode` referenced by the point at index ``point``. @@ -352,7 +352,7 @@ Returns the :ref:`AnimationRootNode` referenced by the .. rst-class:: classref-method -:ref:`Vector2` **get_blend_point_position**\ (\ point\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_blend_point_position**\ (\ point\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the point at index ``point``. @@ -364,7 +364,7 @@ Returns the position of the point at index ``point``. .. rst-class:: classref-method -:ref:`int` **get_triangle_count**\ (\ ) |const| +:ref:`int` **get_triangle_count**\ (\ ) |const| :ref:`🔗` Returns the number of triangles in the blend space. @@ -376,7 +376,7 @@ Returns the number of triangles in the blend space. .. rst-class:: classref-method -:ref:`int` **get_triangle_point**\ (\ triangle\: :ref:`int`, point\: :ref:`int`\ ) +:ref:`int` **get_triangle_point**\ (\ triangle\: :ref:`int`, point\: :ref:`int`\ ) :ref:`🔗` Returns the position of the point at index ``point`` in the triangle of index ``triangle``. @@ -388,7 +388,7 @@ Returns the position of the point at index ``point`` in the triangle of index `` .. rst-class:: classref-method -|void| **remove_blend_point**\ (\ point\: :ref:`int`\ ) +|void| **remove_blend_point**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Removes the point at index ``point`` from the blend space. @@ -400,7 +400,7 @@ Removes the point at index ``point`` from the blend space. .. rst-class:: classref-method -|void| **remove_triangle**\ (\ triangle\: :ref:`int`\ ) +|void| **remove_triangle**\ (\ triangle\: :ref:`int`\ ) :ref:`🔗` Removes the triangle at index ``triangle`` from the blend space. @@ -412,7 +412,7 @@ Removes the triangle at index ``triangle`` from the blend space. .. rst-class:: classref-method -|void| **set_blend_point_node**\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) +|void| **set_blend_point_node**\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) :ref:`🔗` Changes the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -424,7 +424,7 @@ Changes the :ref:`AnimationNode` referenced by the point at .. rst-class:: classref-method -|void| **set_blend_point_position**\ (\ point\: :ref:`int`, pos\: :ref:`Vector2`\ ) +|void| **set_blend_point_position**\ (\ point\: :ref:`int`, pos\: :ref:`Vector2`\ ) :ref:`🔗` Updates the position of the point at index ``point`` on the blend axis. diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index da7c6ca52b6..c2efe95881f 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -83,7 +83,7 @@ Signals .. rst-class:: classref-signal -**node_changed**\ (\ node_name\: :ref:`StringName`\ ) +**node_changed**\ (\ node_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when the input port information is changed. @@ -100,7 +100,7 @@ Constants .. rst-class:: classref-constant -**CONNECTION_OK** = ``0`` +**CONNECTION_OK** = ``0`` :ref:`🔗` The connection was successful. @@ -108,7 +108,7 @@ The connection was successful. .. rst-class:: classref-constant -**CONNECTION_ERROR_NO_INPUT** = ``1`` +**CONNECTION_ERROR_NO_INPUT** = ``1`` :ref:`🔗` The input node is ``null``. @@ -116,7 +116,7 @@ The input node is ``null``. .. rst-class:: classref-constant -**CONNECTION_ERROR_NO_INPUT_INDEX** = ``2`` +**CONNECTION_ERROR_NO_INPUT_INDEX** = ``2`` :ref:`🔗` The specified input port is out of range. @@ -124,7 +124,7 @@ The specified input port is out of range. .. rst-class:: classref-constant -**CONNECTION_ERROR_NO_OUTPUT** = ``3`` +**CONNECTION_ERROR_NO_OUTPUT** = ``3`` :ref:`🔗` The output node is ``null``. @@ -132,7 +132,7 @@ The output node is ``null``. .. rst-class:: classref-constant -**CONNECTION_ERROR_SAME_NODE** = ``4`` +**CONNECTION_ERROR_SAME_NODE** = ``4`` :ref:`🔗` Input and output nodes are the same. @@ -140,7 +140,7 @@ Input and output nodes are the same. .. rst-class:: classref-constant -**CONNECTION_ERROR_CONNECTION_EXISTS** = ``5`` +**CONNECTION_ERROR_CONNECTION_EXISTS** = ``5`` :ref:`🔗` The specified connection already exists. @@ -157,7 +157,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **graph_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **graph_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds an :ref:`AnimationNode` at the given ``position``. The ``name`` is used to identify the created sub animation node later. @@ -191,7 +191,7 @@ Adds an :ref:`AnimationNode` at the given ``position``. The .. rst-class:: classref-method -|void| **connect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) +|void| **connect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) :ref:`🔗` Connects the output of an :ref:`AnimationNode` as input for another :ref:`AnimationNode`, at the input port specified by ``input_index``. @@ -203,7 +203,7 @@ Connects the output of an :ref:`AnimationNode` as input for .. rst-class:: classref-method -|void| **disconnect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) +|void| **disconnect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) :ref:`🔗` Disconnects the animation node connected to the specified input. @@ -215,7 +215,7 @@ Disconnects the animation node connected to the specified input. .. rst-class:: classref-method -:ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the sub animation node with the specified ``name``. @@ -227,7 +227,7 @@ Returns the sub animation node with the specified ``name``. .. rst-class:: classref-method -:ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the position of the sub animation node with the specified ``name``. @@ -239,7 +239,7 @@ Returns the position of the sub animation node with the specified ``name``. .. rst-class:: classref-method -:ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a sub animation node with specified ``name`` exists. @@ -251,7 +251,7 @@ Returns ``true`` if a sub animation node with specified ``name`` exists. .. rst-class:: classref-method -|void| **remove_node**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_node**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a sub animation node. @@ -263,7 +263,7 @@ Removes a sub animation node. .. rst-class:: classref-method -|void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) +|void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) :ref:`🔗` Changes the name of a sub animation node. @@ -275,7 +275,7 @@ Changes the name of a sub animation node. .. rst-class:: classref-method -|void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) +|void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) :ref:`🔗` Modifies the position of a sub animation node. diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 2e83fc832ae..176e75af2e0 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -122,7 +122,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OneShotRequest**: +enum **OneShotRequest**: :ref:`🔗` .. _class_AnimationNodeOneShot_constant_ONE_SHOT_REQUEST_NONE: @@ -164,7 +164,7 @@ The request to fade out the animation connected to "shot" port. .. rst-class:: classref-enumeration -enum **MixMode**: +enum **MixMode**: :ref:`🔗` .. _class_AnimationNodeOneShot_constant_MIX_MODE_BLEND: @@ -195,7 +195,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **autorestart** = ``false`` +:ref:`bool` **autorestart** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,7 +214,7 @@ In other words, to start auto restarting, the animation must be played once with .. rst-class:: classref-property -:ref:`float` **autorestart_delay** = ``1.0`` +:ref:`float` **autorestart_delay** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ The delay after which the automatic restart is triggered, in seconds. .. rst-class:: classref-property -:ref:`float` **autorestart_random_delay** = ``0.0`` +:ref:`float` **autorestart_random_delay** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -248,7 +248,7 @@ If :ref:`autorestart` is ``true .. rst-class:: classref-property -:ref:`bool` **break_loop_at_end** = ``false`` +:ref:`bool` **break_loop_at_end** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -265,7 +265,7 @@ If ``true``, breaks the loop at the end of the loop cycle for transition, even i .. rst-class:: classref-property -:ref:`Curve` **fadein_curve** +:ref:`Curve` **fadein_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -282,7 +282,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio .. rst-class:: classref-property -:ref:`float` **fadein_time** = ``0.0`` +:ref:`float` **fadein_time** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -301,7 +301,7 @@ The fade-in duration. For example, setting this to ``1.0`` for a 5 second length .. rst-class:: classref-property -:ref:`Curve` **fadeout_curve** +:ref:`Curve` **fadeout_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -318,7 +318,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio .. rst-class:: classref-property -:ref:`float` **fadeout_time** = ``0.0`` +:ref:`float` **fadeout_time** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -337,7 +337,7 @@ The fade-out duration. For example, setting this to ``1.0`` for a 5 second lengt .. rst-class:: classref-property -:ref:`MixMode` **mix_mode** = ``0`` +:ref:`MixMode` **mix_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index aa73899bbee..f567081cc0b 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -122,7 +122,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **StateMachineType**: +enum **StateMachineType**: :ref:`🔗` .. _class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_ROOT: @@ -161,7 +161,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_transition_to_self** = ``false`` +:ref:`bool` **allow_transition_to_self** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ If ``true``, allows teleport to the self state with :ref:`AnimationNodeStateMach .. rst-class:: classref-property -:ref:`bool` **reset_ends** = ``false`` +:ref:`bool` **reset_ends** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -197,7 +197,7 @@ In most cases, when additional cross-fades are performed in the parent :ref:`Ani .. rst-class:: classref-property -:ref:`StateMachineType` **state_machine_type** = ``0`` +:ref:`StateMachineType` **state_machine_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds a new animation node to the graph. The ``position`` is used for display in the editor. @@ -231,7 +231,7 @@ Adds a new animation node to the graph. The ``position`` is used for display in .. rst-class:: classref-method -|void| **add_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`, transition\: :ref:`AnimationNodeStateMachineTransition`\ ) +|void| **add_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`, transition\: :ref:`AnimationNodeStateMachineTransition`\ ) :ref:`🔗` Adds a transition between the given animation nodes. @@ -243,7 +243,7 @@ Adds a transition between the given animation nodes. .. rst-class:: classref-method -:ref:`Vector2` **get_graph_offset**\ (\ ) |const| +:ref:`Vector2` **get_graph_offset**\ (\ ) |const| :ref:`🔗` Returns the draw offset of the graph. Used for display in the editor. @@ -255,7 +255,7 @@ Returns the draw offset of the graph. Used for display in the editor. .. rst-class:: classref-method -:ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the animation node with the given name. @@ -267,7 +267,7 @@ Returns the animation node with the given name. .. rst-class:: classref-method -:ref:`StringName` **get_node_name**\ (\ node\: :ref:`AnimationNode`\ ) |const| +:ref:`StringName` **get_node_name**\ (\ node\: :ref:`AnimationNode`\ ) |const| :ref:`🔗` Returns the given animation node's name. @@ -279,7 +279,7 @@ Returns the given animation node's name. .. rst-class:: classref-method -:ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the given animation node's coordinates. Used for display in the editor. @@ -291,7 +291,7 @@ Returns the given animation node's coordinates. Used for display in the editor. .. rst-class:: classref-method -:ref:`AnimationNodeStateMachineTransition` **get_transition**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`AnimationNodeStateMachineTransition` **get_transition**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given transition. @@ -303,7 +303,7 @@ Returns the given transition. .. rst-class:: classref-method -:ref:`int` **get_transition_count**\ (\ ) |const| +:ref:`int` **get_transition_count**\ (\ ) |const| :ref:`🔗` Returns the number of connections in the graph. @@ -315,7 +315,7 @@ Returns the number of connections in the graph. .. rst-class:: classref-method -:ref:`StringName` **get_transition_from**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_transition_from**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given transition's start node. @@ -327,7 +327,7 @@ Returns the given transition's start node. .. rst-class:: classref-method -:ref:`StringName` **get_transition_to**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_transition_to**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given transition's end node. @@ -339,7 +339,7 @@ Returns the given transition's end node. .. rst-class:: classref-method -:ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the graph contains the given animation node. @@ -351,7 +351,7 @@ Returns ``true`` if the graph contains the given animation node. .. rst-class:: classref-method -:ref:`bool` **has_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a transition between the given animation nodes. @@ -363,7 +363,7 @@ Returns ``true`` if there is a transition between the given animation nodes. .. rst-class:: classref-method -|void| **remove_node**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_node**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Deletes the given animation node from the graph. @@ -375,7 +375,7 @@ Deletes the given animation node from the graph. .. rst-class:: classref-method -|void| **remove_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) +|void| **remove_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) :ref:`🔗` Deletes the transition between the two specified animation nodes. @@ -387,7 +387,7 @@ Deletes the transition between the two specified animation nodes. .. rst-class:: classref-method -|void| **remove_transition_by_index**\ (\ idx\: :ref:`int`\ ) +|void| **remove_transition_by_index**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Deletes the given transition by index. @@ -399,7 +399,7 @@ Deletes the given transition by index. .. rst-class:: classref-method -|void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) +|void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) :ref:`🔗` Renames the given animation node. @@ -411,7 +411,7 @@ Renames the given animation node. .. rst-class:: classref-method -|void| **replace_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`\ ) +|void| **replace_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`\ ) :ref:`🔗` Replaces the given animation node with a new animation node. @@ -423,7 +423,7 @@ Replaces the given animation node with a new animation node. .. rst-class:: classref-method -|void| **set_graph_offset**\ (\ offset\: :ref:`Vector2`\ ) +|void| **set_graph_offset**\ (\ offset\: :ref:`Vector2`\ ) :ref:`🔗` Sets the draw offset of the graph. Used for display in the editor. @@ -435,7 +435,7 @@ Sets the draw offset of the graph. Used for display in the editor. .. rst-class:: classref-method -|void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) +|void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the animation node's coordinates. Used for display in the editor. diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 52fb2f528ad..221d1f62aa3 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -100,7 +100,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_current_length**\ (\ ) |const| +:ref:`float` **get_current_length**\ (\ ) |const| :ref:`🔗` Returns the current state length. @@ -114,7 +114,7 @@ Returns the current state length. .. rst-class:: classref-method -:ref:`StringName` **get_current_node**\ (\ ) |const| +:ref:`StringName` **get_current_node**\ (\ ) |const| :ref:`🔗` Returns the currently playing animation state. @@ -128,7 +128,7 @@ Returns the currently playing animation state. .. rst-class:: classref-method -:ref:`float` **get_current_play_position**\ (\ ) |const| +:ref:`float` **get_current_play_position**\ (\ ) |const| :ref:`🔗` Returns the playback position within the current animation state. @@ -140,7 +140,7 @@ Returns the playback position within the current animation state. .. rst-class:: classref-method -:ref:`StringName` **get_fading_from_node**\ (\ ) |const| +:ref:`StringName` **get_fading_from_node**\ (\ ) |const| :ref:`🔗` Returns the starting state of currently fading animation. @@ -152,7 +152,7 @@ Returns the starting state of currently fading animation. .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_travel_path**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **get_travel_path**\ (\ ) |const| :ref:`🔗` Returns the current travel path as computed internally by the A\* algorithm. @@ -164,7 +164,7 @@ Returns the current travel path as computed internally by the A\* algorithm. .. rst-class:: classref-method -:ref:`bool` **is_playing**\ (\ ) |const| +:ref:`bool` **is_playing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if an animation is playing. @@ -176,7 +176,7 @@ Returns ``true`` if an animation is playing. .. rst-class:: classref-method -|void| **next**\ (\ ) +|void| **next**\ (\ ) :ref:`🔗` If there is a next path by travel or auto advance, immediately transitions from the current state to the next state. @@ -188,7 +188,7 @@ If there is a next path by travel or auto advance, immediately transitions from .. rst-class:: classref-method -|void| **start**\ (\ node\: :ref:`StringName`, reset\: :ref:`bool` = true\ ) +|void| **start**\ (\ node\: :ref:`StringName`, reset\: :ref:`bool` = true\ ) :ref:`🔗` Starts playing the given animation. @@ -202,7 +202,7 @@ If ``reset`` is ``true``, the animation is played from the beginning. .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops the currently playing animation. @@ -214,7 +214,7 @@ Stops the currently playing animation. .. rst-class:: classref-method -|void| **travel**\ (\ to_node\: :ref:`StringName`, reset_on_teleport\: :ref:`bool` = true\ ) +|void| **travel**\ (\ to_node\: :ref:`StringName`, reset_on_teleport\: :ref:`bool` = true\ ) :ref:`🔗` Transitions from the current state to another one, following the shortest path. diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 4b440903f12..1a4973608e7 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -71,7 +71,7 @@ Signals .. rst-class:: classref-signal -**advance_condition_changed**\ (\ ) +**advance_condition_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`advance_condition` is changed. @@ -88,7 +88,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SwitchMode**: +enum **SwitchMode**: :ref:`🔗` .. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_IMMEDIATE: @@ -122,7 +122,7 @@ Wait for the current state playback to end, then switch to the beginning of the .. rst-class:: classref-enumeration -enum **AdvanceMode**: +enum **AdvanceMode**: :ref:`🔗` .. _class_AnimationNodeStateMachineTransition_constant_ADVANCE_MODE_DISABLED: @@ -161,7 +161,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **advance_condition** = ``&""`` +:ref:`StringName` **advance_condition** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ Turn on auto advance when this condition is set. The provided name will become a .. rst-class:: classref-property -:ref:`String` **advance_expression** = ``""`` +:ref:`String` **advance_expression** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -208,7 +208,7 @@ Use an expression as a condition for state machine transitions. It is possible t .. rst-class:: classref-property -:ref:`AdvanceMode` **advance_mode** = ``1`` +:ref:`AdvanceMode` **advance_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ Determines whether the transition should disabled, enabled when using :ref:`Anim .. rst-class:: classref-property -:ref:`bool` **break_loop_at_end** = ``false`` +:ref:`bool` **break_loop_at_end** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ If ``true``, breaks the loop at the end of the loop cycle for transition, even i .. rst-class:: classref-property -:ref:`int` **priority** = ``1`` +:ref:`int` **priority** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -259,7 +259,7 @@ Lower priority transitions are preferred when travelling through the tree via :r .. rst-class:: classref-property -:ref:`bool` **reset** = ``true`` +:ref:`bool` **reset** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ If ``true``, the destination animation is played back from the beginning when sw .. rst-class:: classref-property -:ref:`SwitchMode` **switch_mode** = ``0`` +:ref:`SwitchMode` **switch_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -293,7 +293,7 @@ The transition type. .. rst-class:: classref-property -:ref:`Curve` **xfade_curve** +:ref:`Curve` **xfade_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -310,7 +310,7 @@ Ease curve for better control over cross-fade between this state and the next. .. rst-class:: classref-property -:ref:`float` **xfade_time** = ``0.0`` +:ref:`float` **xfade_time** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_animationnodesync.rst b/classes/class_animationnodesync.rst index 36f2df62084..bbe20f0a346 100644 --- a/classes/class_animationnodesync.rst +++ b/classes/class_animationnodesync.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **sync** = ``false`` +:ref:`bool` **sync** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index dbb40e868fc..f79beea9972 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -122,7 +122,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_transition_to_self** = ``false`` +:ref:`bool` **allow_transition_to_self** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ If ``true``, allows transition to the self state. When the reset option is enabl .. rst-class:: classref-property -:ref:`int` **input_count** = ``0`` +:ref:`int` **input_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The number of enabled input ports for this animation node. .. rst-class:: classref-property -:ref:`Curve` **xfade_curve** +:ref:`Curve` **xfade_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio .. rst-class:: classref-property -:ref:`float` **xfade_time** = ``0.0`` +:ref:`float` **xfade_time** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -197,7 +197,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_input_loop_broken_at_end**\ (\ input\: :ref:`int`\ ) |const| +:ref:`bool` **is_input_loop_broken_at_end**\ (\ input\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the animation breaks the loop at the end of the loop cycle for transition. @@ -209,7 +209,7 @@ Returns whether the animation breaks the loop at the end of the loop cycle for t .. rst-class:: classref-method -:ref:`bool` **is_input_reset**\ (\ input\: :ref:`int`\ ) |const| +:ref:`bool` **is_input_reset**\ (\ input\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the animation restarts when the animation transitions from the other animation. @@ -221,7 +221,7 @@ Returns whether the animation restarts when the animation transitions from the o .. rst-class:: classref-method -:ref:`bool` **is_input_set_as_auto_advance**\ (\ input\: :ref:`int`\ ) |const| +:ref:`bool` **is_input_set_as_auto_advance**\ (\ input\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if auto-advance is enabled for the given ``input`` index. @@ -233,7 +233,7 @@ Returns ``true`` if auto-advance is enabled for the given ``input`` index. .. rst-class:: classref-method -|void| **set_input_as_auto_advance**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_input_as_auto_advance**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Enables or disables auto-advance for the given ``input`` index. If enabled, state changes to the next input after playing the animation once. If enabled for the last input state, it loops to the first. @@ -245,7 +245,7 @@ Enables or disables auto-advance for the given ``input`` index. If enabled, stat .. rst-class:: classref-method -|void| **set_input_break_loop_at_end**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_input_break_loop_at_end**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, breaks the loop at the end of the loop cycle for transition, even if the animation is looping. @@ -257,7 +257,7 @@ If ``true``, breaks the loop at the end of the loop cycle for transition, even i .. rst-class:: classref-method -|void| **set_input_reset**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_input_reset**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the destination animation is restarted when the animation transitions. diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index fc8a9fd692c..ffa39105dba 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -137,7 +137,7 @@ Signals .. rst-class:: classref-signal -**animation_changed**\ (\ old_name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) +**animation_changed**\ (\ old_name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when a queued animation plays after the previous animation finished. See also :ref:`queue`. @@ -151,7 +151,7 @@ Emitted when a queued animation plays after the previous animation finished. See .. rst-class:: classref-signal -**current_animation_changed**\ (\ name\: :ref:`String`\ ) +**current_animation_changed**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Emitted when :ref:`current_animation` changes. @@ -168,7 +168,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AnimationProcessCallback**: +enum **AnimationProcessCallback**: :ref:`🔗` .. _class_AnimationPlayer_constant_ANIMATION_PROCESS_PHYSICS: @@ -208,7 +208,7 @@ enum **AnimationProcessCallback**: .. rst-class:: classref-enumeration -enum **AnimationMethodCallMode**: +enum **AnimationMethodCallMode**: :ref:`🔗` .. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_DEFERRED: @@ -243,7 +243,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **assigned_animation** +:ref:`String` **assigned_animation** :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ If playing, the current animation's key, otherwise, the animation last played. W .. rst-class:: classref-property -:ref:`String` **autoplay** = ``""`` +:ref:`String` **autoplay** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ The key of the animation to play when the scene loads. .. rst-class:: classref-property -:ref:`String` **current_animation** = ``""`` +:ref:`String` **current_animation** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -296,7 +296,7 @@ The key of the currently playing animation. If no animation is playing, the prop .. rst-class:: classref-property -:ref:`float` **current_animation_length** +:ref:`float` **current_animation_length** :ref:`🔗` .. rst-class:: classref-property-setget @@ -312,7 +312,7 @@ The length (in seconds) of the currently playing animation. .. rst-class:: classref-property -:ref:`float` **current_animation_position** +:ref:`float` **current_animation_position** :ref:`🔗` .. rst-class:: classref-property-setget @@ -328,7 +328,7 @@ The position (in seconds) of the currently playing animation. .. rst-class:: classref-property -:ref:`bool` **movie_quit_on_finish** = ``false`` +:ref:`bool` **movie_quit_on_finish** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +347,7 @@ If ``true`` and the engine is running in Movie Maker mode (see :ref:`MovieWriter .. rst-class:: classref-property -:ref:`bool` **playback_auto_capture** = ``true`` +:ref:`bool` **playback_auto_capture** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -366,7 +366,7 @@ If ``true``, performs :ref:`AnimationMixer.capture` **playback_auto_capture_duration** = ``-1.0`` +:ref:`float` **playback_auto_capture_duration** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -385,7 +385,7 @@ If :ref:`playback_auto_capture_duration` **playback_auto_capture_ease_type** = ``0`` +:ref:`EaseType` **playback_auto_capture_ease_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -402,7 +402,7 @@ The ease type of the capture interpolation. See also :ref:`EaseType` **playback_auto_capture_transition_type** = ``0`` +:ref:`TransitionType` **playback_auto_capture_transition_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -419,7 +419,7 @@ The transition type of the capture interpolation. See also :ref:`TransitionType< .. rst-class:: classref-property -:ref:`float` **playback_default_blend_time** = ``0.0`` +:ref:`float` **playback_default_blend_time** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -436,7 +436,7 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -460,7 +460,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **animation_get_next**\ (\ animation_from\: :ref:`StringName`\ ) |const| +:ref:`StringName` **animation_get_next**\ (\ animation_from\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the key of the animation which is queued to play after the ``animation_from`` animation. @@ -472,7 +472,7 @@ Returns the key of the animation which is queued to play after the ``animation_f .. rst-class:: classref-method -|void| **animation_set_next**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) +|void| **animation_set_next**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) :ref:`🔗` Triggers the ``animation_to`` animation when the ``animation_from`` animation completes. @@ -484,7 +484,7 @@ Triggers the ``animation_to`` animation when the ``animation_from`` animation co .. rst-class:: classref-method -|void| **clear_queue**\ (\ ) +|void| **clear_queue**\ (\ ) :ref:`🔗` Clears all queued, unplayed animations. @@ -496,7 +496,7 @@ Clears all queued, unplayed animations. .. rst-class:: classref-method -:ref:`float` **get_blend_time**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) |const| +:ref:`float` **get_blend_time**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the blend time (in seconds) between two animations, referenced by their keys. @@ -508,7 +508,7 @@ Returns the blend time (in seconds) between two animations, referenced by their .. rst-class:: classref-method -:ref:`AnimationMethodCallMode` **get_method_call_mode**\ (\ ) |const| +:ref:`AnimationMethodCallMode` **get_method_call_mode**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.callback_mode_method` instead. @@ -522,7 +522,7 @@ Returns the call mode used for "Call Method" tracks. .. rst-class:: classref-method -:ref:`float` **get_playing_speed**\ (\ ) |const| +:ref:`float` **get_playing_speed**\ (\ ) |const| :ref:`🔗` Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -536,7 +536,7 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`AnimationProcessCallback` **get_process_callback**\ (\ ) |const| +:ref:`AnimationProcessCallback` **get_process_callback**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. @@ -550,7 +550,7 @@ Returns the process notification in which to update animations. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_queue**\ (\ ) +:ref:`PackedStringArray` **get_queue**\ (\ ) :ref:`🔗` Returns a list of the animation keys that are currently queued to play. @@ -562,7 +562,7 @@ Returns a list of the animation keys that are currently queued to play. .. rst-class:: classref-method -:ref:`NodePath` **get_root**\ (\ ) |const| +:ref:`NodePath` **get_root**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.root_node` instead. @@ -576,7 +576,7 @@ Returns the node which node path references will travel from. .. rst-class:: classref-method -:ref:`bool` **is_playing**\ (\ ) |const| +:ref:`bool` **is_playing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale` and/or ``custom_speed`` are ``0``). @@ -588,7 +588,7 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale .. rst-class:: classref-method -|void| **pause**\ (\ ) +|void| **pause**\ (\ ) :ref:`🔗` Pauses the currently playing animation. The :ref:`current_animation_position` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments or with the same animation name as :ref:`assigned_animation` will resume the animation. @@ -602,7 +602,7 @@ See also :ref:`stop`. .. rst-class:: classref-method -|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) +|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) :ref:`🔗` Plays the animation with key ``name``. Custom blend times and speed can be set. @@ -620,7 +620,7 @@ The **AnimationPlayer** keeps track of its current or last played animation with .. rst-class:: classref-method -|void| **play_backwards**\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) +|void| **play_backwards**\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) :ref:`🔗` Plays the animation with key ``name`` in reverse. @@ -634,7 +634,7 @@ This method is a shorthand for :ref:`play` wi .. rst-class:: classref-method -|void| **play_with_capture**\ (\ name\: :ref:`StringName` = &"", duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) +|void| **play_with_capture**\ (\ name\: :ref:`StringName` = &"", duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) :ref:`🔗` See also :ref:`AnimationMixer.capture`. @@ -659,7 +659,7 @@ If ``duration`` is a negative value, the duration is set to the interval between .. rst-class:: classref-method -|void| **queue**\ (\ name\: :ref:`StringName`\ ) +|void| **queue**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Queues an animation for playback once the current one is done. @@ -673,7 +673,7 @@ Queues an animation for playback once the current one is done. .. rst-class:: classref-method -|void| **seek**\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) +|void| **seek**\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) :ref:`🔗` Seeks the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. Events between the current frame and ``seconds`` are skipped. @@ -689,7 +689,7 @@ If ``update_only`` is ``true``, the method / audio / animation playback tracks w .. rst-class:: classref-method -|void| **set_blend_time**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) +|void| **set_blend_time**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) :ref:`🔗` Specifies a blend time (in seconds) between two animations, referenced by their keys. @@ -701,7 +701,7 @@ Specifies a blend time (in seconds) between two animations, referenced by their .. rst-class:: classref-method -|void| **set_method_call_mode**\ (\ mode\: :ref:`AnimationMethodCallMode`\ ) +|void| **set_method_call_mode**\ (\ mode\: :ref:`AnimationMethodCallMode`\ ) :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.callback_mode_method` instead. @@ -715,7 +715,7 @@ Sets the call mode used for "Call Method" tracks. .. rst-class:: classref-method -|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback`\ ) +|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback`\ ) :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. @@ -729,7 +729,7 @@ Sets the process notification in which to update animations. .. rst-class:: classref-method -|void| **set_root**\ (\ path\: :ref:`NodePath`\ ) +|void| **set_root**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.root_node` instead. @@ -743,7 +743,7 @@ Sets the node which node path references will travel from. .. rst-class:: classref-method -|void| **stop**\ (\ keep_state\: :ref:`bool` = false\ ) +|void| **stop**\ (\ keep_state\: :ref:`bool` = false\ ) :ref:`🔗` Stops the currently playing animation. The animation position is reset to ``0`` and the ``custom_speed`` is reset to ``1.0``. See also :ref:`pause`. diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 7091d5ecc2d..ed8653c446f 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -79,7 +79,7 @@ Signals .. rst-class:: classref-signal -**animation_player_changed**\ (\ ) +**animation_player_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`anim_player` is changed. @@ -96,7 +96,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AnimationProcessCallback**: +enum **AnimationProcessCallback**: :ref:`🔗` .. _class_AnimationTree_constant_ANIMATION_PROCESS_PHYSICS: @@ -141,7 +141,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **advance_expression_base_node** = ``NodePath(".")`` +:ref:`NodePath` **advance_expression_base_node** = ``NodePath(".")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -158,7 +158,7 @@ The path to the :ref:`Node` used to evaluate the :ref:`AnimationNode .. rst-class:: classref-property -:ref:`NodePath` **anim_player** = ``NodePath("")`` +:ref:`NodePath` **anim_player** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -175,7 +175,7 @@ The path to the :ref:`AnimationPlayer` used for animating .. rst-class:: classref-property -:ref:`AnimationRootNode` **tree_root** +:ref:`AnimationRootNode` **tree_root** :ref:`🔗` .. rst-class:: classref-property-setget @@ -197,7 +197,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AnimationProcessCallback` **get_process_callback**\ (\ ) |const| +:ref:`AnimationProcessCallback` **get_process_callback**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. @@ -211,7 +211,7 @@ Returns the process notification in which to update animations. .. rst-class:: classref-method -|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback`\ ) +|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback`\ ) :ref:`🔗` **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index dc4b6f66cb3..a47df40ffed 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -116,7 +116,7 @@ Signals .. rst-class:: classref-signal -**area_entered**\ (\ area\: :ref:`Area2D`\ ) +**area_entered**\ (\ area\: :ref:`Area2D`\ ) :ref:`🔗` Emitted when the received ``area`` enters this area. Requires :ref:`monitoring` to be set to ``true``. @@ -128,7 +128,7 @@ Emitted when the received ``area`` enters this area. Requires :ref:`monitoring`\ ) +**area_exited**\ (\ area\: :ref:`Area2D`\ ) :ref:`🔗` Emitted when the received ``area`` exits this area. Requires :ref:`monitoring` to be set to ``true``. @@ -140,7 +140,7 @@ Emitted when the received ``area`` exits this area. Requires :ref:`monitoring`, area\: :ref:`Area2D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**area_shape_entered**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area2D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape2D` of the received ``area`` enters a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -169,7 +169,7 @@ Emitted when a :ref:`Shape2D` of the received ``area`` enters a s .. rst-class:: classref-signal -**area_shape_exited**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area2D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**area_shape_exited**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area2D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape2D` of the received ``area`` exits a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -183,7 +183,7 @@ See also :ref:`area_shape_entered`. .. rst-class:: classref-signal -**body_entered**\ (\ body\: :ref:`Node2D`\ ) +**body_entered**\ (\ body\: :ref:`Node2D`\ ) :ref:`🔗` Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -195,7 +195,7 @@ Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`Phy .. rst-class:: classref-signal -**body_exited**\ (\ body\: :ref:`Node2D`\ ) +**body_exited**\ (\ body\: :ref:`Node2D`\ ) :ref:`🔗` Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -207,7 +207,7 @@ Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`Phys .. rst-class:: classref-signal -**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node2D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node2D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape2D` of the received ``body`` enters a shape of this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -236,7 +236,7 @@ Emitted when a :ref:`Shape2D` of the received ``body`` enters a s .. rst-class:: classref-signal -**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node2D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node2D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape2D` of the received ``body`` exits a shape of this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -255,7 +255,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SpaceOverride**: +enum **SpaceOverride**: :ref:`🔗` .. _class_Area2D_constant_SPACE_OVERRIDE_DISABLED: @@ -310,7 +310,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_damp** = ``1.0`` +:ref:`float` **angular_damp** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -329,7 +329,7 @@ See :ref:`ProjectSettings.physics/2d/default_angular_damp` **angular_damp_space_override** = ``0`` +:ref:`SpaceOverride` **angular_damp_space_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -346,7 +346,7 @@ Override mode for angular damping calculations within this area. See :ref:`Space .. rst-class:: classref-property -:ref:`StringName` **audio_bus_name** = ``&"Master"`` +:ref:`StringName` **audio_bus_name** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -363,7 +363,7 @@ The name of the area's audio bus. .. rst-class:: classref-property -:ref:`bool` **audio_bus_override** = ``false`` +:ref:`bool` **audio_bus_override** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -380,7 +380,7 @@ If ``true``, the area's audio bus overrides the default audio bus. .. rst-class:: classref-property -:ref:`float` **gravity** = ``980.0`` +:ref:`float` **gravity** = ``980.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -397,7 +397,7 @@ The area's gravity intensity (in pixels per second squared). This value multipli .. rst-class:: classref-property -:ref:`Vector2` **gravity_direction** = ``Vector2(0, 1)`` +:ref:`Vector2` **gravity_direction** = ``Vector2(0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -414,7 +414,7 @@ The area's gravity vector (not normalized). .. rst-class:: classref-property -:ref:`bool` **gravity_point** = ``false`` +:ref:`bool` **gravity_point** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -431,7 +431,7 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_cen .. rst-class:: classref-property -:ref:`Vector2` **gravity_point_center** = ``Vector2(0, 1)`` +:ref:`Vector2` **gravity_point_center** = ``Vector2(0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -448,7 +448,7 @@ If gravity is a point (see :ref:`gravity_point` **gravity_point_unit_distance** = ``0.0`` +:ref:`float` **gravity_point_unit_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -467,7 +467,7 @@ The above is true only when the unit distance is a positive number. When this is .. rst-class:: classref-property -:ref:`SpaceOverride` **gravity_space_override** = ``0`` +:ref:`SpaceOverride` **gravity_space_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -484,7 +484,7 @@ Override mode for gravity calculations within this area. See :ref:`SpaceOverride .. rst-class:: classref-property -:ref:`float` **linear_damp** = ``0.1`` +:ref:`float` **linear_damp** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -503,7 +503,7 @@ See :ref:`ProjectSettings.physics/2d/default_linear_damp` **linear_damp_space_override** = ``0`` +:ref:`SpaceOverride` **linear_damp_space_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -520,7 +520,7 @@ Override mode for linear damping calculations within this area. See :ref:`SpaceO .. rst-class:: classref-property -:ref:`bool` **monitorable** = ``true`` +:ref:`bool` **monitorable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -537,7 +537,7 @@ If ``true``, other monitoring areas can detect this area. .. rst-class:: classref-property -:ref:`bool` **monitoring** = ``true`` +:ref:`bool` **monitoring** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -554,7 +554,7 @@ If ``true``, the area detects bodies or areas entering and exiting it. .. rst-class:: classref-property -:ref:`int` **priority** = ``0`` +:ref:`int` **priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -576,7 +576,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Area2D`\] **get_overlapping_areas**\ (\ ) |const| +:ref:`Array`\[:ref:`Area2D`\] **get_overlapping_areas**\ (\ ) |const| :ref:`🔗` Returns a list of intersecting **Area2D**\ s. The overlapping area's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -590,7 +590,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node2D`\] **get_overlapping_bodies**\ (\ ) |const| +:ref:`Array`\[:ref:`Node2D`\] **get_overlapping_bodies**\ (\ ) |const| :ref:`🔗` Returns a list of intersecting :ref:`PhysicsBody2D`\ s and :ref:`TileMap`\ s. The overlapping body's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -604,7 +604,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`bool` **has_overlapping_areas**\ (\ ) |const| +:ref:`bool` **has_overlapping_areas**\ (\ ) |const| :ref:`🔗` Returns ``true`` if intersecting any **Area2D**\ s, otherwise returns ``false``. The overlapping area's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -618,7 +618,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **has_overlapping_bodies**\ (\ ) |const| +:ref:`bool` **has_overlapping_bodies**\ (\ ) |const| :ref:`🔗` Returns ``true`` if intersecting any :ref:`PhysicsBody2D`\ s or :ref:`TileMap`\ s, otherwise returns ``false``. The overlapping body's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -632,7 +632,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **overlaps_area**\ (\ area\: :ref:`Node`\ ) |const| +:ref:`bool` **overlaps_area**\ (\ area\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if the given **Area2D** intersects or overlaps this **Area2D**, ``false`` otherwise. @@ -646,7 +646,7 @@ Returns ``true`` if the given **Area2D** intersects or overlaps this **Area2D**, .. rst-class:: classref-method -:ref:`bool` **overlaps_body**\ (\ body\: :ref:`Node`\ ) |const| +:ref:`bool` **overlaps_body**\ (\ body\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if the given physics body intersects or overlaps this **Area2D**, ``false`` otherwise. diff --git a/classes/class_area3d.rst b/classes/class_area3d.rst index 5b35f3e7b9e..67d979f8775 100644 --- a/classes/class_area3d.rst +++ b/classes/class_area3d.rst @@ -130,7 +130,7 @@ Signals .. rst-class:: classref-signal -**area_entered**\ (\ area\: :ref:`Area3D`\ ) +**area_entered**\ (\ area\: :ref:`Area3D`\ ) :ref:`🔗` Emitted when the received ``area`` enters this area. Requires :ref:`monitoring` to be set to ``true``. @@ -142,7 +142,7 @@ Emitted when the received ``area`` enters this area. Requires :ref:`monitoring`\ ) +**area_exited**\ (\ area\: :ref:`Area3D`\ ) :ref:`🔗` Emitted when the received ``area`` exits this area. Requires :ref:`monitoring` to be set to ``true``. @@ -154,7 +154,7 @@ Emitted when the received ``area`` exits this area. Requires :ref:`monitoring`, area\: :ref:`Area3D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**area_shape_entered**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area3D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape3D` of the received ``area`` enters a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -183,7 +183,7 @@ Emitted when a :ref:`Shape3D` of the received ``area`` enters a s .. rst-class:: classref-signal -**area_shape_exited**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area3D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**area_shape_exited**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area3D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape3D` of the received ``area`` exits a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -197,7 +197,7 @@ See also :ref:`area_shape_entered`. .. rst-class:: classref-signal -**body_entered**\ (\ body\: :ref:`Node3D`\ ) +**body_entered**\ (\ body\: :ref:`Node3D`\ ) :ref:`🔗` Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -209,7 +209,7 @@ Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`Phy .. rst-class:: classref-signal -**body_exited**\ (\ body\: :ref:`Node3D`\ ) +**body_exited**\ (\ body\: :ref:`Node3D`\ ) :ref:`🔗` Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -221,7 +221,7 @@ Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`Phys .. rst-class:: classref-signal -**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node3D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node3D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape3D` of the received ``body`` enters a shape of this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -250,7 +250,7 @@ Emitted when a :ref:`Shape3D` of the received ``body`` enters a s .. rst-class:: classref-signal -**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node3D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node3D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`Shape3D` of the received ``body`` exits a shape of this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -269,7 +269,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SpaceOverride**: +enum **SpaceOverride**: :ref:`🔗` .. _class_Area3D_constant_SPACE_OVERRIDE_DISABLED: @@ -324,7 +324,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_damp** = ``0.1`` +:ref:`float` **angular_damp** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -343,7 +343,7 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` **angular_damp_space_override** = ``0`` +:ref:`SpaceOverride` **angular_damp_space_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -360,7 +360,7 @@ Override mode for angular damping calculations within this area. See :ref:`Space .. rst-class:: classref-property -:ref:`StringName` **audio_bus_name** = ``&"Master"`` +:ref:`StringName` **audio_bus_name** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -377,7 +377,7 @@ The name of the area's audio bus. .. rst-class:: classref-property -:ref:`bool` **audio_bus_override** = ``false`` +:ref:`bool` **audio_bus_override** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -394,7 +394,7 @@ If ``true``, the area's audio bus overrides the default audio bus. .. rst-class:: classref-property -:ref:`float` **gravity** = ``9.8`` +:ref:`float` **gravity** = ``9.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -411,7 +411,7 @@ The area's gravity intensity (in meters per second squared). This value multipli .. rst-class:: classref-property -:ref:`Vector3` **gravity_direction** = ``Vector3(0, -1, 0)`` +:ref:`Vector3` **gravity_direction** = ``Vector3(0, -1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -428,7 +428,7 @@ The area's gravity vector (not normalized). .. rst-class:: classref-property -:ref:`bool` **gravity_point** = ``false`` +:ref:`bool` **gravity_point** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -445,7 +445,7 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_cen .. rst-class:: classref-property -:ref:`Vector3` **gravity_point_center** = ``Vector3(0, -1, 0)`` +:ref:`Vector3` **gravity_point_center** = ``Vector3(0, -1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -462,7 +462,7 @@ If gravity is a point (see :ref:`gravity_point` **gravity_point_unit_distance** = ``0.0`` +:ref:`float` **gravity_point_unit_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -481,7 +481,7 @@ The above is true only when the unit distance is a positive number. When this is .. rst-class:: classref-property -:ref:`SpaceOverride` **gravity_space_override** = ``0`` +:ref:`SpaceOverride` **gravity_space_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -498,7 +498,7 @@ Override mode for gravity calculations within this area. See :ref:`SpaceOverride .. rst-class:: classref-property -:ref:`float` **linear_damp** = ``0.1`` +:ref:`float` **linear_damp** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -517,7 +517,7 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` **linear_damp_space_override** = ``0`` +:ref:`SpaceOverride` **linear_damp_space_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -534,7 +534,7 @@ Override mode for linear damping calculations within this area. See :ref:`SpaceO .. rst-class:: classref-property -:ref:`bool` **monitorable** = ``true`` +:ref:`bool` **monitorable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -551,7 +551,7 @@ If ``true``, other monitoring areas can detect this area. .. rst-class:: classref-property -:ref:`bool` **monitoring** = ``true`` +:ref:`bool` **monitoring** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -568,7 +568,7 @@ If ``true``, the area detects bodies or areas entering and exiting it. .. rst-class:: classref-property -:ref:`int` **priority** = ``0`` +:ref:`int` **priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -585,7 +585,7 @@ The area's priority. Higher priority areas are processed first. The :ref:`World3 .. rst-class:: classref-property -:ref:`float` **reverb_bus_amount** = ``0.0`` +:ref:`float` **reverb_bus_amount** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -602,7 +602,7 @@ The degree to which this area applies reverb to its associated audio. Ranges fro .. rst-class:: classref-property -:ref:`bool` **reverb_bus_enabled** = ``false`` +:ref:`bool` **reverb_bus_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -619,7 +619,7 @@ If ``true``, the area applies reverb to its associated audio. .. rst-class:: classref-property -:ref:`StringName` **reverb_bus_name** = ``&"Master"`` +:ref:`StringName` **reverb_bus_name** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -636,7 +636,7 @@ The name of the reverb bus to use for this area's associated audio. .. rst-class:: classref-property -:ref:`float` **reverb_bus_uniformity** = ``0.0`` +:ref:`float` **reverb_bus_uniformity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -653,7 +653,7 @@ The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to .. rst-class:: classref-property -:ref:`float` **wind_attenuation_factor** = ``0.0`` +:ref:`float` **wind_attenuation_factor** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -672,7 +672,7 @@ The exponential rate at which wind force decreases with distance from its origin .. rst-class:: classref-property -:ref:`float` **wind_force_magnitude** = ``0.0`` +:ref:`float` **wind_force_magnitude** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -691,7 +691,7 @@ The magnitude of area-specific wind force. .. rst-class:: classref-property -:ref:`NodePath` **wind_source_path** = ``NodePath("")`` +:ref:`NodePath` **wind_source_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -715,7 +715,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Area3D`\] **get_overlapping_areas**\ (\ ) |const| +:ref:`Array`\[:ref:`Area3D`\] **get_overlapping_areas**\ (\ ) |const| :ref:`🔗` 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. @@ -729,7 +729,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node3D`\] **get_overlapping_bodies**\ (\ ) |const| +:ref:`Array`\[:ref:`Node3D`\] **get_overlapping_bodies**\ (\ ) |const| :ref:`🔗` Returns a list of intersecting :ref:`PhysicsBody3D`\ s and :ref:`GridMap`\ s. The overlapping body's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -743,7 +743,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`bool` **has_overlapping_areas**\ (\ ) |const| +:ref:`bool` **has_overlapping_areas**\ (\ ) |const| :ref:`🔗` Returns ``true`` if intersecting any **Area3D**\ s, otherwise returns ``false``. The overlapping area's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -757,7 +757,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **has_overlapping_bodies**\ (\ ) |const| +:ref:`bool` **has_overlapping_bodies**\ (\ ) |const| :ref:`🔗` Returns ``true`` if intersecting any :ref:`PhysicsBody3D`\ s or :ref:`GridMap`\ s, otherwise returns ``false``. The overlapping body's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -771,7 +771,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **overlaps_area**\ (\ area\: :ref:`Node`\ ) |const| +:ref:`bool` **overlaps_area**\ (\ area\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if the given **Area3D** intersects or overlaps this **Area3D**, ``false`` otherwise. @@ -785,7 +785,7 @@ Returns ``true`` if the given **Area3D** intersects or overlaps this **Area3D**, .. rst-class:: classref-method -:ref:`bool` **overlaps_body**\ (\ body\: :ref:`Node`\ ) |const| +:ref:`bool` **overlaps_body**\ (\ body\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if the given physics body intersects or overlaps this **Area3D**, ``false`` otherwise. diff --git a/classes/class_array.rst b/classes/class_array.rst index 16b40b07b63..450bbd9761c 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -251,7 +251,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Array` **Array**\ (\ ) +:ref:`Array` **Array**\ (\ ) :ref:`🔗` Constructs an empty **Array**. @@ -418,7 +418,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **all**\ (\ method\: :ref:`Callable`\ ) |const| +:ref:`bool` **all**\ (\ method\: :ref:`Callable`\ ) |const| :ref:`🔗` Calls the provided :ref:`Callable` on each element in the array and returns ``true`` if the :ref:`Callable` returns ``true`` for *all* elements in the array. If the :ref:`Callable` returns ``false`` for one array element or more, this method returns ``false``. @@ -451,7 +451,7 @@ See also :ref:`any`, :ref:`filter` **any**\ (\ method\: :ref:`Callable`\ ) |const| +:ref:`bool` **any**\ (\ method\: :ref:`Callable`\ ) |const| :ref:`🔗` Calls the provided :ref:`Callable` on each element in the array and returns ``true`` if the :ref:`Callable` returns ``true`` for *one or more* elements in the array. If the :ref:`Callable` returns ``false`` for all elements in the array, this method returns ``false``. @@ -484,7 +484,7 @@ See also :ref:`all`, :ref:`filter`\ ) +|void| **append**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -496,7 +496,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`Array`\ ) :ref:`🔗` Appends another array at the end of this array. @@ -515,7 +515,7 @@ Appends another array at the end of this array. .. rst-class:: classref-method -|void| **assign**\ (\ array\: :ref:`Array`\ ) +|void| **assign**\ (\ array\: :ref:`Array`\ ) :ref:`🔗` Assigns elements of another ``array`` into the array. Resizes the array to match ``array``. Performs type conversions if the array is typed. @@ -527,7 +527,7 @@ Assigns elements of another ``array`` into the array. Resizes the array to match .. rst-class:: classref-method -:ref:`Variant` **back**\ (\ ) |const| +:ref:`Variant` **back**\ (\ ) |const| :ref:`🔗` Returns the last element of the array. Prints an error and returns ``null`` if the array is empty. @@ -541,7 +541,7 @@ Returns the last element of the array. Prints an error and returns ``null`` if t .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Variant`, before\: :ref:`bool` = true\ ) |const| +:ref:`int` **bsearch**\ (\ value\: :ref:`Variant`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -561,7 +561,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -:ref:`int` **bsearch_custom**\ (\ value\: :ref:`Variant`, func\: :ref:`Callable`, before\: :ref:`bool` = true\ ) |const| +:ref:`int` **bsearch_custom**\ (\ value\: :ref:`Variant`, func\: :ref:`Callable`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. @@ -577,7 +577,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -589,7 +589,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`Variant`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -601,7 +601,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`Array` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| +:ref:`Array` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a copy of the array. @@ -615,7 +615,7 @@ If ``deep`` is ``true``, a deep copy is performed: all nested arrays and diction .. rst-class:: classref-method -|void| **erase**\ (\ value\: :ref:`Variant`\ ) +|void| **erase**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, use :ref:`remove_at` instead. @@ -633,7 +633,7 @@ Removes the first occurrence of a value from the array. If the value does not ex .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`Variant`\ ) +|void| **fill**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements: @@ -664,7 +664,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`Array` **filter**\ (\ method\: :ref:`Callable`\ ) |const| +:ref:`Array` **filter**\ (\ method\: :ref:`Callable`\ ) |const| :ref:`🔗` Calls the provided :ref:`Callable` on each element in the array and returns a new array with the elements for which the method returned ``true``. @@ -689,7 +689,7 @@ See also :ref:`any`, :ref:`all`, .. rst-class:: classref-method -:ref:`int` **find**\ (\ what\: :ref:`Variant`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ what\: :ref:`Variant`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -701,7 +701,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`Variant` **front**\ (\ ) |const| +:ref:`Variant` **front**\ (\ ) |const| :ref:`🔗` Returns the first element of the array. Prints an error and returns ``null`` if the array is empty. @@ -715,7 +715,7 @@ Returns the first element of the array. Prints an error and returns ``null`` if .. rst-class:: classref-method -:ref:`int` **get_typed_builtin**\ (\ ) |const| +:ref:`int` **get_typed_builtin**\ (\ ) |const| :ref:`🔗` Returns the built-in type of the typed array as a :ref:`Variant.Type` constant. If the array is not typed, returns :ref:`@GlobalScope.TYPE_NIL`. @@ -727,7 +727,7 @@ Returns the built-in type of the typed array as a :ref:`Variant.Type` **get_typed_class_name**\ (\ ) |const| +:ref:`StringName` **get_typed_class_name**\ (\ ) |const| :ref:`🔗` Returns the **native** class name of the typed array if the built-in type is :ref:`@GlobalScope.TYPE_OBJECT`. Otherwise, this method returns an empty string. @@ -739,7 +739,7 @@ Returns the **native** class name of the typed array if the built-in type is :re .. rst-class:: classref-method -:ref:`Variant` **get_typed_script**\ (\ ) |const| +:ref:`Variant` **get_typed_script**\ (\ ) |const| :ref:`🔗` Returns the script associated with the typed array. This method returns a :ref:`Script` instance or ``null``. @@ -751,7 +751,7 @@ Returns the script associated with the typed array. This method returns a :ref:` .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`Variant`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains the given value. @@ -806,7 +806,7 @@ Returns ``true`` if the array contains the given value. .. rst-class:: classref-method -:ref:`int` **hash**\ (\ ) |const| +:ref:`int` **hash**\ (\ ) |const| :ref:`🔗` Returns a hashed 32-bit integer value representing the array and its contents. @@ -820,7 +820,7 @@ Returns a hashed 32-bit integer value representing the array and its contents. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ position\: :ref:`int`, value\: :ref:`Variant`\ ) +:ref:`int` **insert**\ (\ position\: :ref:`int`, value\: :ref:`Variant`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``). Returns :ref:`@GlobalScope.OK` on success, or one of the other :ref:`Error` values if the operation failed. @@ -836,7 +836,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -848,7 +848,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **is_read_only**\ (\ ) |const| +:ref:`bool` **is_read_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is read-only. See :ref:`make_read_only`. Arrays are automatically read-only if declared with ``const`` keyword. @@ -860,7 +860,7 @@ Returns ``true`` if the array is read-only. See :ref:`make_read_only` **is_same_typed**\ (\ array\: :ref:`Array`\ ) |const| +:ref:`bool` **is_same_typed**\ (\ array\: :ref:`Array`\ ) |const| :ref:`🔗` Returns ``true`` if the array is typed the same as ``array``. @@ -872,7 +872,7 @@ Returns ``true`` if the array is typed the same as ``array``. .. rst-class:: classref-method -:ref:`bool` **is_typed**\ (\ ) |const| +:ref:`bool` **is_typed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is typed. Typed arrays can only store elements of their associated type and provide type safety for the ``[]`` operator. Methods of typed array still return :ref:`Variant`. @@ -884,7 +884,7 @@ Returns ``true`` if the array is typed. Typed arrays can only store elements of .. rst-class:: classref-method -|void| **make_read_only**\ (\ ) +|void| **make_read_only**\ (\ ) :ref:`🔗` Makes the array read-only, i.e. disabled modifying of the array's elements. Does not apply to nested content, e.g. content of nested arrays. @@ -896,7 +896,7 @@ Makes the array read-only, i.e. disabled modifying of the array's elements. Does .. rst-class:: classref-method -:ref:`Array` **map**\ (\ method\: :ref:`Callable`\ ) |const| +:ref:`Array` **map**\ (\ method\: :ref:`Callable`\ ) |const| :ref:`🔗` Calls the provided :ref:`Callable` for each element in the array and returns a new array filled with values returned by the method. @@ -921,7 +921,7 @@ See also :ref:`filter`, :ref:`reduce` **max**\ (\ ) |const| +:ref:`Variant` **max**\ (\ ) |const| :ref:`🔗` Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. @@ -945,7 +945,7 @@ To find the maximum value using a custom comparator, you can use :ref:`reduce` **min**\ (\ ) |const| +:ref:`Variant` **min**\ (\ ) |const| :ref:`🔗` Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. @@ -959,7 +959,7 @@ See also :ref:`max` for an example of using a custom com .. rst-class:: classref-method -:ref:`Variant` **pick_random**\ (\ ) |const| +:ref:`Variant` **pick_random**\ (\ ) |const| :ref:`🔗` Returns a random value from the target array. Prints an error and returns ``null`` if the array is empty. @@ -986,7 +986,7 @@ Returns a random value from the target array. Prints an error and returns ``null .. rst-class:: classref-method -:ref:`Variant` **pop_at**\ (\ position\: :ref:`int`\ ) +:ref:`Variant` **pop_at**\ (\ position\: :ref:`int`\ ) :ref:`🔗` Removes and returns the element of the array at index ``position``. If negative, ``position`` is considered relative to the end of the array. Leaves the array unchanged and returns ``null`` if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty. @@ -1000,7 +1000,7 @@ Removes and returns the element of the array at index ``position``. If negative, .. rst-class:: classref-method -:ref:`Variant` **pop_back**\ (\ ) +:ref:`Variant` **pop_back**\ (\ ) :ref:`🔗` Removes and returns the last element of the array. Returns ``null`` if the array is empty, without printing an error message. See also :ref:`pop_front`. @@ -1012,7 +1012,7 @@ Removes and returns the last element of the array. Returns ``null`` if the array .. rst-class:: classref-method -:ref:`Variant` **pop_front**\ (\ ) +:ref:`Variant` **pop_front**\ (\ ) :ref:`🔗` Removes and returns the first element of the array. Returns ``null`` if the array is empty, without printing an error message. See also :ref:`pop_back`. @@ -1026,7 +1026,7 @@ Removes and returns the first element of the array. Returns ``null`` if the arra .. rst-class:: classref-method -|void| **push_back**\ (\ value\: :ref:`Variant`\ ) +|void| **push_back**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Appends an element at the end of the array. See also :ref:`push_front`. @@ -1038,7 +1038,7 @@ Appends an element at the end of the array. See also :ref:`push_front`\ ) +|void| **push_front**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Adds an element at the beginning of the array. See also :ref:`push_back`. @@ -1052,7 +1052,7 @@ Adds an element at the beginning of the array. See also :ref:`push_back` **reduce**\ (\ method\: :ref:`Callable`, accum\: :ref:`Variant` = null\ ) |const| +:ref:`Variant` **reduce**\ (\ method\: :ref:`Callable`, accum\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Calls the provided :ref:`Callable` for each element in array and accumulates the result in ``accum``. @@ -1077,7 +1077,7 @@ See also :ref:`map`, :ref:`filter`\ ) +|void| **remove_at**\ (\ position\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use :ref:`erase` instead. @@ -1095,7 +1095,7 @@ Removes an element from the array by index. If the index does not exist in the a .. rst-class:: classref-method -:ref:`int` **resize**\ (\ size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ size\: :ref:`int`\ ) :ref:`🔗` Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are ``null``. Returns :ref:`@GlobalScope.OK` on success, or one of the other :ref:`Error` values if the operation failed. @@ -1111,7 +1111,7 @@ Calling :ref:`resize` once and assigning the new valu .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -1123,7 +1123,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ what\: :ref:`Variant`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ what\: :ref:`Variant`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -1135,7 +1135,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **shuffle**\ (\ ) +|void| **shuffle**\ (\ ) :ref:`🔗` Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as :ref:`@GlobalScope.randi`. Call :ref:`@GlobalScope.randomize` to ensure that a new seed will be used each time if you want non-reproducible shuffling. @@ -1147,7 +1147,7 @@ Shuffles the array such that the items will have a random order. This method use .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -1159,7 +1159,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647, step\: :ref:`int` = 1, deep\: :ref:`bool` = false\ ) |const| +:ref:`Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647, step\: :ref:`int` = 1, deep\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the slice of the **Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **Array**. @@ -1181,7 +1181,7 @@ If ``deep`` is true, each element will be copied by value rather than by referen .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the array. @@ -1222,7 +1222,7 @@ To perform natural order sorting, you can use :ref:`sort_custom`\ ) +|void| **sort_custom**\ (\ func\: :ref:`Callable`\ ) :ref:`🔗` Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either ``true`` or ``false``. For two elements ``a`` and ``b``, if the given method returns ``true``, element ``b`` will be after element ``a`` in the array. @@ -1268,7 +1268,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Compares the left operand **Array** against the ``right`` **Array**. Returns ``true`` if the sizes or contents of the arrays are *not* equal, ``false`` otherwise. @@ -1280,7 +1280,7 @@ Compares the left operand **Array** against the ``right`` **Array**. Returns ``t .. rst-class:: classref-operator -:ref:`Array` **operator +**\ (\ right\: :ref:`Array`\ ) +:ref:`Array` **operator +**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Concatenates two **Array**\ s together, with the ``right`` **Array** being added to the end of the **Array** specified in the left operand. For example, ``[1, 2] + [3, 4]`` results in ``[1, 2, 3, 4]``. @@ -1292,7 +1292,7 @@ Concatenates two **Array**\ s together, with the ``right`` **Array** being added .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Array`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is less, or ``false`` if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``false`` if the left operand **Array** has fewer elements, otherwise it returns ``true``. @@ -1304,7 +1304,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Array`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is less, or ``false`` if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``true`` if the left operand **Array** has the same number of elements or fewer, otherwise it returns ``false``. @@ -1316,7 +1316,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Compares the left operand **Array** against the ``right`` **Array**. Returns ``true`` if the sizes and contents of the arrays are equal, ``false`` otherwise. @@ -1328,7 +1328,7 @@ Compares the left operand **Array** against the ``right`` **Array**. Returns ``t .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Array`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is greater, or ``false`` if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``true`` if the ``right`` **Array** has more elements, otherwise it returns ``false``. @@ -1340,7 +1340,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Array`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Array`\ ) :ref:`🔗` Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is greater, or ``false`` if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``true`` if the ``right`` **Array** has more or the same number of elements, otherwise it returns ``false``. @@ -1352,7 +1352,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`Variant` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Variant` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns a reference to the element of type :ref:`Variant` at the specified location. Arrays start at index 0. ``index`` can be a zero or positive value to start from the beginning, or a negative value to start from the end. Out-of-bounds array access causes a run-time error, which will result in an error being printed and the project execution pausing if run from the editor. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index b8905fb4bdc..629392dde74 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -156,7 +156,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BlendShapeMode` **blend_shape_mode** = ``1`` +:ref:`BlendShapeMode` **blend_shape_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ Sets the blend shape mode to one of :ref:`BlendShapeMode` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ Overrides the :ref:`AABB` with one defined by user for use with frus .. rst-class:: classref-property -:ref:`ArrayMesh` **shadow_mesh** +:ref:`ArrayMesh` **shadow_mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_blend_shape**\ (\ name\: :ref:`StringName`\ ) +|void| **add_blend_shape**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Adds name for a blend shape that will be added with :ref:`add_surface_from_arrays`. Must be called before surface is added. @@ -224,7 +224,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface_from_array .. rst-class:: classref-method -|void| **add_surface_from_arrays**\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, flags\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) +|void| **add_surface_from_arrays**\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, flags\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) :ref:`🔗` Creates a new surface. :ref:`Mesh.get_surface_count` will become the ``surf_idx`` for this new surface. @@ -248,7 +248,7 @@ The ``flags`` argument is the bitwise or of, as required: One value of :ref:`Arr .. rst-class:: classref-method -|void| **clear_blend_shapes**\ (\ ) +|void| **clear_blend_shapes**\ (\ ) :ref:`🔗` Removes all blend shapes from this **ArrayMesh**. @@ -260,7 +260,7 @@ Removes all blend shapes from this **ArrayMesh**. .. rst-class:: classref-method -|void| **clear_surfaces**\ (\ ) +|void| **clear_surfaces**\ (\ ) :ref:`🔗` Removes all surfaces from this **ArrayMesh**. @@ -272,7 +272,7 @@ Removes all surfaces from this **ArrayMesh**. .. rst-class:: classref-method -:ref:`int` **get_blend_shape_count**\ (\ ) |const| +:ref:`int` **get_blend_shape_count**\ (\ ) |const| :ref:`🔗` Returns the number of blend shapes that the **ArrayMesh** holds. @@ -284,7 +284,7 @@ Returns the number of blend shapes that the **ArrayMesh** holds. .. rst-class:: classref-method -:ref:`StringName` **get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |const| +:ref:`StringName` **get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the blend shape at this index. @@ -296,7 +296,7 @@ Returns the name of the blend shape at this index. .. rst-class:: classref-method -:ref:`Error` **lightmap_unwrap**\ (\ transform\: :ref:`Transform3D`, texel_size\: :ref:`float`\ ) +:ref:`Error` **lightmap_unwrap**\ (\ transform\: :ref:`Transform3D`, texel_size\: :ref:`float`\ ) :ref:`🔗` Performs a UV unwrap on the **ArrayMesh** to prepare the mesh for lightmapping. @@ -308,7 +308,7 @@ Performs a UV unwrap on the **ArrayMesh** to prepare the mesh for lightmapping. .. rst-class:: classref-method -|void| **regen_normal_maps**\ (\ ) +|void| **regen_normal_maps**\ (\ ) :ref:`🔗` Regenerates tangents for each of the **ArrayMesh**'s surfaces. @@ -320,7 +320,7 @@ Regenerates tangents for each of the **ArrayMesh**'s surfaces. .. rst-class:: classref-method -|void| **set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) +|void| **set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) :ref:`🔗` Sets the name of the blend shape at this index. @@ -332,7 +332,7 @@ Sets the name of the blend shape at this index. .. rst-class:: classref-method -:ref:`int` **surface_find_by_name**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **surface_find_by_name**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the index of the first surface with this name held within this **ArrayMesh**. If none are found, -1 is returned. @@ -344,7 +344,7 @@ Returns the index of the first surface with this name held within this **ArrayMe .. rst-class:: classref-method -:ref:`int` **surface_get_array_index_len**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`int` **surface_get_array_index_len**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). @@ -356,7 +356,7 @@ Returns the length in indices of the index array in the requested surface (see : .. rst-class:: classref-method -:ref:`int` **surface_get_array_len**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`int` **surface_get_array_len**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). @@ -368,7 +368,7 @@ Returns the length in vertices of the vertex array in the requested surface (see .. rst-class:: classref-method -|bitfield|\[:ref:`ArrayFormat`\] **surface_get_format**\ (\ surf_idx\: :ref:`int`\ ) |const| +|bitfield|\[:ref:`ArrayFormat`\] **surface_get_format**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays`). @@ -380,7 +380,7 @@ Returns the format mask of the requested surface (see :ref:`add_surface_from_arr .. rst-class:: classref-method -:ref:`String` **surface_get_name**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`String` **surface_get_name**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Gets the name assigned to this surface. @@ -392,7 +392,7 @@ Gets the name assigned to this surface. .. rst-class:: classref-method -:ref:`PrimitiveType` **surface_get_primitive_type**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`PrimitiveType` **surface_get_primitive_type**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). @@ -404,7 +404,7 @@ Returns the primitive type of the requested surface (see :ref:`add_surface_from_ .. rst-class:: classref-method -|void| **surface_set_name**\ (\ surf_idx\: :ref:`int`, name\: :ref:`String`\ ) +|void| **surface_set_name**\ (\ surf_idx\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets a name for a given surface. @@ -416,7 +416,7 @@ Sets a name for a given surface. .. rst-class:: classref-method -|void| **surface_update_attribute_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +|void| **surface_update_attribute_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute @@ -430,7 +430,7 @@ Sets a name for a given surface. .. rst-class:: classref-method -|void| **surface_update_skin_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +|void| **surface_update_skin_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute @@ -444,7 +444,7 @@ Sets a name for a given surface. .. rst-class:: classref-method -|void| **surface_update_vertex_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +|void| **surface_update_vertex_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_arrayoccluder3d.rst b/classes/class_arrayoccluder3d.rst index a31fc6ba882..5bdd43482c2 100644 --- a/classes/class_arrayoccluder3d.rst +++ b/classes/class_arrayoccluder3d.rst @@ -69,7 +69,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **indices** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **indices** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The occluder's index position. Indices determine which points from the :ref:`ver .. rst-class:: classref-property -:ref:`PackedVector3Array` **vertices** = ``PackedVector3Array()`` +:ref:`PackedVector3Array` **vertices** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_arrays**\ (\ vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) +|void| **set_arrays**\ (\ vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Sets :ref:`indices` and :ref:`vertices`, while updating the final occluder only once after both values are set. diff --git a/classes/class_aspectratiocontainer.rst b/classes/class_aspectratiocontainer.rst index a90d06e74c9..c9e5b02c1af 100644 --- a/classes/class_aspectratiocontainer.rst +++ b/classes/class_aspectratiocontainer.rst @@ -59,7 +59,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **StretchMode**: +enum **StretchMode**: :ref:`🔗` .. _class_AspectRatioContainer_constant_STRETCH_WIDTH_CONTROLS_HEIGHT: @@ -103,7 +103,7 @@ When the bounding rectangle of child controls exceed the container's size and :r .. rst-class:: classref-enumeration -enum **AlignmentMode**: +enum **AlignmentMode**: :ref:`🔗` .. _class_AspectRatioContainer_constant_ALIGNMENT_BEGIN: @@ -142,7 +142,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AlignmentMode` **alignment_horizontal** = ``1`` +:ref:`AlignmentMode` **alignment_horizontal** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Specifies the horizontal relative position of child controls. .. rst-class:: classref-property -:ref:`AlignmentMode` **alignment_vertical** = ``1`` +:ref:`AlignmentMode` **alignment_vertical** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Specifies the vertical relative position of child controls. .. rst-class:: classref-property -:ref:`float` **ratio** = ``1.0`` +:ref:`float` **ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ The aspect ratio to enforce on child controls. This is the width divided by the .. rst-class:: classref-property -:ref:`StretchMode` **stretch_mode** = ``2`` +:ref:`StretchMode` **stretch_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index 4e4faea583d..91eef236561 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Called when computing the cost between two connected points. @@ -110,7 +110,7 @@ Note that this function is hidden in the default **AStar2D** class. .. rst-class:: classref-method -:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Called when estimating the cost between a point and the path's ending point. @@ -124,7 +124,7 @@ Note that this function is hidden in the default **AStar2D** class. .. rst-class:: classref-method -|void| **add_point**\ (\ id\: :ref:`int`, position\: :ref:`Vector2`, weight_scale\: :ref:`float` = 1.0\ ) +|void| **add_point**\ (\ id\: :ref:`int`, position\: :ref:`Vector2`, weight_scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Adds a new point at the given position with the given identifier. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 0.0 or greater. @@ -155,7 +155,7 @@ If there already exists a point for the given ``id``, its position and weight sc .. rst-class:: classref-method -:ref:`bool` **are_points_connected**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| +:ref:`bool` **are_points_connected**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns whether there is a connection/segment between the given points. If ``bidirectional`` is ``false``, returns whether movement from ``id`` to ``to_id`` is possible through this segment. @@ -167,7 +167,7 @@ Returns whether there is a connection/segment between the given points. If ``bid .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears all the points and segments. @@ -179,7 +179,7 @@ Clears all the points and segments. .. rst-class:: classref-method -|void| **connect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) +|void| **connect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) :ref:`🔗` Creates a segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is allowed, not the reverse direction. @@ -210,7 +210,7 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o .. rst-class:: classref-method -|void| **disconnect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) +|void| **disconnect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) :ref:`🔗` Deletes the segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is prevented, and a unidirectional segment possibly remains. @@ -222,7 +222,7 @@ Deletes the segment between the given points. If ``bidirectional`` is ``false``, .. rst-class:: classref-method -:ref:`int` **get_available_point_id**\ (\ ) |const| +:ref:`int` **get_available_point_id**\ (\ ) |const| :ref:`🔗` Returns the next available point ID with no point associated to it. @@ -234,7 +234,7 @@ Returns the next available point ID with no point associated to it. .. rst-class:: classref-method -:ref:`int` **get_closest_point**\ (\ to_position\: :ref:`Vector2`, include_disabled\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_closest_point**\ (\ to_position\: :ref:`Vector2`, include_disabled\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the ID of the closest point to ``to_position``, optionally taking disabled points into account. Returns ``-1`` if there are no points in the points pool. @@ -248,7 +248,7 @@ Returns the ID of the closest point to ``to_position``, optionally taking disabl .. rst-class:: classref-method -:ref:`Vector2` **get_closest_position_in_segment**\ (\ to_position\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **get_closest_position_in_segment**\ (\ to_position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -283,7 +283,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) +:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -333,7 +333,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. rst-class:: classref-method -:ref:`int` **get_point_capacity**\ (\ ) |const| +:ref:`int` **get_point_capacity**\ (\ ) |const| :ref:`🔗` Returns the capacity of the structure backing the points, useful in conjunction with :ref:`reserve_space`. @@ -345,7 +345,7 @@ Returns the capacity of the structure backing the points, useful in conjunction .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_connections**\ (\ id\: :ref:`int`\ ) +:ref:`PackedInt64Array` **get_point_connections**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns an array with the IDs of the points that form the connection with the given point. @@ -388,7 +388,7 @@ Returns an array with the IDs of the points that form the connection with the gi .. rst-class:: classref-method -:ref:`int` **get_point_count**\ (\ ) |const| +:ref:`int` **get_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of points currently in the points pool. @@ -400,7 +400,7 @@ Returns the number of points currently in the points pool. .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_ids**\ (\ ) +:ref:`PackedInt64Array` **get_point_ids**\ (\ ) :ref:`🔗` Returns an array of all point IDs. @@ -412,7 +412,7 @@ Returns an array of all point IDs. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) +:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -428,7 +428,7 @@ If there is no valid path to the target, and ``allow_partial_path`` is ``true``, .. rst-class:: classref-method -:ref:`Vector2` **get_point_position**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_point_position**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the point associated with the given ``id``. @@ -440,7 +440,7 @@ Returns the position of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`int`\ ) |const| +:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the weight scale of the point associated with the given ``id``. @@ -452,7 +452,7 @@ Returns the weight scale of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`bool` **has_point**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **has_point**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether a point associated with the given ``id`` exists. @@ -464,7 +464,7 @@ Returns whether a point associated with the given ``id`` exists. .. rst-class:: classref-method -:ref:`bool` **is_point_disabled**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **is_point_disabled**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. @@ -476,7 +476,7 @@ Returns whether a point is disabled or not for pathfinding. By default, all poin .. rst-class:: classref-method -|void| **remove_point**\ (\ id\: :ref:`int`\ ) +|void| **remove_point**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the point associated with the given ``id`` from the points pool. @@ -488,7 +488,7 @@ Removes the point associated with the given ``id`` from the points pool. .. rst-class:: classref-method -|void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) +|void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) :ref:`🔗` Reserves space internally for ``num_nodes`` points, useful if you're adding a known large number of points at once, such as points on a grid. New capacity must be greater or equals to old capacity. @@ -500,7 +500,7 @@ Reserves space internally for ``num_nodes`` points, useful if you're adding a kn .. rst-class:: classref-method -|void| **set_point_disabled**\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) +|void| **set_point_disabled**\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) :ref:`🔗` Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. @@ -512,7 +512,7 @@ Disables or enables the specified point for pathfinding. Useful for making a tem .. rst-class:: classref-method -|void| **set_point_position**\ (\ id\: :ref:`int`, position\: :ref:`Vector2`\ ) +|void| **set_point_position**\ (\ id\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the ``position`` for the point with the given ``id``. @@ -524,7 +524,7 @@ Sets the ``position`` for the point with the given ``id``. .. rst-class:: classref-method -|void| **set_point_weight_scale**\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) +|void| **set_point_weight_scale**\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) :ref:`🔗` Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scale`` is multiplied by the result of :ref:`_compute_cost` when determining the overall cost of traveling across a segment from a neighboring point to this point. diff --git a/classes/class_astar3d.rst b/classes/class_astar3d.rst index 6f23f7ddbb5..68a00d86253 100644 --- a/classes/class_astar3d.rst +++ b/classes/class_astar3d.rst @@ -133,7 +133,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Called when computing the cost between two connected points. @@ -147,7 +147,7 @@ Note that this function is hidden in the default **AStar3D** class. .. rst-class:: classref-method -:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Called when estimating the cost between a point and the path's ending point. @@ -161,7 +161,7 @@ Note that this function is hidden in the default **AStar3D** class. .. rst-class:: classref-method -|void| **add_point**\ (\ id\: :ref:`int`, position\: :ref:`Vector3`, weight_scale\: :ref:`float` = 1.0\ ) +|void| **add_point**\ (\ id\: :ref:`int`, position\: :ref:`Vector3`, weight_scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Adds a new point at the given position with the given identifier. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 0.0 or greater. @@ -192,7 +192,7 @@ If there already exists a point for the given ``id``, its position and weight sc .. rst-class:: classref-method -:ref:`bool` **are_points_connected**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| +:ref:`bool` **are_points_connected**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns whether the two given points are directly connected by a segment. If ``bidirectional`` is ``false``, returns whether movement from ``id`` to ``to_id`` is possible through this segment. @@ -204,7 +204,7 @@ Returns whether the two given points are directly connected by a segment. If ``b .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears all the points and segments. @@ -216,7 +216,7 @@ Clears all the points and segments. .. rst-class:: classref-method -|void| **connect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) +|void| **connect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) :ref:`🔗` Creates a segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is allowed, not the reverse direction. @@ -247,7 +247,7 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o .. rst-class:: classref-method -|void| **disconnect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) +|void| **disconnect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) :ref:`🔗` Deletes the segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is prevented, and a unidirectional segment possibly remains. @@ -259,7 +259,7 @@ Deletes the segment between the given points. If ``bidirectional`` is ``false``, .. rst-class:: classref-method -:ref:`int` **get_available_point_id**\ (\ ) |const| +:ref:`int` **get_available_point_id**\ (\ ) |const| :ref:`🔗` Returns the next available point ID with no point associated to it. @@ -271,7 +271,7 @@ Returns the next available point ID with no point associated to it. .. rst-class:: classref-method -:ref:`int` **get_closest_point**\ (\ to_position\: :ref:`Vector3`, include_disabled\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_closest_point**\ (\ to_position\: :ref:`Vector3`, include_disabled\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the ID of the closest point to ``to_position``, optionally taking disabled points into account. Returns ``-1`` if there are no points in the points pool. @@ -285,7 +285,7 @@ Returns the ID of the closest point to ``to_position``, optionally taking disabl .. rst-class:: classref-method -:ref:`Vector3` **get_closest_position_in_segment**\ (\ to_position\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **get_closest_position_in_segment**\ (\ to_position\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -320,7 +320,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) +:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` Returns an array with the IDs of the points that form the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -369,7 +369,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. rst-class:: classref-method -:ref:`int` **get_point_capacity**\ (\ ) |const| +:ref:`int` **get_point_capacity**\ (\ ) |const| :ref:`🔗` Returns the capacity of the structure backing the points, useful in conjunction with :ref:`reserve_space`. @@ -381,7 +381,7 @@ Returns the capacity of the structure backing the points, useful in conjunction .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_connections**\ (\ id\: :ref:`int`\ ) +:ref:`PackedInt64Array` **get_point_connections**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns an array with the IDs of the points that form the connection with the given point. @@ -423,7 +423,7 @@ Returns an array with the IDs of the points that form the connection with the gi .. rst-class:: classref-method -:ref:`int` **get_point_count**\ (\ ) |const| +:ref:`int` **get_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of points currently in the points pool. @@ -435,7 +435,7 @@ Returns the number of points currently in the points pool. .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_ids**\ (\ ) +:ref:`PackedInt64Array` **get_point_ids**\ (\ ) :ref:`🔗` Returns an array of all point IDs. @@ -447,7 +447,7 @@ Returns an array of all point IDs. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) +:ref:`PackedVector3Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -463,7 +463,7 @@ If there is no valid path to the target, and ``allow_partial_path`` is ``true``, .. rst-class:: classref-method -:ref:`Vector3` **get_point_position**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_point_position**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the point associated with the given ``id``. @@ -475,7 +475,7 @@ Returns the position of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`int`\ ) |const| +:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the weight scale of the point associated with the given ``id``. @@ -487,7 +487,7 @@ Returns the weight scale of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`bool` **has_point**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **has_point**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether a point associated with the given ``id`` exists. @@ -499,7 +499,7 @@ Returns whether a point associated with the given ``id`` exists. .. rst-class:: classref-method -:ref:`bool` **is_point_disabled**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **is_point_disabled**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. @@ -511,7 +511,7 @@ Returns whether a point is disabled or not for pathfinding. By default, all poin .. rst-class:: classref-method -|void| **remove_point**\ (\ id\: :ref:`int`\ ) +|void| **remove_point**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the point associated with the given ``id`` from the points pool. @@ -523,7 +523,7 @@ Removes the point associated with the given ``id`` from the points pool. .. rst-class:: classref-method -|void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) +|void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) :ref:`🔗` Reserves space internally for ``num_nodes`` points. Useful if you're adding a known large number of points at once, such as points on a grid. New capacity must be greater or equals to old capacity. @@ -535,7 +535,7 @@ Reserves space internally for ``num_nodes`` points. Useful if you're adding a kn .. rst-class:: classref-method -|void| **set_point_disabled**\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) +|void| **set_point_disabled**\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) :ref:`🔗` Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. @@ -547,7 +547,7 @@ Disables or enables the specified point for pathfinding. Useful for making a tem .. rst-class:: classref-method -|void| **set_point_position**\ (\ id\: :ref:`int`, position\: :ref:`Vector3`\ ) +|void| **set_point_position**\ (\ id\: :ref:`int`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the ``position`` for the point with the given ``id``. @@ -559,7 +559,7 @@ Sets the ``position`` for the point with the given ``id``. .. rst-class:: classref-method -|void| **set_point_weight_scale**\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) +|void| **set_point_weight_scale**\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) :ref:`🔗` Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scale`` is multiplied by the result of :ref:`_compute_cost` when determining the overall cost of traveling across a segment from a neighboring point to this point. diff --git a/classes/class_astargrid2d.rst b/classes/class_astargrid2d.rst index fe0434c38f6..770356dc125 100644 --- a/classes/class_astargrid2d.rst +++ b/classes/class_astargrid2d.rst @@ -131,7 +131,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Heuristic**: +enum **Heuristic**: :ref:`🔗` .. _class_AStarGrid2D_constant_HEURISTIC_EUCLIDEAN: @@ -210,7 +210,7 @@ Represents the size of the :ref:`Heuristic` enum. .. rst-class:: classref-enumeration -enum **DiagonalMode**: +enum **DiagonalMode**: :ref:`🔗` .. _class_AStarGrid2D_constant_DIAGONAL_MODE_ALWAYS: @@ -260,7 +260,7 @@ Represents the size of the :ref:`DiagonalMode` en .. rst-class:: classref-enumeration -enum **CellShape**: +enum **CellShape**: :ref:`🔗` .. _class_AStarGrid2D_constant_CELL_SHAPE_SQUARE: @@ -307,7 +307,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CellShape` **cell_shape** = ``0`` +:ref:`CellShape` **cell_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ The cell shape. Affects how the positions are placed in the grid. If changed, :r .. rst-class:: classref-property -:ref:`Vector2` **cell_size** = ``Vector2(1, 1)`` +:ref:`Vector2` **cell_size** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -341,7 +341,7 @@ The size of the point cell which will be applied to calculate the resulting poin .. rst-class:: classref-property -:ref:`Heuristic` **default_compute_heuristic** = ``0`` +:ref:`Heuristic` **default_compute_heuristic** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ The default :ref:`Heuristic` which will be used to c .. rst-class:: classref-property -:ref:`Heuristic` **default_estimate_heuristic** = ``0`` +:ref:`Heuristic` **default_estimate_heuristic** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ The default :ref:`Heuristic` which will be used to c .. rst-class:: classref-property -:ref:`DiagonalMode` **diagonal_mode** = ``0`` +:ref:`DiagonalMode` **diagonal_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ A specific :ref:`DiagonalMode` mode which will fo .. rst-class:: classref-property -:ref:`bool` **jumping_enabled** = ``false`` +:ref:`bool` **jumping_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -411,7 +411,7 @@ Enables or disables jumping to skip up the intermediate points and speeds up the .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -428,7 +428,7 @@ The offset of the grid which will be applied to calculate the resulting point po .. rst-class:: classref-property -:ref:`Rect2i` **region** = ``Rect2i(0, 0, 0, 0)`` +:ref:`Rect2i` **region** = ``Rect2i(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -445,7 +445,7 @@ The region of grid cells available for pathfinding. If changed, :ref:`update` **size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -469,7 +469,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| +:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` Called when computing the cost between two connected points. @@ -483,7 +483,7 @@ Note that this function is hidden in the default **AStarGrid2D** class. .. rst-class:: classref-method -:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| +:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` Called when estimating the cost between a point and the path's ending point. @@ -497,7 +497,7 @@ Note that this function is hidden in the default **AStarGrid2D** class. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the grid and sets the :ref:`region` to ``Rect2i(0, 0, 0, 0)``. @@ -509,7 +509,7 @@ Clears the grid and sets the :ref:`region` to .. rst-class:: classref-method -|void| **fill_solid_region**\ (\ region\: :ref:`Rect2i`, solid\: :ref:`bool` = true\ ) +|void| **fill_solid_region**\ (\ region\: :ref:`Rect2i`, solid\: :ref:`bool` = true\ ) :ref:`🔗` Fills the given ``region`` on the grid with the specified value for the solid flag. @@ -523,7 +523,7 @@ Fills the given ``region`` on the grid with the specified value for the solid fl .. rst-class:: classref-method -|void| **fill_weight_scale_region**\ (\ region\: :ref:`Rect2i`, weight_scale\: :ref:`float`\ ) +|void| **fill_weight_scale_region**\ (\ region\: :ref:`Rect2i`, weight_scale\: :ref:`float`\ ) :ref:`🔗` Fills the given ``region`` on the grid with the specified value for the weight scale. @@ -537,7 +537,7 @@ Fills the given ``region`` on the grid with the specified value for the weight s .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_id_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) +:ref:`Array`\[:ref:`Vector2i`\] **get_id_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -551,7 +551,7 @@ If there is no valid path to the target, and ``allow_partial_path`` is ``true``, .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) +:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) :ref:`🔗` Returns an array with the points that are in the path found by **AStarGrid2D** between the given points. The array is ordered from the starting point to the ending point of the path. @@ -567,7 +567,7 @@ If there is no valid path to the target, and ``allow_partial_path`` is ``true``, .. rst-class:: classref-method -:ref:`Vector2` **get_point_position**\ (\ id\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2` **get_point_position**\ (\ id\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the position of the point associated with the given ``id``. @@ -579,7 +579,7 @@ Returns the position of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`Vector2i`\ ) |const| +:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the weight scale of the point associated with the given ``id``. @@ -591,7 +591,7 @@ Returns the weight scale of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`bool` **is_dirty**\ (\ ) |const| +:ref:`bool` **is_dirty**\ (\ ) |const| :ref:`🔗` Indicates that the grid parameters were changed and :ref:`update` needs to be called. @@ -603,7 +603,7 @@ Indicates that the grid parameters were changed and :ref:`update` **is_in_bounds**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| +:ref:`bool` **is_in_bounds**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the ``x`` and ``y`` is a valid grid coordinate (id), i.e. if it is inside :ref:`region`. Equivalent to ``region.has_point(Vector2i(x, y))``. @@ -615,7 +615,7 @@ Returns ``true`` if the ``x`` and ``y`` is a valid grid coordinate (id), i.e. if .. rst-class:: classref-method -:ref:`bool` **is_in_boundsv**\ (\ id\: :ref:`Vector2i`\ ) |const| +:ref:`bool` **is_in_boundsv**\ (\ id\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns ``true`` if the ``id`` vector is a valid grid coordinate, i.e. if it is inside :ref:`region`. Equivalent to ``region.has_point(id)``. @@ -627,7 +627,7 @@ Returns ``true`` if the ``id`` vector is a valid grid coordinate, i.e. if it is .. rst-class:: classref-method -:ref:`bool` **is_point_solid**\ (\ id\: :ref:`Vector2i`\ ) |const| +:ref:`bool` **is_point_solid**\ (\ id\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns ``true`` if a point is disabled for pathfinding. By default, all points are enabled. @@ -639,7 +639,7 @@ Returns ``true`` if a point is disabled for pathfinding. By default, all points .. rst-class:: classref-method -|void| **set_point_solid**\ (\ id\: :ref:`Vector2i`, solid\: :ref:`bool` = true\ ) +|void| **set_point_solid**\ (\ id\: :ref:`Vector2i`, solid\: :ref:`bool` = true\ ) :ref:`🔗` Disables or enables the specified point for pathfinding. Useful for making an obstacle. By default, all points are enabled. @@ -653,7 +653,7 @@ Disables or enables the specified point for pathfinding. Useful for making an ob .. rst-class:: classref-method -|void| **set_point_weight_scale**\ (\ id\: :ref:`Vector2i`, weight_scale\: :ref:`float`\ ) +|void| **set_point_weight_scale**\ (\ id\: :ref:`Vector2i`, weight_scale\: :ref:`float`\ ) :ref:`🔗` Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scale`` is multiplied by the result of :ref:`_compute_cost` when determining the overall cost of traveling across a segment from a neighboring point to this point. @@ -667,7 +667,7 @@ Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scal .. rst-class:: classref-method -|void| **update**\ (\ ) +|void| **update**\ (\ ) :ref:`🔗` Updates the internal state of the grid according to the parameters to prepare it to search the path. Needs to be called if parameters like :ref:`region`, :ref:`cell_size` or :ref:`offset` are changed. :ref:`is_dirty` will return ``true`` if this is the case and this needs to be called. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index dfa08025df5..42228a2387e 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -58,7 +58,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture2D` **atlas** +:ref:`Texture2D` **atlas** :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ The texture that contains the atlas. Can be any type inheriting from :ref:`Textu .. rst-class:: classref-property -:ref:`bool` **filter_clip** = ``false`` +:ref:`bool` **filter_clip** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -92,7 +92,7 @@ If ``true``, the area outside of the :ref:`region` **margin** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **margin** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -109,7 +109,7 @@ The margin around the :ref:`region`. Useful .. rst-class:: classref-property -:ref:`Rect2` **region** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **region** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 95ce3b49651..21fc6d2680b 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -59,7 +59,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioEffectInstance` **_instantiate**\ (\ ) |virtual| +:ref:`AudioEffectInstance` **_instantiate**\ (\ ) |virtual| :ref:`🔗` Override this method to customize the :ref:`AudioEffectInstance` created when this effect is applied on a bus in the editor's Audio panel, or through :ref:`AudioServer.add_bus_effect`. diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 4b3aeea0bf6..f6714bf15b6 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -53,7 +53,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **volume_db** = ``0.0`` +:ref:`float` **volume_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index 75d76d9f05b..46470fef148 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -81,7 +81,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **buffer_length** = ``0.1`` +:ref:`float` **buffer_length** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_get_buffer**\ (\ frames\: :ref:`int`\ ) |const| +:ref:`bool` **can_get_buffer**\ (\ frames\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if at least ``frames`` audio frames are available to read in the internal ring buffer. @@ -115,7 +115,7 @@ Returns ``true`` if at least ``frames`` audio frames are available to read in th .. rst-class:: classref-method -|void| **clear_buffer**\ (\ ) +|void| **clear_buffer**\ (\ ) :ref:`🔗` Clears the internal ring buffer. @@ -129,7 +129,7 @@ Clears the internal ring buffer. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_buffer**\ (\ frames\: :ref:`int`\ ) +:ref:`PackedVector2Array` **get_buffer**\ (\ frames\: :ref:`int`\ ) :ref:`🔗` Gets the next ``frames`` audio samples from the internal ring buffer. @@ -145,7 +145,7 @@ The samples are signed floating-point PCM between ``-1`` and ``1``. You will hav .. rst-class:: classref-method -:ref:`int` **get_buffer_length_frames**\ (\ ) |const| +:ref:`int` **get_buffer_length_frames**\ (\ ) |const| :ref:`🔗` Returns the total size of the internal ring buffer in frames. @@ -157,7 +157,7 @@ Returns the total size of the internal ring buffer in frames. .. rst-class:: classref-method -:ref:`int` **get_discarded_frames**\ (\ ) |const| +:ref:`int` **get_discarded_frames**\ (\ ) |const| :ref:`🔗` Returns the number of audio frames discarded from the audio bus due to full buffer. @@ -169,7 +169,7 @@ Returns the number of audio frames discarded from the audio bus due to full buff .. rst-class:: classref-method -:ref:`int` **get_frames_available**\ (\ ) |const| +:ref:`int` **get_frames_available**\ (\ ) |const| :ref:`🔗` Returns the number of frames available to read using :ref:`get_buffer`. @@ -181,7 +181,7 @@ Returns the number of frames available to read using :ref:`get_buffer` **get_pushed_frames**\ (\ ) |const| +:ref:`int` **get_pushed_frames**\ (\ ) |const| :ref:`🔗` Returns the number of audio frames inserted from the audio bus. diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 02efed89f78..12bf1a71050 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -139,7 +139,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **dry** = ``1.0`` +:ref:`float` **dry** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The effect's raw signal. .. rst-class:: classref-property -:ref:`float` **voice/1/cutoff_hz** = ``8000.0`` +:ref:`float` **voice/1/cutoff_hz** = ``8000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ The voice's cutoff frequency. .. rst-class:: classref-property -:ref:`float` **voice/1/delay_ms** = ``15.0`` +:ref:`float` **voice/1/delay_ms** = ``15.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ The voice's signal delay. .. rst-class:: classref-property -:ref:`float` **voice/1/depth_ms** = ``2.0`` +:ref:`float` **voice/1/depth_ms** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -207,7 +207,7 @@ The voice filter's depth. .. rst-class:: classref-property -:ref:`float` **voice/1/level_db** = ``0.0`` +:ref:`float` **voice/1/level_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -224,7 +224,7 @@ The voice's volume. .. rst-class:: classref-property -:ref:`float` **voice/1/pan** = ``-0.5`` +:ref:`float` **voice/1/pan** = ``-0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ The voice's pan level. .. rst-class:: classref-property -:ref:`float` **voice/1/rate_hz** = ``0.8`` +:ref:`float` **voice/1/rate_hz** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ The voice's filter rate. .. rst-class:: classref-property -:ref:`float` **voice/2/cutoff_hz** = ``8000.0`` +:ref:`float` **voice/2/cutoff_hz** = ``8000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -275,7 +275,7 @@ The voice's cutoff frequency. .. rst-class:: classref-property -:ref:`float` **voice/2/delay_ms** = ``20.0`` +:ref:`float` **voice/2/delay_ms** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ The voice's signal delay. .. rst-class:: classref-property -:ref:`float` **voice/2/depth_ms** = ``3.0`` +:ref:`float` **voice/2/depth_ms** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -309,7 +309,7 @@ The voice filter's depth. .. rst-class:: classref-property -:ref:`float` **voice/2/level_db** = ``0.0`` +:ref:`float` **voice/2/level_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -326,7 +326,7 @@ The voice's volume. .. rst-class:: classref-property -:ref:`float` **voice/2/pan** = ``0.5`` +:ref:`float` **voice/2/pan** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -343,7 +343,7 @@ The voice's pan level. .. rst-class:: classref-property -:ref:`float` **voice/2/rate_hz** = ``1.2`` +:ref:`float` **voice/2/rate_hz** = ``1.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -360,7 +360,7 @@ The voice's filter rate. .. rst-class:: classref-property -:ref:`float` **voice/3/cutoff_hz** +:ref:`float` **voice/3/cutoff_hz** :ref:`🔗` .. rst-class:: classref-property-setget @@ -377,7 +377,7 @@ The voice's cutoff frequency. .. rst-class:: classref-property -:ref:`float` **voice/3/delay_ms** +:ref:`float` **voice/3/delay_ms** :ref:`🔗` .. rst-class:: classref-property-setget @@ -394,7 +394,7 @@ The voice's signal delay. .. rst-class:: classref-property -:ref:`float` **voice/3/depth_ms** +:ref:`float` **voice/3/depth_ms** :ref:`🔗` .. rst-class:: classref-property-setget @@ -411,7 +411,7 @@ The voice filter's depth. .. rst-class:: classref-property -:ref:`float` **voice/3/level_db** +:ref:`float` **voice/3/level_db** :ref:`🔗` .. rst-class:: classref-property-setget @@ -428,7 +428,7 @@ The voice's volume. .. rst-class:: classref-property -:ref:`float` **voice/3/pan** +:ref:`float` **voice/3/pan** :ref:`🔗` .. rst-class:: classref-property-setget @@ -445,7 +445,7 @@ The voice's pan level. .. rst-class:: classref-property -:ref:`float` **voice/3/rate_hz** +:ref:`float` **voice/3/rate_hz** :ref:`🔗` .. rst-class:: classref-property-setget @@ -462,7 +462,7 @@ The voice's filter rate. .. rst-class:: classref-property -:ref:`float` **voice/4/cutoff_hz** +:ref:`float` **voice/4/cutoff_hz** :ref:`🔗` .. rst-class:: classref-property-setget @@ -479,7 +479,7 @@ The voice's cutoff frequency. .. rst-class:: classref-property -:ref:`float` **voice/4/delay_ms** +:ref:`float` **voice/4/delay_ms** :ref:`🔗` .. rst-class:: classref-property-setget @@ -496,7 +496,7 @@ The voice's signal delay. .. rst-class:: classref-property -:ref:`float` **voice/4/depth_ms** +:ref:`float` **voice/4/depth_ms** :ref:`🔗` .. rst-class:: classref-property-setget @@ -513,7 +513,7 @@ The voice filter's depth. .. rst-class:: classref-property -:ref:`float` **voice/4/level_db** +:ref:`float` **voice/4/level_db** :ref:`🔗` .. rst-class:: classref-property-setget @@ -530,7 +530,7 @@ The voice's volume. .. rst-class:: classref-property -:ref:`float` **voice/4/pan** +:ref:`float` **voice/4/pan** :ref:`🔗` .. rst-class:: classref-property-setget @@ -547,7 +547,7 @@ The voice's pan level. .. rst-class:: classref-property -:ref:`float` **voice/4/rate_hz** +:ref:`float` **voice/4/rate_hz** :ref:`🔗` .. rst-class:: classref-property-setget @@ -564,7 +564,7 @@ The voice's filter rate. .. rst-class:: classref-property -:ref:`int` **voice_count** = ``2`` +:ref:`int` **voice_count** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -581,7 +581,7 @@ The number of voices in the effect. .. rst-class:: classref-property -:ref:`float` **wet** = ``0.5`` +:ref:`float` **wet** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -603,7 +603,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -617,7 +617,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -631,7 +631,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -645,7 +645,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -659,7 +659,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -673,7 +673,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -687,7 +687,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) +|void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -701,7 +701,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) +|void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -715,7 +715,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) +|void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -729,7 +729,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) +|void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -743,7 +743,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) +|void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -757,7 +757,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) +|void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index b19b05bd427..9df4dc5cbbd 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -77,7 +77,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **attack_us** = ``20.0`` +:ref:`float` **attack_us** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ Compressor's reaction time when the signal exceeds the threshold, in microsecond .. rst-class:: classref-property -:ref:`float` **gain** = ``0.0`` +:ref:`float` **gain** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Gain applied to the output signal. .. rst-class:: classref-property -:ref:`float` **mix** = ``1.0`` +:ref:`float` **mix** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ Balance between original signal and effect signal. Value can range from 0 (total .. rst-class:: classref-property -:ref:`float` **ratio** = ``4.0`` +:ref:`float` **ratio** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ Amount of compression applied to the audio once it passes the threshold level. T .. rst-class:: classref-property -:ref:`float` **release_ms** = ``250.0`` +:ref:`float` **release_ms** = ``250.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ Compressor's delay time to stop reducing the signal after the signal level falls .. rst-class:: classref-property -:ref:`StringName` **sidechain** = ``&""`` +:ref:`StringName` **sidechain** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ Reduce the sound level using another audio bus for threshold detection. .. rst-class:: classref-property -:ref:`float` **threshold** = ``0.0`` +:ref:`float` **threshold** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 0d1d8cbfcdc..3356f60327d 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **dry** = ``1.0`` +:ref:`float` **dry** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca .. rst-class:: classref-property -:ref:`bool` **feedback_active** = ``false`` +:ref:`bool` **feedback_active** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ If ``true``, feedback is enabled. .. rst-class:: classref-property -:ref:`float` **feedback_delay_ms** = ``340.0`` +:ref:`float` **feedback_delay_ms** = ``340.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Feedback delay time in milliseconds. .. rst-class:: classref-property -:ref:`float` **feedback_level_db** = ``-6.0`` +:ref:`float` **feedback_level_db** = ``-6.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ Sound level for feedback. .. rst-class:: classref-property -:ref:`float` **feedback_lowpass** = ``16000.0`` +:ref:`float` **feedback_lowpass** = ``16000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ Low-pass filter for feedback, in Hz. Frequencies below this value are filtered o .. rst-class:: classref-property -:ref:`bool` **tap1_active** = ``true`` +:ref:`bool` **tap1_active** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ If ``true``, the first tap will be enabled. .. rst-class:: classref-property -:ref:`float` **tap1_delay_ms** = ``250.0`` +:ref:`float` **tap1_delay_ms** = ``250.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ First tap delay time in milliseconds. .. rst-class:: classref-property -:ref:`float` **tap1_level_db** = ``-6.0`` +:ref:`float` **tap1_level_db** = ``-6.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ Sound level for the first tap. .. rst-class:: classref-property -:ref:`float` **tap1_pan** = ``0.2`` +:ref:`float` **tap1_pan** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -232,7 +232,7 @@ Pan position for the first tap. Value can range from -1 (fully left) to 1 (fully .. rst-class:: classref-property -:ref:`bool` **tap2_active** = ``true`` +:ref:`bool` **tap2_active** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -249,7 +249,7 @@ If ``true``, the second tap will be enabled. .. rst-class:: classref-property -:ref:`float` **tap2_delay_ms** = ``500.0`` +:ref:`float` **tap2_delay_ms** = ``500.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -266,7 +266,7 @@ Second tap delay time in milliseconds. .. rst-class:: classref-property -:ref:`float` **tap2_level_db** = ``-12.0`` +:ref:`float` **tap2_level_db** = ``-12.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -283,7 +283,7 @@ Sound level for the second tap. .. rst-class:: classref-property -:ref:`float` **tap2_pan** = ``-0.4`` +:ref:`float` **tap2_pan** = ``-0.4`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index df9d138c7ec..ef3dd123514 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -65,7 +65,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_AudioEffectDistortion_constant_MODE_CLIP: @@ -124,7 +124,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **drive** = ``0.0`` +:ref:`float` **drive** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ Distortion power. Value can range from 0 to 1. .. rst-class:: classref-property -:ref:`float` **keep_hf_hz** = ``16000.0`` +:ref:`float` **keep_hf_hz** = ``16000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -158,7 +158,7 @@ High-pass filter, in Hz. Frequencies higher than this value will not be affected .. rst-class:: classref-property -:ref:`Mode` **mode** = ``0`` +:ref:`Mode` **mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -175,7 +175,7 @@ Distortion type. .. rst-class:: classref-property -:ref:`float` **post_gain** = ``0.0`` +:ref:`float` **post_gain** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ Increases or decreases the volume after the effect, in decibels. Value can range .. rst-class:: classref-property -:ref:`float` **pre_gain** = ``0.0`` +:ref:`float` **pre_gain** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 6115db78170..1200927b7d8 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_band_count**\ (\ ) |const| +:ref:`int` **get_band_count**\ (\ ) |const| :ref:`🔗` Returns the number of bands of the equalizer. @@ -73,7 +73,7 @@ Returns the number of bands of the equalizer. .. rst-class:: classref-method -:ref:`float` **get_band_gain_db**\ (\ band_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_band_gain_db**\ (\ band_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the band's gain at the specified index, in dB. @@ -85,7 +85,7 @@ Returns the band's gain at the specified index, in dB. .. rst-class:: classref-method -|void| **set_band_gain_db**\ (\ band_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) +|void| **set_band_gain_db**\ (\ band_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) :ref:`🔗` Sets band's gain at the specified index, in dB. diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index a102ead0e2c..b3d55990523 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -61,7 +61,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FilterDB**: +enum **FilterDB**: :ref:`🔗` .. _class_AudioEffectFilter_constant_FILTER_6DB: @@ -124,7 +124,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **cutoff_hz** = ``2000.0`` +:ref:`float` **cutoff_hz** = ``2000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ Threshold frequency for the filter, in Hz. .. rst-class:: classref-property -:ref:`FilterDB` **db** = ``0`` +:ref:`FilterDB` **db** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -160,7 +160,7 @@ Threshold frequency for the filter, in Hz. .. rst-class:: classref-property -:ref:`float` **gain** = ``1.0`` +:ref:`float` **gain** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -177,7 +177,7 @@ Gain amount of the frequencies after the filter. .. rst-class:: classref-property -:ref:`float` **resonance** = ``0.5`` +:ref:`float` **resonance** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffecthardlimiter.rst b/classes/class_audioeffecthardlimiter.rst index efd7f7890aa..d576bce8225 100644 --- a/classes/class_audioeffecthardlimiter.rst +++ b/classes/class_audioeffecthardlimiter.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **ceiling_db** = ``-0.3`` +:ref:`float` **ceiling_db** = ``-0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -76,7 +76,7 @@ The default value of ``-0.3`` prevents potential inter-sample peaks (ISP) from c .. rst-class:: classref-property -:ref:`float` **pre_gain_db** = ``0.0`` +:ref:`float` **pre_gain_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Gain to apply before limiting, in decibels. .. rst-class:: classref-property -:ref:`float` **release** = ``0.1`` +:ref:`float` **release** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index 199ca3f9dc5..64b4ca1debc 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_process**\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| +|void| **_process**\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| :ref:`🔗` Called by the :ref:`AudioServer` to process this effect. When :ref:`_process_silence` is not overridden or it returns ``false``, this method is called only when the bus is active. @@ -71,7 +71,7 @@ Called by the :ref:`AudioServer` to process this effect. When .. rst-class:: classref-method -:ref:`bool` **_process_silence**\ (\ ) |virtual| |const| +:ref:`bool` **_process_silence**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to customize the processing behavior of this effect instance. diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index f30ab79a15b..5eeae4ec3aa 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **ceiling_db** = ``-0.1`` +:ref:`float` **ceiling_db** = ``-0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ The waveform's maximum allowed value, in decibels. Value can range from -20 to - .. rst-class:: classref-property -:ref:`float` **soft_clip_db** = ``2.0`` +:ref:`float` **soft_clip_db** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. .. rst-class:: classref-property -:ref:`float` **soft_clip_ratio** = ``10.0`` +:ref:`float` **soft_clip_ratio** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. .. rst-class:: classref-property -:ref:`float` **threshold_db** = ``0.0`` +:ref:`float` **threshold_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index 1352091dc22..7638e38ab35 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -53,7 +53,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **pan** = ``0.0`` +:ref:`float` **pan** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 4d16c17beee..015a6faa3e4 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **depth** = ``1.0`` +:ref:`float` **depth** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b .. rst-class:: classref-property -:ref:`float` **feedback** = ``0.7`` +:ref:`float` **feedback** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. .. rst-class:: classref-property -:ref:`float` **range_max_hz** = ``1600.0`` +:ref:`float` **range_max_hz** = ``1600.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ Determines the maximum frequency affected by the LFO modulations, in Hz. Value c .. rst-class:: classref-property -:ref:`float` **range_min_hz** = ``440.0`` +:ref:`float` **range_min_hz** = ``440.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ Determines the minimum frequency affected by the LFO modulations, in Hz. Value c .. rst-class:: classref-property -:ref:`float` **rate_hz** = ``0.5`` +:ref:`float` **rate_hz** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index ca17f0d2099..9ba21b4ae12 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -59,7 +59,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FFTSize**: +enum **FFTSize**: :ref:`🔗` .. _class_AudioEffectPitchShift_constant_FFT_SIZE_256: @@ -122,7 +122,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`FFTSize` **fft_size** = ``3`` +:ref:`FFTSize` **fft_size** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ The size of the `Fast Fourier transform ` **oversampling** = ``4`` +:ref:`int` **oversampling** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The oversampling factor to use. Higher values result in better quality, but are .. rst-class:: classref-property -:ref:`float` **pitch_scale** = ``1.0`` +:ref:`float` **pitch_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index 0dc140b54ed..c1e2646fd14 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -77,7 +77,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Format` **format** = ``1`` +:ref:`Format` **format** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamWAV` **get_recording**\ (\ ) |const| +:ref:`AudioStreamWAV` **get_recording**\ (\ ) |const| :ref:`🔗` Returns the recorded sample. @@ -111,7 +111,7 @@ Returns the recorded sample. .. rst-class:: classref-method -:ref:`bool` **is_recording_active**\ (\ ) |const| +:ref:`bool` **is_recording_active**\ (\ ) |const| :ref:`🔗` Returns whether the recording is active or not. @@ -123,7 +123,7 @@ Returns whether the recording is active or not. .. rst-class:: classref-method -|void| **set_recording_active**\ (\ record\: :ref:`bool`\ ) +|void| **set_recording_active**\ (\ record\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 01bf4a04528..86c999fd979 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -69,7 +69,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **damping** = ``0.5`` +:ref:`float` **damping** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to .. rst-class:: classref-property -:ref:`float` **dry** = ``1.0`` +:ref:`float` **dry** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Output percent of original sound. At 0, only modified sound is outputted. Value .. rst-class:: classref-property -:ref:`float` **hipass** = ``0.0`` +:ref:`float` **hipass** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr .. rst-class:: classref-property -:ref:`float` **predelay_feedback** = ``0.4`` +:ref:`float` **predelay_feedback** = ``0.4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ Output percent of predelay. Value can range from 0 to 1. .. rst-class:: classref-property -:ref:`float` **predelay_msec** = ``150.0`` +:ref:`float` **predelay_msec** = ``150.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ Time between the original signal and the early reflections of the reverb signal, .. rst-class:: classref-property -:ref:`float` **room_size** = ``0.8`` +:ref:`float` **room_size** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t .. rst-class:: classref-property -:ref:`float` **spread** = ``1.0`` +:ref:`float` **spread** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Val .. rst-class:: classref-property -:ref:`float` **wet** = ``0.5`` +:ref:`float` **wet** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 685bcdc5e0f..c2f812bfd36 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -59,7 +59,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FFTSize**: +enum **FFTSize**: :ref:`🔗` .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_256: @@ -122,7 +122,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **buffer_length** = ``2.0`` +:ref:`float` **buffer_length** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ The length of the buffer to keep (in seconds). Higher values keep data around fo .. rst-class:: classref-property -:ref:`FFTSize` **fft_size** = ``2`` +:ref:`FFTSize` **fft_size** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The size of the `Fast Fourier transform ` **tap_back_pos** = ``0.01`` +:ref:`float` **tap_back_pos** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst index 703ab024faa..bd15e48e710 100644 --- a/classes/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -41,7 +41,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MagnitudeMode**: +enum **MagnitudeMode**: :ref:`🔗` .. _class_AudioEffectSpectrumAnalyzerInstance_constant_MAGNITUDE_AVERAGE: @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_magnitude_for_frequency_range**\ (\ from_hz\: :ref:`float`, to_hz\: :ref:`float`, mode\: :ref:`MagnitudeMode` = 1\ ) |const| +:ref:`Vector2` **get_magnitude_for_frequency_range**\ (\ from_hz\: :ref:`float`, to_hz\: :ref:`float`, mode\: :ref:`MagnitudeMode` = 1\ ) |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 50474394b4e..ed98852e81e 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **pan_pullout** = ``1.0`` +:ref:`float` **pan_pullout** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -74,7 +74,7 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu .. rst-class:: classref-property -:ref:`float` **surround** = ``0.0`` +:ref:`float` **surround** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu .. rst-class:: classref-property -:ref:`float` **time_pullout_ms** = ``0.0`` +:ref:`float` **time_pullout_ms** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audiolistener2d.rst b/classes/class_audiolistener2d.rst index da5bbfd1de2..7fed4577abb 100644 --- a/classes/class_audiolistener2d.rst +++ b/classes/class_audiolistener2d.rst @@ -55,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_current**\ (\ ) +|void| **clear_current**\ (\ ) :ref:`🔗` Disables the **AudioListener2D**. If it's not set as current, this method will have no effect. @@ -67,7 +67,7 @@ Disables the **AudioListener2D**. If it's not set as current, this method will h .. rst-class:: classref-method -:ref:`bool` **is_current**\ (\ ) |const| +:ref:`bool` **is_current**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **AudioListener2D** is currently active. @@ -79,7 +79,7 @@ Returns ``true`` if this **AudioListener2D** is currently active. .. rst-class:: classref-method -|void| **make_current**\ (\ ) +|void| **make_current**\ (\ ) :ref:`🔗` Makes the **AudioListener2D** active, setting it as the hearing point for the sounds. If there is already another active **AudioListener2D**, it will be disabled. diff --git a/classes/class_audiolistener3d.rst b/classes/class_audiolistener3d.rst index 2138839f322..d90896c68c9 100644 --- a/classes/class_audiolistener3d.rst +++ b/classes/class_audiolistener3d.rst @@ -55,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_current**\ (\ ) +|void| **clear_current**\ (\ ) :ref:`🔗` Disables the listener to use the current camera's listener instead. @@ -67,7 +67,7 @@ Disables the listener to use the current camera's listener instead. .. rst-class:: classref-method -:ref:`Transform3D` **get_listener_transform**\ (\ ) |const| +:ref:`Transform3D` **get_listener_transform**\ (\ ) |const| :ref:`🔗` Returns the listener's global orthonormalized :ref:`Transform3D`. @@ -79,7 +79,7 @@ Returns the listener's global orthonormalized :ref:`Transform3D` **is_current**\ (\ ) |const| +:ref:`bool` **is_current**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the listener was made current using :ref:`make_current`, ``false`` otherwise. @@ -93,7 +93,7 @@ Returns ``true`` if the listener was made current using :ref:`make_current` Enables the listener. This will override the current camera's listener. diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 4122ffd93b5..49137077052 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -153,7 +153,7 @@ Signals .. rst-class:: classref-signal -**bus_layout_changed**\ (\ ) +**bus_layout_changed**\ (\ ) :ref:`🔗` Emitted when an audio bus is added, deleted, or moved. @@ -165,7 +165,7 @@ Emitted when an audio bus is added, deleted, or moved. .. rst-class:: classref-signal -**bus_renamed**\ (\ bus_index\: :ref:`int`, old_name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) +**bus_renamed**\ (\ bus_index\: :ref:`int`, old_name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when the audio bus at ``bus_index`` is renamed from ``old_name`` to ``new_name``. @@ -182,7 +182,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SpeakerMode**: +enum **SpeakerMode**: :ref:`🔗` .. _class_AudioServer_constant_SPEAKER_MODE_STEREO: @@ -229,7 +229,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bus_count** = ``1`` +:ref:`int` **bus_count** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -246,7 +246,7 @@ Number of available audio buses. .. rst-class:: classref-property -:ref:`String` **input_device** = ``"Default"`` +:ref:`String` **input_device** = ``"Default"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -265,7 +265,7 @@ Name of the current device for audio input (see :ref:`get_input_device_list` **output_device** = ``"Default"`` +:ref:`String` **output_device** = ``"Default"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -282,7 +282,7 @@ Name of the current device for audio output (see :ref:`get_output_device_list` **playback_speed_scale** = ``1.0`` +:ref:`float` **playback_speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_bus**\ (\ at_position\: :ref:`int` = -1\ ) +|void| **add_bus**\ (\ at_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a bus at ``at_position``. @@ -316,7 +316,7 @@ Adds a bus at ``at_position``. .. rst-class:: classref-method -|void| **add_bus_effect**\ (\ bus_idx\: :ref:`int`, effect\: :ref:`AudioEffect`, at_position\: :ref:`int` = -1\ ) +|void| **add_bus_effect**\ (\ bus_idx\: :ref:`int`, effect\: :ref:`AudioEffect`, at_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. @@ -328,7 +328,7 @@ Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ` .. rst-class:: classref-method -:ref:`AudioBusLayout` **generate_bus_layout**\ (\ ) |const| +:ref:`AudioBusLayout` **generate_bus_layout**\ (\ ) |const| :ref:`🔗` Generates an :ref:`AudioBusLayout` using the available buses and effects. @@ -340,7 +340,7 @@ Generates an :ref:`AudioBusLayout` using the available bus .. rst-class:: classref-method -:ref:`int` **get_bus_channels**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_bus_channels**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of channels of the bus at index ``bus_idx``. @@ -352,7 +352,7 @@ Returns the number of channels of the bus at index ``bus_idx``. .. rst-class:: classref-method -:ref:`AudioEffect` **get_bus_effect**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) +:ref:`AudioEffect` **get_bus_effect**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`AudioEffect` at position ``effect_idx`` in bus ``bus_idx``. @@ -364,7 +364,7 @@ Returns the :ref:`AudioEffect` at position ``effect_idx`` in .. rst-class:: classref-method -:ref:`int` **get_bus_effect_count**\ (\ bus_idx\: :ref:`int`\ ) +:ref:`int` **get_bus_effect_count**\ (\ bus_idx\: :ref:`int`\ ) :ref:`🔗` Returns the number of effects on the bus at ``bus_idx``. @@ -376,7 +376,7 @@ Returns the number of effects on the bus at ``bus_idx``. .. rst-class:: classref-method -:ref:`AudioEffectInstance` **get_bus_effect_instance**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, channel\: :ref:`int` = 0\ ) +:ref:`AudioEffectInstance` **get_bus_effect_instance**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, channel\: :ref:`int` = 0\ ) :ref:`🔗` Returns the :ref:`AudioEffectInstance` assigned to the given bus and effect indices (and optionally channel). @@ -388,7 +388,7 @@ Returns the :ref:`AudioEffectInstance` assigned to th .. rst-class:: classref-method -:ref:`int` **get_bus_index**\ (\ bus_name\: :ref:`StringName`\ ) |const| +:ref:`int` **get_bus_index**\ (\ bus_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the index of the bus with the name ``bus_name``. Returns ``-1`` if no bus with the specified name exist. @@ -400,7 +400,7 @@ Returns the index of the bus with the name ``bus_name``. Returns ``-1`` if no bu .. rst-class:: classref-method -:ref:`String` **get_bus_name**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_bus_name**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the bus with the index ``bus_idx``. @@ -412,7 +412,7 @@ Returns the name of the bus with the index ``bus_idx``. .. rst-class:: classref-method -:ref:`float` **get_bus_peak_volume_left_db**\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| +:ref:`float` **get_bus_peak_volume_left_db**\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| :ref:`🔗` Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. @@ -424,7 +424,7 @@ Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel .. rst-class:: classref-method -:ref:`float` **get_bus_peak_volume_right_db**\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| +:ref:`float` **get_bus_peak_volume_right_db**\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| :ref:`🔗` Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. @@ -436,7 +436,7 @@ Returns the peak volume of the right speaker at bus index ``bus_idx`` and channe .. rst-class:: classref-method -:ref:`StringName` **get_bus_send**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_bus_send**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the bus that the bus at index ``bus_idx`` sends to. @@ -448,7 +448,7 @@ Returns the name of the bus that the bus at index ``bus_idx`` sends to. .. rst-class:: classref-method -:ref:`float` **get_bus_volume_db**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_bus_volume_db**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the volume of the bus at index ``bus_idx`` in dB. @@ -460,7 +460,7 @@ Returns the volume of the bus at index ``bus_idx`` in dB. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_input_device_list**\ (\ ) +:ref:`PackedStringArray` **get_input_device_list**\ (\ ) :ref:`🔗` Returns the names of all audio input devices detected on the system. @@ -474,7 +474,7 @@ Returns the names of all audio input devices detected on the system. .. rst-class:: classref-method -:ref:`float` **get_mix_rate**\ (\ ) |const| +:ref:`float` **get_mix_rate**\ (\ ) |const| :ref:`🔗` Returns the sample rate at the output of the **AudioServer**. @@ -486,7 +486,7 @@ Returns the sample rate at the output of the **AudioServer**. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_output_device_list**\ (\ ) +:ref:`PackedStringArray` **get_output_device_list**\ (\ ) :ref:`🔗` Returns the names of all audio output devices detected on the system. @@ -498,7 +498,7 @@ Returns the names of all audio output devices detected on the system. .. rst-class:: classref-method -:ref:`float` **get_output_latency**\ (\ ) |const| +:ref:`float` **get_output_latency**\ (\ ) |const| :ref:`🔗` Returns the audio driver's effective output latency. This is based on :ref:`ProjectSettings.audio/driver/output_latency`, but the exact returned value will differ depending on the operating system and audio driver. @@ -512,7 +512,7 @@ Returns the audio driver's effective output latency. This is based on :ref:`Proj .. rst-class:: classref-method -:ref:`SpeakerMode` **get_speaker_mode**\ (\ ) |const| +:ref:`SpeakerMode` **get_speaker_mode**\ (\ ) |const| :ref:`🔗` Returns the speaker configuration. @@ -524,7 +524,7 @@ Returns the speaker configuration. .. rst-class:: classref-method -:ref:`float` **get_time_since_last_mix**\ (\ ) |const| +:ref:`float` **get_time_since_last_mix**\ (\ ) |const| :ref:`🔗` Returns the relative time since the last mix occurred. @@ -536,7 +536,7 @@ Returns the relative time since the last mix occurred. .. rst-class:: classref-method -:ref:`float` **get_time_to_next_mix**\ (\ ) |const| +:ref:`float` **get_time_to_next_mix**\ (\ ) |const| :ref:`🔗` Returns the relative time until the next mix occurs. @@ -548,7 +548,7 @@ Returns the relative time until the next mix occurs. .. rst-class:: classref-method -:ref:`bool` **is_bus_bypassing_effects**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_bus_bypassing_effects**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` If ``true``, the bus at index ``bus_idx`` is bypassing effects. @@ -560,7 +560,7 @@ If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. rst-class:: classref-method -:ref:`bool` **is_bus_effect_enabled**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_bus_effect_enabled**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) |const| :ref:`🔗` If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. @@ -572,7 +572,7 @@ If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` .. rst-class:: classref-method -:ref:`bool` **is_bus_mute**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_bus_mute**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` If ``true``, the bus at index ``bus_idx`` is muted. @@ -584,7 +584,7 @@ If ``true``, the bus at index ``bus_idx`` is muted. .. rst-class:: classref-method -:ref:`bool` **is_bus_solo**\ (\ bus_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_bus_solo**\ (\ bus_idx\: :ref:`int`\ ) |const| :ref:`🔗` If ``true``, the bus at index ``bus_idx`` is in solo mode. @@ -596,7 +596,7 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode. .. rst-class:: classref-method -|void| **lock**\ (\ ) +|void| **lock**\ (\ ) :ref:`🔗` Locks the audio driver's main loop. @@ -610,7 +610,7 @@ Locks the audio driver's main loop. .. rst-class:: classref-method -|void| **move_bus**\ (\ index\: :ref:`int`, to_index\: :ref:`int`\ ) +|void| **move_bus**\ (\ index\: :ref:`int`, to_index\: :ref:`int`\ ) :ref:`🔗` Moves the bus from index ``index`` to index ``to_index``. @@ -622,7 +622,7 @@ Moves the bus from index ``index`` to index ``to_index``. .. rst-class:: classref-method -|void| **remove_bus**\ (\ index\: :ref:`int`\ ) +|void| **remove_bus**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes the bus at index ``index``. @@ -634,7 +634,7 @@ Removes the bus at index ``index``. .. rst-class:: classref-method -|void| **remove_bus_effect**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) +|void| **remove_bus_effect**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) :ref:`🔗` Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. @@ -646,7 +646,7 @@ Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. .. rst-class:: classref-method -|void| **set_bus_bypass_effects**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_bus_bypass_effects**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the bus at index ``bus_idx`` is bypassing effects. @@ -658,7 +658,7 @@ If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. rst-class:: classref-method -|void| **set_bus_effect_enabled**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) +|void| **set_bus_effect_enabled**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. @@ -670,7 +670,7 @@ If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` .. rst-class:: classref-method -|void| **set_bus_layout**\ (\ bus_layout\: :ref:`AudioBusLayout`\ ) +|void| **set_bus_layout**\ (\ bus_layout\: :ref:`AudioBusLayout`\ ) :ref:`🔗` Overwrites the currently used :ref:`AudioBusLayout`. @@ -682,7 +682,7 @@ Overwrites the currently used :ref:`AudioBusLayout`. .. rst-class:: classref-method -|void| **set_bus_mute**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_bus_mute**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the bus at index ``bus_idx`` is muted. @@ -694,7 +694,7 @@ If ``true``, the bus at index ``bus_idx`` is muted. .. rst-class:: classref-method -|void| **set_bus_name**\ (\ bus_idx\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_bus_name**\ (\ bus_idx\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the bus at index ``bus_idx`` to ``name``. @@ -706,7 +706,7 @@ Sets the name of the bus at index ``bus_idx`` to ``name``. .. rst-class:: classref-method -|void| **set_bus_send**\ (\ bus_idx\: :ref:`int`, send\: :ref:`StringName`\ ) +|void| **set_bus_send**\ (\ bus_idx\: :ref:`int`, send\: :ref:`StringName`\ ) :ref:`🔗` Connects the output of the bus at ``bus_idx`` to the bus named ``send``. @@ -718,7 +718,7 @@ Connects the output of the bus at ``bus_idx`` to the bus named ``send``. .. rst-class:: classref-method -|void| **set_bus_solo**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_bus_solo**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the bus at index ``bus_idx`` is in solo mode. @@ -730,7 +730,7 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode. .. rst-class:: classref-method -|void| **set_bus_volume_db**\ (\ bus_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) +|void| **set_bus_volume_db**\ (\ bus_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) :ref:`🔗` Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. @@ -742,7 +742,7 @@ Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. .. rst-class:: classref-method -|void| **set_enable_tagging_used_audio_streams**\ (\ enable\: :ref:`bool`\ ) +|void| **set_enable_tagging_used_audio_streams**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, all instances of :ref:`AudioStreamPlayback` will call :ref:`AudioStreamPlayback._tag_used_streams` every mix step. @@ -756,7 +756,7 @@ If set to ``true``, all instances of :ref:`AudioStreamPlayback`, effect_idx\: :ref:`int`, by_effect_idx\: :ref:`int`\ ) +|void| **swap_bus_effects**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, by_effect_idx\: :ref:`int`\ ) :ref:`🔗` Swaps the position of two effects in bus ``bus_idx``. @@ -768,7 +768,7 @@ Swaps the position of two effects in bus ``bus_idx``. .. rst-class:: classref-method -|void| **unlock**\ (\ ) +|void| **unlock**\ (\ ) :ref:`🔗` Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 04a0bd0682b..c43c231d081 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -79,7 +79,7 @@ Signals .. rst-class:: classref-signal -**parameter_list_changed**\ (\ ) +**parameter_list_changed**\ (\ ) :ref:`🔗` Signal to be emitted to notify when the parameter list changed. @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_beat_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_beat_count**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return the total number of beats of this audio stream. Used by the engine to determine the position of every beat. @@ -110,7 +110,7 @@ Ideally, the returned value should be based off the stream's sample rate (:ref:` .. rst-class:: classref-method -:ref:`float` **_get_bpm**\ (\ ) |virtual| |const| +:ref:`float` **_get_bpm**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return the tempo of this audio stream, in beats per minute (BPM). Used by the engine to determine the position of every beat. @@ -124,7 +124,7 @@ Ideally, the returned value should be based off the stream's sample rate (:ref:` .. rst-class:: classref-method -:ref:`float` **_get_length**\ (\ ) |virtual| |const| +:ref:`float` **_get_length**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to customize the returned value of :ref:`get_length`. Should return the length of this audio stream, in seconds. @@ -136,7 +136,7 @@ Override this method to customize the returned value of :ref:`get_length`\[:ref:`Dictionary`\] **_get_parameter_list**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_parameter_list**\ (\ ) |virtual| |const| :ref:`🔗` Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see :ref:`Object.get_property_list`). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field. @@ -148,7 +148,7 @@ Return the controllable parameters of this stream. This array contains dictionar .. rst-class:: classref-method -:ref:`String` **_get_stream_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_stream_name**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to customize the name assigned to this audio stream. Unused by the engine. @@ -160,7 +160,7 @@ Override this method to customize the name assigned to this audio stream. Unused .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **_instantiate_playback**\ (\ ) |virtual| |const| +:ref:`AudioStreamPlayback` **_instantiate_playback**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to customize the returned value of :ref:`instantiate_playback`. Should returned a new :ref:`AudioStreamPlayback` created when the stream is played (such as by an :ref:`AudioStreamPlayer`).. @@ -172,7 +172,7 @@ Override this method to customize the returned value of :ref:`instantiate_playba .. rst-class:: classref-method -:ref:`bool` **_is_monophonic**\ (\ ) |virtual| |const| +:ref:`bool` **_is_monophonic**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to customize the returned value of :ref:`is_monophonic`. Should return ``true`` if this audio stream only supports one channel. @@ -184,7 +184,7 @@ Override this method to customize the returned value of :ref:`is_monophonic` **get_length**\ (\ ) |const| +:ref:`float` **get_length**\ (\ ) |const| :ref:`🔗` Returns the length of the audio stream in seconds. @@ -196,7 +196,7 @@ Returns the length of the audio stream in seconds. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **instantiate_playback**\ (\ ) +:ref:`AudioStreamPlayback` **instantiate_playback**\ (\ ) :ref:`🔗` Returns a newly created :ref:`AudioStreamPlayback` intended to play this audio stream. Useful for when you want to extend :ref:`_instantiate_playback` but call :ref:`instantiate_playback` from an internally held AudioStream subresource. An example of this can be found in the source code for ``AudioStreamRandomPitch::instantiate_playback``. @@ -208,7 +208,7 @@ Returns a newly created :ref:`AudioStreamPlayback` in .. rst-class:: classref-method -:ref:`bool` **is_monophonic**\ (\ ) |const| +:ref:`bool` **is_monophonic**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this audio stream only supports one channel (*monophony*), or ``false`` if the audio stream supports two or more channels (*polyphony*). diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index d33e1da6209..eaa588a52f6 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -120,7 +120,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **buffer_length** = ``0.5`` +:ref:`float` **buffer_length** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ The length of the buffer to generate (in seconds). Lower values result in less l .. rst-class:: classref-property -:ref:`float` **mix_rate** = ``44100.0`` +:ref:`float` **mix_rate** = ``44100.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index d75d9089c86..dcbd2c577b2 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -65,7 +65,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_push_buffer**\ (\ amount\: :ref:`int`\ ) |const| +:ref:`bool` **can_push_buffer**\ (\ amount\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if a buffer of the size ``amount`` can be pushed to the audio sample data buffer without overflowing it, ``false`` otherwise. @@ -77,7 +77,7 @@ Returns ``true`` if a buffer of the size ``amount`` can be pushed to the audio s .. rst-class:: classref-method -|void| **clear_buffer**\ (\ ) +|void| **clear_buffer**\ (\ ) :ref:`🔗` Clears the audio sample data buffer. @@ -89,7 +89,7 @@ Clears the audio sample data buffer. .. rst-class:: classref-method -:ref:`int` **get_frames_available**\ (\ ) |const| +:ref:`int` **get_frames_available**\ (\ ) |const| :ref:`🔗` Returns the number of frames that can be pushed to the audio sample data buffer without overflowing it. If the result is ``0``, the buffer is full. @@ -101,7 +101,7 @@ Returns the number of frames that can be pushed to the audio sample data buffer .. rst-class:: classref-method -:ref:`int` **get_skips**\ (\ ) |const| +:ref:`int` **get_skips**\ (\ ) |const| :ref:`🔗` Returns the number of times the playback skipped due to a buffer underrun in the audio sample data. This value is reset at the start of the playback. @@ -113,7 +113,7 @@ Returns the number of times the playback skipped due to a buffer underrun in the .. rst-class:: classref-method -:ref:`bool` **push_buffer**\ (\ frames\: :ref:`PackedVector2Array`\ ) +:ref:`bool` **push_buffer**\ (\ frames\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Pushes several audio data frames to the buffer. This is usually more efficient than :ref:`push_frame` in C# and compiled languages via GDExtension, but :ref:`push_buffer` may be *less* efficient in GDScript. @@ -125,7 +125,7 @@ Pushes several audio data frames to the buffer. This is usually more efficient t .. rst-class:: classref-method -:ref:`bool` **push_frame**\ (\ frame\: :ref:`Vector2`\ ) +:ref:`bool` **push_frame**\ (\ frame\: :ref:`Vector2`\ ) :ref:`🔗` Pushes a single audio data frame to the buffer. This is usually less efficient than :ref:`push_buffer` in C# and compiled languages via GDExtension, but :ref:`push_frame` may be *more* efficient in GDScript. diff --git a/classes/class_audiostreaminteractive.rst b/classes/class_audiostreaminteractive.rst index a96c8b7f719..02e2635cee1 100644 --- a/classes/class_audiostreaminteractive.rst +++ b/classes/class_audiostreaminteractive.rst @@ -98,7 +98,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TransitionFromTime**: +enum **TransitionFromTime**: :ref:`🔗` .. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_IMMEDIATE: @@ -140,7 +140,7 @@ Transition when the current clip finished playing. .. rst-class:: classref-enumeration -enum **TransitionToTime**: +enum **TransitionToTime**: :ref:`🔗` .. _class_AudioStreamInteractive_constant_TRANSITION_TO_TIME_SAME_POSITION: @@ -166,7 +166,7 @@ Transition to the start of the destination clip. .. rst-class:: classref-enumeration -enum **FadeMode**: +enum **FadeMode**: :ref:`🔗` .. _class_AudioStreamInteractive_constant_FADE_DISABLED: @@ -216,7 +216,7 @@ Use automatic fade logic depending on the transition from/to. It is recommended .. rst-class:: classref-enumeration -enum **AutoAdvanceMode**: +enum **AutoAdvanceMode**: :ref:`🔗` .. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_DISABLED: @@ -255,7 +255,7 @@ Constants .. rst-class:: classref-constant -**CLIP_ANY** = ``-1`` +**CLIP_ANY** = ``-1`` :ref:`🔗` This constant describes that any clip is valid for a specific transition as either source or destination. @@ -272,7 +272,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **clip_count** = ``0`` +:ref:`int` **clip_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -289,7 +289,7 @@ Amount of clips contained in this interactive player. .. rst-class:: classref-property -:ref:`int` **initial_clip** = ``0`` +:ref:`int` **initial_clip** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -311,7 +311,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`, from_time\: :ref:`TransitionFromTime`, to_time\: :ref:`TransitionToTime`, fade_mode\: :ref:`FadeMode`, fade_beats\: :ref:`float`, use_filler_clip\: :ref:`bool` = false, filler_clip\: :ref:`int` = -1, hold_previous\: :ref:`bool` = false\ ) +|void| **add_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`, from_time\: :ref:`TransitionFromTime`, to_time\: :ref:`TransitionToTime`, fade_mode\: :ref:`FadeMode`, fade_beats\: :ref:`float`, use_filler_clip\: :ref:`bool` = false, filler_clip\: :ref:`int` = -1, hold_previous\: :ref:`bool` = false\ ) :ref:`🔗` Add a transition between two clips. Provide the indices of the source and destination clips, or use the :ref:`CLIP_ANY` constant to indicate that transition happens to/from any clip to this one. @@ -337,7 +337,7 @@ Add a transition between two clips. Provide the indices of the source and destin .. rst-class:: classref-method -|void| **erase_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) +|void| **erase_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) :ref:`🔗` Erase a transition by providing ``from_clip`` and ``to_clip`` clip indices. :ref:`CLIP_ANY` can be used for either argument or both. @@ -349,7 +349,7 @@ Erase a transition by providing ``from_clip`` and ``to_clip`` clip indices. :ref .. rst-class:: classref-method -:ref:`AutoAdvanceMode` **get_clip_auto_advance**\ (\ clip_index\: :ref:`int`\ ) |const| +:ref:`AutoAdvanceMode` **get_clip_auto_advance**\ (\ clip_index\: :ref:`int`\ ) |const| :ref:`🔗` Return whether a clip has auto-advance enabled. See :ref:`set_clip_auto_advance`. @@ -361,7 +361,7 @@ Return whether a clip has auto-advance enabled. See :ref:`set_clip_auto_advance< .. rst-class:: classref-method -:ref:`int` **get_clip_auto_advance_next_clip**\ (\ clip_index\: :ref:`int`\ ) |const| +:ref:`int` **get_clip_auto_advance_next_clip**\ (\ clip_index\: :ref:`int`\ ) |const| :ref:`🔗` Return the clip towards which the clip referenced by ``clip_index`` will auto-advance to. @@ -373,7 +373,7 @@ Return the clip towards which the clip referenced by ``clip_index`` will auto-ad .. rst-class:: classref-method -:ref:`StringName` **get_clip_name**\ (\ clip_index\: :ref:`int`\ ) |const| +:ref:`StringName` **get_clip_name**\ (\ clip_index\: :ref:`int`\ ) |const| :ref:`🔗` Return the name of a clip. @@ -385,7 +385,7 @@ Return the name of a clip. .. rst-class:: classref-method -:ref:`AudioStream` **get_clip_stream**\ (\ clip_index\: :ref:`int`\ ) |const| +:ref:`AudioStream` **get_clip_stream**\ (\ clip_index\: :ref:`int`\ ) |const| :ref:`🔗` Return the :ref:`AudioStream` associated with a clip. @@ -397,7 +397,7 @@ Return the :ref:`AudioStream` associated with a clip. .. rst-class:: classref-method -:ref:`float` **get_transition_fade_beats**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`float` **get_transition_fade_beats**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return the time (in beats) for a transition (see :ref:`add_transition`). @@ -409,7 +409,7 @@ Return the time (in beats) for a transition (see :ref:`add_transition` **get_transition_fade_mode**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`FadeMode` **get_transition_fade_mode**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return the mode for a transition (see :ref:`add_transition`). @@ -421,7 +421,7 @@ Return the mode for a transition (see :ref:`add_transition` **get_transition_filler_clip**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`int` **get_transition_filler_clip**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return the filler clip for a transition (see :ref:`add_transition`). @@ -433,7 +433,7 @@ Return the filler clip for a transition (see :ref:`add_transition` **get_transition_from_time**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`TransitionFromTime` **get_transition_from_time**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return the source time position for a transition (see :ref:`add_transition`). @@ -445,7 +445,7 @@ Return the source time position for a transition (see :ref:`add_transition` **get_transition_list**\ (\ ) |const| +:ref:`PackedInt32Array` **get_transition_list**\ (\ ) |const| :ref:`🔗` Return the list of transitions (from, to interleaved). @@ -457,7 +457,7 @@ Return the list of transitions (from, to interleaved). .. rst-class:: classref-method -:ref:`TransitionToTime` **get_transition_to_time**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`TransitionToTime` **get_transition_to_time**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return the destination time position for a transition (see :ref:`add_transition`). @@ -469,7 +469,7 @@ Return the destination time position for a transition (see :ref:`add_transition< .. rst-class:: classref-method -:ref:`bool` **has_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`bool` **has_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return true if a given transition exists (was added via :ref:`add_transition`). @@ -481,7 +481,7 @@ Return true if a given transition exists (was added via :ref:`add_transition` **is_transition_holding_previous**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`bool` **is_transition_holding_previous**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return whether a transition uses the *hold previous* functionality (see :ref:`add_transition`). @@ -493,7 +493,7 @@ Return whether a transition uses the *hold previous* functionality (see :ref:`ad .. rst-class:: classref-method -:ref:`bool` **is_transition_using_filler_clip**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| +:ref:`bool` **is_transition_using_filler_clip**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| :ref:`🔗` Return whether a transition uses the *filler clip* functionality (see :ref:`add_transition`). @@ -505,7 +505,7 @@ Return whether a transition uses the *filler clip* functionality (see :ref:`add_ .. rst-class:: classref-method -|void| **set_clip_auto_advance**\ (\ clip_index\: :ref:`int`, mode\: :ref:`AutoAdvanceMode`\ ) +|void| **set_clip_auto_advance**\ (\ clip_index\: :ref:`int`, mode\: :ref:`AutoAdvanceMode`\ ) :ref:`🔗` Set whether a clip will auto-advance by changing the auto-advance mode. @@ -517,7 +517,7 @@ Set whether a clip will auto-advance by changing the auto-advance mode. .. rst-class:: classref-method -|void| **set_clip_auto_advance_next_clip**\ (\ clip_index\: :ref:`int`, auto_advance_next_clip\: :ref:`int`\ ) +|void| **set_clip_auto_advance_next_clip**\ (\ clip_index\: :ref:`int`, auto_advance_next_clip\: :ref:`int`\ ) :ref:`🔗` Set the index of the next clip towards which this clip will auto advance to when finished. If the clip being played loops, then auto-advance will be ignored. @@ -529,7 +529,7 @@ Set the index of the next clip towards which this clip will auto advance to when .. rst-class:: classref-method -|void| **set_clip_name**\ (\ clip_index\: :ref:`int`, name\: :ref:`StringName`\ ) +|void| **set_clip_name**\ (\ clip_index\: :ref:`int`, name\: :ref:`StringName`\ ) :ref:`🔗` Set the name of the current clip (for easier identification). @@ -541,7 +541,7 @@ Set the name of the current clip (for easier identification). .. rst-class:: classref-method -|void| **set_clip_stream**\ (\ clip_index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) +|void| **set_clip_stream**\ (\ clip_index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) :ref:`🔗` Set the :ref:`AudioStream` associated with the current clip. diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index 15c8caabb22..9fb45d8369f 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bar_beats** = ``4`` +:ref:`int` **bar_beats** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **beat_count** = ``0`` +:ref:`int` **beat_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bpm** = ``0.0`` +:ref:`float` **bpm** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedByteArray` **data** = ``PackedByteArray()`` +:ref:`PackedByteArray` **data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ You can load a file without having to import it beforehand using the code snippe .. rst-class:: classref-property -:ref:`bool` **loop** = ``false`` +:ref:`bool` **loop** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ If ``true``, the stream will automatically loop when it reaches the end. .. rst-class:: classref-property -:ref:`float` **loop_offset** = ``0.0`` +:ref:`float` **loop_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 08ae8ab23a1..7fabed67ccd 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -77,7 +77,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bar_beats** = ``4`` +:ref:`int` **bar_beats** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **beat_count** = ``0`` +:ref:`int` **beat_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bpm** = ``0.0`` +:ref:`float` **bpm** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,7 +134,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **loop** = ``false`` +:ref:`bool` **loop** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ If ``true``, the audio will play again from the specified :ref:`loop_offset` **loop_offset** = ``0.0`` +:ref:`float` **loop_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ Time in seconds at which the stream starts after being looped. .. rst-class:: classref-property -:ref:`OggPacketSequence` **packet_sequence** +:ref:`OggPacketSequence` **packet_sequence** :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| +:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data. @@ -202,7 +202,7 @@ Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer mu .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| +:ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format. diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index eaa3e1cfe02..8f404986464 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -73,7 +73,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_loop_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_loop_count**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return ``0``. @@ -85,7 +85,7 @@ Overridable method. Should return how many times this audio stream has looped. M .. rst-class:: classref-method -:ref:`Variant` **_get_parameter**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| +:ref:`Variant` **_get_parameter**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Return the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list`). @@ -97,7 +97,7 @@ Return the current value of a playback parameter by name (see :ref:`AudioStream. .. rst-class:: classref-method -:ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| +:ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return the current progress along the audio stream, in seconds. @@ -109,7 +109,7 @@ Overridable method. Should return the current progress along the audio stream, i .. rst-class:: classref-method -:ref:`bool` **_is_playing**\ (\ ) |virtual| |const| +:ref:`bool` **_is_playing**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return ``true`` if this playback is active and playing its audio stream. @@ -121,7 +121,7 @@ Overridable method. Should return ``true`` if this playback is active and playin .. rst-class:: classref-method -:ref:`int` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| +:ref:`int` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active. @@ -135,7 +135,7 @@ Override this method to customize how the audio stream is mixed. This method is .. rst-class:: classref-method -|void| **_seek**\ (\ position\: :ref:`float`\ ) |virtual| +|void| **_seek**\ (\ position\: :ref:`float`\ ) |virtual| :ref:`🔗` Override this method to customize what happens when seeking this audio stream at the given ``position``, such as by calling :ref:`AudioStreamPlayer.seek`. @@ -147,7 +147,7 @@ Override this method to customize what happens when seeking this audio stream at .. rst-class:: classref-method -|void| **_set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| +|void| **_set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Set the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list`). @@ -159,7 +159,7 @@ Set the current value of a playback parameter by name (see :ref:`AudioStream._ge .. rst-class:: classref-method -|void| **_start**\ (\ from_pos\: :ref:`float`\ ) |virtual| +|void| **_start**\ (\ from_pos\: :ref:`float`\ ) |virtual| :ref:`🔗` Override this method to customize what happens when the playback starts at the given position, such as by calling :ref:`AudioStreamPlayer.play`. @@ -171,7 +171,7 @@ Override this method to customize what happens when the playback starts at the g .. rst-class:: classref-method -|void| **_stop**\ (\ ) |virtual| +|void| **_stop**\ (\ ) |virtual| :ref:`🔗` Override this method to customize what happens when the playback is stopped, such as by calling :ref:`AudioStreamPlayer.stop`. @@ -183,7 +183,7 @@ Override this method to customize what happens when the playback is stopped, suc .. rst-class:: classref-method -|void| **_tag_used_streams**\ (\ ) |virtual| +|void| **_tag_used_streams**\ (\ ) |virtual| :ref:`🔗` Overridable method. Called whenever the audio stream is mixed if the playback is active and :ref:`AudioServer.set_enable_tagging_used_audio_streams` has been set to ``true``. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview. diff --git a/classes/class_audiostreamplaybackinteractive.rst b/classes/class_audiostreamplaybackinteractive.rst index 52af6b0269d..8b9d9a6f496 100644 --- a/classes/class_audiostreamplaybackinteractive.rst +++ b/classes/class_audiostreamplaybackinteractive.rst @@ -48,7 +48,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **switch_to_clip**\ (\ clip_index\: :ref:`int`\ ) +|void| **switch_to_clip**\ (\ clip_index\: :ref:`int`\ ) :ref:`🔗` Switch to a clip (by index). @@ -60,7 +60,7 @@ Switch to a clip (by index). .. rst-class:: classref-method -|void| **switch_to_clip_by_name**\ (\ clip_name\: :ref:`StringName`\ ) +|void| **switch_to_clip_by_name**\ (\ clip_name\: :ref:`StringName`\ ) :ref:`🔗` Switch to a clip (by name). diff --git a/classes/class_audiostreamplaybackpolyphonic.rst b/classes/class_audiostreamplaybackpolyphonic.rst index 293103460a2..9321f96422b 100644 --- a/classes/class_audiostreamplaybackpolyphonic.rst +++ b/classes/class_audiostreamplaybackpolyphonic.rst @@ -54,7 +54,7 @@ Constants .. rst-class:: classref-constant -**INVALID_ID** = ``-1`` +**INVALID_ID** = ``-1`` :ref:`🔗` Returned by :ref:`play_stream` in case it could not allocate a stream for playback. @@ -71,7 +71,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_stream_playing**\ (\ stream\: :ref:`int`\ ) |const| +:ref:`bool` **is_stream_playing**\ (\ stream\: :ref:`int`\ ) |const| :ref:`🔗` Return true whether the stream associated with an integer ID is still playing. Check :ref:`play_stream` for information on when this ID becomes invalid. @@ -83,7 +83,7 @@ Return true whether the stream associated with an integer ID is still playing. C .. rst-class:: classref-method -:ref:`int` **play_stream**\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0\ ) +:ref:`int` **play_stream**\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Play an :ref:`AudioStream` at a given offset, volume and pitch scale. Playback starts immediately. @@ -101,7 +101,7 @@ This function returns :ref:`INVALID_ID`, pitch_scale\: :ref:`float`\ ) +|void| **set_stream_pitch_scale**\ (\ stream\: :ref:`int`, pitch_scale\: :ref:`float`\ ) :ref:`🔗` Change the stream pitch scale. The ``stream`` argument is an integer ID returned by :ref:`play_stream`. @@ -113,7 +113,7 @@ Change the stream pitch scale. The ``stream`` argument is an integer ID returned .. rst-class:: classref-method -|void| **set_stream_volume**\ (\ stream\: :ref:`int`, volume_db\: :ref:`float`\ ) +|void| **set_stream_volume**\ (\ stream\: :ref:`int`, volume_db\: :ref:`float`\ ) :ref:`🔗` Change the stream volume (in db). The ``stream`` argument is an integer ID returned by :ref:`play_stream`. @@ -125,7 +125,7 @@ Change the stream volume (in db). The ``stream`` argument is an integer ID retur .. rst-class:: classref-method -|void| **stop_stream**\ (\ stream\: :ref:`int`\ ) +|void| **stop_stream**\ (\ stream\: :ref:`int`\ ) :ref:`🔗` Stop a stream. The ``stream`` argument is an integer ID returned by :ref:`play_stream`, which becomes invalid after calling this function. diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index 82db9bfa954..6577e73bebd 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -47,7 +47,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_get_stream_sampling_rate**\ (\ ) |virtual| |const| +:ref:`float` **_get_stream_sampling_rate**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_mix_resampled**\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| +:ref:`int` **_mix_resampled**\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **begin_resample**\ (\ ) +|void| **begin_resample**\ (\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 856dc013726..a91e4b7e571 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -108,7 +108,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when a sound finishes playing without interruptions. This signal is *not* emitted when calling :ref:`stop`, or when exiting the tree while sounds are playing. @@ -125,7 +125,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MixTarget**: +enum **MixTarget**: :ref:`🔗` .. _class_AudioStreamPlayer_constant_MIX_TARGET_STEREO: @@ -164,7 +164,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **autoplay** = ``false`` +:ref:`bool` **autoplay** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ If ``true``, this node calls :ref:`play` wh .. rst-class:: classref-property -:ref:`StringName` **bus** = ``&"Master"`` +:ref:`StringName` **bus** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ The target bus name. All sounds from this node will be playing on this bus. .. rst-class:: classref-property -:ref:`int` **max_polyphony** = ``1`` +:ref:`int` **max_polyphony** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ The maximum number of sounds this node can play at the same time. Calling :ref:` .. rst-class:: classref-property -:ref:`MixTarget` **mix_target** = ``0`` +:ref:`MixTarget` **mix_target** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -234,7 +234,7 @@ The mix target channels, as one of the :ref:`MixTarget` **pitch_scale** = ``1.0`` +:ref:`float` **pitch_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -251,7 +251,7 @@ The audio's pitch and tempo, as a multiplier of the :ref:`stream` **playing** = ``false`` +:ref:`bool` **playing** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -267,7 +267,7 @@ If ``true``, this node is playing sounds. Setting this property has the same eff .. rst-class:: classref-property -:ref:`AudioStream` **stream** +:ref:`AudioStream` **stream** :ref:`🔗` .. rst-class:: classref-property-setget @@ -284,7 +284,7 @@ The :ref:`AudioStream` resource to be played. Setting this pr .. rst-class:: classref-property -:ref:`bool` **stream_paused** = ``false`` +:ref:`bool` **stream_paused** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -303,7 +303,7 @@ If ``true``, the sounds are paused. Setting :ref:`stream_paused` **volume_db** = ``0.0`` +:ref:`float` **volume_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -327,7 +327,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playback_position**\ (\ ) +:ref:`float` **get_playback_position**\ (\ ) :ref:`🔗` Returns the position in the :ref:`AudioStream` of the latest sound, in seconds. Returns ``0.0`` if no sounds are playing. @@ -341,7 +341,7 @@ Returns the position in the :ref:`AudioStream` of the latest .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) +:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) :ref:`🔗` Returns the latest :ref:`AudioStreamPlayback` of this node, usually the most recently created by :ref:`play`. If no sounds are playing, this method fails and returns an empty playback. @@ -353,7 +353,7 @@ Returns the latest :ref:`AudioStreamPlayback` of this .. rst-class:: classref-method -:ref:`bool` **has_stream_playback**\ (\ ) +:ref:`bool` **has_stream_playback**\ (\ ) :ref:`🔗` Returns ``true`` if any sound is active, even if :ref:`stream_paused` is set to ``true``. See also :ref:`playing` and :ref:`get_stream_playback`. @@ -365,7 +365,7 @@ Returns ``true`` if any sound is active, even if :ref:`stream_paused` = 0.0\ ) +|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) :ref:`🔗` Plays a sound from the beginning, or the given ``from_position`` in seconds. @@ -377,7 +377,7 @@ Plays a sound from the beginning, or the given ``from_position`` in seconds. .. rst-class:: classref-method -|void| **seek**\ (\ to_position\: :ref:`float`\ ) +|void| **seek**\ (\ to_position\: :ref:`float`\ ) :ref:`🔗` Restarts all sounds to be played from the given ``to_position``, in seconds. Does nothing if no sounds are playing. @@ -389,7 +389,7 @@ Restarts all sounds to be played from the given ``to_position``, in seconds. Doe .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops all sounds from this node. diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 1a055f6d5f5..c2cd8a42dfb 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -106,7 +106,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when the audio stops playing. @@ -123,7 +123,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **area_mask** = ``1`` +:ref:`int` **area_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ Determines which :ref:`Area2D` layers affect the sound for reverb .. rst-class:: classref-property -:ref:`float` **attenuation** = ``1.0`` +:ref:`float` **attenuation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ The volume is attenuated over distance with this as an exponent. .. rst-class:: classref-property -:ref:`bool` **autoplay** = ``false`` +:ref:`bool` **autoplay** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ If ``true``, audio plays when added to scene tree. .. rst-class:: classref-property -:ref:`StringName` **bus** = ``&"Master"`` +:ref:`StringName` **bus** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ Bus on which this audio is playing. .. rst-class:: classref-property -:ref:`float` **max_distance** = ``2000.0`` +:ref:`float` **max_distance** = ``2000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ Maximum distance from which audio is still hearable. .. rst-class:: classref-property -:ref:`int` **max_polyphony** = ``1`` +:ref:`int` **max_polyphony** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -227,7 +227,7 @@ The maximum number of sounds this node can play at the same time. Playing additi .. rst-class:: classref-property -:ref:`float` **panning_strength** = ``1.0`` +:ref:`float` **panning_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -244,7 +244,7 @@ Scales the panning strength for this node by multiplying the base :ref:`ProjectS .. rst-class:: classref-property -:ref:`float` **pitch_scale** = ``1.0`` +:ref:`float` **pitch_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -261,7 +261,7 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp .. rst-class:: classref-property -:ref:`bool` **playing** = ``false`` +:ref:`bool` **playing** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ If ``true``, audio is playing or is queued to be played (see :ref:`play` **stream** +:ref:`AudioStream` **stream** :ref:`🔗` .. rst-class:: classref-property-setget @@ -294,7 +294,7 @@ The :ref:`AudioStream` object to be played. .. rst-class:: classref-property -:ref:`bool` **stream_paused** = ``false`` +:ref:`bool` **stream_paused** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -311,7 +311,7 @@ If ``true``, the playback is paused. You can resume it by setting :ref:`stream_p .. rst-class:: classref-property -:ref:`float` **volume_db** = ``0.0`` +:ref:`float` **volume_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -333,7 +333,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playback_position**\ (\ ) +:ref:`float` **get_playback_position**\ (\ ) :ref:`🔗` Returns the position in the :ref:`AudioStream`. @@ -345,7 +345,7 @@ Returns the position in the :ref:`AudioStream`. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) +:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) :ref:`🔗` Returns the :ref:`AudioStreamPlayback` object associated with this **AudioStreamPlayer2D**. @@ -357,7 +357,7 @@ Returns the :ref:`AudioStreamPlayback` object associa .. rst-class:: classref-method -:ref:`bool` **has_stream_playback**\ (\ ) +:ref:`bool` **has_stream_playback**\ (\ ) :ref:`🔗` Returns whether the :ref:`AudioStreamPlayer` can return the :ref:`AudioStreamPlayback` object or not. @@ -369,7 +369,7 @@ Returns whether the :ref:`AudioStreamPlayer` can return .. rst-class:: classref-method -|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) +|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) :ref:`🔗` Queues the audio to play on the next physics frame, from the given position ``from_position``, in seconds. @@ -381,7 +381,7 @@ Queues the audio to play on the next physics frame, from the given position ``fr .. rst-class:: classref-method -|void| **seek**\ (\ to_position\: :ref:`float`\ ) +|void| **seek**\ (\ to_position\: :ref:`float`\ ) :ref:`🔗` Sets the position from which audio will be played, in seconds. @@ -393,7 +393,7 @@ Sets the position from which audio will be played, in seconds. .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops the audio. diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index be810990ac8..d9bdd501b02 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -122,7 +122,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when the audio stops playing. @@ -139,7 +139,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AttenuationModel**: +enum **AttenuationModel**: :ref:`🔗` .. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_DISTANCE: @@ -181,7 +181,7 @@ No attenuation of loudness according to distance. The sound will still be heard .. rst-class:: classref-enumeration -enum **DopplerTracking**: +enum **DopplerTracking**: :ref:`🔗` .. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED: @@ -220,7 +220,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **area_mask** = ``1`` +:ref:`int` **area_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ Determines which :ref:`Area3D` layers affect the sound for reverb .. rst-class:: classref-property -:ref:`float` **attenuation_filter_cutoff_hz** = ``5000.0`` +:ref:`float` **attenuation_filter_cutoff_hz** = ``5000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ The cutoff frequency of the attenuation low-pass filter, in Hz. A sound above th .. rst-class:: classref-property -:ref:`float` **attenuation_filter_db** = ``-24.0`` +:ref:`float` **attenuation_filter_db** = ``-24.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ Amount how much the filter affects the loudness, in decibels. .. rst-class:: classref-property -:ref:`AttenuationModel` **attenuation_model** = ``0`` +:ref:`AttenuationModel` **attenuation_model** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -288,7 +288,7 @@ Decides if audio should get quieter with distance linearly, quadratically, logar .. rst-class:: classref-property -:ref:`bool` **autoplay** = ``false`` +:ref:`bool` **autoplay** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -305,7 +305,7 @@ If ``true``, audio plays when the AudioStreamPlayer3D node is added to scene tre .. rst-class:: classref-property -:ref:`StringName` **bus** = ``&"Master"`` +:ref:`StringName` **bus** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ The bus on which this audio is playing. .. rst-class:: classref-property -:ref:`DopplerTracking` **doppler_tracking** = ``0`` +:ref:`DopplerTracking` **doppler_tracking** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -341,7 +341,7 @@ Decides in which step the Doppler effect should be calculated. .. rst-class:: classref-property -:ref:`float` **emission_angle_degrees** = ``45.0`` +:ref:`float` **emission_angle_degrees** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ The angle in which the audio reaches a listener unattenuated. .. rst-class:: classref-property -:ref:`bool` **emission_angle_enabled** = ``false`` +:ref:`bool` **emission_angle_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ If ``true``, the audio should be attenuated according to the direction of the so .. rst-class:: classref-property -:ref:`float` **emission_angle_filter_attenuation_db** = ``-12.0`` +:ref:`float` **emission_angle_filter_attenuation_db** = ``-12.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ Attenuation factor used if listener is outside of :ref:`emission_angle_degrees` **max_db** = ``3.0`` +:ref:`float` **max_db** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -409,7 +409,7 @@ Sets the absolute maximum of the sound level, in decibels. .. rst-class:: classref-property -:ref:`float` **max_distance** = ``0.0`` +:ref:`float` **max_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -426,7 +426,7 @@ The distance past which the sound can no longer be heard at all. Only has an eff .. rst-class:: classref-property -:ref:`int` **max_polyphony** = ``1`` +:ref:`int` **max_polyphony** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -443,7 +443,7 @@ The maximum number of sounds this node can play at the same time. Playing additi .. rst-class:: classref-property -:ref:`float` **panning_strength** = ``1.0`` +:ref:`float` **panning_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -460,7 +460,7 @@ Scales the panning strength for this node by multiplying the base :ref:`ProjectS .. rst-class:: classref-property -:ref:`float` **pitch_scale** = ``1.0`` +:ref:`float` **pitch_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -477,7 +477,7 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp .. rst-class:: classref-property -:ref:`bool` **playing** = ``false`` +:ref:`bool` **playing** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -493,7 +493,7 @@ If ``true``, audio is playing or is queued to be played (see :ref:`play` **stream** +:ref:`AudioStream` **stream** :ref:`🔗` .. rst-class:: classref-property-setget @@ -510,7 +510,7 @@ The :ref:`AudioStream` resource to be played. .. rst-class:: classref-property -:ref:`bool` **stream_paused** = ``false`` +:ref:`bool` **stream_paused** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -527,7 +527,7 @@ If ``true``, the playback is paused. You can resume it by setting :ref:`stream_p .. rst-class:: classref-property -:ref:`float` **unit_size** = ``10.0`` +:ref:`float` **unit_size** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -544,7 +544,7 @@ The factor for the attenuation effect. Higher values make the sound audible over .. rst-class:: classref-property -:ref:`float` **volume_db** = ``0.0`` +:ref:`float` **volume_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -566,7 +566,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playback_position**\ (\ ) +:ref:`float` **get_playback_position**\ (\ ) :ref:`🔗` Returns the position in the :ref:`AudioStream`. @@ -578,7 +578,7 @@ Returns the position in the :ref:`AudioStream`. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) +:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) :ref:`🔗` Returns the :ref:`AudioStreamPlayback` object associated with this **AudioStreamPlayer3D**. @@ -590,7 +590,7 @@ Returns the :ref:`AudioStreamPlayback` object associa .. rst-class:: classref-method -:ref:`bool` **has_stream_playback**\ (\ ) +:ref:`bool` **has_stream_playback**\ (\ ) :ref:`🔗` Returns whether the :ref:`AudioStreamPlayer` can return the :ref:`AudioStreamPlayback` object or not. @@ -602,7 +602,7 @@ Returns whether the :ref:`AudioStreamPlayer` can return .. rst-class:: classref-method -|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) +|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) :ref:`🔗` Queues the audio to play on the next physics frame, from the given position ``from_position``, in seconds. @@ -614,7 +614,7 @@ Queues the audio to play on the next physics frame, from the given position ``fr .. rst-class:: classref-method -|void| **seek**\ (\ to_position\: :ref:`float`\ ) +|void| **seek**\ (\ to_position\: :ref:`float`\ ) :ref:`🔗` Sets the position from which audio will be played, in seconds. @@ -626,7 +626,7 @@ Sets the position from which audio will be played, in seconds. .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops the audio. diff --git a/classes/class_audiostreamplaylist.rst b/classes/class_audiostreamplaylist.rst index a303dec5469..2b3a62d7206 100644 --- a/classes/class_audiostreamplaylist.rst +++ b/classes/class_audiostreamplaylist.rst @@ -61,7 +61,7 @@ Constants .. rst-class:: classref-constant -**MAX_STREAMS** = ``64`` +**MAX_STREAMS** = ``64`` :ref:`🔗` Maximum amount of streams supported in the playlist. @@ -78,7 +78,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **fade_time** = ``0.3`` +:ref:`float` **fade_time** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -95,7 +95,7 @@ Fade time used when a stream ends, when going to the next one. Streams are expec .. rst-class:: classref-property -:ref:`bool` **loop** = ``true`` +:ref:`bool` **loop** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -112,7 +112,7 @@ If true, the playlist will loop, otherwise the playlist when end when the last s .. rst-class:: classref-property -:ref:`bool` **shuffle** = ``false`` +:ref:`bool` **shuffle** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -129,7 +129,7 @@ Shuffle the playlist. Streams are played in random order. .. rst-class:: classref-property -:ref:`int` **stream_count** = ``0`` +:ref:`int` **stream_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_bpm**\ (\ ) |const| +:ref:`float` **get_bpm**\ (\ ) |const| :ref:`🔗` Return the bpm of the playlist, which can vary depending on the clip being played. @@ -163,7 +163,7 @@ Return the bpm of the playlist, which can vary depending on the clip being playe .. rst-class:: classref-method -:ref:`AudioStream` **get_list_stream**\ (\ stream_index\: :ref:`int`\ ) |const| +:ref:`AudioStream` **get_list_stream**\ (\ stream_index\: :ref:`int`\ ) |const| :ref:`🔗` Get the stream at playback position index. @@ -175,7 +175,7 @@ Get the stream at playback position index. .. rst-class:: classref-method -|void| **set_list_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) +|void| **set_list_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) :ref:`🔗` Set the stream at playback position index. diff --git a/classes/class_audiostreampolyphonic.rst b/classes/class_audiostreampolyphonic.rst index 2e078fe2781..cb9d7ae9670 100644 --- a/classes/class_audiostreampolyphonic.rst +++ b/classes/class_audiostreampolyphonic.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **polyphony** = ``32`` +:ref:`int` **polyphony** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_audiostreamrandomizer.rst b/classes/class_audiostreamrandomizer.rst index 0834a902257..afa65b7513a 100644 --- a/classes/class_audiostreamrandomizer.rst +++ b/classes/class_audiostreamrandomizer.rst @@ -76,7 +76,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PlaybackMode**: +enum **PlaybackMode**: :ref:`🔗` .. _class_AudioStreamRandomizer_constant_PLAYBACK_RANDOM_NO_REPEATS: @@ -115,7 +115,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PlaybackMode` **playback_mode** = ``0`` +:ref:`PlaybackMode` **playback_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next. .. rst-class:: classref-property -:ref:`float` **random_pitch** = ``1.0`` +:ref:`float` **random_pitch** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ The intensity of random pitch variation. A value of 1 means no variation. .. rst-class:: classref-property -:ref:`float` **random_volume_offset_db** = ``0.0`` +:ref:`float` **random_volume_offset_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ The intensity of random volume variation. A value of 0 means no variation. .. rst-class:: classref-property -:ref:`int` **streams_count** = ``0`` +:ref:`int` **streams_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_stream**\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`, weight\: :ref:`float` = 1.0\ ) +|void| **add_stream**\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`, weight\: :ref:`float` = 1.0\ ) :ref:`🔗` Insert a stream at the specified index. If the index is less than zero, the insertion occurs at the end of the underlying pool. @@ -200,7 +200,7 @@ Insert a stream at the specified index. If the index is less than zero, the inse .. rst-class:: classref-method -:ref:`AudioStream` **get_stream**\ (\ index\: :ref:`int`\ ) |const| +:ref:`AudioStream` **get_stream**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the stream at the specified index. @@ -212,7 +212,7 @@ Returns the stream at the specified index. .. rst-class:: classref-method -:ref:`float` **get_stream_probability_weight**\ (\ index\: :ref:`int`\ ) |const| +:ref:`float` **get_stream_probability_weight**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the probability weight associated with the stream at the given index. @@ -224,7 +224,7 @@ Returns the probability weight associated with the stream at the given index. .. rst-class:: classref-method -|void| **move_stream**\ (\ index_from\: :ref:`int`, index_to\: :ref:`int`\ ) +|void| **move_stream**\ (\ index_from\: :ref:`int`, index_to\: :ref:`int`\ ) :ref:`🔗` Move a stream from one index to another. @@ -236,7 +236,7 @@ Move a stream from one index to another. .. rst-class:: classref-method -|void| **remove_stream**\ (\ index\: :ref:`int`\ ) +|void| **remove_stream**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Remove the stream at the specified index. @@ -248,7 +248,7 @@ Remove the stream at the specified index. .. rst-class:: classref-method -|void| **set_stream**\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) +|void| **set_stream**\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) :ref:`🔗` Set the AudioStream at the specified index. @@ -260,7 +260,7 @@ Set the AudioStream at the specified index. .. rst-class:: classref-method -|void| **set_stream_probability_weight**\ (\ index\: :ref:`int`, weight\: :ref:`float`\ ) +|void| **set_stream_probability_weight**\ (\ index\: :ref:`int`, weight\: :ref:`float`\ ) :ref:`🔗` Set the probability weight of the stream at the specified index. The higher this value, the more likely that the randomizer will choose this stream during random playback modes. diff --git a/classes/class_audiostreamsynchronized.rst b/classes/class_audiostreamsynchronized.rst index 40018eb9d55..a83a29f5c6f 100644 --- a/classes/class_audiostreamsynchronized.rst +++ b/classes/class_audiostreamsynchronized.rst @@ -64,7 +64,7 @@ Constants .. rst-class:: classref-constant -**MAX_STREAMS** = ``32`` +**MAX_STREAMS** = ``32`` :ref:`🔗` Maximum amount of streams that can be synchrohized. @@ -81,7 +81,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **stream_count** = ``0`` +:ref:`int` **stream_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStream` **get_sync_stream**\ (\ stream_index\: :ref:`int`\ ) |const| +:ref:`AudioStream` **get_sync_stream**\ (\ stream_index\: :ref:`int`\ ) |const| :ref:`🔗` Get one of the synchronized streams, by index. @@ -115,7 +115,7 @@ Get one of the synchronized streams, by index. .. rst-class:: classref-method -:ref:`float` **get_sync_stream_volume**\ (\ stream_index\: :ref:`int`\ ) |const| +:ref:`float` **get_sync_stream_volume**\ (\ stream_index\: :ref:`int`\ ) |const| :ref:`🔗` Get the volume of one of the synchronized streams, by index. @@ -127,7 +127,7 @@ Get the volume of one of the synchronized streams, by index. .. rst-class:: classref-method -|void| **set_sync_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) +|void| **set_sync_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) :ref:`🔗` Set one of the synchronized streams, by index. @@ -139,7 +139,7 @@ Set one of the synchronized streams, by index. .. rst-class:: classref-method -|void| **set_sync_stream_volume**\ (\ stream_index\: :ref:`int`, volume_db\: :ref:`float`\ ) +|void| **set_sync_stream_volume**\ (\ stream_index\: :ref:`int`, volume_db\: :ref:`float`\ ) :ref:`🔗` Set the volume of one of the synchronized streams, by index. diff --git a/classes/class_audiostreamwav.rst b/classes/class_audiostreamwav.rst index 4c741303ea1..733b5fff25a 100644 --- a/classes/class_audiostreamwav.rst +++ b/classes/class_audiostreamwav.rst @@ -79,7 +79,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Format**: +enum **Format**: :ref:`🔗` .. _class_AudioStreamWAV_constant_FORMAT_8_BITS: @@ -121,7 +121,7 @@ Audio is compressed as QOA (`Quite OK Audio `__). .. rst-class:: classref-enumeration -enum **LoopMode**: +enum **LoopMode**: :ref:`🔗` .. _class_AudioStreamWAV_constant_LOOP_DISABLED: @@ -168,7 +168,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedByteArray` **data** = ``PackedByteArray()`` +:ref:`PackedByteArray` **data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ Contains the audio data in bytes. .. rst-class:: classref-property -:ref:`Format` **format** = ``0`` +:ref:`Format` **format** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ Audio format. See :ref:`Format` constants for values .. rst-class:: classref-property -:ref:`int` **loop_begin** = ``0`` +:ref:`int` **loop_begin** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ The loop start point (in number of samples, relative to the beginning of the sam .. rst-class:: classref-property -:ref:`int` **loop_end** = ``0`` +:ref:`int` **loop_end** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ The loop end point (in number of samples, relative to the beginning of the sampl .. rst-class:: classref-property -:ref:`LoopMode` **loop_mode** = ``0`` +:ref:`LoopMode` **loop_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ The loop mode. This information will be imported automatically from the WAV file .. rst-class:: classref-property -:ref:`int` **mix_rate** = ``44100`` +:ref:`int` **mix_rate** = ``44100`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -278,7 +278,7 @@ According to the `Nyquist-Shannon sampling theorem ` **stereo** = ``false`` +:ref:`bool` **stereo** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -300,7 +300,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **save_to_wav**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **save_to_wav**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Saves the AudioStreamWAV as a WAV file to ``path``. Samples with IMA ADPCM or QOA formats can't be saved. diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index aa8cbd148b6..0b3ac0b753a 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CopyMode**: +enum **CopyMode**: :ref:`🔗` .. _class_BackBufferCopy_constant_COPY_MODE_DISABLED: @@ -89,7 +89,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CopyMode` **copy_mode** = ``1`` +:ref:`CopyMode` **copy_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -106,7 +106,7 @@ Buffer mode. See :ref:`CopyMode` constants. .. rst-class:: classref-property -:ref:`Rect2` **rect** = ``Rect2(-100, -100, 200, 200)`` +:ref:`Rect2` **rect** = ``Rect2(-100, -100, 200, 200)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 7903421455c..acb2d2a0be8 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -88,7 +88,7 @@ Signals .. rst-class:: classref-signal -**button_down**\ (\ ) +**button_down**\ (\ ) :ref:`🔗` Emitted when the button starts being held down. @@ -100,7 +100,7 @@ Emitted when the button starts being held down. .. rst-class:: classref-signal -**button_up**\ (\ ) +**button_up**\ (\ ) :ref:`🔗` Emitted when the button stops being held down. @@ -112,7 +112,7 @@ Emitted when the button stops being held down. .. rst-class:: classref-signal -**pressed**\ (\ ) +**pressed**\ (\ ) :ref:`🔗` Emitted when the button is toggled or pressed. This is on :ref:`button_down` if :ref:`action_mode` is :ref:`ACTION_MODE_BUTTON_PRESS` and on :ref:`button_up` otherwise. @@ -126,7 +126,7 @@ If you need to know the button's pressed state (and :ref:`toggle_mode`\ ) +**toggled**\ (\ toggled_on\: :ref:`bool`\ ) :ref:`🔗` Emitted when the button was just toggled between pressed and normal states (only if :ref:`toggle_mode` is active). The new state is contained in the ``toggled_on`` argument. @@ -143,7 +143,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawMode**: +enum **DrawMode**: :ref:`🔗` .. _class_BaseButton_constant_DRAW_NORMAL: @@ -193,7 +193,7 @@ The state of buttons are both hovered and pressed. .. rst-class:: classref-enumeration -enum **ActionMode**: +enum **ActionMode**: :ref:`🔗` .. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS: @@ -224,7 +224,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ActionMode` **action_mode** = ``1`` +:ref:`ActionMode` **action_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ Determines when the button is considered clicked, one of the :ref:`ActionMode` **button_group** +:ref:`ButtonGroup` **button_group** :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ The :ref:`ButtonGroup` associated with the button. Not to be .. rst-class:: classref-property -|bitfield|\[:ref:`MouseButtonMask`\] **button_mask** = ``1`` +|bitfield|\[:ref:`MouseButtonMask`\] **button_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -279,7 +279,7 @@ To allow both left-click and right-click, use ``MOUSE_BUTTON_MASK_LEFT | MOUSE_B .. rst-class:: classref-property -:ref:`bool` **button_pressed** = ``false`` +:ref:`bool` **button_pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +298,7 @@ If ``true``, the button's state is pressed. Means the button is pressed down or .. rst-class:: classref-property -:ref:`bool` **disabled** = ``false`` +:ref:`bool` **disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -315,7 +315,7 @@ If ``true``, the button is in disabled state and can't be clicked or toggled. .. rst-class:: classref-property -:ref:`bool` **keep_pressed_outside** = ``false`` +:ref:`bool` **keep_pressed_outside** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -334,7 +334,7 @@ If ``true``, the button stays pressed when moving the cursor outside the button .. rst-class:: classref-property -:ref:`Shortcut` **shortcut** +:ref:`Shortcut` **shortcut** :ref:`🔗` .. rst-class:: classref-property-setget @@ -351,7 +351,7 @@ If ``true``, the button stays pressed when moving the cursor outside the button .. rst-class:: classref-property -:ref:`bool` **shortcut_feedback** = ``true`` +:ref:`bool` **shortcut_feedback** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -368,7 +368,7 @@ If ``true``, the button will highlight for a short amount of time when its short .. rst-class:: classref-property -:ref:`bool` **shortcut_in_tooltip** = ``true`` +:ref:`bool` **shortcut_in_tooltip** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -385,7 +385,7 @@ If ``true``, the button will add information about its shortcut in the tooltip. .. rst-class:: classref-property -:ref:`bool` **toggle_mode** = ``false`` +:ref:`bool` **toggle_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -407,7 +407,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_pressed**\ (\ ) |virtual| +|void| **_pressed**\ (\ ) |virtual| :ref:`🔗` Called when the button is pressed. If you need to know the button's pressed state (and :ref:`toggle_mode` is active), use :ref:`_toggled` instead. @@ -419,7 +419,7 @@ Called when the button is pressed. If you need to know the button's pressed stat .. rst-class:: classref-method -|void| **_toggled**\ (\ toggled_on\: :ref:`bool`\ ) |virtual| +|void| **_toggled**\ (\ toggled_on\: :ref:`bool`\ ) |virtual| :ref:`🔗` Called when the button is toggled (only if :ref:`toggle_mode` is active). @@ -431,7 +431,7 @@ Called when the button is toggled (only if :ref:`toggle_mode` **get_draw_mode**\ (\ ) |const| +:ref:`DrawMode` **get_draw_mode**\ (\ ) |const| :ref:`🔗` Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the :ref:`DrawMode` enum. @@ -443,7 +443,7 @@ Returns the visual state used to draw the button. This is useful mainly when imp .. rst-class:: classref-method -:ref:`bool` **is_hovered**\ (\ ) |const| +:ref:`bool` **is_hovered**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the mouse has entered the button and has not left it yet. @@ -455,7 +455,7 @@ Returns ``true`` if the mouse has entered the button and has not left it yet. .. rst-class:: classref-method -|void| **set_pressed_no_signal**\ (\ pressed\: :ref:`bool`\ ) +|void| **set_pressed_no_signal**\ (\ pressed\: :ref:`bool`\ ) :ref:`🔗` Changes the :ref:`button_pressed` state of the button, without emitting :ref:`toggled`. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if :ref:`toggle_mode` is ``true``. diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 14213c9d0d3..02634ebaf45 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -309,7 +309,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TextureParam**: +enum **TextureParam**: :ref:`🔗` .. _class_BaseMaterial3D_constant_TEXTURE_ALBEDO: @@ -471,7 +471,7 @@ Represents the size of the :ref:`TextureParam` .. rst-class:: classref-enumeration -enum **TextureFilter**: +enum **TextureFilter**: :ref:`🔗` .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST: @@ -537,7 +537,7 @@ Represents the size of the :ref:`TextureFilter` .. _class_BaseMaterial3D_constant_DETAIL_UV_1: @@ -563,7 +563,7 @@ Use ``UV2`` with the detail texture. .. rst-class:: classref-enumeration -enum **Transparency**: +enum **Transparency**: :ref:`🔗` .. _class_BaseMaterial3D_constant_TRANSPARENCY_DISABLED: @@ -621,7 +621,7 @@ Represents the size of the :ref:`Transparency` .. rst-class:: classref-enumeration -enum **ShadingMode**: +enum **ShadingMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_SHADING_MODE_UNSHADED: @@ -663,7 +663,7 @@ Represents the size of the :ref:`ShadingMode` e .. rst-class:: classref-enumeration -enum **Feature**: +enum **Feature**: :ref:`🔗` .. _class_BaseMaterial3D_constant_FEATURE_EMISSION: @@ -777,7 +777,7 @@ Represents the size of the :ref:`Feature` enum. .. rst-class:: classref-enumeration -enum **BlendMode**: +enum **BlendMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_BLEND_MODE_MIX: @@ -827,7 +827,7 @@ The color of the object is added to the background and the alpha channel is used .. rst-class:: classref-enumeration -enum **AlphaAntiAliasing**: +enum **AlphaAntiAliasing**: :ref:`🔗` .. _class_BaseMaterial3D_constant_ALPHA_ANTIALIASING_OFF: @@ -861,7 +861,7 @@ Enables AlphaToCoverage and forces all non-zero alpha values to ``1``. Alpha val .. rst-class:: classref-enumeration -enum **DepthDrawMode**: +enum **DepthDrawMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_DEPTH_DRAW_OPAQUE_ONLY: @@ -897,7 +897,7 @@ Objects will not write their depth to the depth buffer, even during the depth pr .. rst-class:: classref-enumeration -enum **CullMode**: +enum **CullMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_CULL_BACK: @@ -931,7 +931,7 @@ No face culling is performed; both the front face and back face will be visible. .. rst-class:: classref-enumeration -enum **Flags**: +enum **Flags**: :ref:`🔗` .. _class_BaseMaterial3D_constant_FLAG_DISABLE_DEPTH_TEST: @@ -1127,7 +1127,7 @@ Represents the size of the :ref:`Flags` enum. .. rst-class:: classref-enumeration -enum **DiffuseMode**: +enum **DiffuseMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_DIFFUSE_BURLEY: @@ -1169,7 +1169,7 @@ Uses a hard cut for lighting, with smoothing affected by roughness. .. rst-class:: classref-enumeration -enum **SpecularMode**: +enum **SpecularMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_SPECULAR_SCHLICK_GGX: @@ -1203,7 +1203,7 @@ No specular blob. This is slightly faster to render than other specular modes. .. rst-class:: classref-enumeration -enum **BillboardMode**: +enum **BillboardMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_BILLBOARD_DISABLED: @@ -1247,7 +1247,7 @@ The :ref:`ParticleProcessMaterial.anim_speed_min` .. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_RED: @@ -1297,7 +1297,7 @@ Used to read from the linear (non-perceptual) average of the red, green and blue .. rst-class:: classref-enumeration -enum **EmissionOperator**: +enum **EmissionOperator**: :ref:`🔗` .. _class_BaseMaterial3D_constant_EMISSION_OP_ADD: @@ -1323,7 +1323,7 @@ Multiplies the emission color by the color from the emission texture. .. rst-class:: classref-enumeration -enum **DistanceFadeMode**: +enum **DistanceFadeMode**: :ref:`🔗` .. _class_BaseMaterial3D_constant_DISTANCE_FADE_DISABLED: @@ -1370,7 +1370,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **albedo_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **albedo_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1389,7 +1389,7 @@ The material's base color. .. rst-class:: classref-property -:ref:`Texture2D` **albedo_texture** +:ref:`Texture2D` **albedo_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1408,7 +1408,7 @@ If the texture appears unexpectedly too dark or too bright, check :ref:`albedo_t .. rst-class:: classref-property -:ref:`bool` **albedo_texture_force_srgb** = ``false`` +:ref:`bool` **albedo_texture_force_srgb** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1427,7 +1427,7 @@ This should only be enabled when needed (typically when using a :ref:`ViewportTe .. rst-class:: classref-property -:ref:`bool` **albedo_texture_msdf** = ``false`` +:ref:`bool` **albedo_texture_msdf** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1444,7 +1444,7 @@ Enables multichannel signed distance field rendering shader. Use :ref:`msdf_pixe .. rst-class:: classref-property -:ref:`float` **alpha_antialiasing_edge** +:ref:`float` **alpha_antialiasing_edge** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1461,7 +1461,7 @@ Threshold at which antialiasing will be applied on the alpha channel. .. rst-class:: classref-property -:ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** +:ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1478,7 +1478,7 @@ The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing` **alpha_hash_scale** +:ref:`float` **alpha_hash_scale** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1495,7 +1495,7 @@ The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. .. rst-class:: classref-property -:ref:`float` **alpha_scissor_threshold** +:ref:`float` **alpha_scissor_threshold** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1512,7 +1512,7 @@ Threshold at which the alpha scissor will discard values. Higher values will res .. rst-class:: classref-property -:ref:`float` **anisotropy** = ``0.0`` +:ref:`float` **anisotropy** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1529,7 +1529,7 @@ The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_fl .. rst-class:: classref-property -:ref:`bool` **anisotropy_enabled** = ``false`` +:ref:`bool` **anisotropy_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1550,7 +1550,7 @@ If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular .. rst-class:: classref-property -:ref:`Texture2D` **anisotropy_flowmap** +:ref:`Texture2D` **anisotropy_flowmap** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1569,7 +1569,7 @@ If present, the texture's alpha channel will be used to multiply the strength of .. rst-class:: classref-property -:ref:`bool` **ao_enabled** = ``false`` +:ref:`bool` **ao_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1586,7 +1586,7 @@ If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based .. rst-class:: classref-property -:ref:`float` **ao_light_affect** = ``0.0`` +:ref:`float` **ao_light_affect** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1603,7 +1603,7 @@ Amount that ambient occlusion affects lighting from lights. If ``0``, ambient oc .. rst-class:: classref-property -:ref:`bool` **ao_on_uv2** = ``false`` +:ref:`bool` **ao_on_uv2** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1620,7 +1620,7 @@ If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture` **ao_texture** +:ref:`Texture2D` **ao_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1637,7 +1637,7 @@ Texture that defines the amount of ambient occlusion for a given point on the ob .. rst-class:: classref-property -:ref:`TextureChannel` **ao_texture_channel** = ``0`` +:ref:`TextureChannel` **ao_texture_channel** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1654,7 +1654,7 @@ Specifies the channel of the :ref:`ao_texture` **backlight** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **backlight** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1671,7 +1671,7 @@ The color used by the backlight effect. Represents the light passing through an .. rst-class:: classref-property -:ref:`bool` **backlight_enabled** = ``false`` +:ref:`bool` **backlight_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1688,7 +1688,7 @@ If ``true``, the backlight effect is enabled. See also :ref:`subsurf_scatter_tra .. rst-class:: classref-property -:ref:`Texture2D` **backlight_texture** +:ref:`Texture2D` **backlight_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1705,7 +1705,7 @@ Texture used to control the backlight effect per-pixel. Added to :ref:`backlight .. rst-class:: classref-property -:ref:`bool` **billboard_keep_scale** = ``false`` +:ref:`bool` **billboard_keep_scale** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1722,7 +1722,7 @@ If ``true``, the shader will keep the scale set for the mesh. Otherwise, the sca .. rst-class:: classref-property -:ref:`BillboardMode` **billboard_mode** = ``0`` +:ref:`BillboardMode` **billboard_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1743,7 +1743,7 @@ Controls how the object faces the camera. See :ref:`BillboardMode` **blend_mode** = ``0`` +:ref:`BlendMode` **blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1762,7 +1762,7 @@ The material's blend mode. .. rst-class:: classref-property -:ref:`float` **clearcoat** = ``1.0`` +:ref:`float` **clearcoat** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1779,7 +1779,7 @@ Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as di .. rst-class:: classref-property -:ref:`bool` **clearcoat_enabled** = ``false`` +:ref:`bool` **clearcoat_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1798,7 +1798,7 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t .. rst-class:: classref-property -:ref:`float` **clearcoat_roughness** = ``0.5`` +:ref:`float` **clearcoat_roughness** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1815,7 +1815,7 @@ Sets the roughness of the clearcoat pass. A higher value results in a rougher cl .. rst-class:: classref-property -:ref:`Texture2D` **clearcoat_texture** +:ref:`Texture2D` **clearcoat_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1832,7 +1832,7 @@ Texture that defines the strength of the clearcoat effect and the glossiness of .. rst-class:: classref-property -:ref:`CullMode` **cull_mode** = ``0`` +:ref:`CullMode` **cull_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1849,7 +1849,7 @@ Determines which side of the triangle to cull depending on whether the triangle .. rst-class:: classref-property -:ref:`DepthDrawMode` **depth_draw_mode** = ``0`` +:ref:`DepthDrawMode` **depth_draw_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1866,7 +1866,7 @@ Determines when depth rendering takes place. See :ref:`DepthDrawMode` **detail_albedo** +:ref:`Texture2D` **detail_albedo** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1885,7 +1885,7 @@ Texture that specifies the color of the detail overlay. :ref:`detail_albedo` **detail_blend_mode** = ``0`` +:ref:`BlendMode` **detail_blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1902,7 +1902,7 @@ Specifies how the :ref:`detail_albedo` **detail_enabled** = ``false`` +:ref:`bool` **detail_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1919,7 +1919,7 @@ If ``true``, enables the detail overlay. Detail is a second texture that gets mi .. rst-class:: classref-property -:ref:`Texture2D` **detail_mask** +:ref:`Texture2D` **detail_mask** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1936,7 +1936,7 @@ Texture used to specify how the detail textures get blended with the base textur .. rst-class:: classref-property -:ref:`Texture2D` **detail_normal** +:ref:`Texture2D` **detail_normal** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1955,7 +1955,7 @@ Texture that specifies the per-pixel normal of the detail overlay. The :ref:`det .. rst-class:: classref-property -:ref:`DetailUV` **detail_uv_layer** = ``0`` +:ref:`DetailUV` **detail_uv_layer** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1972,7 +1972,7 @@ Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`Detai .. rst-class:: classref-property -:ref:`DiffuseMode` **diffuse_mode** = ``0`` +:ref:`DiffuseMode` **diffuse_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1989,7 +1989,7 @@ The algorithm used for diffuse light scattering. See :ref:`DiffuseMode` **disable_ambient_light** = ``false`` +:ref:`bool` **disable_ambient_light** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2006,7 +2006,7 @@ If ``true``, the object receives no ambient light. .. rst-class:: classref-property -:ref:`bool` **disable_fog** = ``false`` +:ref:`bool` **disable_fog** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2023,7 +2023,7 @@ If ``true``, the object will not be affected by fog (neither volumetric nor dept .. rst-class:: classref-property -:ref:`bool` **disable_receive_shadows** = ``false`` +:ref:`bool` **disable_receive_shadows** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2040,7 +2040,7 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. .. rst-class:: classref-property -:ref:`float` **distance_fade_max_distance** = ``10.0`` +:ref:`float` **distance_fade_max_distance** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2059,7 +2059,7 @@ Distance at which the object appears fully opaque. .. rst-class:: classref-property -:ref:`float` **distance_fade_min_distance** = ``0.0`` +:ref:`float` **distance_fade_min_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2078,7 +2078,7 @@ Distance at which the object starts to become visible. If the object is less tha .. rst-class:: classref-property -:ref:`DistanceFadeMode` **distance_fade_mode** = ``0`` +:ref:`DistanceFadeMode` **distance_fade_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2095,7 +2095,7 @@ Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode` **emission** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **emission** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2112,7 +2112,7 @@ The emitted light's color. See :ref:`emission_enabled` **emission_enabled** = ``false`` +:ref:`bool` **emission_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2129,7 +2129,7 @@ If ``true``, the body emits light. Emitting light makes the object appear bright .. rst-class:: classref-property -:ref:`float` **emission_energy_multiplier** = ``1.0`` +:ref:`float` **emission_energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2146,7 +2146,7 @@ Multiplier for emitted light. See :ref:`emission_enabled` **emission_intensity** +:ref:`float` **emission_intensity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2163,7 +2163,7 @@ Luminance of emitted light, measured in nits (candela per square meter). Only av .. rst-class:: classref-property -:ref:`bool` **emission_on_uv2** = ``false`` +:ref:`bool` **emission_on_uv2** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2180,7 +2180,7 @@ Use ``UV2`` to read from the :ref:`emission_texture` **emission_operator** = ``0`` +:ref:`EmissionOperator` **emission_operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2197,7 +2197,7 @@ Sets how :ref:`emission` interacts with .. rst-class:: classref-property -:ref:`Texture2D` **emission_texture** +:ref:`Texture2D` **emission_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2214,7 +2214,7 @@ Texture that specifies how much surface emits light at a given point. .. rst-class:: classref-property -:ref:`bool` **fixed_size** = ``false`` +:ref:`bool` **fixed_size** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2231,7 +2231,7 @@ If ``true``, the object is rendered at the same size regardless of distance. .. rst-class:: classref-property -:ref:`bool` **grow** = ``false`` +:ref:`bool` **grow** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2250,7 +2250,7 @@ If ``true``, enables the vertex grow setting. This can be used to create mesh-ba .. rst-class:: classref-property -:ref:`float` **grow_amount** = ``0.0`` +:ref:`float` **grow_amount** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2267,7 +2267,7 @@ Grows object vertices in the direction of their normals. Only effective if :ref: .. rst-class:: classref-property -:ref:`bool` **heightmap_deep_parallax** = ``false`` +:ref:`bool` **heightmap_deep_parallax** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2284,7 +2284,7 @@ If ``true``, uses parallax occlusion mapping to represent depth in the material .. rst-class:: classref-property -:ref:`bool` **heightmap_enabled** = ``false`` +:ref:`bool` **heightmap_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2303,7 +2303,7 @@ If ``true``, height mapping is enabled (also called "parallax mapping" or "depth .. rst-class:: classref-property -:ref:`bool` **heightmap_flip_binormal** = ``false`` +:ref:`bool` **heightmap_flip_binormal** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2320,7 +2320,7 @@ If ``true``, flips the mesh's binormal vectors when interpreting the height map. .. rst-class:: classref-property -:ref:`bool` **heightmap_flip_tangent** = ``false`` +:ref:`bool` **heightmap_flip_tangent** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2337,7 +2337,7 @@ If ``true``, flips the mesh's tangent vectors when interpreting the height map. .. rst-class:: classref-property -:ref:`bool` **heightmap_flip_texture** = ``false`` +:ref:`bool` **heightmap_flip_texture** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2356,7 +2356,7 @@ This can be enabled for compatibility with some materials authored for Godot 3.x .. rst-class:: classref-property -:ref:`int` **heightmap_max_layers** +:ref:`int` **heightmap_max_layers** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2375,7 +2375,7 @@ The number of layers to use for parallax occlusion mapping when the camera is up .. rst-class:: classref-property -:ref:`int` **heightmap_min_layers** +:ref:`int` **heightmap_min_layers** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2394,7 +2394,7 @@ The number of layers to use for parallax occlusion mapping when the camera is fa .. rst-class:: classref-property -:ref:`float` **heightmap_scale** = ``5.0`` +:ref:`float` **heightmap_scale** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2413,7 +2413,7 @@ The heightmap scale to use for the parallax effect (see :ref:`heightmap_enabled< .. rst-class:: classref-property -:ref:`Texture2D` **heightmap_texture** +:ref:`Texture2D` **heightmap_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2434,7 +2434,7 @@ For best results, the texture should be normalized (with :ref:`heightmap_scale` **metallic** = ``0.0`` +:ref:`float` **metallic** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2451,7 +2451,7 @@ A high value makes the material appear more like a metal. Non-metals use their a .. rst-class:: classref-property -:ref:`float` **metallic_specular** = ``0.5`` +:ref:`float` **metallic_specular** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2470,7 +2470,7 @@ Adjusts the strength of specular reflections. Specular reflections are composed .. rst-class:: classref-property -:ref:`Texture2D` **metallic_texture** +:ref:`Texture2D` **metallic_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2487,7 +2487,7 @@ Texture used to specify metallic for an object. This is multiplied by :ref:`meta .. rst-class:: classref-property -:ref:`TextureChannel` **metallic_texture_channel** = ``0`` +:ref:`TextureChannel` **metallic_texture_channel** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2504,7 +2504,7 @@ Specifies the channel of the :ref:`metallic_texture` **msdf_outline_size** = ``0.0`` +:ref:`float` **msdf_outline_size** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2521,7 +2521,7 @@ The width of the shape outline. .. rst-class:: classref-property -:ref:`float` **msdf_pixel_range** = ``4.0`` +:ref:`float` **msdf_pixel_range** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2538,7 +2538,7 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property -:ref:`bool` **no_depth_test** = ``false`` +:ref:`bool` **no_depth_test** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2555,7 +2555,7 @@ If ``true``, depth testing is disabled and the object will be drawn in render or .. rst-class:: classref-property -:ref:`bool` **normal_enabled** = ``false`` +:ref:`bool` **normal_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2572,7 +2572,7 @@ If ``true``, normal mapping is enabled. This has a slight performance cost, espe .. rst-class:: classref-property -:ref:`float` **normal_scale** = ``1.0`` +:ref:`float` **normal_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2589,7 +2589,7 @@ The strength of the normal map's effect. .. rst-class:: classref-property -:ref:`Texture2D` **normal_texture** +:ref:`Texture2D` **normal_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2612,7 +2612,7 @@ Texture used to specify the normal at a given pixel. The :ref:`normal_texture` **orm_texture** +:ref:`Texture2D` **orm_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2629,7 +2629,7 @@ The Occlusion/Roughness/Metallic texture to use. This is a more efficient replac .. rst-class:: classref-property -:ref:`int` **particles_anim_h_frames** +:ref:`int` **particles_anim_h_frames** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2646,7 +2646,7 @@ The number of horizontal frames in the particle sprite sheet. Only enabled when .. rst-class:: classref-property -:ref:`bool` **particles_anim_loop** +:ref:`bool` **particles_anim_loop** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2663,7 +2663,7 @@ If ``true``, particle animations are looped. Only enabled when using :ref:`BILLB .. rst-class:: classref-property -:ref:`int` **particles_anim_v_frames** +:ref:`int` **particles_anim_v_frames** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2680,7 +2680,7 @@ The number of vertical frames in the particle sprite sheet. Only enabled when us .. rst-class:: classref-property -:ref:`float` **point_size** = ``1.0`` +:ref:`float` **point_size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2697,7 +2697,7 @@ The point size in pixels. See :ref:`use_point_size` **proximity_fade_distance** = ``1.0`` +:ref:`float` **proximity_fade_distance** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2714,7 +2714,7 @@ Distance over which the fade effect takes place. The larger the distance the lon .. rst-class:: classref-property -:ref:`bool` **proximity_fade_enabled** = ``false`` +:ref:`bool` **proximity_fade_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2731,7 +2731,7 @@ If ``true``, the proximity fade effect is enabled. The proximity fade effect fad .. rst-class:: classref-property -:ref:`bool` **refraction_enabled** = ``false`` +:ref:`bool` **refraction_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2748,7 +2748,7 @@ If ``true``, the refraction effect is enabled. Distorts transparency based on li .. rst-class:: classref-property -:ref:`float` **refraction_scale** = ``0.05`` +:ref:`float` **refraction_scale** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2765,7 +2765,7 @@ The strength of the refraction effect. .. rst-class:: classref-property -:ref:`Texture2D` **refraction_texture** +:ref:`Texture2D` **refraction_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2782,7 +2782,7 @@ Texture that controls the strength of the refraction per-pixel. Multiplied by :r .. rst-class:: classref-property -:ref:`TextureChannel` **refraction_texture_channel** = ``0`` +:ref:`TextureChannel` **refraction_texture_channel** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2799,7 +2799,7 @@ Specifies the channel of the :ref:`refraction_texture` **rim** = ``1.0`` +:ref:`float` **rim** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2816,7 +2816,7 @@ Sets the strength of the rim lighting effect. .. rst-class:: classref-property -:ref:`bool` **rim_enabled** = ``false`` +:ref:`bool` **rim_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2835,7 +2835,7 @@ If ``true``, rim effect is enabled. Rim lighting increases the brightness at gla .. rst-class:: classref-property -:ref:`Texture2D` **rim_texture** +:ref:`Texture2D` **rim_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2852,7 +2852,7 @@ Texture used to set the strength of the rim lighting effect per-pixel. Multiplie .. rst-class:: classref-property -:ref:`float` **rim_tint** = ``0.5`` +:ref:`float` **rim_tint** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2869,7 +2869,7 @@ The amount of to blend light and albedo color when rendering rim effect. If ``0` .. rst-class:: classref-property -:ref:`float` **roughness** = ``1.0`` +:ref:`float` **roughness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2886,7 +2886,7 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o .. rst-class:: classref-property -:ref:`Texture2D` **roughness_texture** +:ref:`Texture2D` **roughness_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2903,7 +2903,7 @@ Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness` **roughness_texture_channel** = ``0`` +:ref:`TextureChannel` **roughness_texture_channel** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2920,7 +2920,7 @@ Specifies the channel of the :ref:`roughness_texture` **shading_mode** = ``1`` +:ref:`ShadingMode` **shading_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2939,7 +2939,7 @@ Sets whether the shading takes place, per-pixel, per-vertex or unshaded. Per-ver .. rst-class:: classref-property -:ref:`bool` **shadow_to_opacity** = ``false`` +:ref:`bool` **shadow_to_opacity** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2956,7 +2956,7 @@ If ``true``, enables the "shadow to opacity" render mode where lighting modifies .. rst-class:: classref-property -:ref:`SpecularMode` **specular_mode** = ``0`` +:ref:`SpecularMode` **specular_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2975,7 +2975,7 @@ The method for rendering the specular blob. See :ref:`SpecularMode` **subsurf_scatter_enabled** = ``false`` +:ref:`bool` **subsurf_scatter_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2992,7 +2992,7 @@ If ``true``, subsurface scattering is enabled. Emulates light that penetrates an .. rst-class:: classref-property -:ref:`bool` **subsurf_scatter_skin_mode** = ``false`` +:ref:`bool` **subsurf_scatter_skin_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3009,7 +3009,7 @@ If ``true``, subsurface scattering will use a special mode optimized for the col .. rst-class:: classref-property -:ref:`float` **subsurf_scatter_strength** = ``0.0`` +:ref:`float` **subsurf_scatter_strength** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3026,7 +3026,7 @@ The strength of the subsurface scattering effect. The depth of the effect is als .. rst-class:: classref-property -:ref:`Texture2D` **subsurf_scatter_texture** +:ref:`Texture2D` **subsurf_scatter_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -3043,7 +3043,7 @@ Texture used to control the subsurface scattering strength. Stored in the red te .. rst-class:: classref-property -:ref:`float` **subsurf_scatter_transmittance_boost** = ``0.0`` +:ref:`float` **subsurf_scatter_transmittance_boost** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3060,7 +3060,7 @@ The intensity of the subsurface scattering transmittance effect. .. rst-class:: classref-property -:ref:`Color` **subsurf_scatter_transmittance_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **subsurf_scatter_transmittance_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3077,7 +3077,7 @@ The color to multiply the subsurface scattering transmittance effect with. Ignor .. rst-class:: classref-property -:ref:`float` **subsurf_scatter_transmittance_depth** = ``0.1`` +:ref:`float` **subsurf_scatter_transmittance_depth** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3094,7 +3094,7 @@ The depth of the subsurface scattering transmittance effect. .. rst-class:: classref-property -:ref:`bool` **subsurf_scatter_transmittance_enabled** = ``false`` +:ref:`bool` **subsurf_scatter_transmittance_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3111,7 +3111,7 @@ If ``true``, enables subsurface scattering transmittance. Only effective if :ref .. rst-class:: classref-property -:ref:`Texture2D` **subsurf_scatter_transmittance_texture** +:ref:`Texture2D` **subsurf_scatter_transmittance_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -3128,7 +3128,7 @@ The texture to use for multiplying the intensity of the subsurface scattering tr .. rst-class:: classref-property -:ref:`TextureFilter` **texture_filter** = ``3`` +:ref:`TextureFilter` **texture_filter** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3147,7 +3147,7 @@ Filter flags for the texture. See :ref:`TextureFilter` **texture_repeat** = ``true`` +:ref:`bool` **texture_repeat** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3164,7 +3164,7 @@ Repeat flags for the texture. See :ref:`TextureFilter` **transparency** = ``0`` +:ref:`Transparency` **transparency** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3181,7 +3181,7 @@ The material's transparency mode. Some transparency modes will disable shadow ca .. rst-class:: classref-property -:ref:`bool` **use_particle_trails** = ``false`` +:ref:`bool` **use_particle_trails** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3198,7 +3198,7 @@ If ``true``, enables parts of the shader required for :ref:`GPUParticles3D` **use_point_size** = ``false`` +:ref:`bool` **use_point_size** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3217,7 +3217,7 @@ If ``true``, render point size can be changed. .. rst-class:: classref-property -:ref:`Vector3` **uv1_offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **uv1_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3234,7 +3234,7 @@ How much to offset the ``UV`` coordinates. This amount will be added to ``UV`` i .. rst-class:: classref-property -:ref:`Vector3` **uv1_scale** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **uv1_scale** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3251,7 +3251,7 @@ How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the ve .. rst-class:: classref-property -:ref:`bool` **uv1_triplanar** = ``false`` +:ref:`bool` **uv1_triplanar** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3268,7 +3268,7 @@ If ``true``, instead of using ``UV`` textures will use a triplanar texture looku .. rst-class:: classref-property -:ref:`float` **uv1_triplanar_sharpness** = ``1.0`` +:ref:`float` **uv1_triplanar_sharpness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3287,7 +3287,7 @@ A lower number blends the texture more softly while a higher number blends the t .. rst-class:: classref-property -:ref:`bool` **uv1_world_triplanar** = ``false`` +:ref:`bool` **uv1_world_triplanar** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3304,7 +3304,7 @@ If ``true``, triplanar mapping for ``UV`` is calculated in world space rather th .. rst-class:: classref-property -:ref:`Vector3` **uv2_offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **uv2_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3321,7 +3321,7 @@ How much to offset the ``UV2`` coordinates. This amount will be added to ``UV2`` .. rst-class:: classref-property -:ref:`Vector3` **uv2_scale** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **uv2_scale** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3338,7 +3338,7 @@ How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the .. rst-class:: classref-property -:ref:`bool` **uv2_triplanar** = ``false`` +:ref:`bool` **uv2_triplanar** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3355,7 +3355,7 @@ If ``true``, instead of using ``UV2`` textures will use a triplanar texture look .. rst-class:: classref-property -:ref:`float` **uv2_triplanar_sharpness** = ``1.0`` +:ref:`float` **uv2_triplanar_sharpness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3374,7 +3374,7 @@ A lower number blends the texture more softly while a higher number blends the t .. rst-class:: classref-property -:ref:`bool` **uv2_world_triplanar** = ``false`` +:ref:`bool` **uv2_world_triplanar** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3391,7 +3391,7 @@ If ``true``, triplanar mapping for ``UV2`` is calculated in world space rather t .. rst-class:: classref-property -:ref:`bool` **vertex_color_is_srgb** = ``false`` +:ref:`bool` **vertex_color_is_srgb** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3410,7 +3410,7 @@ If ``true``, vertex colors are considered to be stored in sRGB color space and a .. rst-class:: classref-property -:ref:`bool` **vertex_color_use_as_albedo** = ``false`` +:ref:`bool` **vertex_color_use_as_albedo** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -3432,7 +3432,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| +:ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| :ref:`🔗` Returns ``true``, if the specified :ref:`Feature` is enabled. @@ -3444,7 +3444,7 @@ Returns ``true``, if the specified :ref:`Feature` i .. rst-class:: classref-method -:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| +:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| :ref:`🔗` Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. @@ -3456,7 +3456,7 @@ Returns ``true``, if the specified flag is enabled. See :ref:`Flags` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| +:ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| :ref:`🔗` Returns the :ref:`Texture2D` associated with the specified :ref:`TextureParam`. @@ -3468,7 +3468,7 @@ Returns the :ref:`Texture2D` associated with the specified :ref .. rst-class:: classref-method -|void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +|void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables the specified :ref:`Feature`. Many features that are available in **BaseMaterial3D**\ s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to ``true``. @@ -3480,7 +3480,7 @@ If ``true``, enables the specified :ref:`Feature`. .. rst-class:: classref-method -|void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +|void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to ``true``. See :ref:`Flags` enumerator for options. @@ -3492,7 +3492,7 @@ If ``true``, enables the specified flag. Flags are optional behavior that can be .. rst-class:: classref-method -|void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +|void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the texture for the slot specified by ``param``. See :ref:`TextureParam` for available slots. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 623e5ed438f..1a0809a5fa8 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -177,7 +177,7 @@ Constants .. rst-class:: classref-constant -**IDENTITY** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` +**IDENTITY** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` :ref:`🔗` The identity basis. This is a basis with no rotation, no shear, and its scale being ``1``. This means that: @@ -206,7 +206,7 @@ This is identical to creating :ref:`Basis` withou .. rst-class:: classref-constant -**FLIP_X** = ``Basis(-1, 0, 0, 0, 1, 0, 0, 0, 1)`` +**FLIP_X** = ``Basis(-1, 0, 0, 0, 1, 0, 0, 0, 1)`` :ref:`🔗` When any basis is multiplied by :ref:`FLIP_X`, it negates all components of the :ref:`x` axis (the X column). @@ -216,7 +216,7 @@ When :ref:`FLIP_X` is multiplied by any basis, it n .. rst-class:: classref-constant -**FLIP_Y** = ``Basis(1, 0, 0, 0, -1, 0, 0, 0, 1)`` +**FLIP_Y** = ``Basis(1, 0, 0, 0, -1, 0, 0, 0, 1)`` :ref:`🔗` When any basis is multiplied by :ref:`FLIP_Y`, it negates all components of the :ref:`y` axis (the Y column). @@ -226,7 +226,7 @@ When :ref:`FLIP_Y` is multiplied by any basis, it n .. rst-class:: classref-constant -**FLIP_Z** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, -1)`` +**FLIP_Z** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, -1)`` :ref:`🔗` When any basis is multiplied by :ref:`FLIP_Z`, it negates all components of the :ref:`z` axis (the Z column). @@ -245,7 +245,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **x** = ``Vector3(1, 0, 0)`` +:ref:`Vector3` **x** = ``Vector3(1, 0, 0)`` :ref:`🔗` The basis's X axis, and the column ``0`` of the matrix. @@ -259,7 +259,7 @@ On the identity basis, this vector points right (:ref:`Vector3.RIGHT` **y** = ``Vector3(0, 1, 0)`` +:ref:`Vector3` **y** = ``Vector3(0, 1, 0)`` :ref:`🔗` The basis's Y axis, and the column ``1`` of the matrix. @@ -273,7 +273,7 @@ On the identity basis, this vector points up (:ref:`Vector3.UP` **z** = ``Vector3(0, 0, 1)`` +:ref:`Vector3` **z** = ``Vector3(0, 0, 1)`` :ref:`🔗` The basis's Z axis, and the column ``2`` of the matrix. @@ -292,7 +292,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Basis` **Basis**\ (\ ) +:ref:`Basis` **Basis**\ (\ ) :ref:`🔗` Constructs a **Basis** identical to the :ref:`IDENTITY`. @@ -353,7 +353,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **determinant**\ (\ ) |const| +:ref:`float` **determinant**\ (\ ) |const| :ref:`🔗` Returns the `determinant `__ of this basis's matrix. For advanced math, this number can be used to determine a few attributes: @@ -371,7 +371,7 @@ Returns the `determinant `__ of this .. rst-class:: classref-method -:ref:`Basis` **from_euler**\ (\ euler\: :ref:`Vector3`, order\: :ref:`int` = 2\ ) |static| +:ref:`Basis` **from_euler**\ (\ euler\: :ref:`Vector3`, order\: :ref:`int` = 2\ ) |static| :ref:`🔗` Constructs a new **Basis** that only represents rotation from the given :ref:`Vector3` of `Euler angles `__, in radians. @@ -410,7 +410,7 @@ The order of each consecutive rotation can be changed with ``order`` (see :ref:` .. rst-class:: classref-method -:ref:`Basis` **from_scale**\ (\ scale\: :ref:`Vector3`\ ) |static| +:ref:`Basis` **from_scale**\ (\ scale\: :ref:`Vector3`\ ) |static| :ref:`🔗` Constructs a new **Basis** that only represents scale, with no rotation or shear, from the given ``scale`` vector. @@ -445,7 +445,7 @@ Constructs a new **Basis** that only represents scale, with no rotation or shear .. rst-class:: classref-method -:ref:`Vector3` **get_euler**\ (\ order\: :ref:`int` = 2\ ) |const| +:ref:`Vector3` **get_euler**\ (\ order\: :ref:`int` = 2\ ) |const| :ref:`🔗` Returns this basis's rotation as a :ref:`Vector3` of `Euler angles `__, in radians. @@ -469,7 +469,7 @@ The order of each consecutive rotation can be changed with ``order`` (see :ref:` .. rst-class:: classref-method -:ref:`Quaternion` **get_rotation_quaternion**\ (\ ) |const| +:ref:`Quaternion` **get_rotation_quaternion**\ (\ ) |const| :ref:`🔗` Returns this basis's rotation as a :ref:`Quaternion`. @@ -483,7 +483,7 @@ Returns this basis's rotation as a :ref:`Quaternion`. .. rst-class:: classref-method -:ref:`Vector3` **get_scale**\ (\ ) |const| +:ref:`Vector3` **get_scale**\ (\ ) |const| :ref:`🔗` Returns the length of each axis of this basis, as a :ref:`Vector3`. If the basis is not sheared, this is the scaling factor. It is not affected by rotation. @@ -528,7 +528,7 @@ Returns the length of each axis of this basis, as a :ref:`Vector3 .. rst-class:: classref-method -:ref:`Basis` **inverse**\ (\ ) |const| +:ref:`Basis` **inverse**\ (\ ) |const| :ref:`🔗` Returns the `inverse of this basis's matrix `__. @@ -540,7 +540,7 @@ Returns the `inverse of this basis's matrix ` **is_conformal**\ (\ ) |const| +:ref:`bool` **is_conformal**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this basis is conformal. A conformal basis is both *orthogonal* (the axes are perpendicular to each other) and *uniform* (the axes share the same length). This method can be especially useful during physics calculations. @@ -552,7 +552,7 @@ Returns ``true`` if this basis is conformal. A conformal basis is both *orthogon .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ b\: :ref:`Basis`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ b\: :ref:`Basis`\ ) |const| :ref:`🔗` Returns ``true`` if this basis and ``b`` are approximately equal, by calling :ref:`@GlobalScope.is_equal_approx` on all vector components. @@ -564,7 +564,7 @@ Returns ``true`` if this basis and ``b`` are approximately equal, by calling :re .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this basis is finite, by calling :ref:`@GlobalScope.is_finite` on all vector components. @@ -576,7 +576,7 @@ Returns ``true`` if this basis is finite, by calling :ref:`@GlobalScope.is_finit .. rst-class:: classref-method -:ref:`Basis` **looking_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |static| +:ref:`Basis` **looking_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |static| :ref:`🔗` Creates a new **Basis** with a rotation such that the forward axis (-Z) points towards the ``target`` position. @@ -592,7 +592,7 @@ The up axis (+Y) points as close to the ``up`` vector as possible while staying .. rst-class:: classref-method -:ref:`Basis` **orthonormalized**\ (\ ) |const| +:ref:`Basis` **orthonormalized**\ (\ ) |const| :ref:`🔗` Returns the orthonormalized version of this basis. An orthonormal basis is both *orthogonal* (the axes are perpendicular to each other) and *normalized* (the axes have a length of ``1``), which also means it can only represent rotation. @@ -630,7 +630,7 @@ It is often useful to call this method to avoid rounding errors on a rotating ba .. rst-class:: classref-method -:ref:`Basis` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| +:ref:`Basis` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns this basis rotated around the given ``axis`` by ``angle`` (in radians). The ``axis`` must be a normalized vector (see :ref:`Vector3.normalized`). @@ -667,7 +667,7 @@ Positive values rotate this basis clockwise around the axis, while negative valu .. rst-class:: classref-method -:ref:`Basis` **scaled**\ (\ scale\: :ref:`Vector3`\ ) |const| +:ref:`Basis` **scaled**\ (\ scale\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns this basis with each axis's components scaled by the given ``scale``'s components. @@ -712,7 +712,7 @@ The basis matrix's rows are multiplied by ``scale``'s components. This operation .. rst-class:: classref-method -:ref:`Basis` **slerp**\ (\ to\: :ref:`Basis`, weight\: :ref:`float`\ ) |const| +:ref:`Basis` **slerp**\ (\ to\: :ref:`Basis`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a spherical-linear interpolation with the ``to`` basis, given a ``weight``. Both this basis and ``to`` should represent a rotation. @@ -737,7 +737,7 @@ Performs a spherical-linear interpolation with the ``to`` basis, given a ``weigh .. rst-class:: classref-method -:ref:`float` **tdotx**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`float` **tdotx**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the transposed dot product between ``with`` and the :ref:`x` axis (see :ref:`transposed`). @@ -751,7 +751,7 @@ This is equivalent to ``basis.x.dot(vector)``. .. rst-class:: classref-method -:ref:`float` **tdoty**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`float` **tdoty**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the transposed dot product between ``with`` and the :ref:`y` axis (see :ref:`transposed`). @@ -765,7 +765,7 @@ This is equivalent to ``basis.y.dot(vector)``. .. rst-class:: classref-method -:ref:`float` **tdotz**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`float` **tdotz**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the transposed dot product between ``with`` and the :ref:`z` axis (see :ref:`transposed`). @@ -779,7 +779,7 @@ This is equivalent to ``basis.z.dot(vector)``. .. rst-class:: classref-method -:ref:`Basis` **transposed**\ (\ ) |const| +:ref:`Basis` **transposed**\ (\ ) |const| :ref:`🔗` Returns the transposed version of this basis. This turns the basis matrix's columns into rows, and its rows into columns. @@ -827,7 +827,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Basis`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Basis`\ ) :ref:`🔗` Returns ``true`` if the components of both **Basis** matrices are not equal. @@ -841,7 +841,7 @@ Returns ``true`` if the components of both **Basis** matrices are not equal. .. rst-class:: classref-operator -:ref:`Basis` **operator ***\ (\ right\: :ref:`Basis`\ ) +:ref:`Basis` **operator ***\ (\ right\: :ref:`Basis`\ ) :ref:`🔗` Transforms (multiplies) the ``right`` basis by this basis. @@ -855,7 +855,7 @@ This is the operation performed between parent and child :ref:`Node3D` **operator ***\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Transforms (multiplies) the ``right`` vector by this basis, returning a :ref:`Vector3`. @@ -882,7 +882,7 @@ Transforms (multiplies) the ``right`` vector by this basis, returning a :ref:`Ve .. rst-class:: classref-operator -:ref:`Basis` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Basis` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies all components of the **Basis** by the given :ref:`float`. This affects the basis's scale uniformly, resizing all 3 axes by the ``right`` value. @@ -894,7 +894,7 @@ Multiplies all components of the **Basis** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Basis` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Basis` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies all components of the **Basis** by the given :ref:`int`. This affects the basis's scale uniformly, resizing all 3 axes by the ``right`` value. @@ -906,7 +906,7 @@ Multiplies all components of the **Basis** by the given :ref:`int`. T .. rst-class:: classref-operator -:ref:`Basis` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Basis` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides all components of the **Basis** by the given :ref:`float`. This affects the basis's scale uniformly, resizing all 3 axes by the ``right`` value. @@ -918,7 +918,7 @@ Divides all components of the **Basis** by the given :ref:`float`. .. rst-class:: classref-operator -:ref:`Basis` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Basis` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides all components of the **Basis** by the given :ref:`int`. This affects the basis's scale uniformly, resizing all 3 axes by the ``right`` value. @@ -930,7 +930,7 @@ Divides all components of the **Basis** by the given :ref:`int`. This .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Basis`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Basis`\ ) :ref:`🔗` Returns ``true`` if the components of both **Basis** matrices are exactly equal. @@ -944,7 +944,7 @@ Returns ``true`` if the components of both **Basis** matrices are exactly equal. .. rst-class:: classref-operator -:ref:`Vector3` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Vector3` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Accesses each axis (column) of this basis by their index. Index ``0`` is the same as :ref:`x`, index ``1`` is the same as :ref:`y`, and index ``2`` is the same as :ref:`z`. diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 3921c5ae443..69b3b3ae7a7 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Image` **convert_to_image**\ (\ ) |const| +:ref:`Image` **convert_to_image**\ (\ ) |const| :ref:`🔗` Returns an image of the same size as the bitmap and with a :ref:`Format` of type :ref:`Image.FORMAT_L8`. ``true`` bits of the bitmap are being converted into white pixels, and ``false`` bits into black. @@ -82,7 +82,7 @@ Returns an image of the same size as the bitmap and with a :ref:`Format`\ ) +|void| **create**\ (\ size\: :ref:`Vector2i`\ ) :ref:`🔗` Creates a bitmap with the specified size, filled with ``false``. @@ -94,7 +94,7 @@ Creates a bitmap with the specified size, filled with ``false``. .. rst-class:: classref-method -|void| **create_from_image_alpha**\ (\ image\: :ref:`Image`, threshold\: :ref:`float` = 0.1\ ) +|void| **create_from_image_alpha**\ (\ image\: :ref:`Image`, threshold\: :ref:`float` = 0.1\ ) :ref:`🔗` Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to ``false`` if the alpha value of the image at that position is equal to ``threshold`` or less, and ``true`` in other case. @@ -106,7 +106,7 @@ Creates a bitmap that matches the given image dimensions, every element of the b .. rst-class:: classref-method -:ref:`bool` **get_bit**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| +:ref:`bool` **get_bit**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| :ref:`🔗` Returns bitmap's value at the specified position. @@ -118,7 +118,7 @@ Returns bitmap's value at the specified position. .. rst-class:: classref-method -:ref:`bool` **get_bitv**\ (\ position\: :ref:`Vector2i`\ ) |const| +:ref:`bool` **get_bitv**\ (\ position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns bitmap's value at the specified position. @@ -130,7 +130,7 @@ Returns bitmap's value at the specified position. .. rst-class:: classref-method -:ref:`Vector2i` **get_size**\ (\ ) |const| +:ref:`Vector2i` **get_size**\ (\ ) |const| :ref:`🔗` Returns bitmap's dimensions. @@ -142,7 +142,7 @@ Returns bitmap's dimensions. .. rst-class:: classref-method -:ref:`int` **get_true_bit_count**\ (\ ) |const| +:ref:`int` **get_true_bit_count**\ (\ ) |const| :ref:`🔗` Returns the number of bitmap elements that are set to ``true``. @@ -154,7 +154,7 @@ Returns the number of bitmap elements that are set to ``true``. .. rst-class:: classref-method -|void| **grow_mask**\ (\ pixels\: :ref:`int`, rect\: :ref:`Rect2i`\ ) +|void| **grow_mask**\ (\ pixels\: :ref:`int`, rect\: :ref:`Rect2i`\ ) :ref:`🔗` Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positive, dilation is applied to the bitmap. If ``pixels`` is negative, erosion is applied to the bitmap. ``rect`` defines the area where the morphological operation is applied. Pixels located outside the ``rect`` are unaffected by :ref:`grow_mask`. @@ -166,7 +166,7 @@ Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positi .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **opaque_to_polygons**\ (\ rect\: :ref:`Rect2i`, epsilon\: :ref:`float` = 2.0\ ) |const| +:ref:`Array`\[:ref:`PackedVector2Array`\] **opaque_to_polygons**\ (\ rect\: :ref:`Rect2i`, epsilon\: :ref:`float` = 2.0\ ) |const| :ref:`🔗` Creates an :ref:`Array` of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a :ref:`PackedVector2Array` of its vertices. @@ -186,7 +186,7 @@ To get polygons covering the whole bitmap, pass: .. rst-class:: classref-method -|void| **resize**\ (\ new_size\: :ref:`Vector2i`\ ) +|void| **resize**\ (\ new_size\: :ref:`Vector2i`\ ) :ref:`🔗` Resizes the image to ``new_size``. @@ -198,7 +198,7 @@ Resizes the image to ``new_size``. .. rst-class:: classref-method -|void| **set_bit**\ (\ x\: :ref:`int`, y\: :ref:`int`, bit\: :ref:`bool`\ ) +|void| **set_bit**\ (\ x\: :ref:`int`, y\: :ref:`int`, bit\: :ref:`bool`\ ) :ref:`🔗` Sets the bitmap's element at the specified position, to the specified value. @@ -210,7 +210,7 @@ Sets the bitmap's element at the specified position, to the specified value. .. rst-class:: classref-method -|void| **set_bit_rect**\ (\ rect\: :ref:`Rect2i`, bit\: :ref:`bool`\ ) +|void| **set_bit_rect**\ (\ rect\: :ref:`Rect2i`, bit\: :ref:`bool`\ ) :ref:`🔗` Sets a rectangular portion of the bitmap to the specified value. @@ -222,7 +222,7 @@ Sets a rectangular portion of the bitmap to the specified value. .. rst-class:: classref-method -|void| **set_bitv**\ (\ position\: :ref:`Vector2i`, bit\: :ref:`bool`\ ) +|void| **set_bitv**\ (\ position\: :ref:`Vector2i`, bit\: :ref:`bool`\ ) :ref:`🔗` Sets the bitmap's element at the specified position, to the specified value. diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index cdd73514b34..1e6460eb4d6 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -80,7 +80,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Transform2D` **rest** = ``Transform2D(0, 0, 0, 0, 0, 0)`` +:ref:`Transform2D` **rest** = ``Transform2D(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **apply_rest**\ (\ ) +|void| **apply_rest**\ (\ ) :ref:`🔗` Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.transform` to :ref:`rest`. @@ -114,7 +114,7 @@ Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.tra .. rst-class:: classref-method -:ref:`bool` **get_autocalculate_length_and_angle**\ (\ ) |const| +:ref:`bool` **get_autocalculate_length_and_angle**\ (\ ) |const| :ref:`🔗` Returns whether this **Bone2D** is going to autocalculate its length and bone angle using its first **Bone2D** child node, if one exists. If there are no **Bone2D** children, then it cannot autocalculate these values and will print a warning. @@ -126,7 +126,7 @@ Returns whether this **Bone2D** is going to autocalculate its length and bone an .. rst-class:: classref-method -:ref:`float` **get_bone_angle**\ (\ ) |const| +:ref:`float` **get_bone_angle**\ (\ ) |const| :ref:`🔗` Returns the angle of the bone in the **Bone2D**. @@ -140,7 +140,7 @@ Returns the angle of the bone in the **Bone2D**. .. rst-class:: classref-method -:ref:`int` **get_index_in_skeleton**\ (\ ) |const| +:ref:`int` **get_index_in_skeleton**\ (\ ) |const| :ref:`🔗` Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D`. @@ -152,7 +152,7 @@ Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D` **get_length**\ (\ ) |const| +:ref:`float` **get_length**\ (\ ) |const| :ref:`🔗` Returns the length of the bone in the **Bone2D** node. @@ -164,7 +164,7 @@ Returns the length of the bone in the **Bone2D** node. .. rst-class:: classref-method -:ref:`Transform2D` **get_skeleton_rest**\ (\ ) |const| +:ref:`Transform2D` **get_skeleton_rest**\ (\ ) |const| :ref:`🔗` Returns the node's :ref:`rest` :ref:`Transform2D` if it doesn't have a parent, or its rest pose relative to its parent. @@ -176,7 +176,7 @@ Returns the node's :ref:`rest` :ref:`Transform2D`\ ) +|void| **set_autocalculate_length_and_angle**\ (\ auto_calculate\: :ref:`bool`\ ) :ref:`🔗` When set to ``true``, the **Bone2D** node will attempt to automatically calculate the bone angle and length using the first child **Bone2D** node, if one exists. If none exist, the **Bone2D** cannot automatically calculate these values and will print a warning. @@ -188,7 +188,7 @@ When set to ``true``, the **Bone2D** node will attempt to automatically calculat .. rst-class:: classref-method -|void| **set_bone_angle**\ (\ angle\: :ref:`float`\ ) +|void| **set_bone_angle**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` Sets the bone angle for the **Bone2D**. This is typically set to the rotation from the **Bone2D** to a child **Bone2D** node. @@ -202,7 +202,7 @@ Sets the bone angle for the **Bone2D**. This is typically set to the rotation fr .. rst-class:: classref-method -|void| **set_length**\ (\ length\: :ref:`float`\ ) +|void| **set_length**\ (\ length\: :ref:`float`\ ) :ref:`🔗` Sets the length of the bone in the **Bone2D**. diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 9a905c7e824..5b5475a34a4 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -73,7 +73,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bone_idx** = ``-1`` +:ref:`int` **bone_idx** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The index of the attached bone. .. rst-class:: classref-property -:ref:`String` **bone_name** = ``""`` +:ref:`String` **bone_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The name of the attached bone. .. rst-class:: classref-property -:ref:`bool` **override_pose** = ``false`` +:ref:`bool` **override_pose** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_external_skeleton**\ (\ ) |const| +:ref:`NodePath` **get_external_skeleton**\ (\ ) |const| :ref:`🔗` Returns the :ref:`NodePath` to the external :ref:`Skeleton3D` node, if one has been set. @@ -143,7 +143,7 @@ Returns the :ref:`NodePath` to the external :ref:`Skeleton3D` **get_use_external_skeleton**\ (\ ) |const| +:ref:`bool` **get_use_external_skeleton**\ (\ ) |const| :ref:`🔗` Returns whether the BoneAttachment3D node is using an external :ref:`Skeleton3D` rather than attempting to use its parent node as the :ref:`Skeleton3D`. @@ -155,7 +155,7 @@ Returns whether the BoneAttachment3D node is using an external :ref:`Skeleton3D< .. rst-class:: classref-method -|void| **on_skeleton_update**\ (\ ) +|void| **on_skeleton_update**\ (\ ) :ref:`🔗` A function that is called automatically when the :ref:`Skeleton3D` is updated. This function is where the **BoneAttachment3D** node updates its position so it is correctly bound when it is *not* set to override the bone pose. @@ -167,7 +167,7 @@ A function that is called automatically when the :ref:`Skeleton3D`\ ) +|void| **set_external_skeleton**\ (\ external_skeleton\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`NodePath` to the external skeleton that the BoneAttachment3D node should use. See :ref:`set_use_external_skeleton` to enable the external :ref:`Skeleton3D` node. @@ -179,7 +179,7 @@ Sets the :ref:`NodePath` to the external skeleton that the BoneA .. rst-class:: classref-method -|void| **set_use_external_skeleton**\ (\ use_external_skeleton\: :ref:`bool`\ ) +|void| **set_use_external_skeleton**\ (\ use_external_skeleton\: :ref:`bool`\ ) :ref:`🔗` Sets whether the BoneAttachment3D node will use an external :ref:`Skeleton3D` node rather than attempting to use its parent node as the :ref:`Skeleton3D`. When set to ``true``, the BoneAttachment3D node will use the external :ref:`Skeleton3D` node set in :ref:`set_external_skeleton`. diff --git a/classes/class_bonemap.rst b/classes/class_bonemap.rst index b9b2d211930..8007915030e 100644 --- a/classes/class_bonemap.rst +++ b/classes/class_bonemap.rst @@ -71,7 +71,7 @@ Signals .. rst-class:: classref-signal -**bone_map_updated**\ (\ ) +**bone_map_updated**\ (\ ) :ref:`🔗` This signal is emitted when change the key value in the **BoneMap**. This is used to validate mapping and to update **BoneMap** editor. @@ -83,7 +83,7 @@ This signal is emitted when change the key value in the **BoneMap**. This is use .. rst-class:: classref-signal -**profile_updated**\ (\ ) +**profile_updated**\ (\ ) :ref:`🔗` This signal is emitted when change the value in profile or change the reference of profile. This is used to update key names in the **BoneMap** and to redraw the **BoneMap** editor. @@ -100,7 +100,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`SkeletonProfile` **profile** +:ref:`SkeletonProfile` **profile** :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **find_profile_bone_name**\ (\ skeleton_bone_name\: :ref:`StringName`\ ) |const| +:ref:`StringName` **find_profile_bone_name**\ (\ skeleton_bone_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a profile bone name having ``skeleton_bone_name``. If not found, an empty :ref:`StringName` will be returned. @@ -136,7 +136,7 @@ In the retargeting process, the returned bone name is the bone name of the targe .. rst-class:: classref-method -:ref:`StringName` **get_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`\ ) |const| +:ref:`StringName` **get_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a skeleton bone name is mapped to ``profile_bone_name``. @@ -150,7 +150,7 @@ In the retargeting process, the returned bone name is the bone name of the sourc .. rst-class:: classref-method -|void| **set_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`, skeleton_bone_name\: :ref:`StringName`\ ) +|void| **set_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`, skeleton_bone_name\: :ref:`StringName`\ ) :ref:`🔗` Maps a skeleton bone name to ``profile_bone_name``. diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 11cad195b4f..9b6508e3266 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -122,7 +122,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`bool` **bool**\ (\ ) +:ref:`bool` **bool**\ (\ ) :ref:`🔗` Constructs a **bool** set to ``false``. @@ -169,7 +169,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`bool`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`bool`\ ) :ref:`🔗` Returns ``true`` if the two booleans are not equal. That is, one is ``true`` and the other is ``false``. This operation can be seen as a logical XOR. @@ -181,7 +181,7 @@ Returns ``true`` if the two booleans are not equal. That is, one is ``true`` and .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`bool`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`bool`\ ) :ref:`🔗` Returns ``true`` if the left operand is ``false`` and the right operand is ``true``. @@ -193,7 +193,7 @@ Returns ``true`` if the left operand is ``false`` and the right operand is ``tru .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`bool`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`bool`\ ) :ref:`🔗` Returns ``true`` if the two booleans are equal. That is, both are ``true`` or both are ``false``. This operation can be seen as a logical EQ or XNOR. @@ -205,7 +205,7 @@ Returns ``true`` if the two booleans are equal. That is, both are ``true`` or bo .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`bool`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`bool`\ ) :ref:`🔗` Returns ``true`` if the left operand is ``true`` and the right operand is ``false``. diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 20336ea66ca..fe99b7b7429 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -81,7 +81,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AlignmentMode**: +enum **AlignmentMode**: :ref:`🔗` .. _class_BoxContainer_constant_ALIGNMENT_BEGIN: @@ -120,7 +120,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AlignmentMode` **alignment** = ``0`` +:ref:`AlignmentMode` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN< .. rst-class:: classref-property -:ref:`bool` **vertical** = ``false`` +:ref:`bool` **vertical** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Control` **add_spacer**\ (\ begin\: :ref:`bool`\ ) +:ref:`Control` **add_spacer**\ (\ begin\: :ref:`bool`\ ) :ref:`🔗` Adds a :ref:`Control` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control` node in front of all other children. @@ -178,7 +178,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **separation** = ``4`` +:ref:`int` **separation** = ``4`` :ref:`🔗` The space between the **BoxContainer**'s elements, in pixels. diff --git a/classes/class_boxmesh.rst b/classes/class_boxmesh.rst index 164246af107..2e0f04fb34c 100644 --- a/classes/class_boxmesh.rst +++ b/classes/class_boxmesh.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ The box's width, height and depth. .. rst-class:: classref-property -:ref:`int` **subdivide_depth** = ``0`` +:ref:`int` **subdivide_depth** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ Number of extra edge loops inserted along the Z axis. .. rst-class:: classref-property -:ref:`int` **subdivide_height** = ``0`` +:ref:`int` **subdivide_height** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ Number of extra edge loops inserted along the Y axis. .. rst-class:: classref-property -:ref:`int` **subdivide_width** = ``0`` +:ref:`int` **subdivide_width** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_boxoccluder3d.rst b/classes/class_boxoccluder3d.rst index 80a543dcb31..bf941c41e18 100644 --- a/classes/class_boxoccluder3d.rst +++ b/classes/class_boxoccluder3d.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_boxshape3d.rst b/classes/class_boxshape3d.rst index 7a2d8e9544e..07a369ddb24 100644 --- a/classes/class_boxshape3d.rst +++ b/classes/class_boxshape3d.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_button.rst b/classes/class_button.rst index ea2d846fb47..442fac68c8e 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -186,7 +186,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`HorizontalAlignment` **alignment** = ``1`` +:ref:`HorizontalAlignment` **alignment** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -203,7 +203,7 @@ Text alignment policy for the button's text, use one of the :ref:`HorizontalAlig .. rst-class:: classref-property -:ref:`AutowrapMode` **autowrap_mode** = ``0`` +:ref:`AutowrapMode` **autowrap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` **clip_text** = ``false`` +:ref:`bool` **clip_text** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ When this property is enabled, text that is too large to fit the button is clipp .. rst-class:: classref-property -:ref:`bool` **expand_icon** = ``false`` +:ref:`bool` **expand_icon** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ When enabled, the button's icon will expand/shrink to fit the button's size whil .. rst-class:: classref-property -:ref:`bool` **flat** = ``false`` +:ref:`bool` **flat** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ Flat buttons don't display decoration. .. rst-class:: classref-property -:ref:`Texture2D` **icon** +:ref:`Texture2D` **icon** :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ To edit margin and spacing of the icon, use :ref:`h_separation` **icon_alignment** = ``0`` +:ref:`HorizontalAlignment` **icon_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -307,7 +307,7 @@ Specifies if the icon should be aligned horizontally to the left, right, or cent .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -341,7 +341,7 @@ The button's text that will be displayed inside the button's area. .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` +:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ Sets the clipping behavior when the text exceeds the node's bounding rectangle. .. rst-class:: classref-property -:ref:`VerticalAlignment` **vertical_icon_alignment** = ``1`` +:ref:`VerticalAlignment` **vertical_icon_alignment** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -397,7 +397,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Default text :ref:`Color` of the **Button**. @@ -409,7 +409,7 @@ Default text :ref:`Color` of the **Button**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Text :ref:`Color` used when the **Button** is disabled. @@ -421,7 +421,7 @@ Text :ref:`Color` used when the **Button** is disabled. .. rst-class:: classref-themeproperty -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` 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. @@ -433,7 +433,7 @@ Text :ref:`Color` used when the **Button** is focused. Only replace .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Text :ref:`Color` used when the **Button** is being hovered. @@ -445,7 +445,7 @@ Text :ref:`Color` used when the **Button** is being hovered. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the **Button** is being hovered and pressed. @@ -457,7 +457,7 @@ Text :ref:`Color` used when the **Button** is being hovered and pre .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the **Button**. @@ -469,7 +469,7 @@ The tint of text outline of the **Button**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the **Button** is being pressed. @@ -481,7 +481,7 @@ Text :ref:`Color` used when the **Button** is being pressed. .. rst-class:: classref-themeproperty -:ref:`Color` **icon_disabled_color** = ``Color(1, 1, 1, 0.4)`` +:ref:`Color` **icon_disabled_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗` Icon modulate :ref:`Color` used when the **Button** is disabled. @@ -493,7 +493,7 @@ Icon modulate :ref:`Color` used when the **Button** is disabled. .. rst-class:: classref-themeproperty -:ref:`Color` **icon_focus_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **icon_focus_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` 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. @@ -505,7 +505,7 @@ Icon modulate :ref:`Color` used when the **Button** is focused. Onl .. rst-class:: classref-themeproperty -:ref:`Color` **icon_hover_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **icon_hover_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Icon modulate :ref:`Color` used when the **Button** is being hovered. @@ -517,7 +517,7 @@ Icon modulate :ref:`Color` used when the **Button** is being hovere .. rst-class:: classref-themeproperty -:ref:`Color` **icon_hover_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **icon_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Icon modulate :ref:`Color` used when the **Button** is being hovered and pressed. @@ -529,7 +529,7 @@ Icon modulate :ref:`Color` used when the **Button** is being hovere .. rst-class:: classref-themeproperty -:ref:`Color` **icon_normal_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **icon_normal_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Default icon modulate :ref:`Color` of the **Button**. @@ -541,7 +541,7 @@ Default icon modulate :ref:`Color` of the **Button**. .. rst-class:: classref-themeproperty -:ref:`Color` **icon_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **icon_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Icon modulate :ref:`Color` used when the **Button** is being pressed. @@ -553,7 +553,7 @@ Icon modulate :ref:`Color` used when the **Button** is being presse .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal space between **Button**'s icon and text. Negative values will be treated as ``0`` when used. @@ -565,9 +565,9 @@ The horizontal space between **Button**'s icon and text. Negative values will be .. rst-class:: classref-themeproperty -:ref:`int` **icon_max_width** = ``0`` +:ref:`int` **icon_max_width** = ``0`` :ref:`🔗` -The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon` is ``true``. The height is adjusted according to the icon's ratio. +The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon` is ``true``. The height is adjusted according to the icon's ratio. If the button has additional icons (e.g. :ref:`CheckBox`), they will also be limited. .. rst-class:: classref-item-separator @@ -577,7 +577,7 @@ The maximum allowed width of the **Button**'s icon. This limit is applied on top .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -591,7 +591,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` of the **Button**'s text. @@ -603,7 +603,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the **Button**'s text. @@ -615,7 +615,7 @@ Font size of the **Button**'s text. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **icon** +:ref:`Texture2D` **icon** :ref:`🔗` Default icon for the **Button**. Appears only if :ref:`icon` is not assigned. @@ -627,7 +627,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **disabled** +:ref:`StyleBox` **disabled** :ref:`🔗` :ref:`StyleBox` used when the **Button** is disabled. @@ -639,7 +639,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **disabled_mirrored** +:ref:`StyleBox` **disabled_mirrored** :ref:`🔗` :ref:`StyleBox` used when the **Button** is disabled (for right-to-left layouts). @@ -651,7 +651,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` :ref:`StyleBox` used when the **Button** is focused. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -663,7 +663,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **hover** +:ref:`StyleBox` **hover** :ref:`🔗` :ref:`StyleBox` used when the **Button** is being hovered. @@ -675,7 +675,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **hover_mirrored** +:ref:`StyleBox` **hover_mirrored** :ref:`🔗` :ref:`StyleBox` used when the **Button** is being hovered (for right-to-left layouts). @@ -687,7 +687,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **hover_pressed** +:ref:`StyleBox` **hover_pressed** :ref:`🔗` :ref:`StyleBox` used when the **Button** is being pressed and hovered at the same time. @@ -699,7 +699,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **hover_pressed_mirrored** +:ref:`StyleBox` **hover_pressed_mirrored** :ref:`🔗` :ref:`StyleBox` used when the **Button** is being pressed and hovered at the same time (for right-to-left layouts). @@ -711,7 +711,7 @@ Default icon for the **Button**. Appears only if :ref:`icon` **normal** +:ref:`StyleBox` **normal** :ref:`🔗` Default :ref:`StyleBox` for the **Button**. @@ -723,7 +723,7 @@ Default :ref:`StyleBox` for the **Button**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **normal_mirrored** +:ref:`StyleBox` **normal_mirrored** :ref:`🔗` Default :ref:`StyleBox` for the **Button** (for right-to-left layouts). @@ -735,7 +735,7 @@ Default :ref:`StyleBox` for the **Button** (for right-to-left la .. rst-class:: classref-themeproperty -:ref:`StyleBox` **pressed** +:ref:`StyleBox` **pressed** :ref:`🔗` :ref:`StyleBox` used when the **Button** is being pressed. @@ -747,7 +747,7 @@ Default :ref:`StyleBox` for the **Button** (for right-to-left la .. rst-class:: classref-themeproperty -:ref:`StyleBox` **pressed_mirrored** +:ref:`StyleBox` **pressed_mirrored** :ref:`🔗` :ref:`StyleBox` used when the **Button** is being pressed (for right-to-left layouts). diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 4b9a673c66e..dee45a48992 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**pressed**\ (\ button\: :ref:`BaseButton`\ ) +**pressed**\ (\ button\: :ref:`BaseButton`\ ) :ref:`🔗` Emitted when one of the buttons of the group is pressed. @@ -81,7 +81,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_unpress** = ``false`` +:ref:`bool` **allow_unpress** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`BaseButton`\] **get_buttons**\ (\ ) +:ref:`Array`\[:ref:`BaseButton`\] **get_buttons**\ (\ ) :ref:`🔗` Returns an :ref:`Array` of :ref:`Button`\ s who have this as their **ButtonGroup** (see :ref:`BaseButton.button_group`). @@ -115,7 +115,7 @@ Returns an :ref:`Array` of :ref:`Button`\ s who have .. rst-class:: classref-method -:ref:`BaseButton` **get_pressed_button**\ (\ ) +:ref:`BaseButton` **get_pressed_button**\ (\ ) :ref:`🔗` Returns the current pressed button. diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 02b66aabb64..691f4482ef9 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -185,7 +185,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Callable` **Callable**\ (\ ) +:ref:`Callable` **Callable**\ (\ ) :ref:`🔗` Constructs an empty **Callable**, with no object nor method bound. @@ -224,7 +224,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Callable` **bind**\ (\ ...\ ) |vararg| |const| +:ref:`Callable` **bind**\ (\ ...\ ) |vararg| |const| :ref:`🔗` Returns a copy of this **Callable** with one or more arguments bound. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. See also :ref:`unbind`. @@ -238,7 +238,7 @@ Returns a copy of this **Callable** with one or more arguments bound. When calle .. rst-class:: classref-method -:ref:`Callable` **bindv**\ (\ arguments\: :ref:`Array`\ ) +:ref:`Callable` **bindv**\ (\ arguments\: :ref:`Array`\ ) :ref:`🔗` Returns a copy of this **Callable** with one or more arguments bound, reading them from an array. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. See also :ref:`unbind`. @@ -252,7 +252,7 @@ Returns a copy of this **Callable** with one or more arguments bound, reading th .. rst-class:: classref-method -:ref:`Variant` **call**\ (\ ...\ ) |vararg| |const| +:ref:`Variant` **call**\ (\ ...\ ) |vararg| |const| :ref:`🔗` Calls the method represented by this **Callable**. Arguments can be passed and should match the method's signature. @@ -264,7 +264,7 @@ Calls the method represented by this **Callable**. Arguments can be passed and s .. rst-class:: classref-method -|void| **call_deferred**\ (\ ...\ ) |vararg| |const| +|void| **call_deferred**\ (\ ...\ ) |vararg| |const| :ref:`🔗` Calls the method represented by this **Callable** in deferred mode, i.e. at the end of the current frame. Arguments can be passed and should match the method's signature. @@ -297,7 +297,7 @@ See also :ref:`Object.call_deferred`. .. rst-class:: classref-method -:ref:`Variant` **callv**\ (\ arguments\: :ref:`Array`\ ) |const| +:ref:`Variant` **callv**\ (\ arguments\: :ref:`Array`\ ) |const| :ref:`🔗` Calls the method represented by this **Callable**. Unlike :ref:`call`, this method expects all arguments to be contained inside the ``arguments`` :ref:`Array`. @@ -309,7 +309,7 @@ Calls the method represented by this **Callable**. Unlike :ref:`call` **create**\ (\ variant\: :ref:`Variant`, method\: :ref:`StringName`\ ) |static| +:ref:`Callable` **create**\ (\ variant\: :ref:`Variant`, method\: :ref:`StringName`\ ) |static| :ref:`🔗` Creates a new **Callable** for the method named ``method`` in the specified ``variant``. To represent a method of a built-in :ref:`Variant` type, a custom callable is used (see :ref:`is_custom`). If ``variant`` is :ref:`Object`, then a standard callable will be created instead. @@ -323,7 +323,7 @@ Creates a new **Callable** for the method named ``method`` in the specified ``va .. rst-class:: classref-method -:ref:`int` **get_argument_count**\ (\ ) |const| +:ref:`int` **get_argument_count**\ (\ ) |const| :ref:`🔗` Returns the total number of arguments this **Callable** should take, including optional arguments. This means that any arguments bound with :ref:`bind` are *subtracted* from the result, and any arguments unbound with :ref:`unbind` are *added* to the result. @@ -335,7 +335,7 @@ Returns the total number of arguments this **Callable** should take, including o .. rst-class:: classref-method -:ref:`Array` **get_bound_arguments**\ (\ ) |const| +:ref:`Array` **get_bound_arguments**\ (\ ) |const| :ref:`🔗` Return the bound arguments (as long as :ref:`get_bound_arguments_count` is greater than zero), or empty (if :ref:`get_bound_arguments_count` is less than or equal to zero). @@ -347,7 +347,7 @@ Return the bound arguments (as long as :ref:`get_bound_arguments_count` **get_bound_arguments_count**\ (\ ) |const| +:ref:`int` **get_bound_arguments_count**\ (\ ) |const| :ref:`🔗` Returns the total amount of arguments bound (or unbound) via successive :ref:`bind` or :ref:`unbind` calls. If the amount of arguments unbound is greater than the ones bound, this function returns a value less than zero. @@ -359,7 +359,7 @@ Returns the total amount of arguments bound (or unbound) via successive :ref:`bi .. rst-class:: classref-method -:ref:`StringName` **get_method**\ (\ ) |const| +:ref:`StringName` **get_method**\ (\ ) |const| :ref:`🔗` Returns the name of the method represented by this **Callable**. If the callable is a GDScript lambda function, returns the function's name or ``""``. @@ -371,7 +371,7 @@ Returns the name of the method represented by this **Callable**. If the callable .. rst-class:: classref-method -:ref:`Object` **get_object**\ (\ ) |const| +:ref:`Object` **get_object**\ (\ ) |const| :ref:`🔗` Returns the object on which this **Callable** is called. @@ -383,7 +383,7 @@ Returns the object on which this **Callable** is called. .. rst-class:: classref-method -:ref:`int` **get_object_id**\ (\ ) |const| +:ref:`int` **get_object_id**\ (\ ) |const| :ref:`🔗` Returns the ID of this **Callable**'s object (see :ref:`Object.get_instance_id`). @@ -395,7 +395,7 @@ Returns the ID of this **Callable**'s object (see :ref:`Object.get_instance_id` **hash**\ (\ ) |const| +:ref:`int` **hash**\ (\ ) |const| :ref:`🔗` Returns the 32-bit hash value of this **Callable**'s object. @@ -409,7 +409,7 @@ Returns the 32-bit hash value of this **Callable**'s object. .. rst-class:: classref-method -:ref:`bool` **is_custom**\ (\ ) |const| +:ref:`bool` **is_custom**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Callable** is a custom callable. Custom callables are used: @@ -429,7 +429,7 @@ Returns ``true`` if this **Callable** is a custom callable. Custom callables are .. rst-class:: classref-method -:ref:`bool` **is_null**\ (\ ) |const| +:ref:`bool` **is_null**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Callable** has no target to call the method on. @@ -441,7 +441,7 @@ Returns ``true`` if this **Callable** has no target to call the method on. .. rst-class:: classref-method -:ref:`bool` **is_standard**\ (\ ) |const| +:ref:`bool` **is_standard**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Callable** is a standard callable. This method is the opposite of :ref:`is_custom`. Returns ``false`` if this callable is a lambda function. @@ -453,7 +453,7 @@ Returns ``true`` if this **Callable** is a standard callable. This method is the .. rst-class:: classref-method -:ref:`bool` **is_valid**\ (\ ) |const| +:ref:`bool` **is_valid**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the callable's object exists and has a valid method name assigned, or is a custom callable. @@ -465,7 +465,7 @@ Returns ``true`` if the callable's object exists and has a valid method name ass .. rst-class:: classref-method -|void| **rpc**\ (\ ...\ ) |vararg| |const| +|void| **rpc**\ (\ ...\ ) |vararg| |const| :ref:`🔗` Perform an RPC (Remote Procedure Call) on all connected peers. This is used for multiplayer and is normally not available, unless the function being called has been marked as *RPC* (using :ref:`@GDScript.@rpc` or :ref:`Node.rpc_config`). Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc`. @@ -477,7 +477,7 @@ Perform an RPC (Remote Procedure Call) on all connected peers. This is used for .. rst-class:: classref-method -|void| **rpc_id**\ (\ peer_id\: :ref:`int`, ...\ ) |vararg| |const| +|void| **rpc_id**\ (\ peer_id\: :ref:`int`, ...\ ) |vararg| |const| :ref:`🔗` Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as *RPC* (using :ref:`@GDScript.@rpc` or :ref:`Node.rpc_config`). Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc_id`. @@ -489,7 +489,7 @@ Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer do .. rst-class:: classref-method -:ref:`Callable` **unbind**\ (\ argcount\: :ref:`int`\ ) |const| +:ref:`Callable` **unbind**\ (\ argcount\: :ref:`int`\ ) |const| :ref:`🔗` Returns a copy of this **Callable** with a number of arguments unbound. In other words, when the new callable is called the last few arguments supplied by the user are ignored, according to ``argcount``. The remaining arguments are passed to the callable. This allows to use the original callable in a context that attempts to pass more arguments than this callable can handle, e.g. a signal with a fixed number of arguments. See also :ref:`bind`. @@ -514,7 +514,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Callable`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Callable`\ ) :ref:`🔗` Returns ``true`` if both **Callable**\ s invoke different targets. @@ -526,7 +526,7 @@ Returns ``true`` if both **Callable**\ s invoke different targets. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Callable`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Callable`\ ) :ref:`🔗` Returns ``true`` if both **Callable**\ s invoke the same custom target. diff --git a/classes/class_callbacktweener.rst b/classes/class_callbacktweener.rst index 961111b782b..b78d9c67348 100644 --- a/classes/class_callbacktweener.rst +++ b/classes/class_callbacktweener.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`CallbackTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) +:ref:`CallbackTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) :ref:`🔗` Makes the callback call delayed by given time in seconds. diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 810348fa9c6..e9c3bece41b 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -145,7 +145,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AnchorMode**: +enum **AnchorMode**: :ref:`🔗` .. _class_Camera2D_constant_ANCHOR_MODE_FIXED_TOP_LEFT: @@ -171,7 +171,7 @@ The camera's position takes into account vertical/horizontal offsets and the scr .. rst-class:: classref-enumeration -enum **Camera2DProcessCallback**: +enum **Camera2DProcessCallback**: :ref:`🔗` .. _class_Camera2D_constant_CAMERA2D_PROCESS_PHYSICS: @@ -202,7 +202,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AnchorMode` **anchor_mode** = ``1`` +:ref:`AnchorMode` **anchor_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ The Camera2D's anchor point. See :ref:`AnchorMode` con .. rst-class:: classref-property -:ref:`Node` **custom_viewport** +:ref:`Node` **custom_viewport** :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ The custom :ref:`Viewport` node attached to the **Camera2D**. If .. rst-class:: classref-property -:ref:`float` **drag_bottom_margin** = ``0.2`` +:ref:`float` **drag_bottom_margin** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -253,7 +253,7 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move .. rst-class:: classref-property -:ref:`bool` **drag_horizontal_enabled** = ``false`` +:ref:`bool` **drag_horizontal_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -270,7 +270,7 @@ If ``true``, the camera only moves when reaching the horizontal (left and right) .. rst-class:: classref-property -:ref:`float` **drag_horizontal_offset** = ``0.0`` +:ref:`float` **drag_horizontal_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -289,7 +289,7 @@ The relative horizontal drag offset of the camera between the right (``-1``) and .. rst-class:: classref-property -:ref:`float` **drag_left_margin** = ``0.2`` +:ref:`float` **drag_left_margin** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on .. rst-class:: classref-property -:ref:`float` **drag_right_margin** = ``0.2`` +:ref:`float` **drag_right_margin** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o .. rst-class:: classref-property -:ref:`float` **drag_top_margin** = ``0.2`` +:ref:`float` **drag_top_margin** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl .. rst-class:: classref-property -:ref:`bool` **drag_vertical_enabled** = ``false`` +:ref:`bool` **drag_vertical_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -357,7 +357,7 @@ If ``true``, the camera only moves when reaching the vertical (top and bottom) d .. rst-class:: classref-property -:ref:`float` **drag_vertical_offset** = ``0.0`` +:ref:`float` **drag_vertical_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -376,7 +376,7 @@ The relative vertical drag offset of the camera between the bottom (``-1``) and .. rst-class:: classref-property -:ref:`bool` **editor_draw_drag_margin** = ``false`` +:ref:`bool` **editor_draw_drag_margin** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -393,7 +393,7 @@ If ``true``, draws the camera's drag margin rectangle in the editor. .. rst-class:: classref-property -:ref:`bool` **editor_draw_limits** = ``false`` +:ref:`bool` **editor_draw_limits** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -410,7 +410,7 @@ If ``true``, draws the camera's limits rectangle in the editor. .. rst-class:: classref-property -:ref:`bool` **editor_draw_screen** = ``true`` +:ref:`bool` **editor_draw_screen** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -427,7 +427,7 @@ If ``true``, draws the camera's screen rectangle in the editor. .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -446,7 +446,7 @@ When the camera is currently active and :ref:`enabled` **ignore_rotation** = ``true`` +:ref:`bool` **ignore_rotation** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -463,7 +463,7 @@ If ``true``, the camera's rendered view is not affected by its :ref:`Node2D.rota .. rst-class:: classref-property -:ref:`int` **limit_bottom** = ``10000000`` +:ref:`int` **limit_bottom** = ``10000000`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -480,7 +480,7 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value, .. rst-class:: classref-property -:ref:`int` **limit_left** = ``-10000000`` +:ref:`int` **limit_left** = ``-10000000`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -497,7 +497,7 @@ Left scroll limit in pixels. The camera stops moving when reaching this value, b .. rst-class:: classref-property -:ref:`int` **limit_right** = ``10000000`` +:ref:`int` **limit_right** = ``10000000`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -514,7 +514,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value, .. rst-class:: classref-property -:ref:`bool` **limit_smoothed** = ``false`` +:ref:`bool` **limit_smoothed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -535,7 +535,7 @@ This property has no effect if :ref:`position_smoothing_enabled` **limit_top** = ``-10000000`` +:ref:`int` **limit_top** = ``-10000000`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -552,7 +552,7 @@ Top scroll limit in pixels. The camera stops moving when reaching this value, bu .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -569,7 +569,7 @@ The camera's relative offset. Useful for looking around or camera shake animatio .. rst-class:: classref-property -:ref:`bool` **position_smoothing_enabled** = ``false`` +:ref:`bool` **position_smoothing_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -586,7 +586,7 @@ If ``true``, the camera's view smoothly moves towards its target position at :re .. rst-class:: classref-property -:ref:`float` **position_smoothing_speed** = ``5.0`` +:ref:`float` **position_smoothing_speed** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -603,7 +603,7 @@ Speed in pixels per second of the camera's smoothing effect when :ref:`position_ .. rst-class:: classref-property -:ref:`Camera2DProcessCallback` **process_callback** = ``1`` +:ref:`Camera2DProcessCallback` **process_callback** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -620,7 +620,7 @@ The camera's process callback. See :ref:`Camera2DProcessCallback` **rotation_smoothing_enabled** = ``false`` +:ref:`bool` **rotation_smoothing_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -639,7 +639,7 @@ If ``true``, the camera's view smoothly rotates, via asymptotic smoothing, to al .. rst-class:: classref-property -:ref:`float` **rotation_smoothing_speed** = ``5.0`` +:ref:`float` **rotation_smoothing_speed** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -656,7 +656,7 @@ The angular, asymptotic speed of the camera's rotation smoothing effect when :re .. rst-class:: classref-property -:ref:`Vector2` **zoom** = ``Vector2(1, 1)`` +:ref:`Vector2` **zoom** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -680,7 +680,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **align**\ (\ ) +|void| **align**\ (\ ) :ref:`🔗` Aligns the camera to the tracked node. @@ -692,7 +692,7 @@ Aligns the camera to the tracked node. .. rst-class:: classref-method -|void| **force_update_scroll**\ (\ ) +|void| **force_update_scroll**\ (\ ) :ref:`🔗` Forces the camera to update scroll immediately. @@ -704,7 +704,7 @@ Forces the camera to update scroll immediately. .. rst-class:: classref-method -:ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the specified :ref:`Side`'s margin. See also :ref:`drag_bottom_margin`, :ref:`drag_top_margin`, :ref:`drag_left_margin`, and :ref:`drag_right_margin`. @@ -716,7 +716,7 @@ Returns the specified :ref:`Side`'s margin. See also :re .. rst-class:: classref-method -:ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the camera limit for the specified :ref:`Side`. See also :ref:`limit_bottom`, :ref:`limit_top`, :ref:`limit_left`, and :ref:`limit_right`. @@ -728,7 +728,7 @@ Returns the camera limit for the specified :ref:`Side`. .. rst-class:: classref-method -:ref:`Vector2` **get_screen_center_position**\ (\ ) |const| +:ref:`Vector2` **get_screen_center_position**\ (\ ) |const| :ref:`🔗` Returns the center of the screen from this camera's point of view, in global coordinates. @@ -742,7 +742,7 @@ Returns the center of the screen from this camera's point of view, in global coo .. rst-class:: classref-method -:ref:`Vector2` **get_target_position**\ (\ ) |const| +:ref:`Vector2` **get_target_position**\ (\ ) |const| :ref:`🔗` Returns this camera's target position, in global coordinates. @@ -756,7 +756,7 @@ Returns this camera's target position, in global coordinates. .. rst-class:: classref-method -:ref:`bool` **is_current**\ (\ ) |const| +:ref:`bool` **is_current**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Camera2D** is the active camera (see :ref:`Viewport.get_camera_2d`). @@ -768,7 +768,7 @@ Returns ``true`` if this **Camera2D** is the active camera (see :ref:`Viewport.g .. rst-class:: classref-method -|void| **make_current**\ (\ ) +|void| **make_current**\ (\ ) :ref:`🔗` Forces this **Camera2D** to become the current active one. :ref:`enabled` must be ``true``. @@ -780,7 +780,7 @@ Forces this **Camera2D** to become the current active one. :ref:`enabled` Sets the camera's position immediately to its current smoothing destination. @@ -794,7 +794,7 @@ This method has no effect if :ref:`position_smoothing_enabled`, drag_margin\: :ref:`float`\ ) +|void| **set_drag_margin**\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) :ref:`🔗` Sets the specified :ref:`Side`'s margin. See also :ref:`drag_bottom_margin`, :ref:`drag_top_margin`, :ref:`drag_left_margin`, and :ref:`drag_right_margin`. @@ -806,7 +806,7 @@ Sets the specified :ref:`Side`'s margin. See also :ref:` .. rst-class:: classref-method -|void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) +|void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) :ref:`🔗` Sets the camera limit for the specified :ref:`Side`. See also :ref:`limit_bottom`, :ref:`limit_top`, :ref:`limit_left`, and :ref:`limit_right`. diff --git a/classes/class_camera3d.rst b/classes/class_camera3d.rst index dfdde08de55..21b31fa7a43 100644 --- a/classes/class_camera3d.rst +++ b/classes/class_camera3d.rst @@ -131,7 +131,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ProjectionType**: +enum **ProjectionType**: :ref:`🔗` .. _class_Camera3D_constant_PROJECTION_PERSPECTIVE: @@ -165,7 +165,7 @@ Frustum projection. This mode allows adjusting :ref:`frustum_offset` .. _class_Camera3D_constant_KEEP_WIDTH: @@ -191,7 +191,7 @@ Preserves the vertical aspect ratio; also known as Hor+ scaling. This is usually .. rst-class:: classref-enumeration -enum **DopplerTracking**: +enum **DopplerTracking**: :ref:`🔗` .. _class_Camera3D_constant_DOPPLER_TRACKING_DISABLED: @@ -230,7 +230,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CameraAttributes` **attributes** +:ref:`CameraAttributes` **attributes** :ref:`🔗` .. rst-class:: classref-property-setget @@ -247,7 +247,7 @@ The :ref:`CameraAttributes` to use for this camera. .. rst-class:: classref-property -:ref:`Compositor` **compositor** +:ref:`Compositor` **compositor** :ref:`🔗` .. rst-class:: classref-property-setget @@ -264,7 +264,7 @@ The :ref:`Compositor` to use for this camera. .. rst-class:: classref-property -:ref:`int` **cull_mask** = ``1048575`` +:ref:`int` **cull_mask** = ``1048575`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -287,7 +287,7 @@ To adjust :ref:`cull_mask` more easily using .. rst-class:: classref-property -:ref:`bool` **current** = ``false`` +:ref:`bool` **current** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ If multiple cameras are in the scene, one will always be made current. For examp .. rst-class:: classref-property -:ref:`DopplerTracking` **doppler_tracking** = ``0`` +:ref:`DopplerTracking` **doppler_tracking** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ If not :ref:`DOPPLER_TRACKING_DISABLED` **environment** +:ref:`Environment` **environment** :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ The :ref:`Environment` to use for this camera. .. rst-class:: classref-property -:ref:`float` **far** = ``4000.0`` +:ref:`float` **far** = ``4000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -357,7 +357,7 @@ The distance to the far culling boundary for this camera relative to its local Z .. rst-class:: classref-property -:ref:`float` **fov** = ``75.0`` +:ref:`float` **fov** = ``75.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -384,7 +384,7 @@ For reference, the default vertical field of view value (``75.0``) is equivalent .. rst-class:: classref-property -:ref:`Vector2` **frustum_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **frustum_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -403,7 +403,7 @@ The camera's frustum offset. This can be changed from the default to create "til .. rst-class:: classref-property -:ref:`float` **h_offset** = ``0.0`` +:ref:`float` **h_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -420,7 +420,7 @@ The horizontal (X) offset of the camera viewport. .. rst-class:: classref-property -:ref:`KeepAspect` **keep_aspect** = ``1`` +:ref:`KeepAspect` **keep_aspect** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -437,7 +437,7 @@ The axis to lock during :ref:`fov`/:ref:`size` **near** = ``0.05`` +:ref:`float` **near** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -454,7 +454,7 @@ The distance to the near culling boundary for this camera relative to its local .. rst-class:: classref-property -:ref:`ProjectionType` **projection** = ``0`` +:ref:`ProjectionType` **projection** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -471,7 +471,7 @@ The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE` **size** = ``1.0`` +:ref:`float` **size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -488,7 +488,7 @@ The camera's size in meters measured as the diameter of the width or height, dep .. rst-class:: classref-property -:ref:`float` **v_offset** = ``0.0`` +:ref:`float` **v_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -510,7 +510,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_current**\ (\ enable_next\: :ref:`bool` = true\ ) +|void| **clear_current**\ (\ enable_next\: :ref:`bool` = true\ ) :ref:`🔗` If this is the current camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next camera current, if any. @@ -522,7 +522,7 @@ If this is the current camera, remove it from being current. If ``enable_next`` .. rst-class:: classref-method -:ref:`Projection` **get_camera_projection**\ (\ ) |const| +:ref:`Projection` **get_camera_projection**\ (\ ) |const| :ref:`🔗` Returns the projection matrix that this camera uses to render to its associated viewport. The camera must be part of the scene tree to function. @@ -534,7 +534,7 @@ Returns the projection matrix that this camera uses to render to its associated .. rst-class:: classref-method -:ref:`RID` **get_camera_rid**\ (\ ) |const| +:ref:`RID` **get_camera_rid**\ (\ ) |const| :ref:`🔗` Returns the camera's RID from the :ref:`RenderingServer`. @@ -546,7 +546,7 @@ Returns the camera's RID from the :ref:`RenderingServer`. .. rst-class:: classref-method -:ref:`Transform3D` **get_camera_transform**\ (\ ) |const| +:ref:`Transform3D` **get_camera_transform**\ (\ ) |const| :ref:`🔗` Returns the transform of the camera plus the vertical (:ref:`v_offset`) and horizontal (:ref:`h_offset`) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as :ref:`XRCamera3D`. @@ -558,7 +558,7 @@ Returns the transform of the camera plus the vertical (:ref:`v_offset` **get_cull_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_cull_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`cull_mask` is enabled, given a ``layer_number`` between 1 and 20. @@ -570,7 +570,7 @@ Returns whether or not the specified layer of the :ref:`cull_mask`\[:ref:`Plane`\] **get_frustum**\ (\ ) |const| +:ref:`Array`\[:ref:`Plane`\] **get_frustum**\ (\ ) |const| :ref:`🔗` Returns the camera's frustum planes in world space units as an array of :ref:`Plane`\ s in the following order: near, far, left, top, right, bottom. Not to be confused with :ref:`frustum_offset`. @@ -582,7 +582,7 @@ Returns the camera's frustum planes in world space units as an array of :ref:`Pl .. rst-class:: classref-method -:ref:`RID` **get_pyramid_shape_rid**\ (\ ) +:ref:`RID` **get_pyramid_shape_rid**\ (\ ) :ref:`🔗` Returns the RID of a pyramid shape encompassing the camera's view frustum, ignoring the camera's near plane. The tip of the pyramid represents the position of the camera. @@ -594,7 +594,7 @@ Returns the RID of a pyramid shape encompassing the camera's view frustum, ignor .. rst-class:: classref-method -:ref:`bool` **is_position_behind**\ (\ world_point\: :ref:`Vector3`\ ) |const| +:ref:`bool` **is_position_behind**\ (\ world_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if the given position is behind the camera (the blue part of the linked diagram). `See this diagram `__ for an overview of position query methods. @@ -608,7 +608,7 @@ Returns ``true`` if the given position is behind the camera (the blue part of th .. rst-class:: classref-method -:ref:`bool` **is_position_in_frustum**\ (\ world_point\: :ref:`Vector3`\ ) |const| +:ref:`bool` **is_position_in_frustum**\ (\ world_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if the given position is inside the camera's frustum (the green part of the linked diagram). `See this diagram `__ for an overview of position query methods. @@ -620,7 +620,7 @@ Returns ``true`` if the given position is inside the camera's frustum (the green .. rst-class:: classref-method -|void| **make_current**\ (\ ) +|void| **make_current**\ (\ ) :ref:`🔗` Makes this camera the current camera for the :ref:`Viewport` (see class description). If the camera node is outside the scene tree, it will attempt to become current once it's added. @@ -632,7 +632,7 @@ Makes this camera the current camera for the :ref:`Viewport` (se .. rst-class:: classref-method -:ref:`Vector3` **project_local_ray_normal**\ (\ screen_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector3` **project_local_ray_normal**\ (\ screen_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. @@ -644,7 +644,7 @@ Returns a normal vector from the screen point location directed along the camera .. rst-class:: classref-method -:ref:`Vector3` **project_position**\ (\ screen_point\: :ref:`Vector2`, z_depth\: :ref:`float`\ ) |const| +:ref:`Vector3` **project_position**\ (\ screen_point\: :ref:`Vector2`, z_depth\: :ref:`float`\ ) |const| :ref:`🔗` Returns the 3D point in world space that maps to the given 2D coordinate in the :ref:`Viewport` rectangle on a plane that is the given ``z_depth`` distance into the scene away from the camera. @@ -656,7 +656,7 @@ Returns the 3D point in world space that maps to the given 2D coordinate in the .. rst-class:: classref-method -:ref:`Vector3` **project_ray_normal**\ (\ screen_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector3` **project_ray_normal**\ (\ screen_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a normal vector in world space, that is the result of projecting a point on the :ref:`Viewport` rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. @@ -668,7 +668,7 @@ Returns a normal vector in world space, that is the result of projecting a point .. rst-class:: classref-method -:ref:`Vector3` **project_ray_origin**\ (\ screen_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector3` **project_ray_origin**\ (\ screen_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a 3D position in world space, that is the result of projecting a point on the :ref:`Viewport` rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. @@ -680,7 +680,7 @@ Returns a 3D position in world space, that is the result of projecting a point o .. rst-class:: classref-method -|void| **set_cull_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_cull_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`cull_mask`, given a ``layer_number`` between 1 and 20. @@ -692,7 +692,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`cull_ma .. rst-class:: classref-method -|void| **set_frustum**\ (\ size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) +|void| **set_frustum**\ (\ size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` Sets the camera projection to frustum mode (see :ref:`PROJECTION_FRUSTUM`), by specifying a ``size``, an ``offset``, and the ``z_near`` and ``z_far`` clip planes in world space units. See also :ref:`frustum_offset`. @@ -704,7 +704,7 @@ Sets the camera projection to frustum mode (see :ref:`PROJECTION_FRUSTUM`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) +|void| **set_orthogonal**\ (\ size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` Sets the camera projection to orthogonal mode (see :ref:`PROJECTION_ORTHOGONAL`), by specifying a ``size``, and the ``z_near`` and ``z_far`` clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.) @@ -716,7 +716,7 @@ Sets the camera projection to orthogonal mode (see :ref:`PROJECTION_ORTHOGONAL`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) +|void| **set_perspective**\ (\ fov\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` Sets the camera projection to perspective mode (see :ref:`PROJECTION_PERSPECTIVE`), by specifying a ``fov`` (field of view) angle in degrees, and the ``z_near`` and ``z_far`` clip planes in world space units. @@ -728,7 +728,7 @@ Sets the camera projection to perspective mode (see :ref:`PROJECTION_PERSPECTIVE .. rst-class:: classref-method -:ref:`Vector2` **unproject_position**\ (\ world_point\: :ref:`Vector3`\ ) |const| +:ref:`Vector2` **unproject_position**\ (\ world_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the 2D coordinate in the :ref:`Viewport` rectangle that maps to the given 3D point in world space. diff --git a/classes/class_cameraattributes.rst b/classes/class_cameraattributes.rst index 3104407d7d2..2bbe852e8b0 100644 --- a/classes/class_cameraattributes.rst +++ b/classes/class_cameraattributes.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **auto_exposure_enabled** = ``false`` +:ref:`bool` **auto_exposure_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ If ``true``, enables the tonemapping auto exposure mode of the scene renderer. I .. rst-class:: classref-property -:ref:`float` **auto_exposure_scale** = ``0.4`` +:ref:`float` **auto_exposure_scale** = ``0.4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ The scale of the auto exposure effect. Affects the intensity of auto exposure. .. rst-class:: classref-property -:ref:`float` **auto_exposure_speed** = ``0.5`` +:ref:`float` **auto_exposure_speed** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The speed of the auto exposure effect. Affects the time needed for the camera to .. rst-class:: classref-property -:ref:`float` **exposure_multiplier** = ``1.0`` +:ref:`float` **exposure_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Multiplier for the exposure amount. A higher value results in a brighter image. .. rst-class:: classref-property -:ref:`float` **exposure_sensitivity** = ``100.0`` +:ref:`float` **exposure_sensitivity** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst index 3b3c1760fcf..1399d5f135c 100644 --- a/classes/class_cameraattributesphysical.rst +++ b/classes/class_cameraattributesphysical.rst @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **auto_exposure_max_exposure_value** = ``10.0`` +:ref:`float` **auto_exposure_max_exposure_value** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ The maximum luminance (in EV100) used when calculating auto exposure. When calcu .. rst-class:: classref-property -:ref:`float` **auto_exposure_min_exposure_value** = ``-8.0`` +:ref:`float` **auto_exposure_min_exposure_value** = ``-8.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -119,7 +119,7 @@ The minimum luminance luminance (in EV100) used when calculating auto exposure. .. rst-class:: classref-property -:ref:`float` **exposure_aperture** = ``16.0`` +:ref:`float` **exposure_aperture** = ``16.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physi .. rst-class:: classref-property -:ref:`float` **exposure_shutter_speed** = ``100.0`` +:ref:`float` **exposure_shutter_speed** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physi .. rst-class:: classref-property -:ref:`float` **frustum_far** = ``4000.0`` +:ref:`float` **frustum_far** = ``4000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ Override value for :ref:`Camera3D.far`. Used intern .. rst-class:: classref-property -:ref:`float` **frustum_focal_length** = ``35.0`` +:ref:`float` **frustum_focal_length** = ``35.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ Distance between camera lens and camera aperture, measured in millimeters. Contr .. rst-class:: classref-property -:ref:`float` **frustum_focus_distance** = ``10.0`` +:ref:`float` **frustum_focus_distance** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -208,7 +208,7 @@ Distance from camera of object that will be in focus, measured in meters. Intern .. rst-class:: classref-property -:ref:`float` **frustum_near** = ``0.05`` +:ref:`float` **frustum_near** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_fov**\ (\ ) |const| +:ref:`float` **get_fov**\ (\ ) |const| :ref:`🔗` Returns the vertical field of view that corresponds to the :ref:`frustum_focal_length`. This value is calculated internally whenever :ref:`frustum_focal_length` is changed. diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst index 25a6d7bb593..4165ce5fa3f 100644 --- a/classes/class_cameraattributespractical.rst +++ b/classes/class_cameraattributespractical.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **auto_exposure_max_sensitivity** = ``800.0`` +:ref:`float` **auto_exposure_max_sensitivity** = ``800.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -81,7 +81,7 @@ The maximum sensitivity (in ISO) used when calculating auto exposure. When calcu .. rst-class:: classref-property -:ref:`float` **auto_exposure_min_sensitivity** = ``0.0`` +:ref:`float` **auto_exposure_min_sensitivity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -98,7 +98,7 @@ The minimum sensitivity (in ISO) used when calculating auto exposure. When calcu .. rst-class:: classref-property -:ref:`float` **dof_blur_amount** = ``0.1`` +:ref:`float` **dof_blur_amount** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ Sets the maximum amount of blur. When using physically-based blur amounts, will .. rst-class:: classref-property -:ref:`float` **dof_blur_far_distance** = ``10.0`` +:ref:`float` **dof_blur_far_distance** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ Objects further from the :ref:`Camera3D` by this amount will be .. rst-class:: classref-property -:ref:`bool` **dof_blur_far_enabled** = ``false`` +:ref:`bool` **dof_blur_far_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ Enables depth of field blur for objects further than :ref:`dof_blur_far_distance .. rst-class:: classref-property -:ref:`float` **dof_blur_far_transition** = ``5.0`` +:ref:`float` **dof_blur_far_transition** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ When positive, distance over which (starting from :ref:`dof_blur_far_distance` **dof_blur_near_distance** = ``2.0`` +:ref:`float` **dof_blur_near_distance** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ Objects closer from the :ref:`Camera3D` by this amount will be b .. rst-class:: classref-property -:ref:`bool` **dof_blur_near_enabled** = ``false`` +:ref:`bool` **dof_blur_near_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -204,7 +204,7 @@ Enables depth of field blur for objects closer than :ref:`dof_blur_near_distance .. rst-class:: classref-property -:ref:`float` **dof_blur_near_transition** = ``1.0`` +:ref:`float` **dof_blur_near_transition** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index 39512f121db..5774048fbc9 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -68,7 +68,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FeedDataType**: +enum **FeedDataType**: :ref:`🔗` .. _class_CameraFeed_constant_FEED_NOIMAGE: @@ -110,7 +110,7 @@ Feed supplies separate Y and CbCr images that need to be combined and converted .. rst-class:: classref-enumeration -enum **FeedPosition**: +enum **FeedPosition**: :ref:`🔗` .. _class_CameraFeed_constant_FEED_UNSPECIFIED: @@ -149,7 +149,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **feed_is_active** = ``false`` +:ref:`bool` **feed_is_active** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ If ``true``, the feed is active. .. rst-class:: classref-property -:ref:`Transform2D` **feed_transform** = ``Transform2D(1, 0, 0, -1, 0, 1)`` +:ref:`Transform2D` **feed_transform** = ``Transform2D(1, 0, 0, -1, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`FeedDataType` **get_datatype**\ (\ ) |const| +:ref:`FeedDataType` **get_datatype**\ (\ ) |const| :ref:`🔗` Returns feed image data type. @@ -200,7 +200,7 @@ Returns feed image data type. .. rst-class:: classref-method -:ref:`int` **get_id**\ (\ ) |const| +:ref:`int` **get_id**\ (\ ) |const| :ref:`🔗` Returns the unique ID for this feed. @@ -212,7 +212,7 @@ Returns the unique ID for this feed. .. rst-class:: classref-method -:ref:`String` **get_name**\ (\ ) |const| +:ref:`String` **get_name**\ (\ ) |const| :ref:`🔗` Returns the camera's name. @@ -224,7 +224,7 @@ Returns the camera's name. .. rst-class:: classref-method -:ref:`FeedPosition` **get_position**\ (\ ) |const| +:ref:`FeedPosition` **get_position**\ (\ ) |const| :ref:`🔗` Returns the position of camera on the device. diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index 65719ba195b..9d3800bbf74 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -58,7 +58,7 @@ Signals .. rst-class:: classref-signal -**camera_feed_added**\ (\ id\: :ref:`int`\ ) +**camera_feed_added**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`CameraFeed` is added (e.g. a webcam is plugged in). @@ -70,7 +70,7 @@ Emitted when a :ref:`CameraFeed` is added (e.g. a webcam is pl .. rst-class:: classref-signal -**camera_feed_removed**\ (\ id\: :ref:`int`\ ) +**camera_feed_removed**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when a :ref:`CameraFeed` is removed (e.g. a webcam is unplugged). @@ -87,7 +87,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FeedImage**: +enum **FeedImage**: :ref:`🔗` .. _class_CameraServer_constant_FEED_RGBA_IMAGE: @@ -134,7 +134,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_feed**\ (\ feed\: :ref:`CameraFeed`\ ) +|void| **add_feed**\ (\ feed\: :ref:`CameraFeed`\ ) :ref:`🔗` Adds the camera ``feed`` to the camera server. @@ -146,7 +146,7 @@ Adds the camera ``feed`` to the camera server. .. rst-class:: classref-method -:ref:`Array`\[:ref:`CameraFeed`\] **feeds**\ (\ ) +:ref:`Array`\[:ref:`CameraFeed`\] **feeds**\ (\ ) :ref:`🔗` Returns an array of :ref:`CameraFeed`\ s. @@ -158,7 +158,7 @@ Returns an array of :ref:`CameraFeed`\ s. .. rst-class:: classref-method -:ref:`CameraFeed` **get_feed**\ (\ index\: :ref:`int`\ ) +:ref:`CameraFeed` **get_feed**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`CameraFeed` corresponding to the camera with the given ``index``. @@ -170,7 +170,7 @@ Returns the :ref:`CameraFeed` corresponding to the camera with .. rst-class:: classref-method -:ref:`int` **get_feed_count**\ (\ ) +:ref:`int` **get_feed_count**\ (\ ) :ref:`🔗` Returns the number of :ref:`CameraFeed`\ s registered. @@ -182,7 +182,7 @@ Returns the number of :ref:`CameraFeed`\ s registered. .. rst-class:: classref-method -|void| **remove_feed**\ (\ feed\: :ref:`CameraFeed`\ ) +|void| **remove_feed**\ (\ feed\: :ref:`CameraFeed`\ ) :ref:`🔗` Removes the specified camera ``feed``. diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index e0d4f6f5d09..64fd3ee572e 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **camera_feed_id** = ``0`` +:ref:`int` **camera_feed_id** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ The ID of the :ref:`CameraFeed` for which we want to display t .. rst-class:: classref-property -:ref:`bool` **camera_is_active** = ``false`` +:ref:`bool` **camera_is_active** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ Convenience property that gives access to the active property of the :ref:`Camer .. rst-class:: classref-property -:ref:`FeedImage` **which_feed** = ``0`` +:ref:`FeedImage` **which_feed** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_canvasgroup.rst b/classes/class_canvasgroup.rst index ad6c99f447d..54b8f53ba82 100644 --- a/classes/class_canvasgroup.rst +++ b/classes/class_canvasgroup.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **clear_margin** = ``10.0`` +:ref:`float` **clear_margin** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ Sets the size of the margin used to expand the clearing rect of this **CanvasGro .. rst-class:: classref-property -:ref:`float` **fit_margin** = ``10.0`` +:ref:`float` **fit_margin** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ Sets the size of a margin used to expand the drawable rect of this **CanvasGroup .. rst-class:: classref-property -:ref:`bool` **use_mipmaps** = ``false`` +:ref:`bool` **use_mipmaps** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 8bac328ac31..eb18bdb7958 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -221,7 +221,7 @@ Signals .. rst-class:: classref-signal -**draw**\ (\ ) +**draw**\ (\ ) :ref:`🔗` Emitted when the **CanvasItem** must redraw, *after* the related :ref:`NOTIFICATION_DRAW` notification, and *before* :ref:`_draw` is called. @@ -235,7 +235,7 @@ Emitted when the **CanvasItem** must redraw, *after* the related :ref:`NOTIFICAT .. rst-class:: classref-signal -**hidden**\ (\ ) +**hidden**\ (\ ) :ref:`🔗` Emitted when becoming hidden. @@ -247,7 +247,7 @@ Emitted when becoming hidden. .. rst-class:: classref-signal -**item_rect_changed**\ (\ ) +**item_rect_changed**\ (\ ) :ref:`🔗` Emitted when the item's :ref:`Rect2` boundaries (position or size) have changed, or when an action is taking place that may have impacted these boundaries (e.g. changing :ref:`Sprite2D.texture`). @@ -259,7 +259,7 @@ Emitted when the item's :ref:`Rect2` boundaries (position or size) .. rst-class:: classref-signal -**visibility_changed**\ (\ ) +**visibility_changed**\ (\ ) :ref:`🔗` Emitted when the visibility (hidden/visible) changes. @@ -276,7 +276,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TextureFilter**: +enum **TextureFilter**: :ref:`🔗` .. _class_CanvasItem_constant_TEXTURE_FILTER_PARENT_NODE: @@ -358,7 +358,7 @@ Represents the size of the :ref:`TextureFilter` e .. rst-class:: classref-enumeration -enum **TextureRepeat**: +enum **TextureRepeat**: :ref:`🔗` .. _class_CanvasItem_constant_TEXTURE_REPEAT_PARENT_NODE: @@ -408,7 +408,7 @@ Represents the size of the :ref:`TextureRepeat` e .. rst-class:: classref-enumeration -enum **ClipChildrenMode**: +enum **ClipChildrenMode**: :ref:`🔗` .. _class_CanvasItem_constant_CLIP_CHILDREN_DISABLED: @@ -455,7 +455,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` +**NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗` The **CanvasItem**'s global transform has changed. This notification is only received if enabled by :ref:`set_notify_transform`. @@ -463,7 +463,7 @@ The **CanvasItem**'s global transform has changed. This notification is only rec .. rst-class:: classref-constant -**NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``35`` +**NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``35`` :ref:`🔗` The **CanvasItem**'s local transform has changed. This notification is only received if enabled by :ref:`set_notify_local_transform`. @@ -471,7 +471,7 @@ The **CanvasItem**'s local transform has changed. This notification is only rece .. rst-class:: classref-constant -**NOTIFICATION_DRAW** = ``30`` +**NOTIFICATION_DRAW** = ``30`` :ref:`🔗` The **CanvasItem** is requested to draw (see :ref:`_draw`). @@ -479,7 +479,7 @@ The **CanvasItem** is requested to draw (see :ref:`_draw` The **CanvasItem**'s visibility has changed. @@ -487,7 +487,7 @@ The **CanvasItem**'s visibility has changed. .. rst-class:: classref-constant -**NOTIFICATION_ENTER_CANVAS** = ``32`` +**NOTIFICATION_ENTER_CANVAS** = ``32`` :ref:`🔗` The **CanvasItem** has entered the canvas. @@ -495,7 +495,7 @@ The **CanvasItem** has entered the canvas. .. rst-class:: classref-constant -**NOTIFICATION_EXIT_CANVAS** = ``33`` +**NOTIFICATION_EXIT_CANVAS** = ``33`` :ref:`🔗` The **CanvasItem** has exited the canvas. @@ -503,7 +503,7 @@ The **CanvasItem** has exited the canvas. .. rst-class:: classref-constant -**NOTIFICATION_WORLD_2D_CHANGED** = ``36`` +**NOTIFICATION_WORLD_2D_CHANGED** = ``36`` :ref:`🔗` The **CanvasItem**'s active :ref:`World2D` changed. @@ -520,7 +520,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ClipChildrenMode` **clip_children** = ``0`` +:ref:`ClipChildrenMode` **clip_children** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -537,7 +537,7 @@ Allows the current node to clip child nodes, essentially acting as a mask. .. rst-class:: classref-property -:ref:`int` **light_mask** = ``1`` +:ref:`int` **light_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -554,7 +554,7 @@ The rendering layers in which this **CanvasItem** responds to :ref:`Light2D` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -571,7 +571,7 @@ The material applied to this **CanvasItem**. .. rst-class:: classref-property -:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -588,7 +588,7 @@ The color applied to this **CanvasItem**. This property does affect child **Canv .. rst-class:: classref-property -:ref:`Color` **self_modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **self_modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -607,7 +607,7 @@ The color applied to this **CanvasItem**. This property does **not** affect chil .. rst-class:: classref-property -:ref:`bool` **show_behind_parent** = ``false`` +:ref:`bool` **show_behind_parent** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -624,7 +624,7 @@ If ``true``, the object draws behind its parent. .. rst-class:: classref-property -:ref:`TextureFilter` **texture_filter** = ``0`` +:ref:`TextureFilter` **texture_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -641,7 +641,7 @@ The texture filtering mode to use on this **CanvasItem**. .. rst-class:: classref-property -:ref:`TextureRepeat` **texture_repeat** = ``0`` +:ref:`TextureRepeat` **texture_repeat** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -658,7 +658,7 @@ The texture repeating mode to use on this **CanvasItem**. .. rst-class:: classref-property -:ref:`bool` **top_level** = ``false`` +:ref:`bool` **top_level** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -675,7 +675,7 @@ If ``true``, this **CanvasItem** will *not* inherit its transform from parent ** .. rst-class:: classref-property -:ref:`bool` **use_parent_material** = ``false`` +:ref:`bool` **use_parent_material** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -692,7 +692,7 @@ If ``true``, the parent **CanvasItem**'s :ref:`material` **visibility_layer** = ``1`` +:ref:`int` **visibility_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -709,7 +709,7 @@ The rendering layer in which this **CanvasItem** is rendered by :ref:`Viewport` **visible** = ``true`` +:ref:`bool` **visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -728,7 +728,7 @@ If ``true``, this **CanvasItem** is drawn. The node is only visible if all of it .. rst-class:: classref-property -:ref:`bool` **y_sort_enabled** = ``false`` +:ref:`bool` **y_sort_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -749,7 +749,7 @@ Nodes sort relative to each other only if they are on the same :ref:`z_index` **z_as_relative** = ``true`` +:ref:`bool` **z_as_relative** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -766,7 +766,7 @@ If ``true``, the node's Z index is relative to its parent's Z index. If this nod .. rst-class:: classref-property -:ref:`int` **z_index** = ``0`` +:ref:`int` **z_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -790,7 +790,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_draw**\ (\ ) |virtual| +|void| **_draw**\ (\ ) |virtual| :ref:`🔗` Called when **CanvasItem** has been requested to redraw (after :ref:`queue_redraw` is called, either manually or by the engine). @@ -804,7 +804,7 @@ Corresponds to the :ref:`NOTIFICATION_DRAW`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) +|void| **draw_animation_slice**\ (\ animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) :ref:`🔗` Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. @@ -816,7 +816,7 @@ Subsequent drawing commands will be ignored unless they fall within the specifie .. rst-class:: classref-method -|void| **draw_arc**\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_arc**\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws an unfilled arc between the given angles with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). The larger the value of ``point_count``, the smoother the curve. See also :ref:`draw_circle`. @@ -832,7 +832,7 @@ The arc is drawn from ``start_angle`` towards the value of ``end_angle`` so in c .. rst-class:: classref-method -|void| **draw_char**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_char**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draws a string first character using a custom font. @@ -844,7 +844,7 @@ Draws a string first character using a custom font. .. rst-class:: classref-method -|void| **draw_char_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_char_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draws a string first character outline using a custom font. @@ -856,7 +856,7 @@ Draws a string first character outline using a custom font. .. rst-class:: classref-method -|void| **draw_circle**\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_circle**\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a circle. See also :ref:`draw_arc`, :ref:`draw_polyline`, and :ref:`draw_polygon`. @@ -876,7 +876,7 @@ If ``antialiased`` is ``true``, half transparent "feathers" will be attached to .. rst-class:: classref-method -|void| **draw_colored_polygon**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) +|void| **draw_colored_polygon**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` Draws a colored polygon of any number of points, convex or concave. Unlike :ref:`draw_polygon`, a single color must be specified for the whole polygon. @@ -888,7 +888,7 @@ Draws a colored polygon of any number of points, convex or concave. Unlike :ref: .. rst-class:: classref-method -|void| **draw_dashed_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true, antialiased\: :ref:`bool` = false\ ) +|void| **draw_dashed_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a dashed line from a 2D point to another, with a given color and width. See also :ref:`draw_multiline` and :ref:`draw_polyline`. @@ -906,7 +906,7 @@ If ``antialiased`` is ``true``, half transparent "feathers" will be attached to .. rst-class:: classref-method -|void| **draw_end_animation**\ (\ ) +|void| **draw_end_animation**\ (\ ) :ref:`🔗` After submitting all animations slices via :ref:`draw_animation_slice`, this function can be used to revert drawing to its default state (all subsequent drawing commands will be visible). If you don't care about this particular use case, usage of this function after submitting the slices is not required. @@ -918,7 +918,7 @@ After submitting all animations slices via :ref:`draw_animation_slice`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **draw_lcd_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Draws a textured rectangle region of the font texture with LCD subpixel anti-aliasing at a given position, optionally modulated by a color. @@ -939,7 +939,7 @@ Texture is drawn using the following blend operation, blend mode of the :ref:`Ca .. rst-class:: classref-method -|void| **draw_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also :ref:`draw_multiline` and :ref:`draw_polyline`. @@ -953,7 +953,7 @@ If ``width`` is negative, then a two-point primitive will be drawn instead of a .. rst-class:: classref-method -|void| **draw_mesh**\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **draw_mesh**\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`MeshInstance2D` for related documentation. @@ -965,7 +965,7 @@ Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`Mes .. rst-class:: classref-method -|void| **draw_msdf_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) +|void| **draw_msdf_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See :ref:`FontFile.multichannel_signed_distance_field` for more information and caveats about MSDF font rendering. @@ -981,7 +981,7 @@ Value of the ``pixel_range`` should the same that was used during distance field .. rst-class:: classref-method -|void| **draw_multiline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_multiline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws multiple disconnected lines with a uniform ``width`` and ``color``. Each line is defined by two consecutive points from ``points`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw interconnected lines, use :ref:`draw_polyline` instead. @@ -997,7 +997,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f .. rst-class:: classref-method -|void| **draw_multiline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_multiline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws multiple disconnected lines with a uniform ``width`` and segment-by-segment coloring. Each segment is defined by two consecutive points from ``points`` array and a corresponding color from ``colors`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints and has ``colors[i]`` color. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw interconnected lines, use :ref:`draw_polyline_colors` instead. @@ -1013,7 +1013,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f .. rst-class:: classref-method -|void| **draw_multiline_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_multiline_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Breaks ``text`` into lines and draws it using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1025,7 +1025,7 @@ Breaks ``text`` into lines and draws it using the specified ``font`` at the ``po .. rst-class:: classref-method -|void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Breaks ``text`` to the lines and draws text outline using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1037,7 +1037,7 @@ Breaks ``text`` to the lines and draws text outline using the specified ``font`` .. rst-class:: classref-method -|void| **draw_multimesh**\ (\ multimesh\: :ref:`MultiMesh`, texture\: :ref:`Texture2D`\ ) +|void| **draw_multimesh**\ (\ multimesh\: :ref:`MultiMesh`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Draws a :ref:`MultiMesh` in 2D with the provided texture. See :ref:`MultiMeshInstance2D` for related documentation. @@ -1049,7 +1049,7 @@ Draws a :ref:`MultiMesh` in 2D with the provided texture. See : .. rst-class:: classref-method -|void| **draw_polygon**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) +|void| **draw_polygon**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`draw_colored_polygon`, each point's color can be changed individually. See also :ref:`draw_polyline` and :ref:`draw_polyline_colors`. If you need more flexibility (such as being able to use bones), use :ref:`RenderingServer.canvas_item_add_triangle_array` instead. @@ -1061,7 +1061,7 @@ Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`d .. rst-class:: classref-method -|void| **draw_polyline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_polyline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw disconnected lines, use :ref:`draw_multiline` instead. See also :ref:`draw_polygon`. @@ -1075,7 +1075,7 @@ If ``width`` is negative, it will be ignored and the polyline will be drawn usin .. rst-class:: classref-method -|void| **draw_polyline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_polyline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws interconnected line segments with a uniform ``width``, point-by-point coloring, and optional antialiasing (supported only for positive ``width``). Colors assigned to line points match by index between ``points`` and ``colors``, i.e. each line segment is filled with a gradient between the colors of the endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw disconnected lines, use :ref:`draw_multiline_colors` instead. See also :ref:`draw_polygon`. @@ -1089,7 +1089,7 @@ If ``width`` is negative, it will be ignored and the polyline will be drawn usin .. rst-class:: classref-method -|void| **draw_primitive**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) +|void| **draw_primitive**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also :ref:`draw_line`, :ref:`draw_polyline`, :ref:`draw_polygon`, and :ref:`draw_rect`. @@ -1101,7 +1101,7 @@ Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for .. rst-class:: classref-method -|void| **draw_rect**\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **draw_rect**\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. See also :ref:`draw_texture_rect`. @@ -1121,7 +1121,7 @@ If ``antialiased`` is ``true``, half transparent "feathers" will be attached to .. rst-class:: classref-method -|void| **draw_set_transform**\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) +|void| **draw_set_transform**\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) :ref:`🔗` Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. @@ -1135,7 +1135,7 @@ Sets a custom transform for drawing via components. Anything drawn afterwards wi .. rst-class:: classref-method -|void| **draw_set_transform_matrix**\ (\ xform\: :ref:`Transform2D`\ ) +|void| **draw_set_transform_matrix**\ (\ xform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. @@ -1147,7 +1147,7 @@ Sets a custom transform for drawing via matrix. Anything drawn afterwards will b .. rst-class:: classref-method -|void| **draw_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Draws ``text`` using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1186,7 +1186,7 @@ See also :ref:`Font.draw_string`. .. rst-class:: classref-method -|void| **draw_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1198,7 +1198,7 @@ Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left .. rst-class:: classref-method -|void| **draw_style_box**\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) +|void| **draw_style_box**\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) :ref:`🔗` Draws a styled rectangle. @@ -1210,7 +1210,7 @@ Draws a styled rectangle. .. rst-class:: classref-method -|void| **draw_texture**\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **draw_texture**\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Draws a texture at a given position. @@ -1222,7 +1222,7 @@ Draws a texture at a given position. .. rst-class:: classref-method -|void| **draw_texture_rect**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) +|void| **draw_texture_rect**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) :ref:`🔗` Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_rect` and :ref:`draw_texture_rect_region`. @@ -1234,7 +1234,7 @@ Draws a textured rectangle at a given position, optionally modulated by a color. .. rst-class:: classref-method -|void| **draw_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) +|void| **draw_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) :ref:`🔗` Draws a textured rectangle from a texture's region (specified by ``src_rect``) at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_texture_rect`. @@ -1246,7 +1246,7 @@ Draws a textured rectangle from a texture's region (specified by ``src_rect``) a .. rst-class:: classref-method -|void| **force_update_transform**\ (\ ) +|void| **force_update_transform**\ (\ ) :ref:`🔗` Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. @@ -1258,7 +1258,7 @@ Forces the transform to update. Transform changes in physics are not instant for .. rst-class:: classref-method -:ref:`RID` **get_canvas**\ (\ ) |const| +:ref:`RID` **get_canvas**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the :ref:`World2D` canvas where this item is in. @@ -1270,7 +1270,7 @@ Returns the :ref:`RID` of the :ref:`World2D` canvas wh .. rst-class:: classref-method -:ref:`RID` **get_canvas_item**\ (\ ) |const| +:ref:`RID` **get_canvas_item**\ (\ ) |const| :ref:`🔗` Returns the canvas item RID used by :ref:`RenderingServer` for this item. @@ -1282,7 +1282,7 @@ Returns the canvas item RID used by :ref:`RenderingServer .. rst-class:: classref-method -:ref:`CanvasLayer` **get_canvas_layer_node**\ (\ ) |const| +:ref:`CanvasLayer` **get_canvas_layer_node**\ (\ ) |const| :ref:`🔗` Returns the :ref:`CanvasLayer` that contains this node, or ``null`` if the node is not in any :ref:`CanvasLayer`. @@ -1294,7 +1294,7 @@ Returns the :ref:`CanvasLayer` that contains this node, or `` .. rst-class:: classref-method -:ref:`Transform2D` **get_canvas_transform**\ (\ ) |const| +:ref:`Transform2D` **get_canvas_transform**\ (\ ) |const| :ref:`🔗` Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport`\ s coordinate system. @@ -1306,7 +1306,7 @@ Returns the transform from the coordinate system of the canvas, this item is in, .. rst-class:: classref-method -:ref:`Vector2` **get_global_mouse_position**\ (\ ) |const| +:ref:`Vector2` **get_global_mouse_position**\ (\ ) |const| :ref:`🔗` Returns the mouse's position in the :ref:`CanvasLayer` that this **CanvasItem** is in using the coordinate system of the :ref:`CanvasLayer`. @@ -1320,7 +1320,7 @@ Returns the mouse's position in the :ref:`CanvasLayer` that t .. rst-class:: classref-method -:ref:`Transform2D` **get_global_transform**\ (\ ) |const| +:ref:`Transform2D` **get_global_transform**\ (\ ) |const| :ref:`🔗` Returns the global transform matrix of this item, i.e. the combined transform up to the topmost **CanvasItem** node. The topmost item is a **CanvasItem** that either has no parent, has non-**CanvasItem** parent or it has :ref:`top_level` enabled. @@ -1332,7 +1332,7 @@ Returns the global transform matrix of this item, i.e. the combined transform up .. rst-class:: classref-method -:ref:`Transform2D` **get_global_transform_with_canvas**\ (\ ) |const| +:ref:`Transform2D` **get_global_transform_with_canvas**\ (\ ) |const| :ref:`🔗` Returns the transform from the local coordinate system of this **CanvasItem** to the :ref:`Viewport`\ s coordinate system. @@ -1344,7 +1344,7 @@ Returns the transform from the local coordinate system of this **CanvasItem** to .. rst-class:: classref-method -:ref:`Vector2` **get_local_mouse_position**\ (\ ) |const| +:ref:`Vector2` **get_local_mouse_position**\ (\ ) |const| :ref:`🔗` Returns the mouse's position in this **CanvasItem** using the local coordinate system of this **CanvasItem**. @@ -1356,7 +1356,7 @@ Returns the mouse's position in this **CanvasItem** using the local coordinate s .. rst-class:: classref-method -:ref:`Transform2D` **get_screen_transform**\ (\ ) |const| +:ref:`Transform2D` **get_screen_transform**\ (\ ) |const| :ref:`🔗` Returns the transform of this **CanvasItem** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. @@ -1370,7 +1370,7 @@ Equals to :ref:`get_global_transform` **get_transform**\ (\ ) |const| +:ref:`Transform2D` **get_transform**\ (\ ) |const| :ref:`🔗` Returns the transform matrix of this item. @@ -1382,7 +1382,7 @@ Returns the transform matrix of this item. .. rst-class:: classref-method -:ref:`Rect2` **get_viewport_rect**\ (\ ) |const| +:ref:`Rect2` **get_viewport_rect**\ (\ ) |const| :ref:`🔗` Returns the viewport's boundaries as a :ref:`Rect2`. @@ -1394,7 +1394,7 @@ Returns the viewport's boundaries as a :ref:`Rect2`. .. rst-class:: classref-method -:ref:`Transform2D` **get_viewport_transform**\ (\ ) |const| +:ref:`Transform2D` **get_viewport_transform**\ (\ ) |const| :ref:`🔗` Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport`\ s embedders coordinate system. @@ -1406,7 +1406,7 @@ Returns the transform from the coordinate system of the canvas, this item is in, .. rst-class:: classref-method -:ref:`bool` **get_visibility_layer_bit**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`bool` **get_visibility_layer_bit**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns an individual bit on the rendering visibility layer. @@ -1418,7 +1418,7 @@ Returns an individual bit on the rendering visibility layer. .. rst-class:: classref-method -:ref:`World2D` **get_world_2d**\ (\ ) |const| +:ref:`World2D` **get_world_2d**\ (\ ) |const| :ref:`🔗` Returns the :ref:`World2D` where this item is in. @@ -1430,7 +1430,7 @@ Returns the :ref:`World2D` where this item is in. .. rst-class:: classref-method -|void| **hide**\ (\ ) +|void| **hide**\ (\ ) :ref:`🔗` Hide the **CanvasItem** if it's currently visible. This is equivalent to setting :ref:`visible` to ``false``. @@ -1442,7 +1442,7 @@ Hide the **CanvasItem** if it's currently visible. This is equivalent to setting .. rst-class:: classref-method -:ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| +:ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if local transform notifications are communicated to children. @@ -1454,7 +1454,7 @@ Returns ``true`` if local transform notifications are communicated to children. .. rst-class:: classref-method -:ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| +:ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if global transform notifications are communicated to children. @@ -1466,7 +1466,7 @@ Returns ``true`` if global transform notifications are communicated to children. .. rst-class:: classref-method -:ref:`bool` **is_visible_in_tree**\ (\ ) |const| +:ref:`bool` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is therefore not drawn (see :ref:`_draw`). @@ -1478,7 +1478,7 @@ Returns ``true`` if the node is present in the :ref:`SceneTree` .. rst-class:: classref-method -:ref:`Vector2` **make_canvas_position_local**\ (\ screen_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **make_canvas_position_local**\ (\ screen_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Assigns ``screen_point`` as this node's new local transform. @@ -1490,7 +1490,7 @@ Assigns ``screen_point`` as this node's new local transform. .. rst-class:: classref-method -:ref:`InputEvent` **make_input_local**\ (\ event\: :ref:`InputEvent`\ ) |const| +:ref:`InputEvent` **make_input_local**\ (\ event\: :ref:`InputEvent`\ ) |const| :ref:`🔗` Transformations issued by ``event``'s inputs are applied in local space instead of global space. @@ -1502,7 +1502,7 @@ Transformations issued by ``event``'s inputs are applied in local space instead .. rst-class:: classref-method -|void| **move_to_front**\ (\ ) +|void| **move_to_front**\ (\ ) :ref:`🔗` Moves this node to display on top of its siblings. @@ -1516,7 +1516,7 @@ Internally, the node is moved to the bottom of parent's child list. The method h .. rst-class:: classref-method -|void| **queue_redraw**\ (\ ) +|void| **queue_redraw**\ (\ ) :ref:`🔗` Queues the **CanvasItem** to redraw. During idle time, if **CanvasItem** is visible, :ref:`NOTIFICATION_DRAW` is sent and :ref:`_draw` is called. This only occurs **once** per frame, even if this method has been called multiple times. @@ -1528,7 +1528,7 @@ Queues the **CanvasItem** to redraw. During idle time, if **CanvasItem** is visi .. rst-class:: classref-method -|void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) +|void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` when its local transform changes. @@ -1540,7 +1540,7 @@ If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANS .. rst-class:: classref-method -|void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) +|void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` when its global transform changes. @@ -1552,7 +1552,7 @@ If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_TRANSFORM_C .. rst-class:: classref-method -|void| **set_visibility_layer_bit**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) +|void| **set_visibility_layer_bit**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Set/clear individual bits on the rendering visibility layer. This simplifies editing this **CanvasItem**'s visibility layer. @@ -1564,7 +1564,7 @@ Set/clear individual bits on the rendering visibility layer. This simplifies edi .. rst-class:: classref-method -|void| **show**\ (\ ) +|void| **show**\ (\ ) :ref:`🔗` Show the **CanvasItem** if it's currently hidden. This is equivalent to setting :ref:`visible` to ``true``. For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index eb657b52a74..0fadbe027b9 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BlendMode**: +enum **BlendMode**: :ref:`🔗` .. _class_CanvasItemMaterial_constant_BLEND_MODE_MIX: @@ -106,7 +106,7 @@ Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) .. rst-class:: classref-enumeration -enum **LightMode**: +enum **LightMode**: :ref:`🔗` .. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL: @@ -145,7 +145,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BlendMode` **blend_mode** = ``0`` +:ref:`BlendMode` **blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ The manner in which a material's rendering is applied to underlying textures. .. rst-class:: classref-property -:ref:`LightMode` **light_mode** = ``0`` +:ref:`LightMode` **light_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ The manner in which material reacts to lighting. .. rst-class:: classref-property -:ref:`int` **particles_anim_h_frames** +:ref:`int` **particles_anim_h_frames** :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ The number of columns in the spritesheet assigned as :ref:`Texture2D` **particles_anim_loop** +:ref:`bool` **particles_anim_loop** :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If ``true``, the particles animation will loop. .. rst-class:: classref-property -:ref:`int` **particles_anim_v_frames** +:ref:`int` **particles_anim_v_frames** :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ The number of rows in the spritesheet assigned as :ref:`Texture2D` **particles_animation** = ``false`` +:ref:`bool` **particles_animation** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index b98daac1c4d..ac3e8ce8717 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -99,7 +99,7 @@ Signals .. rst-class:: classref-signal -**visibility_changed**\ (\ ) +**visibility_changed**\ (\ ) :ref:`🔗` Emitted when visibility of the layer is changed. See :ref:`visible`. @@ -116,7 +116,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Node` **custom_viewport** +:ref:`Node` **custom_viewport** :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The custom :ref:`Viewport` node assigned to the **CanvasLayer**. .. rst-class:: classref-property -:ref:`bool` **follow_viewport_enabled** = ``false`` +:ref:`bool` **follow_viewport_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ Together with :ref:`follow_viewport_scale` **follow_viewport_scale** = ``1.0`` +:ref:`float` **follow_viewport_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ Scales the layer when using :ref:`follow_viewport_enabled` **layer** = ``1`` +:ref:`int` **layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Layer index for draw order. Lower values are drawn behind higher values. .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ The layer's base offset. .. rst-class:: classref-property -:ref:`float` **rotation** = ``0.0`` +:ref:`float` **rotation** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ The layer's rotation in radians. .. rst-class:: classref-property -:ref:`Vector2` **scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ The layer's scale. .. rst-class:: classref-property -:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` +:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -256,7 +256,7 @@ The layer's transform. .. rst-class:: classref-property -:ref:`bool` **visible** = ``true`` +:ref:`bool` **visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -280,7 +280,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_canvas**\ (\ ) |const| +:ref:`RID` **get_canvas**\ (\ ) |const| :ref:`🔗` Returns the RID of the canvas used by this layer. @@ -292,7 +292,7 @@ Returns the RID of the canvas used by this layer. .. rst-class:: classref-method -:ref:`Transform2D` **get_final_transform**\ (\ ) |const| +:ref:`Transform2D` **get_final_transform**\ (\ ) |const| :ref:`🔗` Returns the transform from the **CanvasLayer**\ s coordinate system to the :ref:`Viewport`\ s coordinate system. @@ -304,7 +304,7 @@ Returns the transform from the **CanvasLayer**\ s coordinate system to the :ref: .. rst-class:: classref-method -|void| **hide**\ (\ ) +|void| **hide**\ (\ ) :ref:`🔗` Hides any :ref:`CanvasItem` under this **CanvasLayer**. This is equivalent to setting :ref:`visible` to ``false``. @@ -316,7 +316,7 @@ Hides any :ref:`CanvasItem` under this **CanvasLayer**. This i .. rst-class:: classref-method -|void| **show**\ (\ ) +|void| **show**\ (\ ) :ref:`🔗` Shows any :ref:`CanvasItem` under this **CanvasLayer**. This is equivalent to setting :ref:`visible` to ``true``. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 645746d72f6..a90a5687fcf 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -49,7 +49,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_canvastexture.rst b/classes/class_canvastexture.rst index 281813669d7..b9e28e5a240 100644 --- a/classes/class_canvastexture.rst +++ b/classes/class_canvastexture.rst @@ -69,7 +69,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture2D` **diffuse_texture** +:ref:`Texture2D` **diffuse_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ The diffuse (color) texture to use. This is the main texture you want to set in .. rst-class:: classref-property -:ref:`Texture2D` **normal_texture** +:ref:`Texture2D` **normal_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The normal map texture to use. Only has a visible effect if :ref:`Light2D` **specular_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **specular_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ The multiplier for specular reflection colors. The :ref:`Light2D` .. rst-class:: classref-property -:ref:`float` **specular_shininess** = ``1.0`` +:ref:`float` **specular_shininess** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ The specular exponent for :ref:`Light2D` specular reflections. Hi .. rst-class:: classref-property -:ref:`Texture2D` **specular_texture** +:ref:`Texture2D` **specular_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The specular map to use for :ref:`Light2D` specular reflections. .. rst-class:: classref-property -:ref:`TextureFilter` **texture_filter** = ``0`` +:ref:`TextureFilter` **texture_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ The texture filtering mode to use when drawing this **CanvasTexture**. .. rst-class:: classref-property -:ref:`TextureRepeat` **texture_repeat** = ``0`` +:ref:`TextureRepeat` **texture_repeat** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 2cdbd1b4777..344e76e7825 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``2.0`` +:ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ Total height of the capsule mesh (including the hemispherical ends). .. rst-class:: classref-property -:ref:`int` **radial_segments** = ``64`` +:ref:`int` **radial_segments** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ Number of radial segments on the capsule mesh. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Radius of the capsule mesh. .. rst-class:: classref-property -:ref:`int` **rings** = ``8`` +:ref:`int` **rings** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index d2d002d1079..7e94ff5cc99 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``30.0`` +:ref:`float` **height** = ``30.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ The capsule's height. .. rst-class:: classref-property -:ref:`float` **radius** = ``10.0`` +:ref:`float` **radius** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_capsuleshape3d.rst b/classes/class_capsuleshape3d.rst index 9e69bcfc2de..e68a2354602 100644 --- a/classes/class_capsuleshape3d.rst +++ b/classes/class_capsuleshape3d.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``2.0`` +:ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -74,7 +74,7 @@ The capsule's height. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 65262727954..01b05d18370 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -53,7 +53,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **use_top_left** = ``false`` +:ref:`bool` **use_top_left** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index d48aacf586c..ea56c53059b 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -135,7 +135,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MotionMode**: +enum **MotionMode**: :ref:`🔗` .. _class_CharacterBody2D_constant_MOTION_MODE_GROUNDED: @@ -161,7 +161,7 @@ Apply when there is no notion of floor or ceiling. All collisions will be report .. rst-class:: classref-enumeration -enum **PlatformOnLeave**: +enum **PlatformOnLeave**: :ref:`🔗` .. _class_CharacterBody2D_constant_PLATFORM_ON_LEAVE_ADD_VELOCITY: @@ -200,7 +200,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **floor_block_on_wall** = ``true`` +:ref:`bool` **floor_block_on_wall** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If ``true``, the body will be able to move on the floor only. This option avoids .. rst-class:: classref-property -:ref:`bool` **floor_constant_speed** = ``false`` +:ref:`bool` **floor_constant_speed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ If ``true``, the body will always move at the same speed on the ground no matter .. rst-class:: classref-property -:ref:`float` **floor_max_angle** = ``0.785398`` +:ref:`float` **floor_max_angle** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -253,7 +253,7 @@ Maximum angle (in radians) where a slope is still considered a floor (or a ceili .. rst-class:: classref-property -:ref:`float` **floor_snap_length** = ``1.0`` +:ref:`float` **floor_snap_length** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -272,7 +272,7 @@ As long as the snapping vector is in contact with the ground and the body moves .. rst-class:: classref-property -:ref:`bool` **floor_stop_on_slope** = ``true`` +:ref:`bool` **floor_stop_on_slope** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -291,7 +291,7 @@ If ``false``, the body will slide on floor's slopes when :ref:`velocity` **max_slides** = ``4`` +:ref:`int` **max_slides** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -308,7 +308,7 @@ Maximum number of times the body can change direction before it stops when calli .. rst-class:: classref-property -:ref:`MotionMode` **motion_mode** = ``0`` +:ref:`MotionMode` **motion_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -325,7 +325,7 @@ Sets the motion mode which defines the behavior of :ref:`move_and_slide` **platform_floor_layers** = ``4294967295`` +:ref:`int` **platform_floor_layers** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -342,7 +342,7 @@ Collision layers that will be included for detecting floor bodies that will act .. rst-class:: classref-property -:ref:`PlatformOnLeave` **platform_on_leave** = ``0`` +:ref:`PlatformOnLeave` **platform_on_leave** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -359,7 +359,7 @@ Sets the behavior to apply when you leave a moving platform. By default, to be p .. rst-class:: classref-property -:ref:`int` **platform_wall_layers** = ``0`` +:ref:`int` **platform_wall_layers** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -376,7 +376,7 @@ Collision layers that will be included for detecting wall bodies that will act a .. rst-class:: classref-property -:ref:`float` **safe_margin** = ``0.08`` +:ref:`float` **safe_margin** = ``0.08`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -399,7 +399,7 @@ A lower value forces the collision algorithm to use more exact detection, so it .. rst-class:: classref-property -:ref:`bool` **slide_on_ceiling** = ``true`` +:ref:`bool` **slide_on_ceiling** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -416,7 +416,7 @@ If ``true``, during a jump against the ceiling, the body will slide, if ``false` .. rst-class:: classref-property -:ref:`Vector2` **up_direction** = ``Vector2(0, -1)`` +:ref:`Vector2` **up_direction** = ``Vector2(0, -1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -433,7 +433,7 @@ Vector pointing upwards, used to determine what is a wall and what is a floor (o .. rst-class:: classref-property -:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -450,7 +450,7 @@ Current velocity vector in pixels per second, used and modified during calls to .. rst-class:: classref-property -:ref:`float` **wall_min_slide_angle** = ``0.261799`` +:ref:`float` **wall_min_slide_angle** = ``0.261799`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -472,7 +472,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **apply_floor_snap**\ (\ ) +|void| **apply_floor_snap**\ (\ ) :ref:`🔗` Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when :ref:`is_on_floor` returns ``true``. @@ -484,7 +484,7 @@ Allows to manually apply a snap to the floor regardless of the body's velocity. .. rst-class:: classref-method -:ref:`float` **get_floor_angle**\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| +:ref:`float` **get_floor_angle**\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| :ref:`🔗` Returns the floor's collision angle at the last collision point according to ``up_direction``, which is :ref:`Vector2.UP` by default. This value is always positive and only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -496,7 +496,7 @@ Returns the floor's collision angle at the last collision point according to ``u .. rst-class:: classref-method -:ref:`Vector2` **get_floor_normal**\ (\ ) |const| +:ref:`Vector2` **get_floor_normal**\ (\ ) |const| :ref:`🔗` Returns the collision normal of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -510,7 +510,7 @@ Returns the collision normal of the floor at the last collision point. Only vali .. rst-class:: classref-method -:ref:`Vector2` **get_last_motion**\ (\ ) |const| +:ref:`Vector2` **get_last_motion**\ (\ ) |const| :ref:`🔗` Returns the last motion applied to the **CharacterBody2D** during the last call to :ref:`move_and_slide`. The movement can be split into multiple motions when sliding occurs, and this method return the last one, which is useful to retrieve the current direction of the movement. @@ -522,7 +522,7 @@ Returns the last motion applied to the **CharacterBody2D** during the last call .. rst-class:: classref-method -:ref:`KinematicCollision2D` **get_last_slide_collision**\ (\ ) +:ref:`KinematicCollision2D` **get_last_slide_collision**\ (\ ) :ref:`🔗` Returns a :ref:`KinematicCollision2D`, which contains information about the latest collision that occurred during the last call to :ref:`move_and_slide`. @@ -534,7 +534,7 @@ Returns a :ref:`KinematicCollision2D`, which contain .. rst-class:: classref-method -:ref:`Vector2` **get_platform_velocity**\ (\ ) |const| +:ref:`Vector2` **get_platform_velocity**\ (\ ) |const| :ref:`🔗` Returns the linear velocity of the platform at the last collision point. Only valid after calling :ref:`move_and_slide`. @@ -546,7 +546,7 @@ Returns the linear velocity of the platform at the last collision point. Only va .. rst-class:: classref-method -:ref:`Vector2` **get_position_delta**\ (\ ) |const| +:ref:`Vector2` **get_position_delta**\ (\ ) |const| :ref:`🔗` Returns the travel (position delta) that occurred during the last call to :ref:`move_and_slide`. @@ -558,7 +558,7 @@ Returns the travel (position delta) that occurred during the last call to :ref:` .. rst-class:: classref-method -:ref:`Vector2` **get_real_velocity**\ (\ ) |const| +:ref:`Vector2` **get_real_velocity**\ (\ ) |const| :ref:`🔗` Returns the current real velocity since the last call to :ref:`move_and_slide`. For example, when you climb a slope, you will move diagonally even though the velocity is horizontal. This method returns the diagonal movement, as opposed to :ref:`velocity` which returns the requested velocity. @@ -570,7 +570,7 @@ Returns the current real velocity since the last call to :ref:`move_and_slide` **get_slide_collision**\ (\ slide_idx\: :ref:`int`\ ) +:ref:`KinematicCollision2D` **get_slide_collision**\ (\ slide_idx\: :ref:`int`\ ) :ref:`🔗` Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occurred during the last call to :ref:`move_and_slide`. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_collision_count` - 1). @@ -603,7 +603,7 @@ Returns a :ref:`KinematicCollision2D`, which contain .. rst-class:: classref-method -:ref:`int` **get_slide_collision_count**\ (\ ) |const| +:ref:`int` **get_slide_collision_count**\ (\ ) |const| :ref:`🔗` Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. @@ -615,7 +615,7 @@ Returns the number of times the body collided and changed direction during the l .. rst-class:: classref-method -:ref:`Vector2` **get_wall_normal**\ (\ ) |const| +:ref:`Vector2` **get_wall_normal**\ (\ ) |const| :ref:`🔗` Returns the collision normal of the wall at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_wall` returns ``true``. @@ -629,7 +629,7 @@ Returns the collision normal of the wall at the last collision point. Only valid .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling**\ (\ ) |const| +:ref:`bool` **is_on_ceiling**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -641,7 +641,7 @@ Returns ``true`` if the body collided with the ceiling on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling_only**\ (\ ) |const| +:ref:`bool` **is_on_ceiling_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided only with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -653,7 +653,7 @@ Returns ``true`` if the body collided only with the ceiling on the last call of .. rst-class:: classref-method -:ref:`bool` **is_on_floor**\ (\ ) |const| +:ref:`bool` **is_on_floor**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -665,7 +665,7 @@ Returns ``true`` if the body collided with the floor on the last call of :ref:`m .. rst-class:: classref-method -:ref:`bool` **is_on_floor_only**\ (\ ) |const| +:ref:`bool` **is_on_floor_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided only with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -677,7 +677,7 @@ Returns ``true`` if the body collided only with the floor on the last call of :r .. rst-class:: classref-method -:ref:`bool` **is_on_wall**\ (\ ) |const| +:ref:`bool` **is_on_wall**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -689,7 +689,7 @@ Returns ``true`` if the body collided with a wall on the last call of :ref:`move .. rst-class:: classref-method -:ref:`bool` **is_on_wall_only**\ (\ ) |const| +:ref:`bool` **is_on_wall_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided only with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -701,7 +701,7 @@ Returns ``true`` if the body collided only with a wall on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **move_and_slide**\ (\ ) +:ref:`bool` **move_and_slide**\ (\ ) :ref:`🔗` Moves the body based on :ref:`velocity`. If the body collides with another, it will slide along the other body (by default only on floor) rather than stop immediately. If the other body is a **CharacterBody2D** or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index 67bc1081f12..7ea1e95f4f1 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -139,7 +139,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MotionMode**: +enum **MotionMode**: :ref:`🔗` .. _class_CharacterBody3D_constant_MOTION_MODE_GROUNDED: @@ -165,7 +165,7 @@ Apply when there is no notion of floor or ceiling. All collisions will be report .. rst-class:: classref-enumeration -enum **PlatformOnLeave**: +enum **PlatformOnLeave**: :ref:`🔗` .. _class_CharacterBody3D_constant_PLATFORM_ON_LEAVE_ADD_VELOCITY: @@ -204,7 +204,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **floor_block_on_wall** = ``true`` +:ref:`bool` **floor_block_on_wall** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ If ``true``, the body will be able to move on the floor only. This option avoids .. rst-class:: classref-property -:ref:`bool` **floor_constant_speed** = ``false`` +:ref:`bool` **floor_constant_speed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ If ``true``, the body will always move at the same speed on the ground no matter .. rst-class:: classref-property -:ref:`float` **floor_max_angle** = ``0.785398`` +:ref:`float` **floor_max_angle** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ Maximum angle (in radians) where a slope is still considered a floor (or a ceili .. rst-class:: classref-property -:ref:`float` **floor_snap_length** = ``0.1`` +:ref:`float` **floor_snap_length** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ As long as the snapping vector is in contact with the ground and the body moves .. rst-class:: classref-property -:ref:`bool` **floor_stop_on_slope** = ``true`` +:ref:`bool` **floor_stop_on_slope** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -295,7 +295,7 @@ If ``false``, the body will slide on floor's slopes when :ref:`velocity` **max_slides** = ``6`` +:ref:`int` **max_slides** = ``6`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -312,7 +312,7 @@ Maximum number of times the body can change direction before it stops when calli .. rst-class:: classref-property -:ref:`MotionMode` **motion_mode** = ``0`` +:ref:`MotionMode` **motion_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -329,7 +329,7 @@ Sets the motion mode which defines the behavior of :ref:`move_and_slide` **platform_floor_layers** = ``4294967295`` +:ref:`int` **platform_floor_layers** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -346,7 +346,7 @@ Collision layers that will be included for detecting floor bodies that will act .. rst-class:: classref-property -:ref:`PlatformOnLeave` **platform_on_leave** = ``0`` +:ref:`PlatformOnLeave` **platform_on_leave** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -363,7 +363,7 @@ Sets the behavior to apply when you leave a moving platform. By default, to be p .. rst-class:: classref-property -:ref:`int` **platform_wall_layers** = ``0`` +:ref:`int` **platform_wall_layers** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -380,7 +380,7 @@ Collision layers that will be included for detecting wall bodies that will act a .. rst-class:: classref-property -:ref:`float` **safe_margin** = ``0.001`` +:ref:`float` **safe_margin** = ``0.001`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -403,7 +403,7 @@ A lower value forces the collision algorithm to use more exact detection, so it .. rst-class:: classref-property -:ref:`bool` **slide_on_ceiling** = ``true`` +:ref:`bool` **slide_on_ceiling** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -420,7 +420,7 @@ If ``true``, during a jump against the ceiling, the body will slide, if ``false` .. rst-class:: classref-property -:ref:`Vector3` **up_direction** = ``Vector3(0, 1, 0)`` +:ref:`Vector3` **up_direction** = ``Vector3(0, 1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -437,7 +437,7 @@ Vector pointing upwards, used to determine what is a wall and what is a floor (o .. rst-class:: classref-property -:ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -454,7 +454,7 @@ Current velocity vector (typically meters per second), used and modified during .. rst-class:: classref-property -:ref:`float` **wall_min_slide_angle** = ``0.261799`` +:ref:`float` **wall_min_slide_angle** = ``0.261799`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -476,7 +476,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **apply_floor_snap**\ (\ ) +|void| **apply_floor_snap**\ (\ ) :ref:`🔗` Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when :ref:`is_on_floor` returns ``true``. @@ -488,7 +488,7 @@ Allows to manually apply a snap to the floor regardless of the body's velocity. .. rst-class:: classref-method -:ref:`float` **get_floor_angle**\ (\ up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| +:ref:`float` **get_floor_angle**\ (\ up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| :ref:`🔗` Returns the floor's collision angle at the last collision point according to ``up_direction``, which is :ref:`Vector3.UP` by default. This value is always positive and only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -500,7 +500,7 @@ Returns the floor's collision angle at the last collision point according to ``u .. rst-class:: classref-method -:ref:`Vector3` **get_floor_normal**\ (\ ) |const| +:ref:`Vector3` **get_floor_normal**\ (\ ) |const| :ref:`🔗` Returns the collision normal of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -514,7 +514,7 @@ Returns the collision normal of the floor at the last collision point. Only vali .. rst-class:: classref-method -:ref:`Vector3` **get_last_motion**\ (\ ) |const| +:ref:`Vector3` **get_last_motion**\ (\ ) |const| :ref:`🔗` Returns the last motion applied to the **CharacterBody3D** during the last call to :ref:`move_and_slide`. The movement can be split into multiple motions when sliding occurs, and this method return the last one, which is useful to retrieve the current direction of the movement. @@ -526,7 +526,7 @@ Returns the last motion applied to the **CharacterBody3D** during the last call .. rst-class:: classref-method -:ref:`KinematicCollision3D` **get_last_slide_collision**\ (\ ) +:ref:`KinematicCollision3D` **get_last_slide_collision**\ (\ ) :ref:`🔗` Returns a :ref:`KinematicCollision3D`, which contains information about the latest collision that occurred during the last call to :ref:`move_and_slide`. @@ -538,7 +538,7 @@ Returns a :ref:`KinematicCollision3D`, which contain .. rst-class:: classref-method -:ref:`Vector3` **get_platform_angular_velocity**\ (\ ) |const| +:ref:`Vector3` **get_platform_angular_velocity**\ (\ ) |const| :ref:`🔗` Returns the angular velocity of the platform at the last collision point. Only valid after calling :ref:`move_and_slide`. @@ -550,7 +550,7 @@ Returns the angular velocity of the platform at the last collision point. Only v .. rst-class:: classref-method -:ref:`Vector3` **get_platform_velocity**\ (\ ) |const| +:ref:`Vector3` **get_platform_velocity**\ (\ ) |const| :ref:`🔗` Returns the linear velocity of the platform at the last collision point. Only valid after calling :ref:`move_and_slide`. @@ -562,7 +562,7 @@ Returns the linear velocity of the platform at the last collision point. Only va .. rst-class:: classref-method -:ref:`Vector3` **get_position_delta**\ (\ ) |const| +:ref:`Vector3` **get_position_delta**\ (\ ) |const| :ref:`🔗` Returns the travel (position delta) that occurred during the last call to :ref:`move_and_slide`. @@ -574,7 +574,7 @@ Returns the travel (position delta) that occurred during the last call to :ref:` .. rst-class:: classref-method -:ref:`Vector3` **get_real_velocity**\ (\ ) |const| +:ref:`Vector3` **get_real_velocity**\ (\ ) |const| :ref:`🔗` Returns the current real velocity since the last call to :ref:`move_and_slide`. For example, when you climb a slope, you will move diagonally even though the velocity is horizontal. This method returns the diagonal movement, as opposed to :ref:`velocity` which returns the requested velocity. @@ -586,7 +586,7 @@ Returns the current real velocity since the last call to :ref:`move_and_slide` **get_slide_collision**\ (\ slide_idx\: :ref:`int`\ ) +:ref:`KinematicCollision3D` **get_slide_collision**\ (\ slide_idx\: :ref:`int`\ ) :ref:`🔗` Returns a :ref:`KinematicCollision3D`, which contains information about a collision that occurred during the last call to :ref:`move_and_slide`. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_collision_count` - 1). @@ -598,7 +598,7 @@ Returns a :ref:`KinematicCollision3D`, which contain .. rst-class:: classref-method -:ref:`int` **get_slide_collision_count**\ (\ ) |const| +:ref:`int` **get_slide_collision_count**\ (\ ) |const| :ref:`🔗` Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. @@ -610,7 +610,7 @@ Returns the number of times the body collided and changed direction during the l .. rst-class:: classref-method -:ref:`Vector3` **get_wall_normal**\ (\ ) |const| +:ref:`Vector3` **get_wall_normal**\ (\ ) |const| :ref:`🔗` Returns the collision normal of the wall at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_wall` returns ``true``. @@ -624,7 +624,7 @@ Returns the collision normal of the wall at the last collision point. Only valid .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling**\ (\ ) |const| +:ref:`bool` **is_on_ceiling**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -636,7 +636,7 @@ Returns ``true`` if the body collided with the ceiling on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling_only**\ (\ ) |const| +:ref:`bool` **is_on_ceiling_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided only with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -648,7 +648,7 @@ Returns ``true`` if the body collided only with the ceiling on the last call of .. rst-class:: classref-method -:ref:`bool` **is_on_floor**\ (\ ) |const| +:ref:`bool` **is_on_floor**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -660,7 +660,7 @@ Returns ``true`` if the body collided with the floor on the last call of :ref:`m .. rst-class:: classref-method -:ref:`bool` **is_on_floor_only**\ (\ ) |const| +:ref:`bool` **is_on_floor_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided only with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -672,7 +672,7 @@ Returns ``true`` if the body collided only with the floor on the last call of :r .. rst-class:: classref-method -:ref:`bool` **is_on_wall**\ (\ ) |const| +:ref:`bool` **is_on_wall**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -684,7 +684,7 @@ Returns ``true`` if the body collided with a wall on the last call of :ref:`move .. rst-class:: classref-method -:ref:`bool` **is_on_wall_only**\ (\ ) |const| +:ref:`bool` **is_on_wall_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the body collided only with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -696,7 +696,7 @@ Returns ``true`` if the body collided only with a wall on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **move_and_slide**\ (\ ) +:ref:`bool` **move_and_slide**\ (\ ) :ref:`🔗` Moves the body based on :ref:`velocity`. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a **CharacterBody3D** or :ref:`RigidBody3D`, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index 72f6f398acf..25c6eebf6fd 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ The color the character will be drawn with. .. rst-class:: classref-property -:ref:`float` **elapsed_time** = ``0.0`` +:ref:`float` **elapsed_time** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ The time elapsed since the :ref:`RichTextLabel` was added t .. rst-class:: classref-property -:ref:`Dictionary` **env** = ``{}`` +:ref:`Dictionary` **env** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ For example, the opening BBCode tag ``[example foo=hello bar=true baz=42 color=# .. rst-class:: classref-property -:ref:`RID` **font** = ``RID()`` +:ref:`RID` **font** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ Font resource used to render glyph. .. rst-class:: classref-property -:ref:`int` **glyph_count** = ``0`` +:ref:`int` **glyph_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ Number of glyphs in the grapheme cluster. This value is set in the first glyph o .. rst-class:: classref-property -:ref:`int` **glyph_flags** = ``0`` +:ref:`int` **glyph_flags** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ Glyph flags. See :ref:`GraphemeFlag` for more info .. rst-class:: classref-property -:ref:`int` **glyph_index** = ``0`` +:ref:`int` **glyph_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ Font specific glyph index. .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ The position offset the character will be drawn with (in pixels). .. rst-class:: classref-property -:ref:`bool` **outline** = ``false`` +:ref:`bool` **outline** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ If ``true``, FX transform is called for outline drawing. Setting this property w .. rst-class:: classref-property -:ref:`Vector2i` **range** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **range** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ Absolute character range in the string, corresponding to the glyph. Setting this .. rst-class:: classref-property -:ref:`int` **relative_index** = ``0`` +:ref:`int` **relative_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -274,7 +274,7 @@ The character offset of the glyph, relative to the current :ref:`RichTextEffect< .. rst-class:: classref-property -:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` +:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -291,7 +291,7 @@ The current transform of the current glyph. It can be overridden (for example, b .. rst-class:: classref-property -:ref:`bool` **visible** = ``true`` +:ref:`bool` **visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 39f6ea010a5..3bae89dfefa 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -80,7 +80,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **check_v_offset** = ``0`` +:ref:`int` **check_v_offset** = ``0`` :ref:`🔗` The vertical offset used when rendering the check icons (in pixels). @@ -92,7 +92,7 @@ The vertical offset used when rendering the check icons (in pixels). .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked** +:ref:`Texture2D` **checked** :ref:`🔗` The check icon to display when the **CheckBox** is checked. @@ -104,7 +104,7 @@ The check icon to display when the **CheckBox** is checked. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked_disabled** +:ref:`Texture2D` **checked_disabled** :ref:`🔗` The check icon to display when the **CheckBox** is checked and is disabled. @@ -116,7 +116,7 @@ The check icon to display when the **CheckBox** is checked and is disabled. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_checked** +:ref:`Texture2D` **radio_checked** :ref:`🔗` The check icon to display when the **CheckBox** is configured as a radio button and is checked. @@ -128,7 +128,7 @@ The check icon to display when the **CheckBox** is configured as a radio button .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_checked_disabled** +:ref:`Texture2D` **radio_checked_disabled** :ref:`🔗` The check icon to display when the **CheckBox** is configured as a radio button, is disabled, and is unchecked. @@ -140,7 +140,7 @@ The check icon to display when the **CheckBox** is configured as a radio button, .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_unchecked** +:ref:`Texture2D` **radio_unchecked** :ref:`🔗` The check icon to display when the **CheckBox** is configured as a radio button and is unchecked. @@ -152,7 +152,7 @@ The check icon to display when the **CheckBox** is configured as a radio button .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_unchecked_disabled** +:ref:`Texture2D` **radio_unchecked_disabled** :ref:`🔗` The check icon to display when the **CheckBox** is configured as a radio button, is disabled, and is unchecked. @@ -164,7 +164,7 @@ The check icon to display when the **CheckBox** is configured as a radio button, .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked** +:ref:`Texture2D` **unchecked** :ref:`🔗` The check icon to display when the **CheckBox** is unchecked. @@ -176,7 +176,7 @@ The check icon to display when the **CheckBox** is unchecked. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked_disabled** +:ref:`Texture2D` **unchecked_disabled** :ref:`🔗` The check icon to display when the **CheckBox** is unchecked and is disabled. diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index fc6901bc1e2..2da645a505b 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -78,7 +78,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **check_v_offset** = ``0`` +:ref:`int` **check_v_offset** = ``0`` :ref:`🔗` The vertical offset used when rendering the toggle icons (in pixels). @@ -90,7 +90,7 @@ The vertical offset used when rendering the toggle icons (in pixels). .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked** +:ref:`Texture2D` **checked** :ref:`🔗` The icon to display when the **CheckButton** is checked (for left-to-right layouts). @@ -102,7 +102,7 @@ The icon to display when the **CheckButton** is checked (for left-to-right layou .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked_disabled** +:ref:`Texture2D` **checked_disabled** :ref:`🔗` The icon to display when the **CheckButton** is checked and disabled (for left-to-right layouts). @@ -114,7 +114,7 @@ The icon to display when the **CheckButton** is checked and disabled (for left-t .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked_disabled_mirrored** +:ref:`Texture2D` **checked_disabled_mirrored** :ref:`🔗` The icon to display when the **CheckButton** is checked and disabled (for right-to-left layouts). @@ -126,7 +126,7 @@ The icon to display when the **CheckButton** is checked and disabled (for right- .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked_mirrored** +:ref:`Texture2D` **checked_mirrored** :ref:`🔗` The icon to display when the **CheckButton** is checked (for right-to-left layouts). @@ -138,7 +138,7 @@ The icon to display when the **CheckButton** is checked (for right-to-left layou .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked** +:ref:`Texture2D` **unchecked** :ref:`🔗` The icon to display when the **CheckButton** is unchecked (for left-to-right layouts). @@ -150,7 +150,7 @@ The icon to display when the **CheckButton** is unchecked (for left-to-right lay .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked_disabled** +:ref:`Texture2D` **unchecked_disabled** :ref:`🔗` The icon to display when the **CheckButton** is unchecked and disabled (for left-to-right layouts). @@ -162,7 +162,7 @@ The icon to display when the **CheckButton** is unchecked and disabled (for left .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked_disabled_mirrored** +:ref:`Texture2D` **unchecked_disabled_mirrored** :ref:`🔗` The icon to display when the **CheckButton** is unchecked and disabled (for right-to-left layouts). @@ -174,7 +174,7 @@ The icon to display when the **CheckButton** is unchecked and disabled (for righ .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked_mirrored** +:ref:`Texture2D` **unchecked_mirrored** :ref:`🔗` The icon to display when the **CheckButton** is unchecked (for right-to-left layouts). diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index f239f248dc3..16f52a3f117 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **radius** = ``10.0`` +:ref:`float` **radius** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 4fec02815bf..9c5b481cd22 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_instantiate**\ (\ class\: :ref:`StringName`\ ) |const| +:ref:`bool` **can_instantiate**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if objects can be instantiated from the specified ``class``, otherwise returns ``false``. @@ -108,7 +108,7 @@ Returns ``true`` if objects can be instantiated from the specified ``class``, ot .. rst-class:: classref-method -:ref:`bool` **class_exists**\ (\ class\: :ref:`StringName`\ ) |const| +:ref:`bool` **class_exists**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns whether the specified ``class`` is available or not. @@ -120,7 +120,7 @@ Returns whether the specified ``class`` is available or not. .. rst-class:: classref-method -:ref:`PackedStringArray` **class_get_enum_constants**\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`PackedStringArray` **class_get_enum_constants**\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array with all the keys in ``enum`` of ``class`` or its ancestry. @@ -132,7 +132,7 @@ Returns an array with all the keys in ``enum`` of ``class`` or its ancestry. .. rst-class:: classref-method -:ref:`PackedStringArray` **class_get_enum_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`PackedStringArray` **class_get_enum_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array with all the enums of ``class`` or its ancestry. @@ -144,7 +144,7 @@ Returns an array with all the enums of ``class`` or its ancestry. .. rst-class:: classref-method -:ref:`int` **class_get_integer_constant**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| +:ref:`int` **class_get_integer_constant**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the value of the integer constant ``name`` of ``class`` or its ancestry. Always returns 0 when the constant could not be found. @@ -156,7 +156,7 @@ Returns the value of the integer constant ``name`` of ``class`` or its ancestry. .. rst-class:: classref-method -:ref:`StringName` **class_get_integer_constant_enum**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`StringName` **class_get_integer_constant_enum**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns which enum the integer constant ``name`` of ``class`` or its ancestry belongs to. @@ -168,7 +168,7 @@ Returns which enum the integer constant ``name`` of ``class`` or its ancestry be .. rst-class:: classref-method -:ref:`PackedStringArray` **class_get_integer_constant_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`PackedStringArray` **class_get_integer_constant_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array with the names all the integer constants of ``class`` or its ancestry. @@ -180,7 +180,7 @@ Returns an array with the names all the integer constants of ``class`` or its an .. rst-class:: classref-method -:ref:`int` **class_get_method_argument_count**\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`int` **class_get_method_argument_count**\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the number of arguments of the method ``method`` of ``class`` or its ancestry if ``no_inheritance`` is ``false``. @@ -192,7 +192,7 @@ Returns the number of arguments of the method ``method`` of ``class`` or its anc .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **class_get_method_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **class_get_method_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array with all the methods of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -206,7 +206,7 @@ Returns an array with all the methods of ``class`` or its ancestry if ``no_inher .. rst-class:: classref-method -:ref:`Variant` **class_get_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`\ ) |const| +:ref:`Variant` **class_get_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the value of ``property`` of ``object`` or its ancestry. @@ -218,7 +218,7 @@ Returns the value of ``property`` of ``object`` or its ancestry. .. rst-class:: classref-method -:ref:`Variant` **class_get_property_default_value**\ (\ class\: :ref:`StringName`, property\: :ref:`StringName`\ ) |const| +:ref:`Variant` **class_get_property_default_value**\ (\ class\: :ref:`StringName`, property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the default value of ``property`` of ``class`` or its ancestor classes. @@ -230,7 +230,7 @@ Returns the default value of ``property`` of ``class`` or its ancestor classes. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **class_get_property_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **class_get_property_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array with all the properties of ``class`` or its ancestry if ``no_inheritance`` is ``false``. @@ -242,7 +242,7 @@ Returns an array with all the properties of ``class`` or its ancestry if ``no_in .. rst-class:: classref-method -:ref:`Dictionary` **class_get_signal**\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| +:ref:`Dictionary` **class_get_signal**\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the ``signal`` data of ``class`` or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -254,7 +254,7 @@ Returns the ``signal`` data of ``class`` or its ancestry. The returned value is .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **class_get_signal_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **class_get_signal_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array with all the signals of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. @@ -266,7 +266,7 @@ Returns an array with all the signals of ``class`` or its ancestry if ``no_inher .. rst-class:: classref-method -:ref:`bool` **class_has_enum**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`bool` **class_has_enum**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns whether ``class`` or its ancestry has an enum called ``name`` or not. @@ -278,7 +278,7 @@ Returns whether ``class`` or its ancestry has an enum called ``name`` or not. .. rst-class:: classref-method -:ref:`bool` **class_has_integer_constant**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| +:ref:`bool` **class_has_integer_constant**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns whether ``class`` or its ancestry has an integer constant called ``name`` or not. @@ -290,7 +290,7 @@ Returns whether ``class`` or its ancestry has an integer constant called ``name` .. rst-class:: classref-method -:ref:`bool` **class_has_method**\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`bool` **class_has_method**\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) has a method called ``method`` or not. @@ -302,7 +302,7 @@ Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) h .. rst-class:: classref-method -:ref:`bool` **class_has_signal**\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| +:ref:`bool` **class_has_signal**\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. @@ -314,7 +314,7 @@ Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. .. rst-class:: classref-method -:ref:`Error` **class_set_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |const| +:ref:`Error` **class_set_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |const| :ref:`🔗` Sets ``property`` value of ``object`` to ``value``. @@ -326,7 +326,7 @@ Sets ``property`` value of ``object`` to ``value``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_class_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_class_list**\ (\ ) |const| :ref:`🔗` Returns the names of all the classes available. @@ -338,7 +338,7 @@ Returns the names of all the classes available. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_inheriters_from_class**\ (\ class\: :ref:`StringName`\ ) |const| +:ref:`PackedStringArray` **get_inheriters_from_class**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the names of all the classes that directly or indirectly inherit from ``class``. @@ -350,7 +350,7 @@ Returns the names of all the classes that directly or indirectly inherit from `` .. rst-class:: classref-method -:ref:`StringName` **get_parent_class**\ (\ class\: :ref:`StringName`\ ) |const| +:ref:`StringName` **get_parent_class**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the parent class of ``class``. @@ -362,7 +362,7 @@ Returns the parent class of ``class``. .. rst-class:: classref-method -:ref:`Variant` **instantiate**\ (\ class\: :ref:`StringName`\ ) |const| +:ref:`Variant` **instantiate**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` Creates an instance of ``class``. @@ -374,7 +374,7 @@ Creates an instance of ``class``. .. rst-class:: classref-method -:ref:`bool` **is_class_enabled**\ (\ class\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_class_enabled**\ (\ class\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns whether this ``class`` is enabled or not. @@ -386,7 +386,7 @@ Returns whether this ``class`` is enabled or not. .. rst-class:: classref-method -:ref:`bool` **is_class_enum_bitfield**\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_class_enum_bitfield**\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns whether ``class`` (or its ancestor classes if ``no_inheritance`` is ``false``) has an enum called ``enum`` that is a bitfield. @@ -398,7 +398,7 @@ Returns whether ``class`` (or its ancestor classes if ``no_inheritance`` is ``fa .. rst-class:: classref-method -:ref:`bool` **is_parent_class**\ (\ class\: :ref:`StringName`, inherits\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_parent_class**\ (\ class\: :ref:`StringName`, inherits\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns whether ``inherits`` is an ancestor of ``class`` or not. diff --git a/classes/class_codeedit.rst b/classes/class_codeedit.rst index b430f84ef8a..5cfb6a2dc7a 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -304,7 +304,7 @@ Signals .. rst-class:: classref-signal -**breakpoint_toggled**\ (\ line\: :ref:`int`\ ) +**breakpoint_toggled**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. @@ -316,7 +316,7 @@ Emitted when a breakpoint is added or removed from a line. If the line is moved .. rst-class:: classref-signal -**code_completion_requested**\ (\ ) +**code_completion_requested**\ (\ ) :ref:`🔗` Emitted when the user requests code completion. @@ -328,7 +328,7 @@ Emitted when the user requests code completion. .. rst-class:: classref-signal -**symbol_lookup**\ (\ symbol\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`\ ) +**symbol_lookup**\ (\ symbol\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`\ ) :ref:`🔗` Emitted when the user has clicked on a valid symbol. @@ -340,7 +340,7 @@ Emitted when the user has clicked on a valid symbol. .. rst-class:: classref-signal -**symbol_validate**\ (\ symbol\: :ref:`String`\ ) +**symbol_validate**\ (\ symbol\: :ref:`String`\ ) :ref:`🔗` Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling :ref:`set_symbol_lookup_word_as_valid`. @@ -357,7 +357,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CodeCompletionKind**: +enum **CodeCompletionKind**: :ref:`🔗` .. _class_CodeEdit_constant_KIND_CLASS: @@ -447,7 +447,7 @@ Marks the option as unclassified or plain text. .. rst-class:: classref-enumeration -enum **CodeCompletionLocation**: +enum **CodeCompletionLocation**: :ref:`🔗` .. _class_CodeEdit_constant_LOCATION_LOCAL: @@ -494,7 +494,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **auto_brace_completion_enabled** = ``false`` +:ref:`bool` **auto_brace_completion_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -511,7 +511,7 @@ Sets whether brace pairs should be autocompleted. .. rst-class:: classref-property -:ref:`bool` **auto_brace_completion_highlight_matching** = ``false`` +:ref:`bool` **auto_brace_completion_highlight_matching** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -528,7 +528,7 @@ Highlight mismatching brace pairs. .. rst-class:: classref-property -:ref:`Dictionary` **auto_brace_completion_pairs** = ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` +:ref:`Dictionary` **auto_brace_completion_pairs** = ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -545,7 +545,7 @@ Sets the brace pairs to be autocompleted. .. rst-class:: classref-property -:ref:`bool` **code_completion_enabled** = ``false`` +:ref:`bool` **code_completion_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -562,7 +562,7 @@ Sets whether code completion is allowed. .. rst-class:: classref-property -:ref:`Array`\[:ref:`String`\] **code_completion_prefixes** = ``[]`` +:ref:`Array`\[:ref:`String`\] **code_completion_prefixes** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -579,7 +579,7 @@ Sets prefixes that will trigger code completion. .. rst-class:: classref-property -:ref:`Array`\[:ref:`String`\] **delimiter_comments** = ``[]`` +:ref:`Array`\[:ref:`String`\] **delimiter_comments** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -596,7 +596,7 @@ Sets the comment delimiters. All existing comment delimiters will be removed. .. rst-class:: classref-property -:ref:`Array`\[:ref:`String`\] **delimiter_strings** = ``["' '", "\" \""]`` +:ref:`Array`\[:ref:`String`\] **delimiter_strings** = ``["' '", "\" \""]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -613,7 +613,7 @@ Sets the string delimiters. All existing string delimiters will be removed. .. rst-class:: classref-property -:ref:`bool` **gutters_draw_bookmarks** = ``false`` +:ref:`bool` **gutters_draw_bookmarks** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -630,7 +630,7 @@ Sets if bookmarked should be drawn in the gutter. This gutter is shared with bre .. rst-class:: classref-property -:ref:`bool` **gutters_draw_breakpoints_gutter** = ``false`` +:ref:`bool` **gutters_draw_breakpoints_gutter** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -647,7 +647,7 @@ Sets if breakpoints should be drawn in the gutter. This gutter is shared with bo .. rst-class:: classref-property -:ref:`bool` **gutters_draw_executing_lines** = ``false`` +:ref:`bool` **gutters_draw_executing_lines** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -664,7 +664,7 @@ Sets if executing lines should be marked in the gutter. This gutter is shared wi .. rst-class:: classref-property -:ref:`bool` **gutters_draw_fold_gutter** = ``false`` +:ref:`bool` **gutters_draw_fold_gutter** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -681,7 +681,7 @@ Sets if foldable lines icons should be drawn in the gutter. .. rst-class:: classref-property -:ref:`bool` **gutters_draw_line_numbers** = ``false`` +:ref:`bool` **gutters_draw_line_numbers** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -698,7 +698,7 @@ Sets if line numbers should be drawn in the gutter. .. rst-class:: classref-property -:ref:`bool` **gutters_zero_pad_line_numbers** = ``false`` +:ref:`bool` **gutters_zero_pad_line_numbers** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -715,7 +715,7 @@ Sets if line numbers drawn in the gutter are zero padded. .. rst-class:: classref-property -:ref:`bool` **indent_automatic** = ``false`` +:ref:`bool` **indent_automatic** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -732,7 +732,7 @@ Sets whether automatic indent are enabled, this will add an extra indent if a pr .. rst-class:: classref-property -:ref:`Array`\[:ref:`String`\] **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` +:ref:`Array`\[:ref:`String`\] **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -749,7 +749,7 @@ Prefixes to trigger an automatic indent. .. rst-class:: classref-property -:ref:`int` **indent_size** = ``4`` +:ref:`int` **indent_size** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -766,7 +766,7 @@ Size of the tabulation indent (one :kbd:`Tab` press) in characters. If :ref:`ind .. rst-class:: classref-property -:ref:`bool` **indent_use_spaces** = ``false`` +:ref:`bool` **indent_use_spaces** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -783,7 +783,7 @@ Use spaces instead of tabs for indentation. .. rst-class:: classref-property -:ref:`bool` **line_folding** = ``false`` +:ref:`bool` **line_folding** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -800,7 +800,7 @@ Sets whether line folding is allowed. .. rst-class:: classref-property -:ref:`Array`\[:ref:`int`\] **line_length_guidelines** = ``[]`` +:ref:`Array`\[:ref:`int`\] **line_length_guidelines** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -817,7 +817,7 @@ Draws vertical lines at the provided columns. The first entry is considered a ma .. rst-class:: classref-property -:ref:`bool` **symbol_lookup_on_click** = ``false`` +:ref:`bool` **symbol_lookup_on_click** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -839,7 +839,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_confirm_code_completion**\ (\ replace\: :ref:`bool`\ ) |virtual| +|void| **_confirm_code_completion**\ (\ replace\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to define how the selected entry should be inserted. If ``replace`` is ``true``, any existing text should be replaced. @@ -851,7 +851,7 @@ Override this method to define how the selected entry should be inserted. If ``r .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_filter_code_completion_candidates**\ (\ candidates\: :ref:`Array`\[:ref:`Dictionary`\]\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_filter_code_completion_candidates**\ (\ candidates\: :ref:`Array`\[:ref:`Dictionary`\]\ ) |virtual| |const| :ref:`🔗` Override this method to define what items in ``candidates`` should be displayed. @@ -865,7 +865,7 @@ Both ``candidates`` and the return is a :ref:`Array` of :ref:`Dicti .. rst-class:: classref-method -|void| **_request_code_completion**\ (\ force\: :ref:`bool`\ ) |virtual| +|void| **_request_code_completion**\ (\ force\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user requests code completion. If ``force`` is ``true``, any checks should be bypassed. @@ -877,7 +877,7 @@ Override this method to define what happens when the user requests code completi .. rst-class:: classref-method -|void| **add_auto_brace_completion_pair**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`\ ) +|void| **add_auto_brace_completion_pair**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`\ ) :ref:`🔗` Adds a brace pair. @@ -891,7 +891,7 @@ Both the start and end keys must be symbols. Only the start key has to be unique .. rst-class:: classref-method -|void| **add_code_completion_option**\ (\ type\: :ref:`CodeCompletionKind`, display_text\: :ref:`String`, insert_text\: :ref:`String`, text_color\: :ref:`Color` = Color(1, 1, 1, 1), icon\: :ref:`Resource` = null, value\: :ref:`Variant` = null, location\: :ref:`int` = 1024\ ) +|void| **add_code_completion_option**\ (\ type\: :ref:`CodeCompletionKind`, display_text\: :ref:`String`, insert_text\: :ref:`String`, text_color\: :ref:`Color` = Color(1, 1, 1, 1), icon\: :ref:`Resource` = null, value\: :ref:`Variant` = null, location\: :ref:`int` = 1024\ ) :ref:`🔗` Submits an item to the queue of potential candidates for the autocomplete menu. Call :ref:`update_code_completion_options` to update the list. @@ -907,7 +907,7 @@ Submits an item to the queue of potential candidates for the autocomplete menu. .. rst-class:: classref-method -|void| **add_comment_delimiter**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) +|void| **add_comment_delimiter**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) :ref:`🔗` Adds a comment delimiter from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters. @@ -921,7 +921,7 @@ If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) +|void| **add_string_delimiter**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) :ref:`🔗` Defines a string delimiter from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters. @@ -935,7 +935,7 @@ If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String` **can_fold_line**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **can_fold_line**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block. @@ -947,7 +947,7 @@ Returns if the given line is foldable, that is, it has indented lines right belo .. rst-class:: classref-method -|void| **cancel_code_completion**\ (\ ) +|void| **cancel_code_completion**\ (\ ) :ref:`🔗` Cancels the autocomplete menu. @@ -959,7 +959,7 @@ Cancels the autocomplete menu. .. rst-class:: classref-method -|void| **clear_bookmarked_lines**\ (\ ) +|void| **clear_bookmarked_lines**\ (\ ) :ref:`🔗` Clears all bookmarked lines. @@ -971,7 +971,7 @@ Clears all bookmarked lines. .. rst-class:: classref-method -|void| **clear_breakpointed_lines**\ (\ ) +|void| **clear_breakpointed_lines**\ (\ ) :ref:`🔗` Clears all breakpointed lines. @@ -983,7 +983,7 @@ Clears all breakpointed lines. .. rst-class:: classref-method -|void| **clear_comment_delimiters**\ (\ ) +|void| **clear_comment_delimiters**\ (\ ) :ref:`🔗` Removes all comment delimiters. @@ -995,7 +995,7 @@ Removes all comment delimiters. .. rst-class:: classref-method -|void| **clear_executing_lines**\ (\ ) +|void| **clear_executing_lines**\ (\ ) :ref:`🔗` Clears all executed lines. @@ -1007,7 +1007,7 @@ Clears all executed lines. .. rst-class:: classref-method -|void| **clear_string_delimiters**\ (\ ) +|void| **clear_string_delimiters**\ (\ ) :ref:`🔗` Removes all string delimiters. @@ -1019,7 +1019,7 @@ Removes all string delimiters. .. rst-class:: classref-method -|void| **confirm_code_completion**\ (\ replace\: :ref:`bool` = false\ ) +|void| **confirm_code_completion**\ (\ replace\: :ref:`bool` = false\ ) :ref:`🔗` Inserts the selected entry into the text. If ``replace`` is ``true``, any existing text is replaced rather than merged. @@ -1031,7 +1031,7 @@ Inserts the selected entry into the text. If ``replace`` is ``true``, any existi .. rst-class:: classref-method -|void| **convert_indent**\ (\ from_line\: :ref:`int` = -1, to_line\: :ref:`int` = -1\ ) +|void| **convert_indent**\ (\ from_line\: :ref:`int` = -1, to_line\: :ref:`int` = -1\ ) :ref:`🔗` Converts the indents of lines between ``from_line`` and ``to_line`` to tabs or spaces as set by :ref:`indent_use_spaces`. @@ -1045,7 +1045,7 @@ Values of ``-1`` convert the entire text. .. rst-class:: classref-method -|void| **create_code_region**\ (\ ) +|void| **create_code_region**\ (\ ) :ref:`🔗` Creates a new code region with the selection. At least one single line comment delimiter have to be defined (see :ref:`add_comment_delimiter`). @@ -1063,7 +1063,7 @@ Code regions are delimited using start and end tags (respectively ``region`` and .. rst-class:: classref-method -|void| **delete_lines**\ (\ ) +|void| **delete_lines**\ (\ ) :ref:`🔗` Deletes all lines that are selected or have a caret on them. @@ -1075,7 +1075,7 @@ Deletes all lines that are selected or have a caret on them. .. rst-class:: classref-method -|void| **do_indent**\ (\ ) +|void| **do_indent**\ (\ ) :ref:`🔗` Perform an indent as if the user activated the "ui_text_indent" action. @@ -1087,7 +1087,7 @@ Perform an indent as if the user activated the "ui_text_indent" action. .. rst-class:: classref-method -|void| **duplicate_lines**\ (\ ) +|void| **duplicate_lines**\ (\ ) :ref:`🔗` Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line. @@ -1099,7 +1099,7 @@ Duplicates all lines currently selected with any caret. Duplicates the entire li .. rst-class:: classref-method -|void| **duplicate_selection**\ (\ ) +|void| **duplicate_selection**\ (\ ) :ref:`🔗` Duplicates all selected text and duplicates all lines with a caret on them. @@ -1111,7 +1111,7 @@ Duplicates all selected text and duplicates all lines with a caret on them. .. rst-class:: classref-method -|void| **fold_all_lines**\ (\ ) +|void| **fold_all_lines**\ (\ ) :ref:`🔗` Folds all lines that are possible to be folded (see :ref:`can_fold_line`). @@ -1123,7 +1123,7 @@ Folds all lines that are possible to be folded (see :ref:`can_fold_line`\ ) +|void| **fold_line**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Folds the given line, if possible (see :ref:`can_fold_line`). @@ -1135,7 +1135,7 @@ Folds the given line, if possible (see :ref:`can_fold_line` **get_auto_brace_completion_close_key**\ (\ open_key\: :ref:`String`\ ) |const| +:ref:`String` **get_auto_brace_completion_close_key**\ (\ open_key\: :ref:`String`\ ) |const| :ref:`🔗` Gets the matching auto brace close key for ``open_key``. @@ -1147,7 +1147,7 @@ Gets the matching auto brace close key for ``open_key``. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_bookmarked_lines**\ (\ ) |const| +:ref:`PackedInt32Array` **get_bookmarked_lines**\ (\ ) |const| :ref:`🔗` Gets all bookmarked lines. @@ -1159,7 +1159,7 @@ Gets all bookmarked lines. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_breakpointed_lines**\ (\ ) |const| +:ref:`PackedInt32Array` **get_breakpointed_lines**\ (\ ) |const| :ref:`🔗` Gets all breakpointed lines. @@ -1171,7 +1171,7 @@ Gets all breakpointed lines. .. rst-class:: classref-method -:ref:`Dictionary` **get_code_completion_option**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Dictionary` **get_code_completion_option**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Gets the completion option at ``index``. The return :ref:`Dictionary` has the following key-values: @@ -1195,7 +1195,7 @@ Gets the completion option at ``index``. The return :ref:`Dictionary`\[:ref:`Dictionary`\] **get_code_completion_options**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_code_completion_options**\ (\ ) |const| :ref:`🔗` Gets all completion options, see :ref:`get_code_completion_option` for return content. @@ -1207,7 +1207,7 @@ Gets all completion options, see :ref:`get_code_completion_option` **get_code_completion_selected_index**\ (\ ) |const| +:ref:`int` **get_code_completion_selected_index**\ (\ ) |const| :ref:`🔗` Gets the index of the current selected completion option. @@ -1219,7 +1219,7 @@ Gets the index of the current selected completion option. .. rst-class:: classref-method -:ref:`String` **get_code_region_end_tag**\ (\ ) |const| +:ref:`String` **get_code_region_end_tag**\ (\ ) |const| :ref:`🔗` Returns the code region end tag (without comment delimiter). @@ -1231,7 +1231,7 @@ Returns the code region end tag (without comment delimiter). .. rst-class:: classref-method -:ref:`String` **get_code_region_start_tag**\ (\ ) |const| +:ref:`String` **get_code_region_start_tag**\ (\ ) |const| :ref:`🔗` Returns the code region start tag (without comment delimiter). @@ -1243,7 +1243,7 @@ Returns the code region start tag (without comment delimiter). .. rst-class:: classref-method -:ref:`String` **get_delimiter_end_key**\ (\ delimiter_index\: :ref:`int`\ ) |const| +:ref:`String` **get_delimiter_end_key**\ (\ delimiter_index\: :ref:`int`\ ) |const| :ref:`🔗` Gets the end key for a string or comment region index. @@ -1255,7 +1255,7 @@ Gets the end key for a string or comment region index. .. rst-class:: classref-method -:ref:`Vector2` **get_delimiter_end_position**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_delimiter_end_position**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` If ``line`` ``column`` is in a string or comment, returns the end position of the region. If not or no end could be found, both :ref:`Vector2` values will be ``-1``. @@ -1267,7 +1267,7 @@ If ``line`` ``column`` is in a string or comment, returns the end position of th .. rst-class:: classref-method -:ref:`String` **get_delimiter_start_key**\ (\ delimiter_index\: :ref:`int`\ ) |const| +:ref:`String` **get_delimiter_start_key**\ (\ delimiter_index\: :ref:`int`\ ) |const| :ref:`🔗` Gets the start key for a string or comment region index. @@ -1279,7 +1279,7 @@ Gets the start key for a string or comment region index. .. rst-class:: classref-method -:ref:`Vector2` **get_delimiter_start_position**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_delimiter_start_position**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` If ``line`` ``column`` is in a string or comment, returns the start position of the region. If not or no start could be found, both :ref:`Vector2` values will be ``-1``. @@ -1291,7 +1291,7 @@ If ``line`` ``column`` is in a string or comment, returns the start position of .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_executing_lines**\ (\ ) |const| +:ref:`PackedInt32Array` **get_executing_lines**\ (\ ) |const| :ref:`🔗` Gets all executing lines. @@ -1303,7 +1303,7 @@ Gets all executing lines. .. rst-class:: classref-method -:ref:`Array`\[:ref:`int`\] **get_folded_lines**\ (\ ) |const| +:ref:`Array`\[:ref:`int`\] **get_folded_lines**\ (\ ) |const| :ref:`🔗` Returns all lines that are current folded. @@ -1315,7 +1315,7 @@ Returns all lines that are current folded. .. rst-class:: classref-method -:ref:`String` **get_text_for_code_completion**\ (\ ) |const| +:ref:`String` **get_text_for_code_completion**\ (\ ) |const| :ref:`🔗` Returns the full text with char ``0xFFFF`` at the caret location. @@ -1327,7 +1327,7 @@ Returns the full text with char ``0xFFFF`` at the caret location. .. rst-class:: classref-method -:ref:`String` **get_text_for_symbol_lookup**\ (\ ) |const| +:ref:`String` **get_text_for_symbol_lookup**\ (\ ) |const| :ref:`🔗` Returns the full text with char ``0xFFFF`` at the cursor location. @@ -1339,7 +1339,7 @@ Returns the full text with char ``0xFFFF`` at the cursor location. .. rst-class:: classref-method -:ref:`String` **get_text_with_cursor_char**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| +:ref:`String` **get_text_with_cursor_char**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the full text with char ``0xFFFF`` at the specified location. @@ -1351,7 +1351,7 @@ Returns the full text with char ``0xFFFF`` at the specified location. .. rst-class:: classref-method -:ref:`bool` **has_auto_brace_completion_close_key**\ (\ close_key\: :ref:`String`\ ) |const| +:ref:`bool` **has_auto_brace_completion_close_key**\ (\ close_key\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if close key ``close_key`` exists. @@ -1363,7 +1363,7 @@ Returns ``true`` if close key ``close_key`` exists. .. rst-class:: classref-method -:ref:`bool` **has_auto_brace_completion_open_key**\ (\ open_key\: :ref:`String`\ ) |const| +:ref:`bool` **has_auto_brace_completion_open_key**\ (\ open_key\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if open key ``open_key`` exists. @@ -1375,7 +1375,7 @@ Returns ``true`` if open key ``open_key`` exists. .. rst-class:: classref-method -:ref:`bool` **has_comment_delimiter**\ (\ start_key\: :ref:`String`\ ) |const| +:ref:`bool` **has_comment_delimiter**\ (\ start_key\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if comment ``start_key`` exists. @@ -1387,7 +1387,7 @@ Returns ``true`` if comment ``start_key`` exists. .. rst-class:: classref-method -:ref:`bool` **has_string_delimiter**\ (\ start_key\: :ref:`String`\ ) |const| +:ref:`bool` **has_string_delimiter**\ (\ start_key\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if string ``start_key`` exists. @@ -1399,7 +1399,7 @@ Returns ``true`` if string ``start_key`` exists. .. rst-class:: classref-method -|void| **indent_lines**\ (\ ) +|void| **indent_lines**\ (\ ) :ref:`🔗` Indents selected lines, or in the case of no selection the caret line by one. @@ -1411,7 +1411,7 @@ Indents selected lines, or in the case of no selection the caret line by one. .. rst-class:: classref-method -:ref:`int` **is_in_comment**\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| +:ref:`int` **is_in_comment**\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is not provided, will return delimiter index if the entire ``line`` is a comment. Otherwise ``-1``. @@ -1423,7 +1423,7 @@ Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is .. rst-class:: classref-method -:ref:`int` **is_in_string**\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| +:ref:`int` **is_in_string**\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` is not provided, will return the delimiter index if the entire ``line`` is a string. Otherwise ``-1``. @@ -1435,7 +1435,7 @@ Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` .. rst-class:: classref-method -:ref:`bool` **is_line_bookmarked**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_bookmarked**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the line at the specified index is bookmarked or not. @@ -1447,7 +1447,7 @@ Returns whether the line at the specified index is bookmarked or not. .. rst-class:: classref-method -:ref:`bool` **is_line_breakpointed**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_breakpointed**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the line at the specified index is breakpointed or not. @@ -1459,7 +1459,7 @@ Returns whether the line at the specified index is breakpointed or not. .. rst-class:: classref-method -:ref:`bool` **is_line_code_region_end**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_code_region_end**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the line at the specified index is a code region end. @@ -1471,7 +1471,7 @@ Returns whether the line at the specified index is a code region end. .. rst-class:: classref-method -:ref:`bool` **is_line_code_region_start**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_code_region_start**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the line at the specified index is a code region start. @@ -1483,7 +1483,7 @@ Returns whether the line at the specified index is a code region start. .. rst-class:: classref-method -:ref:`bool` **is_line_executing**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_executing**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the line at the specified index is marked as executing or not. @@ -1495,7 +1495,7 @@ Returns whether the line at the specified index is marked as executing or not. .. rst-class:: classref-method -:ref:`bool` **is_line_folded**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_folded**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the line at the specified index is folded or not. @@ -1507,7 +1507,7 @@ Returns whether the line at the specified index is folded or not. .. rst-class:: classref-method -|void| **move_lines_down**\ (\ ) +|void| **move_lines_down**\ (\ ) :ref:`🔗` Moves all lines down that are selected or have a caret on them. @@ -1519,7 +1519,7 @@ Moves all lines down that are selected or have a caret on them. .. rst-class:: classref-method -|void| **move_lines_up**\ (\ ) +|void| **move_lines_up**\ (\ ) :ref:`🔗` Moves all lines up that are selected or have a caret on them. @@ -1531,7 +1531,7 @@ Moves all lines up that are selected or have a caret on them. .. rst-class:: classref-method -|void| **remove_comment_delimiter**\ (\ start_key\: :ref:`String`\ ) +|void| **remove_comment_delimiter**\ (\ start_key\: :ref:`String`\ ) :ref:`🔗` Removes the comment delimiter with ``start_key``. @@ -1543,7 +1543,7 @@ Removes the comment delimiter with ``start_key``. .. rst-class:: classref-method -|void| **remove_string_delimiter**\ (\ start_key\: :ref:`String`\ ) +|void| **remove_string_delimiter**\ (\ start_key\: :ref:`String`\ ) :ref:`🔗` Removes the string delimiter with ``start_key``. @@ -1555,7 +1555,7 @@ Removes the string delimiter with ``start_key``. .. rst-class:: classref-method -|void| **request_code_completion**\ (\ force\: :ref:`bool` = false\ ) +|void| **request_code_completion**\ (\ force\: :ref:`bool` = false\ ) :ref:`🔗` Emits :ref:`code_completion_requested`, if ``force`` is ``true`` will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path, or signal. @@ -1567,7 +1567,7 @@ Emits :ref:`code_completion_requested`\ ) +|void| **set_code_completion_selected_index**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Sets the current selected completion option. @@ -1579,7 +1579,7 @@ Sets the current selected completion option. .. rst-class:: classref-method -|void| **set_code_hint**\ (\ code_hint\: :ref:`String`\ ) +|void| **set_code_hint**\ (\ code_hint\: :ref:`String`\ ) :ref:`🔗` Sets the code hint text. Pass an empty string to clear. @@ -1591,7 +1591,7 @@ Sets the code hint text. Pass an empty string to clear. .. rst-class:: classref-method -|void| **set_code_hint_draw_below**\ (\ draw_below\: :ref:`bool`\ ) +|void| **set_code_hint_draw_below**\ (\ draw_below\: :ref:`bool`\ ) :ref:`🔗` Sets if the code hint should draw below the text. @@ -1603,7 +1603,7 @@ Sets if the code hint should draw below the text. .. rst-class:: classref-method -|void| **set_code_region_tags**\ (\ start\: :ref:`String` = "region", end\: :ref:`String` = "endregion"\ ) +|void| **set_code_region_tags**\ (\ start\: :ref:`String` = "region", end\: :ref:`String` = "endregion"\ ) :ref:`🔗` Sets the code region start and end tags (without comment delimiter). @@ -1615,7 +1615,7 @@ Sets the code region start and end tags (without comment delimiter). .. rst-class:: classref-method -|void| **set_line_as_bookmarked**\ (\ line\: :ref:`int`, bookmarked\: :ref:`bool`\ ) +|void| **set_line_as_bookmarked**\ (\ line\: :ref:`int`, bookmarked\: :ref:`bool`\ ) :ref:`🔗` Sets the line as bookmarked. @@ -1627,7 +1627,7 @@ Sets the line as bookmarked. .. rst-class:: classref-method -|void| **set_line_as_breakpoint**\ (\ line\: :ref:`int`, breakpointed\: :ref:`bool`\ ) +|void| **set_line_as_breakpoint**\ (\ line\: :ref:`int`, breakpointed\: :ref:`bool`\ ) :ref:`🔗` Sets the line as breakpointed. @@ -1639,7 +1639,7 @@ Sets the line as breakpointed. .. rst-class:: classref-method -|void| **set_line_as_executing**\ (\ line\: :ref:`int`, executing\: :ref:`bool`\ ) +|void| **set_line_as_executing**\ (\ line\: :ref:`int`, executing\: :ref:`bool`\ ) :ref:`🔗` Sets the line as executing. @@ -1651,7 +1651,7 @@ Sets the line as executing. .. rst-class:: classref-method -|void| **set_symbol_lookup_word_as_valid**\ (\ valid\: :ref:`bool`\ ) +|void| **set_symbol_lookup_word_as_valid**\ (\ valid\: :ref:`bool`\ ) :ref:`🔗` Sets the symbol emitted by :ref:`symbol_validate` as a valid lookup. @@ -1663,7 +1663,7 @@ Sets the symbol emitted by :ref:`symbol_validate`\ ) +|void| **toggle_foldable_line**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Toggle the folding of the code block at the given line. @@ -1675,7 +1675,7 @@ Toggle the folding of the code block at the given line. .. rst-class:: classref-method -|void| **toggle_foldable_lines_at_carets**\ (\ ) +|void| **toggle_foldable_lines_at_carets**\ (\ ) :ref:`🔗` Toggle the folding of the code block on all lines with a caret on them. @@ -1687,7 +1687,7 @@ Toggle the folding of the code block on all lines with a caret on them. .. rst-class:: classref-method -|void| **unfold_all_lines**\ (\ ) +|void| **unfold_all_lines**\ (\ ) :ref:`🔗` Unfolds all lines, folded or not. @@ -1699,7 +1699,7 @@ Unfolds all lines, folded or not. .. rst-class:: classref-method -|void| **unfold_line**\ (\ line\: :ref:`int`\ ) +|void| **unfold_line**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Unfolds all lines that were previously folded. @@ -1711,7 +1711,7 @@ Unfolds all lines that were previously folded. .. rst-class:: classref-method -|void| **unindent_lines**\ (\ ) +|void| **unindent_lines**\ (\ ) :ref:`🔗` Unindents selected lines, or in the case of no selection the caret line by one. Same as performing "ui_text_unindent" action. @@ -1723,7 +1723,7 @@ Unindents selected lines, or in the case of no selection the caret line by one. .. rst-class:: classref-method -|void| **update_code_completion_options**\ (\ force\: :ref:`bool`\ ) +|void| **update_code_completion_options**\ (\ force\: :ref:`bool`\ ) :ref:`🔗` Submits all completion options added with :ref:`add_code_completion_option`. Will try to force the autocomplete menu to popup, if ``force`` is ``true``. @@ -1742,7 +1742,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **bookmark_color** = ``Color(0.5, 0.64, 1, 0.8)`` +:ref:`Color` **bookmark_color** = ``Color(0.5, 0.64, 1, 0.8)`` :ref:`🔗` :ref:`Color` of the bookmark icon for bookmarked lines. @@ -1754,7 +1754,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **brace_mismatch_color** = ``Color(1, 0.2, 0.2, 1)`` +:ref:`Color` **brace_mismatch_color** = ``Color(1, 0.2, 0.2, 1)`` :ref:`🔗` :ref:`Color` of the text to highlight mismatched braces. @@ -1766,7 +1766,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **breakpoint_color** = ``Color(0.9, 0.29, 0.3, 1)`` +:ref:`Color` **breakpoint_color** = ``Color(0.9, 0.29, 0.3, 1)`` :ref:`🔗` :ref:`Color` of the breakpoint icon for bookmarked lines. @@ -1778,7 +1778,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **code_folding_color** = ``Color(0.8, 0.8, 0.8, 0.8)`` +:ref:`Color` **code_folding_color** = ``Color(0.8, 0.8, 0.8, 0.8)`` :ref:`🔗` :ref:`Color` for all icons related to line folding. @@ -1790,7 +1790,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **completion_background_color** = ``Color(0.17, 0.16, 0.2, 1)`` +:ref:`Color` **completion_background_color** = ``Color(0.17, 0.16, 0.2, 1)`` :ref:`🔗` Sets the background :ref:`Color` for the code completion popup. @@ -1802,7 +1802,7 @@ Sets the background :ref:`Color` for the code completion popup. .. rst-class:: classref-themeproperty -:ref:`Color` **completion_existing_color** = ``Color(0.87, 0.87, 0.87, 0.13)`` +:ref:`Color` **completion_existing_color** = ``Color(0.87, 0.87, 0.87, 0.13)`` :ref:`🔗` Background highlight :ref:`Color` for matching text in code completion options. @@ -1814,7 +1814,7 @@ Background highlight :ref:`Color` for matching text in code complet .. rst-class:: classref-themeproperty -:ref:`Color` **completion_scroll_color** = ``Color(1, 1, 1, 0.29)`` +:ref:`Color` **completion_scroll_color** = ``Color(1, 1, 1, 0.29)`` :ref:`🔗` :ref:`Color` of the scrollbar in the code completion popup. @@ -1826,7 +1826,7 @@ Background highlight :ref:`Color` for matching text in code complet .. rst-class:: classref-themeproperty -:ref:`Color` **completion_scroll_hovered_color** = ``Color(1, 1, 1, 0.4)`` +:ref:`Color` **completion_scroll_hovered_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗` :ref:`Color` of the scrollbar in the code completion popup when hovered. @@ -1838,7 +1838,7 @@ Background highlight :ref:`Color` for matching text in code complet .. rst-class:: classref-themeproperty -:ref:`Color` **completion_selected_color** = ``Color(0.26, 0.26, 0.27, 1)`` +:ref:`Color` **completion_selected_color** = ``Color(0.26, 0.26, 0.27, 1)`` :ref:`🔗` Background highlight :ref:`Color` for the current selected option item in the code completion popup. @@ -1850,7 +1850,7 @@ Background highlight :ref:`Color` for the current selected option i .. rst-class:: classref-themeproperty -:ref:`Color` **executing_line_color** = ``Color(0.98, 0.89, 0.27, 1)`` +:ref:`Color` **executing_line_color** = ``Color(0.98, 0.89, 0.27, 1)`` :ref:`🔗` :ref:`Color` of the executing icon for executing lines. @@ -1862,7 +1862,7 @@ Background highlight :ref:`Color` for the current selected option i .. rst-class:: classref-themeproperty -:ref:`Color` **folded_code_region_color** = ``Color(0.68, 0.46, 0.77, 0.2)`` +:ref:`Color` **folded_code_region_color** = ``Color(0.68, 0.46, 0.77, 0.2)`` :ref:`🔗` :ref:`Color` of background line highlight for folded code region. @@ -1874,7 +1874,7 @@ Background highlight :ref:`Color` for the current selected option i .. rst-class:: classref-themeproperty -:ref:`Color` **line_length_guideline_color** = ``Color(0.3, 0.5, 0.8, 0.1)`` +:ref:`Color` **line_length_guideline_color** = ``Color(0.3, 0.5, 0.8, 0.1)`` :ref:`🔗` :ref:`Color` of the main line length guideline, secondary guidelines will have 50% alpha applied. @@ -1886,7 +1886,7 @@ Background highlight :ref:`Color` for the current selected option i .. rst-class:: classref-themeproperty -:ref:`Color` **line_number_color** = ``Color(0.67, 0.67, 0.67, 0.4)`` +:ref:`Color` **line_number_color** = ``Color(0.67, 0.67, 0.67, 0.4)`` :ref:`🔗` Sets the :ref:`Color` of line numbers. @@ -1898,7 +1898,7 @@ Sets the :ref:`Color` of line numbers. .. rst-class:: classref-themeproperty -:ref:`int` **completion_lines** = ``7`` +:ref:`int` **completion_lines** = ``7`` :ref:`🔗` Max number of options to display in the code completion popup at any one time. @@ -1910,7 +1910,7 @@ Max number of options to display in the code completion popup at any one time. .. rst-class:: classref-themeproperty -:ref:`int` **completion_max_width** = ``50`` +:ref:`int` **completion_max_width** = ``50`` :ref:`🔗` Max width of options in the code completion popup. Options longer than this will be cut off. @@ -1922,7 +1922,7 @@ Max width of options in the code completion popup. Options longer than this will .. rst-class:: classref-themeproperty -:ref:`int` **completion_scroll_width** = ``6`` +:ref:`int` **completion_scroll_width** = ``6`` :ref:`🔗` Width of the scrollbar in the code completion popup. @@ -1934,7 +1934,7 @@ Width of the scrollbar in the code completion popup. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **bookmark** +:ref:`Texture2D` **bookmark** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw in the bookmark gutter for bookmarked lines. @@ -1946,7 +1946,7 @@ Sets a custom :ref:`Texture2D` to draw in the bookmark gutter f .. rst-class:: classref-themeproperty -:ref:`Texture2D` **breakpoint** +:ref:`Texture2D` **breakpoint** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw in the breakpoint gutter for breakpointed lines. @@ -1958,7 +1958,7 @@ Sets a custom :ref:`Texture2D` to draw in the breakpoint gutter .. rst-class:: classref-themeproperty -:ref:`Texture2D` **can_fold** +:ref:`Texture2D` **can_fold** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw in the line folding gutter when a line can be folded. @@ -1970,7 +1970,7 @@ Sets a custom :ref:`Texture2D` to draw in the line folding gutt .. rst-class:: classref-themeproperty -:ref:`Texture2D` **can_fold_code_region** +:ref:`Texture2D` **can_fold_code_region** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw in the line folding gutter when a code region can be folded. @@ -1982,7 +1982,7 @@ Sets a custom :ref:`Texture2D` to draw in the line folding gutt .. rst-class:: classref-themeproperty -:ref:`Texture2D` **executing_line** +:ref:`Texture2D` **executing_line** :ref:`🔗` Icon to draw in the executing gutter for executing lines. @@ -1994,7 +1994,7 @@ Icon to draw in the executing gutter for executing lines. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **folded** +:ref:`Texture2D` **folded** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw in the line folding gutter when a line is folded and can be unfolded. @@ -2006,7 +2006,7 @@ Sets a custom :ref:`Texture2D` to draw in the line folding gutt .. rst-class:: classref-themeproperty -:ref:`Texture2D` **folded_code_region** +:ref:`Texture2D` **folded_code_region** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw in the line folding gutter when a code region is folded and can be unfolded. @@ -2018,7 +2018,7 @@ Sets a custom :ref:`Texture2D` to draw in the line folding gutt .. rst-class:: classref-themeproperty -:ref:`Texture2D` **folded_eol_icon** +:ref:`Texture2D` **folded_eol_icon** :ref:`🔗` Sets a custom :ref:`Texture2D` to draw at the end of a folded line. @@ -2030,7 +2030,7 @@ Sets a custom :ref:`Texture2D` to draw at the end of a folded l .. rst-class:: classref-themeproperty -:ref:`StyleBox` **completion** +:ref:`StyleBox` **completion** :ref:`🔗` :ref:`StyleBox` for the code completion popup. diff --git a/classes/class_codehighlighter.rst b/classes/class_codehighlighter.rst index 582b59eb7ba..3d2e87393cc 100644 --- a/classes/class_codehighlighter.rst +++ b/classes/class_codehighlighter.rst @@ -96,7 +96,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Dictionary` **color_regions** = ``{}`` +:ref:`Dictionary` **color_regions** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ Sets the color regions. All existing regions will be removed. The :ref:`Dictiona .. rst-class:: classref-property -:ref:`Color` **function_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **function_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Sets color for functions. A function is a non-keyword string followed by a '('. .. rst-class:: classref-property -:ref:`Dictionary` **keyword_colors** = ``{}`` +:ref:`Dictionary` **keyword_colors** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ Sets the keyword colors. All existing keywords will be removed. The :ref:`Dictio .. rst-class:: classref-property -:ref:`Dictionary` **member_keyword_colors** = ``{}`` +:ref:`Dictionary` **member_keyword_colors** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ Sets the member keyword colors. All existing member keyword will be removed. The .. rst-class:: classref-property -:ref:`Color` **member_variable_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **member_variable_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ Sets color for member variables. A member variable is non-keyword, non-function .. rst-class:: classref-property -:ref:`Color` **number_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **number_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ Sets the color for numbers. .. rst-class:: classref-property -:ref:`Color` **symbol_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **symbol_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_color_region**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, color\: :ref:`Color`, line_only\: :ref:`bool` = false\ ) +|void| **add_color_region**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, color\: :ref:`Color`, line_only\: :ref:`bool` = false\ ) :ref:`🔗` Adds a color region (such as for comments or strings) from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters. @@ -234,7 +234,7 @@ If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String`, color\: :ref:`Color`\ ) +|void| **add_keyword_color**\ (\ keyword\: :ref:`String`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color for a keyword. @@ -248,7 +248,7 @@ The keyword cannot contain any symbols except '\_'. .. rst-class:: classref-method -|void| **add_member_keyword_color**\ (\ member_keyword\: :ref:`String`, color\: :ref:`Color`\ ) +|void| **add_member_keyword_color**\ (\ member_keyword\: :ref:`String`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color for a member keyword. @@ -264,7 +264,7 @@ It will not be highlighted if preceded by a '.'. .. rst-class:: classref-method -|void| **clear_color_regions**\ (\ ) +|void| **clear_color_regions**\ (\ ) :ref:`🔗` Removes all color regions. @@ -276,7 +276,7 @@ Removes all color regions. .. rst-class:: classref-method -|void| **clear_keyword_colors**\ (\ ) +|void| **clear_keyword_colors**\ (\ ) :ref:`🔗` Removes all keywords. @@ -288,7 +288,7 @@ Removes all keywords. .. rst-class:: classref-method -|void| **clear_member_keyword_colors**\ (\ ) +|void| **clear_member_keyword_colors**\ (\ ) :ref:`🔗` Removes all member keywords. @@ -300,7 +300,7 @@ Removes all member keywords. .. rst-class:: classref-method -:ref:`Color` **get_keyword_color**\ (\ keyword\: :ref:`String`\ ) |const| +:ref:`Color` **get_keyword_color**\ (\ keyword\: :ref:`String`\ ) |const| :ref:`🔗` Returns the color for a keyword. @@ -312,7 +312,7 @@ Returns the color for a keyword. .. rst-class:: classref-method -:ref:`Color` **get_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) |const| +:ref:`Color` **get_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) |const| :ref:`🔗` Returns the color for a member keyword. @@ -324,7 +324,7 @@ Returns the color for a member keyword. .. rst-class:: classref-method -:ref:`bool` **has_color_region**\ (\ start_key\: :ref:`String`\ ) |const| +:ref:`bool` **has_color_region**\ (\ start_key\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the start key exists, else ``false``. @@ -336,7 +336,7 @@ Returns ``true`` if the start key exists, else ``false``. .. rst-class:: classref-method -:ref:`bool` **has_keyword_color**\ (\ keyword\: :ref:`String`\ ) |const| +:ref:`bool` **has_keyword_color**\ (\ keyword\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the keyword exists, else ``false``. @@ -348,7 +348,7 @@ Returns ``true`` if the keyword exists, else ``false``. .. rst-class:: classref-method -:ref:`bool` **has_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) |const| +:ref:`bool` **has_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the member keyword exists, else ``false``. @@ -360,7 +360,7 @@ Returns ``true`` if the member keyword exists, else ``false``. .. rst-class:: classref-method -|void| **remove_color_region**\ (\ start_key\: :ref:`String`\ ) +|void| **remove_color_region**\ (\ start_key\: :ref:`String`\ ) :ref:`🔗` Removes the color region that uses that start key. @@ -372,7 +372,7 @@ Removes the color region that uses that start key. .. rst-class:: classref-method -|void| **remove_keyword_color**\ (\ keyword\: :ref:`String`\ ) +|void| **remove_keyword_color**\ (\ keyword\: :ref:`String`\ ) :ref:`🔗` Removes the keyword. @@ -384,7 +384,7 @@ Removes the keyword. .. rst-class:: classref-method -|void| **remove_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) +|void| **remove_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) :ref:`🔗` Removes the member keyword. diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 5100fa0bc75..8ea2227dc2a 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -126,7 +126,7 @@ Signals .. rst-class:: classref-signal -**input_event**\ (\ viewport\: :ref:`Node`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) +**input_event**\ (\ viewport\: :ref:`Node`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) :ref:`🔗` Emitted when an input event occurs. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. See :ref:`_input_event` for details. @@ -138,7 +138,7 @@ Emitted when an input event occurs. Requires :ref:`input_pickable` Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this signal to be emitted. @@ -152,7 +152,7 @@ Emitted when the mouse pointer enters any of this object's shapes. Requires :ref .. rst-class:: classref-signal -**mouse_exited**\ (\ ) +**mouse_exited**\ (\ ) :ref:`🔗` Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this signal to be emitted. @@ -166,7 +166,7 @@ Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`in .. rst-class:: classref-signal -**mouse_shape_entered**\ (\ shape_idx\: :ref:`int`\ ) +**mouse_shape_entered**\ (\ shape_idx\: :ref:`int`\ ) :ref:`🔗` Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. ``shape_idx`` is the child index of the newly entered :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -178,7 +178,7 @@ Emitted when the mouse pointer enters any of this object's shapes or moves from .. rst-class:: classref-signal -**mouse_shape_exited**\ (\ shape_idx\: :ref:`int`\ ) +**mouse_shape_exited**\ (\ shape_idx\: :ref:`int`\ ) :ref:`🔗` Emitted when the mouse pointer exits any of this object's shapes. ``shape_idx`` is the child index of the exited :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -195,7 +195,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DisableMode**: +enum **DisableMode**: :ref:`🔗` .. _class_CollisionObject2D_constant_DISABLE_MODE_REMOVE: @@ -238,7 +238,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **collision_layer** = ``1`` +:ref:`int` **collision_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ The physics layers this CollisionObject2D is in. Collision objects can exist in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ The physics layers this CollisionObject2D scans. Collision objects can scan one .. rst-class:: classref-property -:ref:`float` **collision_priority** = ``1.0`` +:ref:`float` **collision_priority** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -293,7 +293,7 @@ The priority used to solve colliding when occurring penetration. The higher the .. rst-class:: classref-property -:ref:`DisableMode` **disable_mode** = ``0`` +:ref:`DisableMode` **disable_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -310,7 +310,7 @@ Defines the behavior in physics when :ref:`Node.process_mode` **input_pickable** = ``true`` +:ref:`bool` **input_pickable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -332,7 +332,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_input_event**\ (\ viewport\: :ref:`Viewport`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_input_event**\ (\ viewport\: :ref:`Viewport`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to :ref:`input_event` to easily pick up these events. @@ -346,7 +346,7 @@ Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the c .. rst-class:: classref-method -|void| **_mouse_enter**\ (\ ) |virtual| +|void| **_mouse_enter**\ (\ ) |virtual| :ref:`🔗` Called when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this function to be called. @@ -358,7 +358,7 @@ Called when the mouse pointer enters any of this object's shapes. Requires :ref: .. rst-class:: classref-method -|void| **_mouse_exit**\ (\ ) |virtual| +|void| **_mouse_exit**\ (\ ) |virtual| :ref:`🔗` Called when the mouse pointer exits all this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this function to be called. @@ -370,7 +370,7 @@ Called when the mouse pointer exits all this object's shapes. Requires :ref:`inp .. rst-class:: classref-method -|void| **_mouse_shape_enter**\ (\ shape_idx\: :ref:`int`\ ) |virtual| +|void| **_mouse_shape_enter**\ (\ shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Called when the mouse pointer enters any of this object's shapes or moves from one shape to another. ``shape_idx`` is the child index of the newly entered :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be called. @@ -382,7 +382,7 @@ Called when the mouse pointer enters any of this object's shapes or moves from o .. rst-class:: classref-method -|void| **_mouse_shape_exit**\ (\ shape_idx\: :ref:`int`\ ) |virtual| +|void| **_mouse_shape_exit**\ (\ shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Called when the mouse pointer exits any of this object's shapes. ``shape_idx`` is the child index of the exited :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be called. @@ -394,7 +394,7 @@ Called when the mouse pointer exits any of this object's shapes. ``shape_idx`` i .. rst-class:: classref-method -:ref:`int` **create_shape_owner**\ (\ owner\: :ref:`Object`\ ) +:ref:`int` **create_shape_owner**\ (\ owner\: :ref:`Object`\ ) :ref:`🔗` Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. @@ -406,7 +406,7 @@ Creates a new shape owner for the given object. Returns ``owner_id`` of the new .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -418,7 +418,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -430,7 +430,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the object's :ref:`RID`. @@ -442,7 +442,7 @@ Returns the object's :ref:`RID`. .. rst-class:: classref-method -:ref:`float` **get_shape_owner_one_way_collision_margin**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`float` **get_shape_owner_one_way_collision_margin**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id``. @@ -454,7 +454,7 @@ Returns the ``one_way_collision_margin`` of the shape owner identified by given .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_shape_owners**\ (\ ) +:ref:`PackedInt32Array` **get_shape_owners**\ (\ ) :ref:`🔗` Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. @@ -466,7 +466,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th .. rst-class:: classref-method -:ref:`bool` **is_shape_owner_disabled**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`bool` **is_shape_owner_disabled**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` If ``true``, the shape owner and its shapes are disabled. @@ -478,7 +478,7 @@ If ``true``, the shape owner and its shapes are disabled. .. rst-class:: classref-method -:ref:`bool` **is_shape_owner_one_way_collision_enabled**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`bool` **is_shape_owner_one_way_collision_enabled**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if collisions for the shape owner originating from this **CollisionObject2D** will not be reported to collided with **CollisionObject2D**\ s. @@ -490,7 +490,7 @@ Returns ``true`` if collisions for the shape owner originating from this **Colli .. rst-class:: classref-method -|void| **remove_shape_owner**\ (\ owner_id\: :ref:`int`\ ) +|void| **remove_shape_owner**\ (\ owner_id\: :ref:`int`\ ) :ref:`🔗` Removes the given shape owner. @@ -502,7 +502,7 @@ Removes the given shape owner. .. rst-class:: classref-method -|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -514,7 +514,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -526,7 +526,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -:ref:`int` **shape_find_owner**\ (\ shape_index\: :ref:`int`\ ) |const| +:ref:`int` **shape_find_owner**\ (\ shape_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ``owner_id`` of the given shape. @@ -538,7 +538,7 @@ Returns the ``owner_id`` of the given shape. .. rst-class:: classref-method -|void| **shape_owner_add_shape**\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape2D`\ ) +|void| **shape_owner_add_shape**\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape2D`\ ) :ref:`🔗` Adds a :ref:`Shape2D` to the shape owner. @@ -550,7 +550,7 @@ Adds a :ref:`Shape2D` to the shape owner. .. rst-class:: classref-method -|void| **shape_owner_clear_shapes**\ (\ owner_id\: :ref:`int`\ ) +|void| **shape_owner_clear_shapes**\ (\ owner_id\: :ref:`int`\ ) :ref:`🔗` Removes all shapes from the shape owner. @@ -562,7 +562,7 @@ Removes all shapes from the shape owner. .. rst-class:: classref-method -:ref:`Object` **shape_owner_get_owner**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`Object` **shape_owner_get_owner**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the parent object of the given shape owner. @@ -574,7 +574,7 @@ Returns the parent object of the given shape owner. .. rst-class:: classref-method -:ref:`Shape2D` **shape_owner_get_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| +:ref:`Shape2D` **shape_owner_get_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Shape2D` with the given ID from the given shape owner. @@ -586,7 +586,7 @@ Returns the :ref:`Shape2D` with the given ID from the given shape .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_count**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`int` **shape_owner_get_shape_count**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of shapes the given shape owner contains. @@ -598,7 +598,7 @@ Returns the number of shapes the given shape owner contains. .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_index**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| +:ref:`int` **shape_owner_get_shape_index**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the child index of the :ref:`Shape2D` with the given ID from the given shape owner. @@ -610,7 +610,7 @@ Returns the child index of the :ref:`Shape2D` with the given ID f .. rst-class:: classref-method -:ref:`Transform2D` **shape_owner_get_transform**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`Transform2D` **shape_owner_get_transform**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the shape owner's :ref:`Transform2D`. @@ -622,7 +622,7 @@ Returns the shape owner's :ref:`Transform2D`. .. rst-class:: classref-method -|void| **shape_owner_remove_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) +|void| **shape_owner_remove_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) :ref:`🔗` Removes a shape from the given shape owner. @@ -634,7 +634,7 @@ Removes a shape from the given shape owner. .. rst-class:: classref-method -|void| **shape_owner_set_disabled**\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **shape_owner_set_disabled**\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, disables the given shape owner. @@ -646,7 +646,7 @@ If ``true``, disables the given shape owner. .. rst-class:: classref-method -|void| **shape_owner_set_one_way_collision**\ (\ owner_id\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **shape_owner_set_one_way_collision**\ (\ owner_id\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``enable`` is ``true``, collisions for the shape owner originating from this **CollisionObject2D** will not be reported to collided with **CollisionObject2D**\ s. @@ -658,7 +658,7 @@ If ``enable`` is ``true``, collisions for the shape owner originating from this .. rst-class:: classref-method -|void| **shape_owner_set_one_way_collision_margin**\ (\ owner_id\: :ref:`int`, margin\: :ref:`float`\ ) +|void| **shape_owner_set_one_way_collision_margin**\ (\ owner_id\: :ref:`int`, margin\: :ref:`float`\ ) :ref:`🔗` Sets the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id`` to ``margin`` pixels. @@ -670,7 +670,7 @@ Sets the ``one_way_collision_margin`` of the shape owner identified by given ``o .. rst-class:: classref-method -|void| **shape_owner_set_transform**\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **shape_owner_set_transform**\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the :ref:`Transform2D` of the given shape owner. diff --git a/classes/class_collisionobject3d.rst b/classes/class_collisionobject3d.rst index 87d18e2632f..13737061401 100644 --- a/classes/class_collisionobject3d.rst +++ b/classes/class_collisionobject3d.rst @@ -116,7 +116,7 @@ Signals .. rst-class:: classref-signal -**input_event**\ (\ camera\: :ref:`Node`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) +**input_event**\ (\ camera\: :ref:`Node`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) :ref:`🔗` Emitted when the object receives an unhandled :ref:`InputEvent`. ``event_position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. @@ -128,7 +128,7 @@ Emitted when the object receives an unhandled :ref:`InputEvent .. rst-class:: classref-signal -**mouse_entered**\ (\ ) +**mouse_entered**\ (\ ) :ref:`🔗` Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -142,7 +142,7 @@ Emitted when the mouse pointer enters any of this object's shapes. Requires :ref .. rst-class:: classref-signal -**mouse_exited**\ (\ ) +**mouse_exited**\ (\ ) :ref:`🔗` Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -161,7 +161,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DisableMode**: +enum **DisableMode**: :ref:`🔗` .. _class_CollisionObject3D_constant_DISABLE_MODE_REMOVE: @@ -204,7 +204,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **collision_layer** = ``1`` +:ref:`int` **collision_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ The physics layers this CollisionObject3D **is in**. Collision objects can exist .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ The physics layers this CollisionObject3D **scans**. Collision objects can scan .. rst-class:: classref-property -:ref:`float` **collision_priority** = ``1.0`` +:ref:`float` **collision_priority** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -259,7 +259,7 @@ The priority used to solve colliding when occurring penetration. The higher the .. rst-class:: classref-property -:ref:`DisableMode` **disable_mode** = ``0`` +:ref:`DisableMode` **disable_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ Defines the behavior in physics when :ref:`Node.process_mode` **input_capture_on_drag** = ``false`` +:ref:`bool` **input_capture_on_drag** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -293,7 +293,7 @@ If ``true``, the **CollisionObject3D** will continue to receive input events as .. rst-class:: classref-property -:ref:`bool` **input_ray_pickable** = ``true`` +:ref:`bool` **input_ray_pickable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -315,7 +315,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_input_event**\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_input_event**\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Receives unhandled :ref:`InputEvent`\ s. ``event_position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. Connect to the :ref:`input_event` signal to easily pick up these events. @@ -329,7 +329,7 @@ Receives unhandled :ref:`InputEvent`\ s. ``event_position`` is .. rst-class:: classref-method -|void| **_mouse_enter**\ (\ ) |virtual| +|void| **_mouse_enter**\ (\ ) |virtual| :ref:`🔗` Called when the mouse pointer enters any of this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject3D** won't cause this function to be called. @@ -341,7 +341,7 @@ Called when the mouse pointer enters any of this object's shapes. Requires :ref: .. rst-class:: classref-method -|void| **_mouse_exit**\ (\ ) |virtual| +|void| **_mouse_exit**\ (\ ) |virtual| :ref:`🔗` Called when the mouse pointer exits all this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject3D** won't cause this function to be called. @@ -353,7 +353,7 @@ Called when the mouse pointer exits all this object's shapes. Requires :ref:`inp .. rst-class:: classref-method -:ref:`int` **create_shape_owner**\ (\ owner\: :ref:`Object`\ ) +:ref:`int` **create_shape_owner**\ (\ owner\: :ref:`Object`\ ) :ref:`🔗` Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. @@ -365,7 +365,7 @@ Creates a new shape owner for the given object. Returns ``owner_id`` of the new .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -377,7 +377,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -389,7 +389,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the object's :ref:`RID`. @@ -401,7 +401,7 @@ Returns the object's :ref:`RID`. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_shape_owners**\ (\ ) +:ref:`PackedInt32Array` **get_shape_owners**\ (\ ) :ref:`🔗` Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. @@ -413,7 +413,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th .. rst-class:: classref-method -:ref:`bool` **is_shape_owner_disabled**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`bool` **is_shape_owner_disabled**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` If ``true``, the shape owner and its shapes are disabled. @@ -425,7 +425,7 @@ If ``true``, the shape owner and its shapes are disabled. .. rst-class:: classref-method -|void| **remove_shape_owner**\ (\ owner_id\: :ref:`int`\ ) +|void| **remove_shape_owner**\ (\ owner_id\: :ref:`int`\ ) :ref:`🔗` Removes the given shape owner. @@ -437,7 +437,7 @@ Removes the given shape owner. .. rst-class:: classref-method -|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -449,7 +449,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -461,7 +461,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -:ref:`int` **shape_find_owner**\ (\ shape_index\: :ref:`int`\ ) |const| +:ref:`int` **shape_find_owner**\ (\ shape_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ``owner_id`` of the given shape. @@ -473,7 +473,7 @@ Returns the ``owner_id`` of the given shape. .. rst-class:: classref-method -|void| **shape_owner_add_shape**\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape3D`\ ) +|void| **shape_owner_add_shape**\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape3D`\ ) :ref:`🔗` Adds a :ref:`Shape3D` to the shape owner. @@ -485,7 +485,7 @@ Adds a :ref:`Shape3D` to the shape owner. .. rst-class:: classref-method -|void| **shape_owner_clear_shapes**\ (\ owner_id\: :ref:`int`\ ) +|void| **shape_owner_clear_shapes**\ (\ owner_id\: :ref:`int`\ ) :ref:`🔗` Removes all shapes from the shape owner. @@ -497,7 +497,7 @@ Removes all shapes from the shape owner. .. rst-class:: classref-method -:ref:`Object` **shape_owner_get_owner**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`Object` **shape_owner_get_owner**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the parent object of the given shape owner. @@ -509,7 +509,7 @@ Returns the parent object of the given shape owner. .. rst-class:: classref-method -:ref:`Shape3D` **shape_owner_get_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| +:ref:`Shape3D` **shape_owner_get_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Shape3D` with the given ID from the given shape owner. @@ -521,7 +521,7 @@ Returns the :ref:`Shape3D` with the given ID from the given shape .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_count**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`int` **shape_owner_get_shape_count**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of shapes the given shape owner contains. @@ -533,7 +533,7 @@ Returns the number of shapes the given shape owner contains. .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_index**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| +:ref:`int` **shape_owner_get_shape_index**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the child index of the :ref:`Shape3D` with the given ID from the given shape owner. @@ -545,7 +545,7 @@ Returns the child index of the :ref:`Shape3D` with the given ID f .. rst-class:: classref-method -:ref:`Transform3D` **shape_owner_get_transform**\ (\ owner_id\: :ref:`int`\ ) |const| +:ref:`Transform3D` **shape_owner_get_transform**\ (\ owner_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the shape owner's :ref:`Transform3D`. @@ -557,7 +557,7 @@ Returns the shape owner's :ref:`Transform3D`. .. rst-class:: classref-method -|void| **shape_owner_remove_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) +|void| **shape_owner_remove_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) :ref:`🔗` Removes a shape from the given shape owner. @@ -569,7 +569,7 @@ Removes a shape from the given shape owner. .. rst-class:: classref-method -|void| **shape_owner_set_disabled**\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **shape_owner_set_disabled**\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, disables the given shape owner. @@ -581,7 +581,7 @@ If ``true``, disables the given shape owner. .. rst-class:: classref-method -|void| **shape_owner_set_transform**\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **shape_owner_set_transform**\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the :ref:`Transform3D` of the given shape owner. diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 0275f887f16..c4e05cd1bf5 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BuildMode**: +enum **BuildMode**: :ref:`🔗` .. _class_CollisionPolygon2D_constant_BUILD_SOLIDS: @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BuildMode` **build_mode** = ``0`` +:ref:`BuildMode` **build_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ Collision build mode. Use one of the :ref:`BuildMode` **disabled** = ``false`` +:ref:`bool` **disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ If ``true``, no collisions will be detected. .. rst-class:: classref-property -:ref:`bool` **one_way_collision** = ``false`` +:ref:`bool` **one_way_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ If ``true``, only edges that face up, relative to **CollisionPolygon2D**'s rotat .. rst-class:: classref-property -:ref:`float` **one_way_collision_margin** = ``1.0`` +:ref:`float` **one_way_collision_margin** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ The margin used for one-way collision (in pixels). Higher values will make the s .. rst-class:: classref-property -:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_collisionpolygon3d.rst b/classes/class_collisionpolygon3d.rst index b5f6d8f3ce8..e7e22ec4ec6 100644 --- a/classes/class_collisionpolygon3d.rst +++ b/classes/class_collisionpolygon3d.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **depth** = ``1.0`` +:ref:`float` **depth** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ Length that the resulting collision extends in either direction perpendicular to .. rst-class:: classref-property -:ref:`bool` **disabled** = ``false`` +:ref:`bool` **disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ If ``true``, no collision will be produced. .. rst-class:: classref-property -:ref:`float` **margin** = ``0.04`` +:ref:`float` **margin** = ``0.04`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The collision margin for the generated :ref:`Shape3D`. See :ref:` .. rst-class:: classref-property -:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 7ccf4a7cf05..9816d5b6b94 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -67,7 +67,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **debug_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **debug_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ The collision shape debug color. .. rst-class:: classref-property -:ref:`bool` **disabled** = ``false`` +:ref:`bool` **disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ A disabled collision shape has no effect in the world. This property should be c .. rst-class:: classref-property -:ref:`bool` **one_way_collision** = ``false`` +:ref:`bool` **one_way_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Sets whether this collision shape should only detect collision on one side (top .. rst-class:: classref-property -:ref:`float` **one_way_collision_margin** = ``1.0`` +:ref:`float` **one_way_collision_margin** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ The margin used for one-way collision (in pixels). Higher values will make the s .. rst-class:: classref-property -:ref:`Shape2D` **shape** +:ref:`Shape2D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_collisionshape3d.rst b/classes/class_collisionshape3d.rst index 16648dc0933..38686496911 100644 --- a/classes/class_collisionshape3d.rst +++ b/classes/class_collisionshape3d.rst @@ -77,7 +77,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **disabled** = ``false`` +:ref:`bool` **disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ A disabled collision shape has no effect in the world. .. rst-class:: classref-property -:ref:`Shape3D` **shape** +:ref:`Shape3D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **make_convex_from_siblings**\ (\ ) +|void| **make_convex_from_siblings**\ (\ ) :ref:`🔗` Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance3D` siblings geometry. @@ -128,7 +128,7 @@ Sets the collision shape's shape to the addition of all its convexed :ref:`MeshI .. rst-class:: classref-method -|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) +|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` **Deprecated:** Use :ref:`Resource.changed` instead. diff --git a/classes/class_color.rst b/classes/class_color.rst index 91c401a1bcf..b9b83e07097 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -205,7 +205,7 @@ Constants .. rst-class:: classref-constant -**ALICE_BLUE** = ``Color(0.941176, 0.972549, 1, 1)`` +**ALICE_BLUE** = ``Color(0.941176, 0.972549, 1, 1)`` :ref:`🔗` Alice blue color. @@ -213,7 +213,7 @@ Alice blue color. .. rst-class:: classref-constant -**ANTIQUE_WHITE** = ``Color(0.980392, 0.921569, 0.843137, 1)`` +**ANTIQUE_WHITE** = ``Color(0.980392, 0.921569, 0.843137, 1)`` :ref:`🔗` Antique white color. @@ -221,7 +221,7 @@ Antique white color. .. rst-class:: classref-constant -**AQUA** = ``Color(0, 1, 1, 1)`` +**AQUA** = ``Color(0, 1, 1, 1)`` :ref:`🔗` Aqua color. @@ -229,7 +229,7 @@ Aqua color. .. rst-class:: classref-constant -**AQUAMARINE** = ``Color(0.498039, 1, 0.831373, 1)`` +**AQUAMARINE** = ``Color(0.498039, 1, 0.831373, 1)`` :ref:`🔗` Aquamarine color. @@ -237,7 +237,7 @@ Aquamarine color. .. rst-class:: classref-constant -**AZURE** = ``Color(0.941176, 1, 1, 1)`` +**AZURE** = ``Color(0.941176, 1, 1, 1)`` :ref:`🔗` Azure color. @@ -245,7 +245,7 @@ Azure color. .. rst-class:: classref-constant -**BEIGE** = ``Color(0.960784, 0.960784, 0.862745, 1)`` +**BEIGE** = ``Color(0.960784, 0.960784, 0.862745, 1)`` :ref:`🔗` Beige color. @@ -253,7 +253,7 @@ Beige color. .. rst-class:: classref-constant -**BISQUE** = ``Color(1, 0.894118, 0.768627, 1)`` +**BISQUE** = ``Color(1, 0.894118, 0.768627, 1)`` :ref:`🔗` Bisque color. @@ -261,7 +261,7 @@ Bisque color. .. rst-class:: classref-constant -**BLACK** = ``Color(0, 0, 0, 1)`` +**BLACK** = ``Color(0, 0, 0, 1)`` :ref:`🔗` Black color. In GDScript, this is the default value of any color. @@ -269,7 +269,7 @@ Black color. In GDScript, this is the default value of any color. .. rst-class:: classref-constant -**BLANCHED_ALMOND** = ``Color(1, 0.921569, 0.803922, 1)`` +**BLANCHED_ALMOND** = ``Color(1, 0.921569, 0.803922, 1)`` :ref:`🔗` Blanched almond color. @@ -277,7 +277,7 @@ Blanched almond color. .. rst-class:: classref-constant -**BLUE** = ``Color(0, 0, 1, 1)`` +**BLUE** = ``Color(0, 0, 1, 1)`` :ref:`🔗` Blue color. @@ -285,7 +285,7 @@ Blue color. .. rst-class:: classref-constant -**BLUE_VIOLET** = ``Color(0.541176, 0.168627, 0.886275, 1)`` +**BLUE_VIOLET** = ``Color(0.541176, 0.168627, 0.886275, 1)`` :ref:`🔗` Blue violet color. @@ -293,7 +293,7 @@ Blue violet color. .. rst-class:: classref-constant -**BROWN** = ``Color(0.647059, 0.164706, 0.164706, 1)`` +**BROWN** = ``Color(0.647059, 0.164706, 0.164706, 1)`` :ref:`🔗` Brown color. @@ -301,7 +301,7 @@ Brown color. .. rst-class:: classref-constant -**BURLYWOOD** = ``Color(0.870588, 0.721569, 0.529412, 1)`` +**BURLYWOOD** = ``Color(0.870588, 0.721569, 0.529412, 1)`` :ref:`🔗` Burlywood color. @@ -309,7 +309,7 @@ Burlywood color. .. rst-class:: classref-constant -**CADET_BLUE** = ``Color(0.372549, 0.619608, 0.627451, 1)`` +**CADET_BLUE** = ``Color(0.372549, 0.619608, 0.627451, 1)`` :ref:`🔗` Cadet blue color. @@ -317,7 +317,7 @@ Cadet blue color. .. rst-class:: classref-constant -**CHARTREUSE** = ``Color(0.498039, 1, 0, 1)`` +**CHARTREUSE** = ``Color(0.498039, 1, 0, 1)`` :ref:`🔗` Chartreuse color. @@ -325,7 +325,7 @@ Chartreuse color. .. rst-class:: classref-constant -**CHOCOLATE** = ``Color(0.823529, 0.411765, 0.117647, 1)`` +**CHOCOLATE** = ``Color(0.823529, 0.411765, 0.117647, 1)`` :ref:`🔗` Chocolate color. @@ -333,7 +333,7 @@ Chocolate color. .. rst-class:: classref-constant -**CORAL** = ``Color(1, 0.498039, 0.313726, 1)`` +**CORAL** = ``Color(1, 0.498039, 0.313726, 1)`` :ref:`🔗` Coral color. @@ -341,7 +341,7 @@ Coral color. .. rst-class:: classref-constant -**CORNFLOWER_BLUE** = ``Color(0.392157, 0.584314, 0.929412, 1)`` +**CORNFLOWER_BLUE** = ``Color(0.392157, 0.584314, 0.929412, 1)`` :ref:`🔗` Cornflower blue color. @@ -349,7 +349,7 @@ Cornflower blue color. .. rst-class:: classref-constant -**CORNSILK** = ``Color(1, 0.972549, 0.862745, 1)`` +**CORNSILK** = ``Color(1, 0.972549, 0.862745, 1)`` :ref:`🔗` Cornsilk color. @@ -357,7 +357,7 @@ Cornsilk color. .. rst-class:: classref-constant -**CRIMSON** = ``Color(0.862745, 0.0784314, 0.235294, 1)`` +**CRIMSON** = ``Color(0.862745, 0.0784314, 0.235294, 1)`` :ref:`🔗` Crimson color. @@ -365,7 +365,7 @@ Crimson color. .. rst-class:: classref-constant -**CYAN** = ``Color(0, 1, 1, 1)`` +**CYAN** = ``Color(0, 1, 1, 1)`` :ref:`🔗` Cyan color. @@ -373,7 +373,7 @@ Cyan color. .. rst-class:: classref-constant -**DARK_BLUE** = ``Color(0, 0, 0.545098, 1)`` +**DARK_BLUE** = ``Color(0, 0, 0.545098, 1)`` :ref:`🔗` Dark blue color. @@ -381,7 +381,7 @@ Dark blue color. .. rst-class:: classref-constant -**DARK_CYAN** = ``Color(0, 0.545098, 0.545098, 1)`` +**DARK_CYAN** = ``Color(0, 0.545098, 0.545098, 1)`` :ref:`🔗` Dark cyan color. @@ -389,7 +389,7 @@ Dark cyan color. .. rst-class:: classref-constant -**DARK_GOLDENROD** = ``Color(0.721569, 0.52549, 0.0431373, 1)`` +**DARK_GOLDENROD** = ``Color(0.721569, 0.52549, 0.0431373, 1)`` :ref:`🔗` Dark goldenrod color. @@ -397,7 +397,7 @@ Dark goldenrod color. .. rst-class:: classref-constant -**DARK_GRAY** = ``Color(0.662745, 0.662745, 0.662745, 1)`` +**DARK_GRAY** = ``Color(0.662745, 0.662745, 0.662745, 1)`` :ref:`🔗` Dark gray color. @@ -405,7 +405,7 @@ Dark gray color. .. rst-class:: classref-constant -**DARK_GREEN** = ``Color(0, 0.392157, 0, 1)`` +**DARK_GREEN** = ``Color(0, 0.392157, 0, 1)`` :ref:`🔗` Dark green color. @@ -413,7 +413,7 @@ Dark green color. .. rst-class:: classref-constant -**DARK_KHAKI** = ``Color(0.741176, 0.717647, 0.419608, 1)`` +**DARK_KHAKI** = ``Color(0.741176, 0.717647, 0.419608, 1)`` :ref:`🔗` Dark khaki color. @@ -421,7 +421,7 @@ Dark khaki color. .. rst-class:: classref-constant -**DARK_MAGENTA** = ``Color(0.545098, 0, 0.545098, 1)`` +**DARK_MAGENTA** = ``Color(0.545098, 0, 0.545098, 1)`` :ref:`🔗` Dark magenta color. @@ -429,7 +429,7 @@ Dark magenta color. .. rst-class:: classref-constant -**DARK_OLIVE_GREEN** = ``Color(0.333333, 0.419608, 0.184314, 1)`` +**DARK_OLIVE_GREEN** = ``Color(0.333333, 0.419608, 0.184314, 1)`` :ref:`🔗` Dark olive green color. @@ -437,7 +437,7 @@ Dark olive green color. .. rst-class:: classref-constant -**DARK_ORANGE** = ``Color(1, 0.54902, 0, 1)`` +**DARK_ORANGE** = ``Color(1, 0.54902, 0, 1)`` :ref:`🔗` Dark orange color. @@ -445,7 +445,7 @@ Dark orange color. .. rst-class:: classref-constant -**DARK_ORCHID** = ``Color(0.6, 0.196078, 0.8, 1)`` +**DARK_ORCHID** = ``Color(0.6, 0.196078, 0.8, 1)`` :ref:`🔗` Dark orchid color. @@ -453,7 +453,7 @@ Dark orchid color. .. rst-class:: classref-constant -**DARK_RED** = ``Color(0.545098, 0, 0, 1)`` +**DARK_RED** = ``Color(0.545098, 0, 0, 1)`` :ref:`🔗` Dark red color. @@ -461,7 +461,7 @@ Dark red color. .. rst-class:: classref-constant -**DARK_SALMON** = ``Color(0.913725, 0.588235, 0.478431, 1)`` +**DARK_SALMON** = ``Color(0.913725, 0.588235, 0.478431, 1)`` :ref:`🔗` Dark salmon color. @@ -469,7 +469,7 @@ Dark salmon color. .. rst-class:: classref-constant -**DARK_SEA_GREEN** = ``Color(0.560784, 0.737255, 0.560784, 1)`` +**DARK_SEA_GREEN** = ``Color(0.560784, 0.737255, 0.560784, 1)`` :ref:`🔗` Dark sea green color. @@ -477,7 +477,7 @@ Dark sea green color. .. rst-class:: classref-constant -**DARK_SLATE_BLUE** = ``Color(0.282353, 0.239216, 0.545098, 1)`` +**DARK_SLATE_BLUE** = ``Color(0.282353, 0.239216, 0.545098, 1)`` :ref:`🔗` Dark slate blue color. @@ -485,7 +485,7 @@ Dark slate blue color. .. rst-class:: classref-constant -**DARK_SLATE_GRAY** = ``Color(0.184314, 0.309804, 0.309804, 1)`` +**DARK_SLATE_GRAY** = ``Color(0.184314, 0.309804, 0.309804, 1)`` :ref:`🔗` Dark slate gray color. @@ -493,7 +493,7 @@ Dark slate gray color. .. rst-class:: classref-constant -**DARK_TURQUOISE** = ``Color(0, 0.807843, 0.819608, 1)`` +**DARK_TURQUOISE** = ``Color(0, 0.807843, 0.819608, 1)`` :ref:`🔗` Dark turquoise color. @@ -501,7 +501,7 @@ Dark turquoise color. .. rst-class:: classref-constant -**DARK_VIOLET** = ``Color(0.580392, 0, 0.827451, 1)`` +**DARK_VIOLET** = ``Color(0.580392, 0, 0.827451, 1)`` :ref:`🔗` Dark violet color. @@ -509,7 +509,7 @@ Dark violet color. .. rst-class:: classref-constant -**DEEP_PINK** = ``Color(1, 0.0784314, 0.576471, 1)`` +**DEEP_PINK** = ``Color(1, 0.0784314, 0.576471, 1)`` :ref:`🔗` Deep pink color. @@ -517,7 +517,7 @@ Deep pink color. .. rst-class:: classref-constant -**DEEP_SKY_BLUE** = ``Color(0, 0.74902, 1, 1)`` +**DEEP_SKY_BLUE** = ``Color(0, 0.74902, 1, 1)`` :ref:`🔗` Deep sky blue color. @@ -525,7 +525,7 @@ Deep sky blue color. .. rst-class:: classref-constant -**DIM_GRAY** = ``Color(0.411765, 0.411765, 0.411765, 1)`` +**DIM_GRAY** = ``Color(0.411765, 0.411765, 0.411765, 1)`` :ref:`🔗` Dim gray color. @@ -533,7 +533,7 @@ Dim gray color. .. rst-class:: classref-constant -**DODGER_BLUE** = ``Color(0.117647, 0.564706, 1, 1)`` +**DODGER_BLUE** = ``Color(0.117647, 0.564706, 1, 1)`` :ref:`🔗` Dodger blue color. @@ -541,7 +541,7 @@ Dodger blue color. .. rst-class:: classref-constant -**FIREBRICK** = ``Color(0.698039, 0.133333, 0.133333, 1)`` +**FIREBRICK** = ``Color(0.698039, 0.133333, 0.133333, 1)`` :ref:`🔗` Firebrick color. @@ -549,7 +549,7 @@ Firebrick color. .. rst-class:: classref-constant -**FLORAL_WHITE** = ``Color(1, 0.980392, 0.941176, 1)`` +**FLORAL_WHITE** = ``Color(1, 0.980392, 0.941176, 1)`` :ref:`🔗` Floral white color. @@ -557,7 +557,7 @@ Floral white color. .. rst-class:: classref-constant -**FOREST_GREEN** = ``Color(0.133333, 0.545098, 0.133333, 1)`` +**FOREST_GREEN** = ``Color(0.133333, 0.545098, 0.133333, 1)`` :ref:`🔗` Forest green color. @@ -565,7 +565,7 @@ Forest green color. .. rst-class:: classref-constant -**FUCHSIA** = ``Color(1, 0, 1, 1)`` +**FUCHSIA** = ``Color(1, 0, 1, 1)`` :ref:`🔗` Fuchsia color. @@ -573,7 +573,7 @@ Fuchsia color. .. rst-class:: classref-constant -**GAINSBORO** = ``Color(0.862745, 0.862745, 0.862745, 1)`` +**GAINSBORO** = ``Color(0.862745, 0.862745, 0.862745, 1)`` :ref:`🔗` Gainsboro color. @@ -581,7 +581,7 @@ Gainsboro color. .. rst-class:: classref-constant -**GHOST_WHITE** = ``Color(0.972549, 0.972549, 1, 1)`` +**GHOST_WHITE** = ``Color(0.972549, 0.972549, 1, 1)`` :ref:`🔗` Ghost white color. @@ -589,7 +589,7 @@ Ghost white color. .. rst-class:: classref-constant -**GOLD** = ``Color(1, 0.843137, 0, 1)`` +**GOLD** = ``Color(1, 0.843137, 0, 1)`` :ref:`🔗` Gold color. @@ -597,7 +597,7 @@ Gold color. .. rst-class:: classref-constant -**GOLDENROD** = ``Color(0.854902, 0.647059, 0.12549, 1)`` +**GOLDENROD** = ``Color(0.854902, 0.647059, 0.12549, 1)`` :ref:`🔗` Goldenrod color. @@ -605,7 +605,7 @@ Goldenrod color. .. rst-class:: classref-constant -**GRAY** = ``Color(0.745098, 0.745098, 0.745098, 1)`` +**GRAY** = ``Color(0.745098, 0.745098, 0.745098, 1)`` :ref:`🔗` Gray color. @@ -613,7 +613,7 @@ Gray color. .. rst-class:: classref-constant -**GREEN** = ``Color(0, 1, 0, 1)`` +**GREEN** = ``Color(0, 1, 0, 1)`` :ref:`🔗` Green color. @@ -621,7 +621,7 @@ Green color. .. rst-class:: classref-constant -**GREEN_YELLOW** = ``Color(0.678431, 1, 0.184314, 1)`` +**GREEN_YELLOW** = ``Color(0.678431, 1, 0.184314, 1)`` :ref:`🔗` Green yellow color. @@ -629,7 +629,7 @@ Green yellow color. .. rst-class:: classref-constant -**HONEYDEW** = ``Color(0.941176, 1, 0.941176, 1)`` +**HONEYDEW** = ``Color(0.941176, 1, 0.941176, 1)`` :ref:`🔗` Honeydew color. @@ -637,7 +637,7 @@ Honeydew color. .. rst-class:: classref-constant -**HOT_PINK** = ``Color(1, 0.411765, 0.705882, 1)`` +**HOT_PINK** = ``Color(1, 0.411765, 0.705882, 1)`` :ref:`🔗` Hot pink color. @@ -645,7 +645,7 @@ Hot pink color. .. rst-class:: classref-constant -**INDIAN_RED** = ``Color(0.803922, 0.360784, 0.360784, 1)`` +**INDIAN_RED** = ``Color(0.803922, 0.360784, 0.360784, 1)`` :ref:`🔗` Indian red color. @@ -653,7 +653,7 @@ Indian red color. .. rst-class:: classref-constant -**INDIGO** = ``Color(0.294118, 0, 0.509804, 1)`` +**INDIGO** = ``Color(0.294118, 0, 0.509804, 1)`` :ref:`🔗` Indigo color. @@ -661,7 +661,7 @@ Indigo color. .. rst-class:: classref-constant -**IVORY** = ``Color(1, 1, 0.941176, 1)`` +**IVORY** = ``Color(1, 1, 0.941176, 1)`` :ref:`🔗` Ivory color. @@ -669,7 +669,7 @@ Ivory color. .. rst-class:: classref-constant -**KHAKI** = ``Color(0.941176, 0.901961, 0.54902, 1)`` +**KHAKI** = ``Color(0.941176, 0.901961, 0.54902, 1)`` :ref:`🔗` Khaki color. @@ -677,7 +677,7 @@ Khaki color. .. rst-class:: classref-constant -**LAVENDER** = ``Color(0.901961, 0.901961, 0.980392, 1)`` +**LAVENDER** = ``Color(0.901961, 0.901961, 0.980392, 1)`` :ref:`🔗` Lavender color. @@ -685,7 +685,7 @@ Lavender color. .. rst-class:: classref-constant -**LAVENDER_BLUSH** = ``Color(1, 0.941176, 0.960784, 1)`` +**LAVENDER_BLUSH** = ``Color(1, 0.941176, 0.960784, 1)`` :ref:`🔗` Lavender blush color. @@ -693,7 +693,7 @@ Lavender blush color. .. rst-class:: classref-constant -**LAWN_GREEN** = ``Color(0.486275, 0.988235, 0, 1)`` +**LAWN_GREEN** = ``Color(0.486275, 0.988235, 0, 1)`` :ref:`🔗` Lawn green color. @@ -701,7 +701,7 @@ Lawn green color. .. rst-class:: classref-constant -**LEMON_CHIFFON** = ``Color(1, 0.980392, 0.803922, 1)`` +**LEMON_CHIFFON** = ``Color(1, 0.980392, 0.803922, 1)`` :ref:`🔗` Lemon chiffon color. @@ -709,7 +709,7 @@ Lemon chiffon color. .. rst-class:: classref-constant -**LIGHT_BLUE** = ``Color(0.678431, 0.847059, 0.901961, 1)`` +**LIGHT_BLUE** = ``Color(0.678431, 0.847059, 0.901961, 1)`` :ref:`🔗` Light blue color. @@ -717,7 +717,7 @@ Light blue color. .. rst-class:: classref-constant -**LIGHT_CORAL** = ``Color(0.941176, 0.501961, 0.501961, 1)`` +**LIGHT_CORAL** = ``Color(0.941176, 0.501961, 0.501961, 1)`` :ref:`🔗` Light coral color. @@ -725,7 +725,7 @@ Light coral color. .. rst-class:: classref-constant -**LIGHT_CYAN** = ``Color(0.878431, 1, 1, 1)`` +**LIGHT_CYAN** = ``Color(0.878431, 1, 1, 1)`` :ref:`🔗` Light cyan color. @@ -733,7 +733,7 @@ Light cyan color. .. rst-class:: classref-constant -**LIGHT_GOLDENROD** = ``Color(0.980392, 0.980392, 0.823529, 1)`` +**LIGHT_GOLDENROD** = ``Color(0.980392, 0.980392, 0.823529, 1)`` :ref:`🔗` Light goldenrod color. @@ -741,7 +741,7 @@ Light goldenrod color. .. rst-class:: classref-constant -**LIGHT_GRAY** = ``Color(0.827451, 0.827451, 0.827451, 1)`` +**LIGHT_GRAY** = ``Color(0.827451, 0.827451, 0.827451, 1)`` :ref:`🔗` Light gray color. @@ -749,7 +749,7 @@ Light gray color. .. rst-class:: classref-constant -**LIGHT_GREEN** = ``Color(0.564706, 0.933333, 0.564706, 1)`` +**LIGHT_GREEN** = ``Color(0.564706, 0.933333, 0.564706, 1)`` :ref:`🔗` Light green color. @@ -757,7 +757,7 @@ Light green color. .. rst-class:: classref-constant -**LIGHT_PINK** = ``Color(1, 0.713726, 0.756863, 1)`` +**LIGHT_PINK** = ``Color(1, 0.713726, 0.756863, 1)`` :ref:`🔗` Light pink color. @@ -765,7 +765,7 @@ Light pink color. .. rst-class:: classref-constant -**LIGHT_SALMON** = ``Color(1, 0.627451, 0.478431, 1)`` +**LIGHT_SALMON** = ``Color(1, 0.627451, 0.478431, 1)`` :ref:`🔗` Light salmon color. @@ -773,7 +773,7 @@ Light salmon color. .. rst-class:: classref-constant -**LIGHT_SEA_GREEN** = ``Color(0.12549, 0.698039, 0.666667, 1)`` +**LIGHT_SEA_GREEN** = ``Color(0.12549, 0.698039, 0.666667, 1)`` :ref:`🔗` Light sea green color. @@ -781,7 +781,7 @@ Light sea green color. .. rst-class:: classref-constant -**LIGHT_SKY_BLUE** = ``Color(0.529412, 0.807843, 0.980392, 1)`` +**LIGHT_SKY_BLUE** = ``Color(0.529412, 0.807843, 0.980392, 1)`` :ref:`🔗` Light sky blue color. @@ -789,7 +789,7 @@ Light sky blue color. .. rst-class:: classref-constant -**LIGHT_SLATE_GRAY** = ``Color(0.466667, 0.533333, 0.6, 1)`` +**LIGHT_SLATE_GRAY** = ``Color(0.466667, 0.533333, 0.6, 1)`` :ref:`🔗` Light slate gray color. @@ -797,7 +797,7 @@ Light slate gray color. .. rst-class:: classref-constant -**LIGHT_STEEL_BLUE** = ``Color(0.690196, 0.768627, 0.870588, 1)`` +**LIGHT_STEEL_BLUE** = ``Color(0.690196, 0.768627, 0.870588, 1)`` :ref:`🔗` Light steel blue color. @@ -805,7 +805,7 @@ Light steel blue color. .. rst-class:: classref-constant -**LIGHT_YELLOW** = ``Color(1, 1, 0.878431, 1)`` +**LIGHT_YELLOW** = ``Color(1, 1, 0.878431, 1)`` :ref:`🔗` Light yellow color. @@ -813,7 +813,7 @@ Light yellow color. .. rst-class:: classref-constant -**LIME** = ``Color(0, 1, 0, 1)`` +**LIME** = ``Color(0, 1, 0, 1)`` :ref:`🔗` Lime color. @@ -821,7 +821,7 @@ Lime color. .. rst-class:: classref-constant -**LIME_GREEN** = ``Color(0.196078, 0.803922, 0.196078, 1)`` +**LIME_GREEN** = ``Color(0.196078, 0.803922, 0.196078, 1)`` :ref:`🔗` Lime green color. @@ -829,7 +829,7 @@ Lime green color. .. rst-class:: classref-constant -**LINEN** = ``Color(0.980392, 0.941176, 0.901961, 1)`` +**LINEN** = ``Color(0.980392, 0.941176, 0.901961, 1)`` :ref:`🔗` Linen color. @@ -837,7 +837,7 @@ Linen color. .. rst-class:: classref-constant -**MAGENTA** = ``Color(1, 0, 1, 1)`` +**MAGENTA** = ``Color(1, 0, 1, 1)`` :ref:`🔗` Magenta color. @@ -845,7 +845,7 @@ Magenta color. .. rst-class:: classref-constant -**MAROON** = ``Color(0.690196, 0.188235, 0.376471, 1)`` +**MAROON** = ``Color(0.690196, 0.188235, 0.376471, 1)`` :ref:`🔗` Maroon color. @@ -853,7 +853,7 @@ Maroon color. .. rst-class:: classref-constant -**MEDIUM_AQUAMARINE** = ``Color(0.4, 0.803922, 0.666667, 1)`` +**MEDIUM_AQUAMARINE** = ``Color(0.4, 0.803922, 0.666667, 1)`` :ref:`🔗` Medium aquamarine color. @@ -861,7 +861,7 @@ Medium aquamarine color. .. rst-class:: classref-constant -**MEDIUM_BLUE** = ``Color(0, 0, 0.803922, 1)`` +**MEDIUM_BLUE** = ``Color(0, 0, 0.803922, 1)`` :ref:`🔗` Medium blue color. @@ -869,7 +869,7 @@ Medium blue color. .. rst-class:: classref-constant -**MEDIUM_ORCHID** = ``Color(0.729412, 0.333333, 0.827451, 1)`` +**MEDIUM_ORCHID** = ``Color(0.729412, 0.333333, 0.827451, 1)`` :ref:`🔗` Medium orchid color. @@ -877,7 +877,7 @@ Medium orchid color. .. rst-class:: classref-constant -**MEDIUM_PURPLE** = ``Color(0.576471, 0.439216, 0.858824, 1)`` +**MEDIUM_PURPLE** = ``Color(0.576471, 0.439216, 0.858824, 1)`` :ref:`🔗` Medium purple color. @@ -885,7 +885,7 @@ Medium purple color. .. rst-class:: classref-constant -**MEDIUM_SEA_GREEN** = ``Color(0.235294, 0.701961, 0.443137, 1)`` +**MEDIUM_SEA_GREEN** = ``Color(0.235294, 0.701961, 0.443137, 1)`` :ref:`🔗` Medium sea green color. @@ -893,7 +893,7 @@ Medium sea green color. .. rst-class:: classref-constant -**MEDIUM_SLATE_BLUE** = ``Color(0.482353, 0.407843, 0.933333, 1)`` +**MEDIUM_SLATE_BLUE** = ``Color(0.482353, 0.407843, 0.933333, 1)`` :ref:`🔗` Medium slate blue color. @@ -901,7 +901,7 @@ Medium slate blue color. .. rst-class:: classref-constant -**MEDIUM_SPRING_GREEN** = ``Color(0, 0.980392, 0.603922, 1)`` +**MEDIUM_SPRING_GREEN** = ``Color(0, 0.980392, 0.603922, 1)`` :ref:`🔗` Medium spring green color. @@ -909,7 +909,7 @@ Medium spring green color. .. rst-class:: classref-constant -**MEDIUM_TURQUOISE** = ``Color(0.282353, 0.819608, 0.8, 1)`` +**MEDIUM_TURQUOISE** = ``Color(0.282353, 0.819608, 0.8, 1)`` :ref:`🔗` Medium turquoise color. @@ -917,7 +917,7 @@ Medium turquoise color. .. rst-class:: classref-constant -**MEDIUM_VIOLET_RED** = ``Color(0.780392, 0.0823529, 0.521569, 1)`` +**MEDIUM_VIOLET_RED** = ``Color(0.780392, 0.0823529, 0.521569, 1)`` :ref:`🔗` Medium violet red color. @@ -925,7 +925,7 @@ Medium violet red color. .. rst-class:: classref-constant -**MIDNIGHT_BLUE** = ``Color(0.0980392, 0.0980392, 0.439216, 1)`` +**MIDNIGHT_BLUE** = ``Color(0.0980392, 0.0980392, 0.439216, 1)`` :ref:`🔗` Midnight blue color. @@ -933,7 +933,7 @@ Midnight blue color. .. rst-class:: classref-constant -**MINT_CREAM** = ``Color(0.960784, 1, 0.980392, 1)`` +**MINT_CREAM** = ``Color(0.960784, 1, 0.980392, 1)`` :ref:`🔗` Mint cream color. @@ -941,7 +941,7 @@ Mint cream color. .. rst-class:: classref-constant -**MISTY_ROSE** = ``Color(1, 0.894118, 0.882353, 1)`` +**MISTY_ROSE** = ``Color(1, 0.894118, 0.882353, 1)`` :ref:`🔗` Misty rose color. @@ -949,7 +949,7 @@ Misty rose color. .. rst-class:: classref-constant -**MOCCASIN** = ``Color(1, 0.894118, 0.709804, 1)`` +**MOCCASIN** = ``Color(1, 0.894118, 0.709804, 1)`` :ref:`🔗` Moccasin color. @@ -957,7 +957,7 @@ Moccasin color. .. rst-class:: classref-constant -**NAVAJO_WHITE** = ``Color(1, 0.870588, 0.678431, 1)`` +**NAVAJO_WHITE** = ``Color(1, 0.870588, 0.678431, 1)`` :ref:`🔗` Navajo white color. @@ -965,7 +965,7 @@ Navajo white color. .. rst-class:: classref-constant -**NAVY_BLUE** = ``Color(0, 0, 0.501961, 1)`` +**NAVY_BLUE** = ``Color(0, 0, 0.501961, 1)`` :ref:`🔗` Navy blue color. @@ -973,7 +973,7 @@ Navy blue color. .. rst-class:: classref-constant -**OLD_LACE** = ``Color(0.992157, 0.960784, 0.901961, 1)`` +**OLD_LACE** = ``Color(0.992157, 0.960784, 0.901961, 1)`` :ref:`🔗` Old lace color. @@ -981,7 +981,7 @@ Old lace color. .. rst-class:: classref-constant -**OLIVE** = ``Color(0.501961, 0.501961, 0, 1)`` +**OLIVE** = ``Color(0.501961, 0.501961, 0, 1)`` :ref:`🔗` Olive color. @@ -989,7 +989,7 @@ Olive color. .. rst-class:: classref-constant -**OLIVE_DRAB** = ``Color(0.419608, 0.556863, 0.137255, 1)`` +**OLIVE_DRAB** = ``Color(0.419608, 0.556863, 0.137255, 1)`` :ref:`🔗` Olive drab color. @@ -997,7 +997,7 @@ Olive drab color. .. rst-class:: classref-constant -**ORANGE** = ``Color(1, 0.647059, 0, 1)`` +**ORANGE** = ``Color(1, 0.647059, 0, 1)`` :ref:`🔗` Orange color. @@ -1005,7 +1005,7 @@ Orange color. .. rst-class:: classref-constant -**ORANGE_RED** = ``Color(1, 0.270588, 0, 1)`` +**ORANGE_RED** = ``Color(1, 0.270588, 0, 1)`` :ref:`🔗` Orange red color. @@ -1013,7 +1013,7 @@ Orange red color. .. rst-class:: classref-constant -**ORCHID** = ``Color(0.854902, 0.439216, 0.839216, 1)`` +**ORCHID** = ``Color(0.854902, 0.439216, 0.839216, 1)`` :ref:`🔗` Orchid color. @@ -1021,7 +1021,7 @@ Orchid color. .. rst-class:: classref-constant -**PALE_GOLDENROD** = ``Color(0.933333, 0.909804, 0.666667, 1)`` +**PALE_GOLDENROD** = ``Color(0.933333, 0.909804, 0.666667, 1)`` :ref:`🔗` Pale goldenrod color. @@ -1029,7 +1029,7 @@ Pale goldenrod color. .. rst-class:: classref-constant -**PALE_GREEN** = ``Color(0.596078, 0.984314, 0.596078, 1)`` +**PALE_GREEN** = ``Color(0.596078, 0.984314, 0.596078, 1)`` :ref:`🔗` Pale green color. @@ -1037,7 +1037,7 @@ Pale green color. .. rst-class:: classref-constant -**PALE_TURQUOISE** = ``Color(0.686275, 0.933333, 0.933333, 1)`` +**PALE_TURQUOISE** = ``Color(0.686275, 0.933333, 0.933333, 1)`` :ref:`🔗` Pale turquoise color. @@ -1045,7 +1045,7 @@ Pale turquoise color. .. rst-class:: classref-constant -**PALE_VIOLET_RED** = ``Color(0.858824, 0.439216, 0.576471, 1)`` +**PALE_VIOLET_RED** = ``Color(0.858824, 0.439216, 0.576471, 1)`` :ref:`🔗` Pale violet red color. @@ -1053,7 +1053,7 @@ Pale violet red color. .. rst-class:: classref-constant -**PAPAYA_WHIP** = ``Color(1, 0.937255, 0.835294, 1)`` +**PAPAYA_WHIP** = ``Color(1, 0.937255, 0.835294, 1)`` :ref:`🔗` Papaya whip color. @@ -1061,7 +1061,7 @@ Papaya whip color. .. rst-class:: classref-constant -**PEACH_PUFF** = ``Color(1, 0.854902, 0.72549, 1)`` +**PEACH_PUFF** = ``Color(1, 0.854902, 0.72549, 1)`` :ref:`🔗` Peach puff color. @@ -1069,7 +1069,7 @@ Peach puff color. .. rst-class:: classref-constant -**PERU** = ``Color(0.803922, 0.521569, 0.247059, 1)`` +**PERU** = ``Color(0.803922, 0.521569, 0.247059, 1)`` :ref:`🔗` Peru color. @@ -1077,7 +1077,7 @@ Peru color. .. rst-class:: classref-constant -**PINK** = ``Color(1, 0.752941, 0.796078, 1)`` +**PINK** = ``Color(1, 0.752941, 0.796078, 1)`` :ref:`🔗` Pink color. @@ -1085,7 +1085,7 @@ Pink color. .. rst-class:: classref-constant -**PLUM** = ``Color(0.866667, 0.627451, 0.866667, 1)`` +**PLUM** = ``Color(0.866667, 0.627451, 0.866667, 1)`` :ref:`🔗` Plum color. @@ -1093,7 +1093,7 @@ Plum color. .. rst-class:: classref-constant -**POWDER_BLUE** = ``Color(0.690196, 0.878431, 0.901961, 1)`` +**POWDER_BLUE** = ``Color(0.690196, 0.878431, 0.901961, 1)`` :ref:`🔗` Powder blue color. @@ -1101,7 +1101,7 @@ Powder blue color. .. rst-class:: classref-constant -**PURPLE** = ``Color(0.627451, 0.12549, 0.941176, 1)`` +**PURPLE** = ``Color(0.627451, 0.12549, 0.941176, 1)`` :ref:`🔗` Purple color. @@ -1109,7 +1109,7 @@ Purple color. .. rst-class:: classref-constant -**REBECCA_PURPLE** = ``Color(0.4, 0.2, 0.6, 1)`` +**REBECCA_PURPLE** = ``Color(0.4, 0.2, 0.6, 1)`` :ref:`🔗` Rebecca purple color. @@ -1117,7 +1117,7 @@ Rebecca purple color. .. rst-class:: classref-constant -**RED** = ``Color(1, 0, 0, 1)`` +**RED** = ``Color(1, 0, 0, 1)`` :ref:`🔗` Red color. @@ -1125,7 +1125,7 @@ Red color. .. rst-class:: classref-constant -**ROSY_BROWN** = ``Color(0.737255, 0.560784, 0.560784, 1)`` +**ROSY_BROWN** = ``Color(0.737255, 0.560784, 0.560784, 1)`` :ref:`🔗` Rosy brown color. @@ -1133,7 +1133,7 @@ Rosy brown color. .. rst-class:: classref-constant -**ROYAL_BLUE** = ``Color(0.254902, 0.411765, 0.882353, 1)`` +**ROYAL_BLUE** = ``Color(0.254902, 0.411765, 0.882353, 1)`` :ref:`🔗` Royal blue color. @@ -1141,7 +1141,7 @@ Royal blue color. .. rst-class:: classref-constant -**SADDLE_BROWN** = ``Color(0.545098, 0.270588, 0.0745098, 1)`` +**SADDLE_BROWN** = ``Color(0.545098, 0.270588, 0.0745098, 1)`` :ref:`🔗` Saddle brown color. @@ -1149,7 +1149,7 @@ Saddle brown color. .. rst-class:: classref-constant -**SALMON** = ``Color(0.980392, 0.501961, 0.447059, 1)`` +**SALMON** = ``Color(0.980392, 0.501961, 0.447059, 1)`` :ref:`🔗` Salmon color. @@ -1157,7 +1157,7 @@ Salmon color. .. rst-class:: classref-constant -**SANDY_BROWN** = ``Color(0.956863, 0.643137, 0.376471, 1)`` +**SANDY_BROWN** = ``Color(0.956863, 0.643137, 0.376471, 1)`` :ref:`🔗` Sandy brown color. @@ -1165,7 +1165,7 @@ Sandy brown color. .. rst-class:: classref-constant -**SEA_GREEN** = ``Color(0.180392, 0.545098, 0.341176, 1)`` +**SEA_GREEN** = ``Color(0.180392, 0.545098, 0.341176, 1)`` :ref:`🔗` Sea green color. @@ -1173,7 +1173,7 @@ Sea green color. .. rst-class:: classref-constant -**SEASHELL** = ``Color(1, 0.960784, 0.933333, 1)`` +**SEASHELL** = ``Color(1, 0.960784, 0.933333, 1)`` :ref:`🔗` Seashell color. @@ -1181,7 +1181,7 @@ Seashell color. .. rst-class:: classref-constant -**SIENNA** = ``Color(0.627451, 0.321569, 0.176471, 1)`` +**SIENNA** = ``Color(0.627451, 0.321569, 0.176471, 1)`` :ref:`🔗` Sienna color. @@ -1189,7 +1189,7 @@ Sienna color. .. rst-class:: classref-constant -**SILVER** = ``Color(0.752941, 0.752941, 0.752941, 1)`` +**SILVER** = ``Color(0.752941, 0.752941, 0.752941, 1)`` :ref:`🔗` Silver color. @@ -1197,7 +1197,7 @@ Silver color. .. rst-class:: classref-constant -**SKY_BLUE** = ``Color(0.529412, 0.807843, 0.921569, 1)`` +**SKY_BLUE** = ``Color(0.529412, 0.807843, 0.921569, 1)`` :ref:`🔗` Sky blue color. @@ -1205,7 +1205,7 @@ Sky blue color. .. rst-class:: classref-constant -**SLATE_BLUE** = ``Color(0.415686, 0.352941, 0.803922, 1)`` +**SLATE_BLUE** = ``Color(0.415686, 0.352941, 0.803922, 1)`` :ref:`🔗` Slate blue color. @@ -1213,7 +1213,7 @@ Slate blue color. .. rst-class:: classref-constant -**SLATE_GRAY** = ``Color(0.439216, 0.501961, 0.564706, 1)`` +**SLATE_GRAY** = ``Color(0.439216, 0.501961, 0.564706, 1)`` :ref:`🔗` Slate gray color. @@ -1221,7 +1221,7 @@ Slate gray color. .. rst-class:: classref-constant -**SNOW** = ``Color(1, 0.980392, 0.980392, 1)`` +**SNOW** = ``Color(1, 0.980392, 0.980392, 1)`` :ref:`🔗` Snow color. @@ -1229,7 +1229,7 @@ Snow color. .. rst-class:: classref-constant -**SPRING_GREEN** = ``Color(0, 1, 0.498039, 1)`` +**SPRING_GREEN** = ``Color(0, 1, 0.498039, 1)`` :ref:`🔗` Spring green color. @@ -1237,7 +1237,7 @@ Spring green color. .. rst-class:: classref-constant -**STEEL_BLUE** = ``Color(0.27451, 0.509804, 0.705882, 1)`` +**STEEL_BLUE** = ``Color(0.27451, 0.509804, 0.705882, 1)`` :ref:`🔗` Steel blue color. @@ -1245,7 +1245,7 @@ Steel blue color. .. rst-class:: classref-constant -**TAN** = ``Color(0.823529, 0.705882, 0.54902, 1)`` +**TAN** = ``Color(0.823529, 0.705882, 0.54902, 1)`` :ref:`🔗` Tan color. @@ -1253,7 +1253,7 @@ Tan color. .. rst-class:: classref-constant -**TEAL** = ``Color(0, 0.501961, 0.501961, 1)`` +**TEAL** = ``Color(0, 0.501961, 0.501961, 1)`` :ref:`🔗` Teal color. @@ -1261,7 +1261,7 @@ Teal color. .. rst-class:: classref-constant -**THISTLE** = ``Color(0.847059, 0.74902, 0.847059, 1)`` +**THISTLE** = ``Color(0.847059, 0.74902, 0.847059, 1)`` :ref:`🔗` Thistle color. @@ -1269,7 +1269,7 @@ Thistle color. .. rst-class:: classref-constant -**TOMATO** = ``Color(1, 0.388235, 0.278431, 1)`` +**TOMATO** = ``Color(1, 0.388235, 0.278431, 1)`` :ref:`🔗` Tomato color. @@ -1277,7 +1277,7 @@ Tomato color. .. rst-class:: classref-constant -**TRANSPARENT** = ``Color(1, 1, 1, 0)`` +**TRANSPARENT** = ``Color(1, 1, 1, 0)`` :ref:`🔗` Transparent color (white with zero alpha). @@ -1285,7 +1285,7 @@ Transparent color (white with zero alpha). .. rst-class:: classref-constant -**TURQUOISE** = ``Color(0.25098, 0.878431, 0.815686, 1)`` +**TURQUOISE** = ``Color(0.25098, 0.878431, 0.815686, 1)`` :ref:`🔗` Turquoise color. @@ -1293,7 +1293,7 @@ Turquoise color. .. rst-class:: classref-constant -**VIOLET** = ``Color(0.933333, 0.509804, 0.933333, 1)`` +**VIOLET** = ``Color(0.933333, 0.509804, 0.933333, 1)`` :ref:`🔗` Violet color. @@ -1301,7 +1301,7 @@ Violet color. .. rst-class:: classref-constant -**WEB_GRAY** = ``Color(0.501961, 0.501961, 0.501961, 1)`` +**WEB_GRAY** = ``Color(0.501961, 0.501961, 0.501961, 1)`` :ref:`🔗` Web gray color. @@ -1309,7 +1309,7 @@ Web gray color. .. rst-class:: classref-constant -**WEB_GREEN** = ``Color(0, 0.501961, 0, 1)`` +**WEB_GREEN** = ``Color(0, 0.501961, 0, 1)`` :ref:`🔗` Web green color. @@ -1317,7 +1317,7 @@ Web green color. .. rst-class:: classref-constant -**WEB_MAROON** = ``Color(0.501961, 0, 0, 1)`` +**WEB_MAROON** = ``Color(0.501961, 0, 0, 1)`` :ref:`🔗` Web maroon color. @@ -1325,7 +1325,7 @@ Web maroon color. .. rst-class:: classref-constant -**WEB_PURPLE** = ``Color(0.501961, 0, 0.501961, 1)`` +**WEB_PURPLE** = ``Color(0.501961, 0, 0.501961, 1)`` :ref:`🔗` Web purple color. @@ -1333,7 +1333,7 @@ Web purple color. .. rst-class:: classref-constant -**WHEAT** = ``Color(0.960784, 0.870588, 0.701961, 1)`` +**WHEAT** = ``Color(0.960784, 0.870588, 0.701961, 1)`` :ref:`🔗` Wheat color. @@ -1341,7 +1341,7 @@ Wheat color. .. rst-class:: classref-constant -**WHITE** = ``Color(1, 1, 1, 1)`` +**WHITE** = ``Color(1, 1, 1, 1)`` :ref:`🔗` White color. @@ -1349,7 +1349,7 @@ White color. .. rst-class:: classref-constant -**WHITE_SMOKE** = ``Color(0.960784, 0.960784, 0.960784, 1)`` +**WHITE_SMOKE** = ``Color(0.960784, 0.960784, 0.960784, 1)`` :ref:`🔗` White smoke color. @@ -1357,7 +1357,7 @@ White smoke color. .. rst-class:: classref-constant -**YELLOW** = ``Color(1, 1, 0, 1)`` +**YELLOW** = ``Color(1, 1, 0, 1)`` :ref:`🔗` Yellow color. @@ -1365,7 +1365,7 @@ Yellow color. .. rst-class:: classref-constant -**YELLOW_GREEN** = ``Color(0.603922, 0.803922, 0.196078, 1)`` +**YELLOW_GREEN** = ``Color(0.603922, 0.803922, 0.196078, 1)`` :ref:`🔗` Yellow green color. @@ -1382,7 +1382,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **a** = ``1.0`` +:ref:`float` **a** = ``1.0`` :ref:`🔗` The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque. @@ -1394,7 +1394,7 @@ The color's alpha component, typically on the range of 0 to 1. A value of 0 mean .. rst-class:: classref-property -:ref:`int` **a8** = ``255`` +:ref:`int` **a8** = ``255`` :ref:`🔗` Wrapper for :ref:`a` that uses the range 0 to 255, instead of 0 to 1. @@ -1406,7 +1406,7 @@ Wrapper for :ref:`a` that uses the range 0 to 255, inste .. rst-class:: classref-property -:ref:`float` **b** = ``0.0`` +:ref:`float` **b** = ``0.0`` :ref:`🔗` The color's blue component, typically on the range of 0 to 1. @@ -1418,7 +1418,7 @@ The color's blue component, typically on the range of 0 to 1. .. rst-class:: classref-property -:ref:`int` **b8** = ``0`` +:ref:`int` **b8** = ``0`` :ref:`🔗` Wrapper for :ref:`b` that uses the range 0 to 255, instead of 0 to 1. @@ -1430,7 +1430,7 @@ Wrapper for :ref:`b` that uses the range 0 to 255, inste .. rst-class:: classref-property -:ref:`float` **g** = ``0.0`` +:ref:`float` **g** = ``0.0`` :ref:`🔗` The color's green component, typically on the range of 0 to 1. @@ -1442,7 +1442,7 @@ The color's green component, typically on the range of 0 to 1. .. rst-class:: classref-property -:ref:`int` **g8** = ``0`` +:ref:`int` **g8** = ``0`` :ref:`🔗` Wrapper for :ref:`g` that uses the range 0 to 255, instead of 0 to 1. @@ -1454,7 +1454,7 @@ Wrapper for :ref:`g` that uses the range 0 to 255, inste .. rst-class:: classref-property -:ref:`float` **h** = ``0.0`` +:ref:`float` **h** = ``0.0`` :ref:`🔗` The HSV hue of this color, on the range 0 to 1. @@ -1466,7 +1466,7 @@ The HSV hue of this color, on the range 0 to 1. .. rst-class:: classref-property -:ref:`float` **r** = ``0.0`` +:ref:`float` **r** = ``0.0`` :ref:`🔗` The color's red component, typically on the range of 0 to 1. @@ -1478,7 +1478,7 @@ The color's red component, typically on the range of 0 to 1. .. rst-class:: classref-property -:ref:`int` **r8** = ``0`` +:ref:`int` **r8** = ``0`` :ref:`🔗` Wrapper for :ref:`r` that uses the range 0 to 255, instead of 0 to 1. @@ -1490,7 +1490,7 @@ Wrapper for :ref:`r` that uses the range 0 to 255, inste .. rst-class:: classref-property -:ref:`float` **s** = ``0.0`` +:ref:`float` **s** = ``0.0`` :ref:`🔗` The HSV saturation of this color, on the range 0 to 1. @@ -1502,7 +1502,7 @@ The HSV saturation of this color, on the range 0 to 1. .. rst-class:: classref-property -:ref:`float` **v** = ``0.0`` +:ref:`float` **v** = ``0.0`` :ref:`🔗` The HSV value (brightness) of this color, on the range 0 to 1. @@ -1519,7 +1519,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Color` **Color**\ (\ ) +:ref:`Color` **Color**\ (\ ) :ref:`🔗` Constructs a default **Color** from opaque black. This is the same as :ref:`BLACK`. @@ -1637,7 +1637,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Color` **blend**\ (\ over\: :ref:`Color`\ ) |const| +:ref:`Color` **blend**\ (\ over\: :ref:`Color`\ ) |const| :ref:`🔗` Returns a new color resulting from overlaying this color over the given color. In a painting program, you can imagine it as the ``over`` color painted over this color (including alpha). @@ -1666,7 +1666,7 @@ Returns a new color resulting from overlaying this color over the given color. I .. rst-class:: classref-method -:ref:`Color` **clamp**\ (\ min\: :ref:`Color` = Color(0, 0, 0, 0), max\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +:ref:`Color` **clamp**\ (\ min\: :ref:`Color` = Color(0, 0, 0, 0), max\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Returns a new color with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -1678,7 +1678,7 @@ Returns a new color with all components clamped between the components of ``min` .. rst-class:: classref-method -:ref:`Color` **darkened**\ (\ amount\: :ref:`float`\ ) |const| +:ref:`Color` **darkened**\ (\ amount\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new color resulting from making this color darker by the specified ``amount`` (ratio from 0.0 to 1.0). See also :ref:`lightened`. @@ -1705,7 +1705,7 @@ Returns a new color resulting from making this color darker by the specified ``a .. rst-class:: classref-method -:ref:`Color` **from_hsv**\ (\ h\: :ref:`float`, s\: :ref:`float`, v\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| +:ref:`Color` **from_hsv**\ (\ h\: :ref:`float`, s\: :ref:`float`, v\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| :ref:`🔗` Constructs a color from an `HSV profile `__. The hue (``h``), saturation (``s``), and value (``v``) are typically between 0.0 and 1.0. @@ -1730,7 +1730,7 @@ Constructs a color from an `HSV profile ` **from_ok_hsl**\ (\ h\: :ref:`float`, s\: :ref:`float`, l\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| +:ref:`Color` **from_ok_hsl**\ (\ h\: :ref:`float`, s\: :ref:`float`, l\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| :ref:`🔗` Constructs a color from an `OK HSL profile `__. The hue (``h``), saturation (``s``), and lightness (``l``) are typically between 0.0 and 1.0. @@ -1755,7 +1755,7 @@ Constructs a color from an `OK HSL profile ` **from_rgbe9995**\ (\ rgbe\: :ref:`int`\ ) |static| +:ref:`Color` **from_rgbe9995**\ (\ rgbe\: :ref:`int`\ ) |static| :ref:`🔗` Decodes a **Color** from an RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995`. @@ -1767,7 +1767,7 @@ Decodes a **Color** from an RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE .. rst-class:: classref-method -:ref:`Color` **from_string**\ (\ str\: :ref:`String`, default\: :ref:`Color`\ ) |static| +:ref:`Color` **from_string**\ (\ str\: :ref:`String`, default\: :ref:`Color`\ ) |static| :ref:`🔗` Creates a **Color** from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns ``default`` if the color cannot be inferred from the string. @@ -1779,7 +1779,7 @@ Creates a **Color** from the given string, which can be either an HTML color cod .. rst-class:: classref-method -:ref:`float` **get_luminance**\ (\ ) |const| +:ref:`float` **get_luminance**\ (\ ) |const| :ref:`🔗` Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclusive). This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark. @@ -1793,7 +1793,7 @@ Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclus .. rst-class:: classref-method -:ref:`Color` **hex**\ (\ hex\: :ref:`int`\ ) |static| +:ref:`Color` **hex**\ (\ hex\: :ref:`int`\ ) |static| :ref:`🔗` Returns the **Color** associated with the provided ``hex`` integer in 32-bit RGBA format (8 bits per channel). @@ -1824,7 +1824,7 @@ In GDScript and C#, the :ref:`int` is best visualized with hexadecima .. rst-class:: classref-method -:ref:`Color` **hex64**\ (\ hex\: :ref:`int`\ ) |static| +:ref:`Color` **hex64**\ (\ hex\: :ref:`int`\ ) |static| :ref:`🔗` Returns the **Color** associated with the provided ``hex`` integer in 64-bit RGBA format (16 bits per channel). @@ -1838,7 +1838,7 @@ In GDScript and C#, the :ref:`int` is best visualized with hexadecima .. rst-class:: classref-method -:ref:`Color` **html**\ (\ rgba\: :ref:`String`\ ) |static| +:ref:`Color` **html**\ (\ rgba\: :ref:`String`\ ) |static| :ref:`🔗` Returns a new color from ``rgba``, an HTML hexadecimal color string. ``rgba`` is not case-sensitive, and may be prefixed by a hash sign (``#``). @@ -1869,7 +1869,7 @@ Returns a new color from ``rgba``, an HTML hexadecimal color string. ``rgba`` is .. rst-class:: classref-method -:ref:`bool` **html_is_valid**\ (\ color\: :ref:`String`\ ) |static| +:ref:`bool` **html_is_valid**\ (\ color\: :ref:`String`\ ) |static| :ref:`🔗` Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The string must be a hexadecimal value (case-insensitive) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). This method is identical to :ref:`String.is_valid_html_color`. @@ -1906,7 +1906,7 @@ Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The stri .. rst-class:: classref-method -:ref:`Color` **inverted**\ (\ ) |const| +:ref:`Color` **inverted**\ (\ ) |const| :ref:`🔗` Returns the color with its :ref:`r`, :ref:`g`, and :ref:`b` components inverted (``(1 - r, 1 - g, 1 - b, a)``). @@ -1935,7 +1935,7 @@ Returns the color with its :ref:`r`, :ref:`g` **is_equal_approx**\ (\ to\: :ref:`Color`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Color`\ ) |const| :ref:`🔗` Returns ``true`` if this color and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -1947,7 +1947,7 @@ Returns ``true`` if this color and ``to`` are approximately equal, by running :r .. rst-class:: classref-method -:ref:`Color` **lerp**\ (\ to\: :ref:`Color`, weight\: :ref:`float`\ ) |const| +:ref:`Color` **lerp**\ (\ to\: :ref:`Color`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the linear interpolation between this color's components and ``to``'s components. The interpolation factor ``weight`` should be between 0.0 and 1.0 (inclusive). See also :ref:`@GlobalScope.lerp`. @@ -1982,7 +1982,7 @@ Returns the linear interpolation between this color's components and ``to``'s co .. rst-class:: classref-method -:ref:`Color` **lightened**\ (\ amount\: :ref:`float`\ ) |const| +:ref:`Color` **lightened**\ (\ amount\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new color resulting from making this color lighter by the specified ``amount``, which should be a ratio from 0.0 to 1.0. See also :ref:`darkened`. @@ -2009,7 +2009,7 @@ Returns a new color resulting from making this color lighter by the specified `` .. rst-class:: classref-method -:ref:`Color` **linear_to_srgb**\ (\ ) |const| +:ref:`Color` **linear_to_srgb**\ (\ ) |const| :ref:`🔗` Returns the color converted to the `sRGB `__ color space. This method assumes the original color is in the linear color space. See also :ref:`srgb_to_linear` which performs the opposite operation. @@ -2021,7 +2021,7 @@ Returns the color converted to the `sRGB `__ .. rst-class:: classref-method -:ref:`Color` **srgb_to_linear**\ (\ ) |const| +:ref:`Color` **srgb_to_linear**\ (\ ) |const| :ref:`🔗` Returns the color converted to the linear color space. This method assumes the original color already is in the sRGB color space. See also :ref:`linear_to_srgb` which performs the opposite operation. @@ -2033,7 +2033,7 @@ Returns the color converted to the linear color space. This method assumes the o .. rst-class:: classref-method -:ref:`int` **to_abgr32**\ (\ ) |const| +:ref:`int` **to_abgr32**\ (\ ) |const| :ref:`🔗` Returns the color converted to a 32-bit integer in ABGR format (each component is 8 bits). ABGR is the reversed version of the default RGBA format. @@ -2060,7 +2060,7 @@ Returns the color converted to a 32-bit integer in ABGR format (each component i .. rst-class:: classref-method -:ref:`int` **to_abgr64**\ (\ ) |const| +:ref:`int` **to_abgr64**\ (\ ) |const| :ref:`🔗` Returns the color converted to a 64-bit integer in ABGR format (each component is 16 bits). ABGR is the reversed version of the default RGBA format. @@ -2087,7 +2087,7 @@ Returns the color converted to a 64-bit integer in ABGR format (each component i .. rst-class:: classref-method -:ref:`int` **to_argb32**\ (\ ) |const| +:ref:`int` **to_argb32**\ (\ ) |const| :ref:`🔗` Returns the color converted to a 32-bit integer in ARGB format (each component is 8 bits). ARGB is more compatible with DirectX. @@ -2114,7 +2114,7 @@ Returns the color converted to a 32-bit integer in ARGB format (each component i .. rst-class:: classref-method -:ref:`int` **to_argb64**\ (\ ) |const| +:ref:`int` **to_argb64**\ (\ ) |const| :ref:`🔗` Returns the color converted to a 64-bit integer in ARGB format (each component is 16 bits). ARGB is more compatible with DirectX. @@ -2141,7 +2141,7 @@ Returns the color converted to a 64-bit integer in ARGB format (each component i .. rst-class:: classref-method -:ref:`String` **to_html**\ (\ with_alpha\: :ref:`bool` = true\ ) |const| +:ref:`String` **to_html**\ (\ with_alpha\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns the color converted to an HTML hexadecimal color :ref:`String` in RGBA format, without the hash (``#``) prefix. @@ -2172,7 +2172,7 @@ Setting ``with_alpha`` to ``false``, excludes alpha from the hexadecimal string, .. rst-class:: classref-method -:ref:`int` **to_rgba32**\ (\ ) |const| +:ref:`int` **to_rgba32**\ (\ ) |const| :ref:`🔗` Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. @@ -2199,7 +2199,7 @@ Returns the color converted to a 32-bit integer in RGBA format (each component i .. rst-class:: classref-method -:ref:`int` **to_rgba64**\ (\ ) |const| +:ref:`int` **to_rgba64**\ (\ ) |const| :ref:`🔗` Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. @@ -2231,7 +2231,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Color`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Returns ``true`` if the colors are not exactly equal. @@ -2245,7 +2245,7 @@ Returns ``true`` if the colors are not exactly equal. .. rst-class:: classref-operator -:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) +:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Multiplies each component of the **Color** by the components of the given **Color**. @@ -2257,7 +2257,7 @@ Multiplies each component of the **Color** by the components of the given **Colo .. rst-class:: classref-operator -:ref:`Color` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Color` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Color** by the given :ref:`float`. @@ -2269,7 +2269,7 @@ Multiplies each component of the **Color** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Color` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Color` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Color** by the given :ref:`int`. @@ -2281,7 +2281,7 @@ Multiplies each component of the **Color** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Color` **operator +**\ (\ right\: :ref:`Color`\ ) +:ref:`Color` **operator +**\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Adds each component of the **Color** with the components of the given **Color**. @@ -2293,7 +2293,7 @@ Adds each component of the **Color** with the components of the given **Color**. .. rst-class:: classref-operator -:ref:`Color` **operator -**\ (\ right\: :ref:`Color`\ ) +:ref:`Color` **operator -**\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Subtracts each component of the **Color** by the components of the given **Color**. @@ -2305,7 +2305,7 @@ Subtracts each component of the **Color** by the components of the given **Color .. rst-class:: classref-operator -:ref:`Color` **operator /**\ (\ right\: :ref:`Color`\ ) +:ref:`Color` **operator /**\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Divides each component of the **Color** by the components of the given **Color**. @@ -2317,7 +2317,7 @@ Divides each component of the **Color** by the components of the given **Color** .. rst-class:: classref-operator -:ref:`Color` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Color` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Color** by the given :ref:`float`. @@ -2329,7 +2329,7 @@ Divides each component of the **Color** by the given :ref:`float`. .. rst-class:: classref-operator -:ref:`Color` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Color` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Color** by the given :ref:`int`. @@ -2341,7 +2341,7 @@ Divides each component of the **Color** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Color`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Returns ``true`` if the colors are exactly equal. @@ -2355,7 +2355,7 @@ Returns ``true`` if the colors are exactly equal. .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access color components using their index. ``[0]`` is equivalent to :ref:`r`, ``[1]`` is equivalent to :ref:`g`, ``[2]`` is equivalent to :ref:`b`, and ``[3]`` is equivalent to :ref:`a`. @@ -2367,7 +2367,7 @@ Access color components using their index. ``[0]`` is equivalent to :ref:`r` **operator unary+**\ (\ ) +:ref:`Color` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -2379,7 +2379,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Color` **operator unary-**\ (\ ) +:ref:`Color` **operator unary-**\ (\ ) :ref:`🔗` Inverts the given color. This is equivalent to ``Color.WHITE - c`` or ``Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)``. Unlike with :ref:`inverted`, the :ref:`a` component is inverted, too. diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 9748af112a0..d54507532df 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -147,7 +147,7 @@ Signals .. rst-class:: classref-signal -**color_changed**\ (\ color\: :ref:`Color`\ ) +**color_changed**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Emitted when the color is changed. @@ -159,7 +159,7 @@ Emitted when the color is changed. .. rst-class:: classref-signal -**preset_added**\ (\ color\: :ref:`Color`\ ) +**preset_added**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Emitted when a preset is added. @@ -171,7 +171,7 @@ Emitted when a preset is added. .. rst-class:: classref-signal -**preset_removed**\ (\ color\: :ref:`Color`\ ) +**preset_removed**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Emitted when a preset is removed. @@ -188,7 +188,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ColorModeType**: +enum **ColorModeType**: :ref:`🔗` .. _class_ColorPicker_constant_MODE_RGB: @@ -234,7 +234,7 @@ OKHSL is a new color space similar to HSL but that better match perception by le .. rst-class:: classref-enumeration -enum **PickerShapeType**: +enum **PickerShapeType**: :ref:`🔗` .. _class_ColorPicker_constant_SHAPE_HSV_RECTANGLE: @@ -289,7 +289,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **can_add_swatches** = ``true`` +:ref:`bool` **can_add_swatches** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ If ``true``, it's possible to add presets under Swatches. If ``false``, the butt .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ The currently selected color. .. rst-class:: classref-property -:ref:`ColorModeType` **color_mode** = ``0`` +:ref:`ColorModeType` **color_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ The currently selected color mode. See :ref:`ColorModeType` **color_modes_visible** = ``true`` +:ref:`bool` **color_modes_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -357,7 +357,7 @@ If ``true``, the color mode buttons are visible. .. rst-class:: classref-property -:ref:`bool` **deferred_mode** = ``false`` +:ref:`bool` **deferred_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -374,7 +374,7 @@ If ``true``, the color will apply only after the user releases the mouse button, .. rst-class:: classref-property -:ref:`bool` **edit_alpha** = ``true`` +:ref:`bool` **edit_alpha** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -391,7 +391,7 @@ If ``true``, shows an alpha channel slider (opacity). .. rst-class:: classref-property -:ref:`bool` **hex_visible** = ``true`` +:ref:`bool` **hex_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -408,7 +408,7 @@ If ``true``, the hex color code input field is visible. .. rst-class:: classref-property -:ref:`PickerShapeType` **picker_shape** = ``0`` +:ref:`PickerShapeType` **picker_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -425,7 +425,7 @@ The shape of the color space view. See :ref:`PickerShapeType` **presets_visible** = ``true`` +:ref:`bool` **presets_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -442,7 +442,7 @@ If ``true``, the Swatches and Recent Colors presets are visible. .. rst-class:: classref-property -:ref:`bool` **sampler_visible** = ``true`` +:ref:`bool` **sampler_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -459,7 +459,7 @@ If ``true``, the color sampler and color preview are visible. .. rst-class:: classref-property -:ref:`bool` **sliders_visible** = ``true`` +:ref:`bool` **sliders_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -481,7 +481,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_preset**\ (\ color\: :ref:`Color`\ ) +|void| **add_preset**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. @@ -495,7 +495,7 @@ Adds the given color to a list of color presets. The presets are displayed in th .. rst-class:: classref-method -|void| **add_recent_preset**\ (\ color\: :ref:`Color`\ ) +|void| **add_recent_preset**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Adds the given color to a list of color recent presets so that it can be picked later. Recent presets are the colors that were picked recently, a new preset is automatically created and added to recent presets when you pick a new color. @@ -509,7 +509,7 @@ Adds the given color to a list of color recent presets so that it can be picked .. rst-class:: classref-method -|void| **erase_preset**\ (\ color\: :ref:`Color`\ ) +|void| **erase_preset**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Removes the given color from the list of color presets of this color picker. @@ -521,7 +521,7 @@ Removes the given color from the list of color presets of this color picker. .. rst-class:: classref-method -|void| **erase_recent_preset**\ (\ color\: :ref:`Color`\ ) +|void| **erase_recent_preset**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Removes the given color from the list of color recent presets of this color picker. @@ -533,7 +533,7 @@ Removes the given color from the list of color recent presets of this color pick .. rst-class:: classref-method -:ref:`PackedColorArray` **get_presets**\ (\ ) |const| +:ref:`PackedColorArray` **get_presets**\ (\ ) |const| :ref:`🔗` Returns the list of colors in the presets of the color picker. @@ -545,7 +545,7 @@ Returns the list of colors in the presets of the color picker. .. rst-class:: classref-method -:ref:`PackedColorArray` **get_recent_presets**\ (\ ) |const| +:ref:`PackedColorArray` **get_recent_presets**\ (\ ) |const| :ref:`🔗` Returns the list of colors in the recent presets of the color picker. @@ -562,7 +562,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **center_slider_grabbers** = ``1`` +:ref:`int` **center_slider_grabbers** = ``1`` :ref:`🔗` Overrides the :ref:`Slider.center_grabber` theme property of the sliders. @@ -574,7 +574,7 @@ Overrides the :ref:`Slider.center_grabber` **h_width** = ``30`` +:ref:`int` **h_width** = ``30`` :ref:`🔗` The width of the hue selection slider. @@ -586,7 +586,7 @@ The width of the hue selection slider. .. rst-class:: classref-themeproperty -:ref:`int` **label_width** = ``10`` +:ref:`int` **label_width** = ``10`` :ref:`🔗` The minimum width of the color labels next to sliders. @@ -598,7 +598,7 @@ The minimum width of the color labels next to sliders. .. rst-class:: classref-themeproperty -:ref:`int` **margin** = ``4`` +:ref:`int` **margin** = ``4`` :ref:`🔗` The margin around the **ColorPicker**. @@ -610,7 +610,7 @@ The margin around the **ColorPicker**. .. rst-class:: classref-themeproperty -:ref:`int` **sv_height** = ``256`` +:ref:`int` **sv_height** = ``256`` :ref:`🔗` The height of the saturation-value selection box. @@ -622,7 +622,7 @@ The height of the saturation-value selection box. .. rst-class:: classref-themeproperty -:ref:`int` **sv_width** = ``256`` +:ref:`int` **sv_width** = ``256`` :ref:`🔗` The width of the saturation-value selection box. @@ -634,7 +634,7 @@ The width of the saturation-value selection box. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **add_preset** +:ref:`Texture2D` **add_preset** :ref:`🔗` The icon for the "Add Preset" button. @@ -646,7 +646,7 @@ The icon for the "Add Preset" button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **bar_arrow** +:ref:`Texture2D` **bar_arrow** :ref:`🔗` The texture for the arrow grabber. @@ -658,7 +658,7 @@ The texture for the arrow grabber. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **color_hue** +:ref:`Texture2D` **color_hue** :ref:`🔗` Custom texture for the hue selection slider on the right. @@ -670,7 +670,7 @@ Custom texture for the hue selection slider on the right. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **color_okhsl_hue** +:ref:`Texture2D` **color_okhsl_hue** :ref:`🔗` Custom texture for the H slider in the OKHSL color mode. @@ -682,7 +682,7 @@ Custom texture for the H slider in the OKHSL color mode. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **expanded_arrow** +:ref:`Texture2D` **expanded_arrow** :ref:`🔗` The icon for color preset drop down menu when expanded. @@ -694,7 +694,7 @@ The icon for color preset drop down menu when expanded. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **folded_arrow** +:ref:`Texture2D` **folded_arrow** :ref:`🔗` The icon for color preset drop down menu when folded. @@ -706,7 +706,7 @@ The icon for color preset drop down menu when folded. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **overbright_indicator** +:ref:`Texture2D` **overbright_indicator** :ref:`🔗` The indicator used to signalize that the color value is outside the 0-1 range. @@ -718,7 +718,7 @@ The indicator used to signalize that the color value is outside the 0-1 range. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **picker_cursor** +:ref:`Texture2D` **picker_cursor** :ref:`🔗` The image displayed over the color box/circle (depending on the :ref:`picker_shape`), marking the currently selected color. @@ -730,7 +730,7 @@ The image displayed over the color box/circle (depending on the :ref:`picker_sha .. rst-class:: classref-themeproperty -:ref:`Texture2D` **sample_bg** +:ref:`Texture2D` **sample_bg** :ref:`🔗` Background panel for the color preview box (visible when the color is translucent). @@ -742,7 +742,7 @@ Background panel for the color preview box (visible when the color is translucen .. rst-class:: classref-themeproperty -:ref:`Texture2D` **sample_revert** +:ref:`Texture2D` **sample_revert** :ref:`🔗` The icon for the revert button (visible on the middle of the "old" color when it differs from the currently selected color). This icon is modulated with a dark color if the "old" color is bright enough, so the icon should be bright to ensure visibility in both scenarios. @@ -754,7 +754,7 @@ The icon for the revert button (visible on the middle of the "old" color when it .. rst-class:: classref-themeproperty -:ref:`Texture2D` **screen_picker** +:ref:`Texture2D` **screen_picker** :ref:`🔗` The icon for the screen color picker button. @@ -766,7 +766,7 @@ The icon for the screen color picker button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **shape_circle** +:ref:`Texture2D` **shape_circle** :ref:`🔗` The icon for circular picker shapes. @@ -778,7 +778,7 @@ The icon for circular picker shapes. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **shape_rect** +:ref:`Texture2D` **shape_rect** :ref:`🔗` The icon for rectangular picker shapes. @@ -790,7 +790,7 @@ The icon for rectangular picker shapes. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **shape_rect_wheel** +:ref:`Texture2D` **shape_rect_wheel** :ref:`🔗` The icon for rectangular wheel picker shapes. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 73682f8cf40..4491271d817 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -89,7 +89,7 @@ Signals .. rst-class:: classref-signal -**color_changed**\ (\ color\: :ref:`Color`\ ) +**color_changed**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Emitted when the color changes. @@ -101,7 +101,7 @@ Emitted when the color changes. .. rst-class:: classref-signal -**picker_created**\ (\ ) +**picker_created**\ (\ ) :ref:`🔗` Emitted when the :ref:`ColorPicker` is created (the button is pressed for the first time). @@ -113,7 +113,7 @@ Emitted when the :ref:`ColorPicker` is created (the button is .. rst-class:: classref-signal -**popup_closed**\ (\ ) +**popup_closed**\ (\ ) :ref:`🔗` Emitted when the :ref:`ColorPicker` is closed. @@ -130,7 +130,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The currently selected color. .. rst-class:: classref-property -:ref:`bool` **edit_alpha** = ``true`` +:ref:`bool` **edit_alpha** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ColorPicker` **get_picker**\ (\ ) +:ref:`ColorPicker` **get_picker**\ (\ ) :ref:`🔗` Returns the :ref:`ColorPicker` that this node toggles. @@ -183,7 +183,7 @@ Returns the :ref:`ColorPicker` that this node toggles. .. rst-class:: classref-method -:ref:`PopupPanel` **get_popup**\ (\ ) +:ref:`PopupPanel` **get_popup**\ (\ ) :ref:`🔗` 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. @@ -202,7 +202,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Texture2D` **bg** +:ref:`Texture2D` **bg** :ref:`🔗` The background of the color preview rect on the button. diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 458a146a201..fcfcb2ef07e 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -53,7 +53,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_compositor.rst b/classes/class_compositor.rst index 77cd55b4ab1..ec0e40c519f 100644 --- a/classes/class_compositor.rst +++ b/classes/class_compositor.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array`\[:ref:`CompositorEffect`\] **compositor_effects** = ``[]`` +:ref:`Array`\[:ref:`CompositorEffect`\] **compositor_effects** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_compositoreffect.rst b/classes/class_compositoreffect.rst index bbc7dbf0b5f..fc44b84775d 100644 --- a/classes/class_compositoreffect.rst +++ b/classes/class_compositoreffect.rst @@ -72,7 +72,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **EffectCallbackType**: +enum **EffectCallbackType**: :ref:`🔗` .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_PRE_OPAQUE: @@ -135,7 +135,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **access_resolved_color** +:ref:`bool` **access_resolved_color** :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ If ``true`` and MSAA is enabled, this will trigger a color buffer resolve before .. rst-class:: classref-property -:ref:`bool` **access_resolved_depth** +:ref:`bool` **access_resolved_depth** :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ If ``true`` and MSAA is enabled, this will trigger a depth buffer resolve before .. rst-class:: classref-property -:ref:`EffectCallbackType` **effect_callback_type** +:ref:`EffectCallbackType` **effect_callback_type** :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ The type of effect that is implemented, determines at what stage of rendering th .. rst-class:: classref-property -:ref:`bool` **enabled** +:ref:`bool` **enabled** :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If ``true`` this rendering effect is applied to any viewport it is added to. .. rst-class:: classref-property -:ref:`bool` **needs_motion_vectors** +:ref:`bool` **needs_motion_vectors** :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ If ``true`` this triggers motion vectors being calculated during the opaque rend .. rst-class:: classref-property -:ref:`bool` **needs_normal_roughness** +:ref:`bool` **needs_normal_roughness** :ref:`🔗` .. rst-class:: classref-property-setget @@ -265,7 +265,7 @@ If ``true`` this triggers normal and roughness data to be output during our dept .. rst-class:: classref-property -:ref:`bool` **needs_separate_specular** +:ref:`bool` **needs_separate_specular** :ref:`🔗` .. rst-class:: classref-property-setget @@ -287,7 +287,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_render_callback**\ (\ effect_callback_type\: :ref:`int`, render_data\: :ref:`RenderData`\ ) |virtual| +|void| **_render_callback**\ (\ effect_callback_type\: :ref:`int`, render_data\: :ref:`RenderData`\ ) |virtual| :ref:`🔗` Implement this function with your custom rendering code. ``effect_callback_type`` should always match the effect callback type you've specified in :ref:`effect_callback_type`. ``render_data`` provides access to the rendering state, it is only valid during rendering and should not be stored. diff --git a/classes/class_compressedtexture2d.rst b/classes/class_compressedtexture2d.rst index d9ffa1cf611..85975f8eec4 100644 --- a/classes/class_compressedtexture2d.rst +++ b/classes/class_compressedtexture2d.rst @@ -74,7 +74,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **load_path** = ``""`` +:ref:`String` **load_path** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads the texture from the specified ``path``. diff --git a/classes/class_compressedtexture3d.rst b/classes/class_compressedtexture3d.rst index b88c5a1bb3c..304660acfd2 100644 --- a/classes/class_compressedtexture3d.rst +++ b/classes/class_compressedtexture3d.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **load_path** = ``""`` +:ref:`String` **load_path** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -84,7 +84,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads the texture from the specified ``path``. diff --git a/classes/class_compressedtexturelayered.rst b/classes/class_compressedtexturelayered.rst index f14ef46aeee..992116fb018 100644 --- a/classes/class_compressedtexturelayered.rst +++ b/classes/class_compressedtexturelayered.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **load_path** = ``""`` +:ref:`String` **load_path** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -82,7 +82,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads the texture at ``path``. diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 25ff0a483bf..e319eb4038c 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedVector2Array` **segments** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **segments** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_concavepolygonshape3d.rst b/classes/class_concavepolygonshape3d.rst index 1a148478e06..c5ac1eecf2a 100644 --- a/classes/class_concavepolygonshape3d.rst +++ b/classes/class_concavepolygonshape3d.rst @@ -75,7 +75,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **backface_collision** = ``false`` +:ref:`bool` **backface_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| +:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| :ref:`🔗` Returns the faces of the trimesh shape as an array of vertices. The array (of length divisible by three) is naturally divided into triples; each triple of vertices defines a triangle. @@ -109,7 +109,7 @@ Returns the faces of the trimesh shape as an array of vertices. The array (of le .. rst-class:: classref-method -|void| **set_faces**\ (\ faces\: :ref:`PackedVector3Array`\ ) +|void| **set_faces**\ (\ faces\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Sets the faces of the trimesh shape from an array of vertices. The ``faces`` array should be composed of triples such that each triple of vertices defines a triangle. diff --git a/classes/class_conetwistjoint3d.rst b/classes/class_conetwistjoint3d.rst index 079ca1eb9b3..b3b13cb57b3 100644 --- a/classes/class_conetwistjoint3d.rst +++ b/classes/class_conetwistjoint3d.rst @@ -68,7 +68,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Param**: +enum **Param**: :ref:`🔗` .. _class_ConeTwistJoint3D_constant_PARAM_SWING_SPAN: @@ -141,7 +141,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bias** = ``0.3`` +:ref:`float` **bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -160,7 +160,7 @@ The higher, the faster. .. rst-class:: classref-property -:ref:`float` **relaxation** = ``1.0`` +:ref:`float` **relaxation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -177,7 +177,7 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce .. rst-class:: classref-property -:ref:`float` **softness** = ``0.8`` +:ref:`float` **softness** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -194,7 +194,7 @@ The ease with which the joint starts to twist. If it's too low, it takes more fo .. rst-class:: classref-property -:ref:`float` **swing_span** = ``0.785398`` +:ref:`float` **swing_span** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If below 0.05, this behavior is locked. .. rst-class:: classref-property -:ref:`float` **twist_span** = ``3.14159`` +:ref:`float` **twist_span** = ``3.14159`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the specified parameter. @@ -253,7 +253,7 @@ Returns the value of the specified parameter. .. rst-class:: classref-method -|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the specified parameter. diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 785e4c41654..156dff9c7a3 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Removes the entire contents of the config. @@ -191,7 +191,7 @@ Removes the entire contents of the config. .. rst-class:: classref-method -:ref:`String` **encode_to_text**\ (\ ) |const| +:ref:`String` **encode_to_text**\ (\ ) |const| :ref:`🔗` Obtain the text version of this config file (the same text that would be written to a file). @@ -203,7 +203,7 @@ Obtain the text version of this config file (the same text that would be written .. rst-class:: classref-method -|void| **erase_section**\ (\ section\: :ref:`String`\ ) +|void| **erase_section**\ (\ section\: :ref:`String`\ ) :ref:`🔗` Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. @@ -215,7 +215,7 @@ Deletes the specified section along with all the key-value pairs inside. Raises .. rst-class:: classref-method -|void| **erase_section_key**\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) +|void| **erase_section_key**\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) :ref:`🔗` Deletes the specified key in a section. Raises an error if either the section or the key do not exist. @@ -227,7 +227,7 @@ Deletes the specified key in a section. Raises an error if either the section or .. rst-class:: classref-method -:ref:`PackedStringArray` **get_section_keys**\ (\ section\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_section_keys**\ (\ section\: :ref:`String`\ ) |const| :ref:`🔗` Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. @@ -239,7 +239,7 @@ Returns an array of all defined key identifiers in the specified section. Raises .. rst-class:: classref-method -:ref:`PackedStringArray` **get_sections**\ (\ ) |const| +:ref:`PackedStringArray` **get_sections**\ (\ ) |const| :ref:`🔗` Returns an array of all defined section identifiers. @@ -251,7 +251,7 @@ Returns an array of all defined section identifiers. .. rst-class:: classref-method -:ref:`Variant` **get_value**\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| +:ref:`Variant` **get_value**\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback ``default`` value. If ``default`` is not specified or set to ``null``, an error is also raised. @@ -263,7 +263,7 @@ Returns the current value for the specified section and key. If either the secti .. rst-class:: classref-method -:ref:`bool` **has_section**\ (\ section\: :ref:`String`\ ) |const| +:ref:`bool` **has_section**\ (\ section\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the specified section exists. @@ -275,7 +275,7 @@ Returns ``true`` if the specified section exists. .. rst-class:: classref-method -:ref:`bool` **has_section_key**\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) |const| +:ref:`bool` **has_section_key**\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the specified section-key pair exists. @@ -287,7 +287,7 @@ Returns ``true`` if the specified section-key pair exists. .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads the config file specified as a parameter. The file's contents are parsed and loaded in the **ConfigFile** object which the method was called on. @@ -301,7 +301,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **load_encrypted**\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_encrypted**\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads the encrypted config file specified as a parameter, using the provided ``key`` to decrypt it. The file's contents are parsed and loaded in the **ConfigFile** object which the method was called on. @@ -315,7 +315,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **load_encrypted_pass**\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) +:ref:`Error` **load_encrypted_pass**\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) :ref:`🔗` Loads the encrypted config file specified as a parameter, using the provided ``password`` to decrypt it. The file's contents are parsed and loaded in the **ConfigFile** object which the method was called on. @@ -329,7 +329,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **parse**\ (\ data\: :ref:`String`\ ) +:ref:`Error` **parse**\ (\ data\: :ref:`String`\ ) :ref:`🔗` Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. @@ -343,7 +343,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **save**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **save**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Saves the contents of the **ConfigFile** object to the file specified as a parameter. The output file uses an INI-style structure. @@ -357,7 +357,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **save_encrypted**\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) +:ref:`Error` **save_encrypted**\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) :ref:`🔗` Saves the contents of the **ConfigFile** object to the AES-256 encrypted file specified as a parameter, using the provided ``key`` to encrypt it. The output file uses an INI-style structure. @@ -371,7 +371,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **save_encrypted_pass**\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) +:ref:`Error` **save_encrypted_pass**\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) :ref:`🔗` Saves the contents of the **ConfigFile** object to the AES-256 encrypted file specified as a parameter, using the provided ``password`` to encrypt it. The output file uses an INI-style structure. @@ -385,7 +385,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -|void| **set_value**\ (\ section\: :ref:`String`, key\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_value**\ (\ section\: :ref:`String`, key\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 16e1c04761a..6ab194cb2b6 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -30,11 +30,11 @@ To get cancel action, you can use: .. code-tab:: gdscript - get_cancel_button().pressed.connect(self.canceled) + get_cancel_button().pressed.connect(_on_canceled) .. code-tab:: csharp - GetCancelButton().Pressed += Canceled; + GetCancelButton().Pressed += OnCanceled; @@ -81,7 +81,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **cancel_button_text** = ``"Cancel"`` +:ref:`String` **cancel_button_text** = ``"Cancel"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Button` **get_cancel_button**\ (\ ) +:ref:`Button` **get_cancel_button**\ (\ ) :ref:`🔗` Returns the cancel button. diff --git a/classes/class_container.rst b/classes/class_container.rst index f8ea36cad8b..fedccd93698 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -73,7 +73,7 @@ Signals .. rst-class:: classref-signal -**pre_sort_children**\ (\ ) +**pre_sort_children**\ (\ ) :ref:`🔗` Emitted when children are going to be sorted. @@ -85,7 +85,7 @@ Emitted when children are going to be sorted. .. rst-class:: classref-signal -**sort_children**\ (\ ) +**sort_children**\ (\ ) :ref:`🔗` Emitted when sorting the children is needed. @@ -102,7 +102,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_PRE_SORT_CHILDREN** = ``50`` +**NOTIFICATION_PRE_SORT_CHILDREN** = ``50`` :ref:`🔗` Notification just before children are going to be sorted, in case there's something to process beforehand. @@ -110,7 +110,7 @@ Notification just before children are going to be sorted, in case there's someth .. rst-class:: classref-constant -**NOTIFICATION_SORT_CHILDREN** = ``51`` +**NOTIFICATION_SORT_CHILDREN** = ``51`` :ref:`🔗` Notification for when sorting the children, it must be obeyed immediately. @@ -127,7 +127,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedInt32Array` **_get_allowed_size_flags_horizontal**\ (\ ) |virtual| |const| +:ref:`PackedInt32Array` **_get_allowed_size_flags_horizontal**\ (\ ) |virtual| |const| :ref:`🔗` Implement to return a list of allowed horizontal :ref:`SizeFlags` for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock. @@ -141,7 +141,7 @@ Implement to return a list of allowed horizontal :ref:`SizeFlags` **_get_allowed_size_flags_vertical**\ (\ ) |virtual| |const| +:ref:`PackedInt32Array` **_get_allowed_size_flags_vertical**\ (\ ) |virtual| |const| :ref:`🔗` Implement to return a list of allowed vertical :ref:`SizeFlags` for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock. @@ -155,7 +155,7 @@ Implement to return a list of allowed vertical :ref:`SizeFlags`, rect\: :ref:`Rect2`\ ) +|void| **fit_child_in_rect**\ (\ child\: :ref:`Control`, rect\: :ref:`Rect2`\ ) :ref:`🔗` Fit a child control in a given rect. This is mainly a helper for creating custom container classes. @@ -167,7 +167,7 @@ Fit a child control in a given rect. This is mainly a helper for creating custom .. rst-class:: classref-method -|void| **queue_sort**\ (\ ) +|void| **queue_sort**\ (\ ) :ref:`🔗` Queue resort of the contained children. This is called automatically anyway, but can be called upon request. diff --git a/classes/class_control.rst b/classes/class_control.rst index a84616cdc5d..c6177e1a018 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -341,7 +341,7 @@ Signals .. rst-class:: classref-signal -**focus_entered**\ (\ ) +**focus_entered**\ (\ ) :ref:`🔗` Emitted when the node gains focus. @@ -353,7 +353,7 @@ Emitted when the node gains focus. .. rst-class:: classref-signal -**focus_exited**\ (\ ) +**focus_exited**\ (\ ) :ref:`🔗` Emitted when the node loses focus. @@ -365,7 +365,7 @@ Emitted when the node loses focus. .. rst-class:: classref-signal -**gui_input**\ (\ event\: :ref:`InputEvent`\ ) +**gui_input**\ (\ event\: :ref:`InputEvent`\ ) :ref:`🔗` Emitted when the node receives an :ref:`InputEvent`. @@ -377,7 +377,7 @@ Emitted when the node receives an :ref:`InputEvent`. .. rst-class:: classref-signal -**minimum_size_changed**\ (\ ) +**minimum_size_changed**\ (\ ) :ref:`🔗` Emitted when the node's minimum size changes. @@ -389,7 +389,7 @@ Emitted when the node's minimum size changes. .. rst-class:: classref-signal -**mouse_entered**\ (\ ) +**mouse_entered**\ (\ ) :ref:`🔗` Emitted when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its :ref:`mouse_filter` lets the event reach it and regardless if it's currently focused or not. @@ -403,7 +403,7 @@ Emitted when the mouse cursor enters the control's (or any child control's) visi .. rst-class:: classref-signal -**mouse_exited**\ (\ ) +**mouse_exited**\ (\ ) :ref:`🔗` Emitted when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its :ref:`mouse_filter` lets the event reach it and regardless if it's currently focused or not. @@ -425,7 +425,7 @@ Emitted when the mouse cursor leaves the control's (and all child control's) vis .. rst-class:: classref-signal -**resized**\ (\ ) +**resized**\ (\ ) :ref:`🔗` Emitted when the control changes size. @@ -437,7 +437,7 @@ Emitted when the control changes size. .. rst-class:: classref-signal -**size_flags_changed**\ (\ ) +**size_flags_changed**\ (\ ) :ref:`🔗` Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. @@ -449,7 +449,7 @@ Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` Emitted when the :ref:`NOTIFICATION_THEME_CHANGED` notification is sent. @@ -466,7 +466,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FocusMode**: +enum **FocusMode**: :ref:`🔗` .. _class_Control_constant_FOCUS_NONE: @@ -500,7 +500,7 @@ The node can grab focus on mouse click, using the arrows and the Tab keys on the .. rst-class:: classref-enumeration -enum **CursorShape**: +enum **CursorShape**: :ref:`🔗` .. _class_Control_constant_CURSOR_ARROW: @@ -646,7 +646,7 @@ Show the system's help mouse cursor when the user hovers the node, a question ma .. rst-class:: classref-enumeration -enum **LayoutPreset**: +enum **LayoutPreset**: :ref:`🔗` .. _class_Control_constant_PRESET_TOP_LEFT: @@ -784,7 +784,7 @@ Snap all 4 anchors to the respective corners of the parent control. Set all 4 of .. rst-class:: classref-enumeration -enum **LayoutPresetMode**: +enum **LayoutPresetMode**: :ref:`🔗` .. _class_Control_constant_PRESET_MODE_MINSIZE: @@ -826,7 +826,7 @@ The control's size will not change. .. rst-class:: classref-enumeration -flags **SizeFlags**: +flags **SizeFlags**: :ref:`🔗` .. _class_Control_constant_SIZE_SHRINK_BEGIN: @@ -886,7 +886,7 @@ Tells the parent :ref:`Container` to align the node with its en .. rst-class:: classref-enumeration -enum **MouseFilter**: +enum **MouseFilter**: :ref:`🔗` .. _class_Control_constant_MOUSE_FILTER_STOP: @@ -922,7 +922,7 @@ The control will not receive mouse movement input events and mouse button input .. rst-class:: classref-enumeration -enum **GrowDirection**: +enum **GrowDirection**: :ref:`🔗` .. _class_Control_constant_GROW_DIRECTION_BEGIN: @@ -956,7 +956,7 @@ The control will grow in both directions equally to make up if its minimum size .. rst-class:: classref-enumeration -enum **Anchor**: +enum **Anchor**: :ref:`🔗` .. _class_Control_constant_ANCHOR_BEGIN: @@ -982,7 +982,7 @@ Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bott .. rst-class:: classref-enumeration -enum **LayoutDirection**: +enum **LayoutDirection**: :ref:`🔗` .. _class_Control_constant_LAYOUT_DIRECTION_INHERITED: @@ -1024,7 +1024,7 @@ Right-to-left layout direction. .. rst-class:: classref-enumeration -enum **TextDirection**: +enum **TextDirection**: :ref:`🔗` .. _class_Control_constant_TEXT_DIRECTION_INHERITED: @@ -1071,7 +1071,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_RESIZED** = ``40`` +**NOTIFICATION_RESIZED** = ``40`` :ref:`🔗` Sent when the node changes size. Use :ref:`size` to get the new size. @@ -1079,7 +1079,7 @@ Sent when the node changes size. Use :ref:`size` to .. rst-class:: classref-constant -**NOTIFICATION_MOUSE_ENTER** = ``41`` +**NOTIFICATION_MOUSE_ENTER** = ``41`` :ref:`🔗` Sent when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its :ref:`mouse_filter` lets the event reach it and regardless if it's currently focused or not. @@ -1091,7 +1091,7 @@ See also :ref:`NOTIFICATION_MOUSE_ENTER_SELF` Sent when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its :ref:`mouse_filter` lets the event reach it and regardless if it's currently focused or not. @@ -1103,7 +1103,7 @@ See also :ref:`NOTIFICATION_MOUSE_EXIT_SELF` **Experimental:** The reason this notification is sent may change in the future. @@ -1117,7 +1117,7 @@ See also :ref:`NOTIFICATION_MOUSE_ENTER` **Experimental:** The reason this notification is sent may change in the future. @@ -1131,7 +1131,7 @@ See also :ref:`NOTIFICATION_MOUSE_EXIT` Sent when the node grabs focus. @@ -1139,7 +1139,7 @@ Sent when the node grabs focus. .. rst-class:: classref-constant -**NOTIFICATION_FOCUS_EXIT** = ``44`` +**NOTIFICATION_FOCUS_EXIT** = ``44`` :ref:`🔗` Sent when the node loses focus. @@ -1147,7 +1147,7 @@ Sent when the node loses focus. .. rst-class:: classref-constant -**NOTIFICATION_THEME_CHANGED** = ``45`` +**NOTIFICATION_THEME_CHANGED** = ``45`` :ref:`🔗` Sent when the node needs to refresh its theme items. This happens in one of the following cases: @@ -1175,7 +1175,7 @@ Sent when the node needs to refresh its theme items. This happens in one of the .. rst-class:: classref-constant -**NOTIFICATION_SCROLL_BEGIN** = ``47`` +**NOTIFICATION_SCROLL_BEGIN** = ``47`` :ref:`🔗` Sent when this node is inside a :ref:`ScrollContainer` which has begun being scrolled when dragging the scrollable area *with a touch event*. This notification is *not* sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events. @@ -1185,7 +1185,7 @@ Sent when this node is inside a :ref:`ScrollContainer` wh .. rst-class:: classref-constant -**NOTIFICATION_SCROLL_END** = ``48`` +**NOTIFICATION_SCROLL_END** = ``48`` :ref:`🔗` Sent when this node is inside a :ref:`ScrollContainer` which has stopped being scrolled when dragging the scrollable area *with a touch event*. This notification is *not* sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events. @@ -1195,7 +1195,7 @@ Sent when this node is inside a :ref:`ScrollContainer` wh .. rst-class:: classref-constant -**NOTIFICATION_LAYOUT_DIRECTION_CHANGED** = ``49`` +**NOTIFICATION_LAYOUT_DIRECTION_CHANGED** = ``49`` :ref:`🔗` Sent when control layout direction is changed. @@ -1212,7 +1212,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **anchor_bottom** = ``0.0`` +:ref:`float` **anchor_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1228,7 +1228,7 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its .. rst-class:: classref-property -:ref:`float` **anchor_left** = ``0.0`` +:ref:`float` **anchor_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1244,7 +1244,7 @@ Anchors the left edge of the node to the origin, the center or the end of its pa .. rst-class:: classref-property -:ref:`float` **anchor_right** = ``0.0`` +:ref:`float` **anchor_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1260,7 +1260,7 @@ Anchors the right edge of the node to the origin, the center or the end of its p .. rst-class:: classref-property -:ref:`float` **anchor_top** = ``0.0`` +:ref:`float` **anchor_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1276,7 +1276,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par .. rst-class:: classref-property -:ref:`bool` **auto_translate** +:ref:`bool` **auto_translate** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1295,7 +1295,7 @@ Toggles if any text should automatically change to its translated version depend .. rst-class:: classref-property -:ref:`bool` **clip_contents** = ``false`` +:ref:`bool` **clip_contents** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1312,7 +1312,7 @@ Enables whether rendering of :ref:`CanvasItem` based children .. rst-class:: classref-property -:ref:`Vector2` **custom_minimum_size** = ``Vector2(0, 0)`` +:ref:`Vector2` **custom_minimum_size** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1329,7 +1329,7 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea .. rst-class:: classref-property -:ref:`FocusMode` **focus_mode** = ``0`` +:ref:`FocusMode` **focus_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1346,7 +1346,7 @@ The focus access mode for the control (None, Click or All). Only one Control can .. rst-class:: classref-property -:ref:`NodePath` **focus_neighbor_bottom** = ``NodePath("")`` +:ref:`NodePath` **focus_neighbor_bottom** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1363,7 +1363,7 @@ Tells Godot which node it should give focus to if the user presses the down arro .. rst-class:: classref-property -:ref:`NodePath` **focus_neighbor_left** = ``NodePath("")`` +:ref:`NodePath` **focus_neighbor_left** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1380,7 +1380,7 @@ Tells Godot which node it should give focus to if the user presses the left arro .. rst-class:: classref-property -:ref:`NodePath` **focus_neighbor_right** = ``NodePath("")`` +:ref:`NodePath` **focus_neighbor_right** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1397,7 +1397,7 @@ Tells Godot which node it should give focus to if the user presses the right arr .. rst-class:: classref-property -:ref:`NodePath` **focus_neighbor_top** = ``NodePath("")`` +:ref:`NodePath` **focus_neighbor_top** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1414,7 +1414,7 @@ Tells Godot which node it should give focus to if the user presses the top arrow .. rst-class:: classref-property -:ref:`NodePath` **focus_next** = ``NodePath("")`` +:ref:`NodePath` **focus_next** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1433,7 +1433,7 @@ If this property is not set, Godot will select a "best guess" based on surroundi .. rst-class:: classref-property -:ref:`NodePath` **focus_previous** = ``NodePath("")`` +:ref:`NodePath` **focus_previous** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1452,7 +1452,7 @@ If this property is not set, Godot will select a "best guess" based on surroundi .. rst-class:: classref-property -:ref:`Vector2` **global_position** +:ref:`Vector2` **global_position** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1468,7 +1468,7 @@ The node's global position, relative to the world (usually to the :ref:`CanvasLa .. rst-class:: classref-property -:ref:`GrowDirection` **grow_horizontal** = ``1`` +:ref:`GrowDirection` **grow_horizontal** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1485,7 +1485,7 @@ Controls the direction on the horizontal axis in which the control should grow i .. rst-class:: classref-property -:ref:`GrowDirection` **grow_vertical** = ``1`` +:ref:`GrowDirection` **grow_vertical** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1502,7 +1502,7 @@ Controls the direction on the vertical axis in which the control should grow if .. rst-class:: classref-property -:ref:`LayoutDirection` **layout_direction** = ``0`` +:ref:`LayoutDirection` **layout_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1519,7 +1519,7 @@ Controls layout direction and text writing direction. Right-to-left layouts are .. rst-class:: classref-property -:ref:`bool` **localize_numeral_system** = ``true`` +:ref:`bool` **localize_numeral_system** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1538,7 +1538,7 @@ If ``true``, automatically converts code line numbers, list indices, :ref:`SpinB .. rst-class:: classref-property -:ref:`CursorShape` **mouse_default_cursor_shape** = ``0`` +:ref:`CursorShape` **mouse_default_cursor_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1557,7 +1557,7 @@ The default cursor shape for this control. Useful for Godot plugins and applicat .. rst-class:: classref-property -:ref:`MouseFilter` **mouse_filter** = ``0`` +:ref:`MouseFilter` **mouse_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1574,7 +1574,7 @@ Controls whether the control will be able to receive mouse button input events t .. rst-class:: classref-property -:ref:`bool` **mouse_force_pass_scroll_events** = ``true`` +:ref:`bool` **mouse_force_pass_scroll_events** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1593,7 +1593,7 @@ You should disable it on the root of your UI if you do not want scroll events to .. rst-class:: classref-property -:ref:`float` **offset_bottom** = ``0.0`` +:ref:`float` **offset_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1612,7 +1612,7 @@ Offsets are often controlled by one or multiple parent :ref:`Container` **offset_left** = ``0.0`` +:ref:`float` **offset_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1631,7 +1631,7 @@ Offsets are often controlled by one or multiple parent :ref:`Container` **offset_right** = ``0.0`` +:ref:`float` **offset_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1650,7 +1650,7 @@ Offsets are often controlled by one or multiple parent :ref:`Container` **offset_top** = ``0.0`` +:ref:`float` **offset_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1669,7 +1669,7 @@ Offsets are often controlled by one or multiple parent :ref:`Container` **pivot_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **pivot_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1686,7 +1686,7 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1702,7 +1702,7 @@ The node's position, relative to its containing node. It corresponds to the rect .. rst-class:: classref-property -:ref:`float` **rotation** = ``0.0`` +:ref:`float` **rotation** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1721,7 +1721,7 @@ The node's rotation around its pivot, in radians. See :ref:`pivot_offset` **rotation_degrees** +:ref:`float` **rotation_degrees** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1738,7 +1738,7 @@ Helper property to access :ref:`rotation` in de .. rst-class:: classref-property -:ref:`Vector2` **scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1761,7 +1761,7 @@ The node's scale, relative to its :ref:`size`. Chan .. rst-class:: classref-property -:ref:`Node` **shortcut_context** +:ref:`Node` **shortcut_context** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1778,7 +1778,7 @@ The :ref:`Node` which must be a parent of the focused **Control** fo .. rst-class:: classref-property -:ref:`Vector2` **size** = ``Vector2(0, 0)`` +:ref:`Vector2` **size** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1794,7 +1794,7 @@ The size of the node's bounding rectangle, in the node's coordinate system. :ref .. rst-class:: classref-property -|bitfield|\[:ref:`SizeFlags`\] **size_flags_horizontal** = ``1`` +|bitfield|\[:ref:`SizeFlags`\] **size_flags_horizontal** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1811,7 +1811,7 @@ Tells the parent :ref:`Container` nodes how they should resize .. rst-class:: classref-property -:ref:`float` **size_flags_stretch_ratio** = ``1.0`` +:ref:`float` **size_flags_stretch_ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1828,7 +1828,7 @@ If the node and at least one of its neighbors uses the :ref:`SIZE_EXPAND`\] **size_flags_vertical** = ``1`` +|bitfield|\[:ref:`SizeFlags`\] **size_flags_vertical** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1845,7 +1845,7 @@ Tells the parent :ref:`Container` nodes how they should resize .. rst-class:: classref-property -:ref:`Theme` **theme** +:ref:`Theme` **theme** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1864,7 +1864,7 @@ The :ref:`Theme` resource this node and all its **Control** and :re .. rst-class:: classref-property -:ref:`StringName` **theme_type_variation** = ``&""`` +:ref:`StringName` **theme_type_variation** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1887,7 +1887,7 @@ When set, this property gives the highest priority to the type of the specified .. rst-class:: classref-property -:ref:`String` **tooltip_text** = ``""`` +:ref:`String` **tooltip_text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1934,7 +1934,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| +:ref:`bool` **_can_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` Godot calls this method to test if ``data`` from a control's :ref:`_get_drag_data` can be dropped at ``at_position``. ``at_position`` is local to this control. @@ -1969,7 +1969,7 @@ This method should only be used to test the data. Process the data in :ref:`_dro .. rst-class:: classref-method -|void| **_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| +|void| **_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Godot calls this method to pass you the ``data`` from a control's :ref:`_get_drag_data` result. Godot first calls :ref:`_can_drop_data` to test if ``data`` is allowed to drop at ``at_position`` where ``at_position`` is local to this control. @@ -2006,7 +2006,7 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`_get_dra .. rst-class:: classref-method -:ref:`Variant` **_get_drag_data**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| +:ref:`Variant` **_get_drag_data**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns ``null`` if there is no data to drag. Controls that want to receive drop data should implement :ref:`_can_drop_data` and :ref:`_drop_data`. ``at_position`` is local to this control. Drag may be forced with :ref:`force_drag`. @@ -2041,7 +2041,7 @@ A preview that will follow the mouse that should represent the data can be set w .. rst-class:: classref-method -:ref:`Vector2` **_get_minimum_size**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_minimum_size**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to :ref:`custom_minimum_size` for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). @@ -2057,7 +2057,7 @@ If not overridden, defaults to :ref:`Vector2.ZERO`. .. rst-class:: classref-method -:ref:`String` **_get_tooltip**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| |const| +:ref:`String` **_get_tooltip**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` Virtual method to be implemented by the user. Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. See :ref:`get_tooltip`. @@ -2071,7 +2071,7 @@ Virtual method to be implemented by the user. Returns the tooltip text for the p .. rst-class:: classref-method -|void| **_gui_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| +|void| **_gui_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See :ref:`accept_event`. @@ -2124,7 +2124,7 @@ The event won't trigger if: .. rst-class:: classref-method -:ref:`bool` **_has_point**\ (\ point\: :ref:`Vector2`\ ) |virtual| |const| +:ref:`bool` **_has_point**\ (\ point\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` Virtual method to be implemented by the user. Returns whether the given ``point`` is inside this control. @@ -2140,7 +2140,7 @@ If not overridden, default behavior is checking if the point is within control's .. rst-class:: classref-method -:ref:`Object` **_make_custom_tooltip**\ (\ for_text\: :ref:`String`\ ) |virtual| |const| +:ref:`Object` **_make_custom_tooltip**\ (\ for_text\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Virtual method to be implemented by the user. Returns a **Control** node that should be used as a tooltip instead of the default one. The ``for_text`` includes the contents of the :ref:`tooltip_text` property. @@ -2206,7 +2206,7 @@ The returned node will be added as child to a :ref:`PopupPanel .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector3i`\] **_structured_text_parser**\ (\ args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Vector3i`\] **_structured_text_parser**\ (\ args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` User defined BiDi algorithm override function. @@ -2220,7 +2220,7 @@ Returns an :ref:`Array` of :ref:`Vector3i` text ran .. rst-class:: classref-method -|void| **accept_event**\ (\ ) +|void| **accept_event**\ (\ ) :ref:`🔗` Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. @@ -2234,7 +2234,7 @@ Marks an input event as handled. Once you accept an input event, it stops propag .. rst-class:: classref-method -|void| **add_theme_color_override**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) +|void| **add_theme_color_override**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) :ref:`🔗` Creates a local override for a theme :ref:`Color` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_color_override`. @@ -2273,7 +2273,7 @@ See also :ref:`get_theme_color`. .. rst-class:: classref-method -|void| **add_theme_constant_override**\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) +|void| **add_theme_constant_override**\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) :ref:`🔗` Creates a local override for a theme constant with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_constant_override`. @@ -2287,7 +2287,7 @@ See also :ref:`get_theme_constant`. .. rst-class:: classref-method -|void| **add_theme_font_override**\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) +|void| **add_theme_font_override**\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) :ref:`🔗` Creates a local override for a theme :ref:`Font` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_override`. @@ -2301,7 +2301,7 @@ See also :ref:`get_theme_font`. .. rst-class:: classref-method -|void| **add_theme_font_size_override**\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) +|void| **add_theme_font_size_override**\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) :ref:`🔗` Creates a local override for a theme font size with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_size_override`. @@ -2315,7 +2315,7 @@ See also :ref:`get_theme_font_size`. .. rst-class:: classref-method -|void| **add_theme_icon_override**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) +|void| **add_theme_icon_override**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Creates a local override for a theme icon with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_icon_override`. @@ -2329,7 +2329,7 @@ See also :ref:`get_theme_icon`. .. rst-class:: classref-method -|void| **add_theme_stylebox_override**\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) +|void| **add_theme_stylebox_override**\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) :ref:`🔗` Creates a local override for a theme :ref:`StyleBox` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_stylebox_override`. @@ -2374,7 +2374,7 @@ See also :ref:`get_theme_stylebox`. .. rst-class:: classref-method -|void| **begin_bulk_theme_override**\ (\ ) +|void| **begin_bulk_theme_override**\ (\ ) :ref:`🔗` Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_CHANGED` until :ref:`end_bulk_theme_override` is called. @@ -2386,7 +2386,7 @@ Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_C .. rst-class:: classref-method -|void| **end_bulk_theme_override**\ (\ ) +|void| **end_bulk_theme_override**\ (\ ) :ref:`🔗` Ends a bulk theme override update. See :ref:`begin_bulk_theme_override`. @@ -2398,7 +2398,7 @@ Ends a bulk theme override update. See :ref:`begin_bulk_theme_override` **find_next_valid_focus**\ (\ ) |const| +:ref:`Control` **find_next_valid_focus**\ (\ ) |const| :ref:`🔗` Finds the next (below in the tree) **Control** that can receive the focus. @@ -2410,7 +2410,7 @@ Finds the next (below in the tree) **Control** that can receive the focus. .. rst-class:: classref-method -:ref:`Control` **find_prev_valid_focus**\ (\ ) |const| +:ref:`Control` **find_prev_valid_focus**\ (\ ) |const| :ref:`🔗` Finds the previous (above in the tree) **Control** that can receive the focus. @@ -2422,7 +2422,7 @@ Finds the previous (above in the tree) **Control** that can receive the focus. .. rst-class:: classref-method -:ref:`Control` **find_valid_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| +:ref:`Control` **find_valid_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| :ref:`🔗` Finds the next **Control** that can receive the focus on the specified :ref:`Side`. @@ -2436,7 +2436,7 @@ Finds the next **Control** that can receive the focus on the specified :ref:`Sid .. rst-class:: classref-method -|void| **force_drag**\ (\ data\: :ref:`Variant`, preview\: :ref:`Control`\ ) +|void| **force_drag**\ (\ data\: :ref:`Variant`, preview\: :ref:`Control`\ ) :ref:`🔗` Forces drag and bypasses :ref:`_get_drag_data` and :ref:`set_drag_preview` by passing ``data`` and ``preview``. Drag will start even if the mouse is neither over nor pressed on this control. @@ -2450,7 +2450,7 @@ The methods :ref:`_can_drop_data` a .. rst-class:: classref-method -:ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| +:ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the anchor for the specified :ref:`Side`. A getter method for :ref:`anchor_bottom`, :ref:`anchor_left`, :ref:`anchor_right` and :ref:`anchor_top`. @@ -2462,7 +2462,7 @@ Returns the anchor for the specified :ref:`Side`. A gett .. rst-class:: classref-method -:ref:`Vector2` **get_begin**\ (\ ) |const| +:ref:`Vector2` **get_begin**\ (\ ) |const| :ref:`🔗` Returns :ref:`offset_left` and :ref:`offset_top`. See also :ref:`position`. @@ -2474,7 +2474,7 @@ Returns :ref:`offset_left` and :ref:`offset_ .. rst-class:: classref-method -:ref:`Vector2` **get_combined_minimum_size**\ (\ ) |const| +:ref:`Vector2` **get_combined_minimum_size**\ (\ ) |const| :ref:`🔗` Returns combined minimum size from :ref:`custom_minimum_size` and :ref:`get_minimum_size`. @@ -2486,7 +2486,7 @@ Returns combined minimum size from :ref:`custom_minimum_size` **get_cursor_shape**\ (\ position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| +:ref:`CursorShape` **get_cursor_shape**\ (\ position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| :ref:`🔗` Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. @@ -2498,7 +2498,7 @@ Returns the mouse cursor shape the control displays on mouse hover. See :ref:`Cu .. rst-class:: classref-method -:ref:`Vector2` **get_end**\ (\ ) |const| +:ref:`Vector2` **get_end**\ (\ ) |const| :ref:`🔗` Returns :ref:`offset_right` and :ref:`offset_bottom`. @@ -2510,7 +2510,7 @@ Returns :ref:`offset_right` and :ref:`offse .. rst-class:: classref-method -:ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| +:ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the focus neighbor for the specified :ref:`Side`. A getter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. @@ -2524,7 +2524,7 @@ Returns the focus neighbor for the specified :ref:`Side` .. rst-class:: classref-method -:ref:`Rect2` **get_global_rect**\ (\ ) |const| +:ref:`Rect2` **get_global_rect**\ (\ ) |const| :ref:`🔗` Returns the position and size of the control relative to the containing canvas. See :ref:`global_position` and :ref:`size`. @@ -2540,7 +2540,7 @@ Returns the position and size of the control relative to the containing canvas. .. rst-class:: classref-method -:ref:`Vector2` **get_minimum_size**\ (\ ) |const| +:ref:`Vector2` **get_minimum_size**\ (\ ) |const| :ref:`🔗` Returns the minimum size for this control. See :ref:`custom_minimum_size`. @@ -2552,7 +2552,7 @@ Returns the minimum size for this control. See :ref:`custom_minimum_size` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| +:ref:`float` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the offset for the specified :ref:`Side`. A getter method for :ref:`offset_bottom`, :ref:`offset_left`, :ref:`offset_right` and :ref:`offset_top`. @@ -2564,7 +2564,7 @@ Returns the offset for the specified :ref:`Side`. A gett .. rst-class:: classref-method -:ref:`Vector2` **get_parent_area_size**\ (\ ) |const| +:ref:`Vector2` **get_parent_area_size**\ (\ ) |const| :ref:`🔗` Returns the width/height occupied in the parent control. @@ -2576,7 +2576,7 @@ Returns the width/height occupied in the parent control. .. rst-class:: classref-method -:ref:`Control` **get_parent_control**\ (\ ) |const| +:ref:`Control` **get_parent_control**\ (\ ) |const| :ref:`🔗` Returns the parent control node. @@ -2588,7 +2588,7 @@ Returns the parent control node. .. rst-class:: classref-method -:ref:`Rect2` **get_rect**\ (\ ) |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| :ref:`🔗` Returns the position and size of the control in the coordinate system of the containing node. See :ref:`position`, :ref:`scale` and :ref:`size`. @@ -2604,7 +2604,7 @@ Returns the position and size of the control in the coordinate system of the con .. rst-class:: classref-method -:ref:`Vector2` **get_screen_position**\ (\ ) |const| +:ref:`Vector2` **get_screen_position**\ (\ ) |const| :ref:`🔗` Returns the position of this **Control** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. @@ -2626,7 +2626,7 @@ Equals to :ref:`global_position` if the .. rst-class:: classref-method -:ref:`Color` **get_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`Color` **get_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a :ref:`Color` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a color item with the specified ``name`` and ``theme_type``. If ``theme_type`` is omitted the class name of the current control is used as the type, or :ref:`theme_type_variation` if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. @@ -2663,7 +2663,7 @@ For the current control its local overrides are considered first (see :ref:`add_ .. rst-class:: classref-method -:ref:`int` **get_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`int` **get_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a constant from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a constant item with the specified ``name`` and ``theme_type``. @@ -2677,7 +2677,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`float` **get_theme_default_base_scale**\ (\ ) |const| +:ref:`float` **get_theme_default_base_scale**\ (\ ) |const| :ref:`🔗` Returns the default base scale value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_base_scale` value. @@ -2691,7 +2691,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`Font` **get_theme_default_font**\ (\ ) |const| +:ref:`Font` **get_theme_default_font**\ (\ ) |const| :ref:`🔗` Returns the default font from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font` value. @@ -2705,7 +2705,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`int` **get_theme_default_font_size**\ (\ ) |const| +:ref:`int` **get_theme_default_font_size**\ (\ ) |const| :ref:`🔗` Returns the default font size value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font_size` value. @@ -2719,7 +2719,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`Font` **get_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`Font` **get_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a :ref:`Font` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font item with the specified ``name`` and ``theme_type``. @@ -2733,7 +2733,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`int` **get_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`int` **get_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a font size from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font size item with the specified ``name`` and ``theme_type``. @@ -2747,7 +2747,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`Texture2D` **get_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`Texture2D` **get_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns an icon from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has an icon item with the specified ``name`` and ``theme_type``. @@ -2761,7 +2761,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`StyleBox` **get_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`StyleBox` **get_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a :ref:`StyleBox` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a stylebox item with the specified ``name`` and ``theme_type``. @@ -2775,7 +2775,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`String` **get_tooltip**\ (\ at_position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| +:ref:`String` **get_tooltip**\ (\ at_position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| :ref:`🔗` Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns :ref:`tooltip_text`. @@ -2791,7 +2791,7 @@ This method can be overridden to customize its behavior. See :ref:`_get_tooltip< .. rst-class:: classref-method -|void| **grab_click_focus**\ (\ ) +|void| **grab_click_focus**\ (\ ) :ref:`🔗` Creates an :ref:`InputEventMouseButton` that attempts to click the control. If the event is received, the control acquires focus. @@ -2820,7 +2820,7 @@ Creates an :ref:`InputEventMouseButton` that attemp .. rst-class:: classref-method -|void| **grab_focus**\ (\ ) +|void| **grab_focus**\ (\ ) :ref:`🔗` Steal the focus from another control and become the focused control (see :ref:`focus_mode`). @@ -2834,7 +2834,7 @@ Steal the focus from another control and become the focused control (see :ref:`f .. rst-class:: classref-method -:ref:`bool` **has_focus**\ (\ ) |const| +:ref:`bool` **has_focus**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. @@ -2846,7 +2846,7 @@ Returns ``true`` if this is the current focused control. See :ref:`focus_mode` **has_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a color item with the specified ``name`` and ``theme_type``. @@ -2860,7 +2860,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_color_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_color_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme :ref:`Color` with the specified ``name`` in this **Control** node. @@ -2874,7 +2874,7 @@ See :ref:`add_theme_color_override` **has_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a constant item with the specified ``name`` and ``theme_type``. @@ -2888,7 +2888,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme constant with the specified ``name`` in this **Control** node. @@ -2902,7 +2902,7 @@ See :ref:`add_theme_constant_override` **has_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font item with the specified ``name`` and ``theme_type``. @@ -2916,7 +2916,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_font_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_font_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme :ref:`Font` with the specified ``name`` in this **Control** node. @@ -2930,7 +2930,7 @@ See :ref:`add_theme_font_override` .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font size item with the specified ``name`` and ``theme_type``. @@ -2944,7 +2944,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme font size with the specified ``name`` in this **Control** node. @@ -2958,7 +2958,7 @@ See :ref:`add_theme_font_size_override` **has_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has an icon item with the specified ``name`` and ``theme_type``. @@ -2972,7 +2972,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme icon with the specified ``name`` in this **Control** node. @@ -2986,7 +2986,7 @@ See :ref:`add_theme_icon_override` .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a stylebox item with the specified ``name`` and ``theme_type``. @@ -3000,7 +3000,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme :ref:`StyleBox` with the specified ``name`` in this **Control** node. @@ -3014,7 +3014,7 @@ See :ref:`add_theme_stylebox_override` **is_drag_successful**\ (\ ) |const| +:ref:`bool` **is_drag_successful**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a drag operation is successful. Alternative to :ref:`Viewport.gui_is_drag_successful`. @@ -3028,7 +3028,7 @@ Best used with :ref:`Node.NOTIFICATION_DRAG_END` **is_layout_rtl**\ (\ ) |const| +:ref:`bool` **is_layout_rtl**\ (\ ) |const| :ref:`🔗` Returns ``true`` if layout is right-to-left. @@ -3040,7 +3040,7 @@ Returns ``true`` if layout is right-to-left. .. rst-class:: classref-method -|void| **release_focus**\ (\ ) +|void| **release_focus**\ (\ ) :ref:`🔗` Give up the focus. No other control will be able to receive input. @@ -3052,7 +3052,7 @@ Give up the focus. No other control will be able to receive input. .. rst-class:: classref-method -|void| **remove_theme_color_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_color_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme :ref:`Color` with the specified ``name`` previously added by :ref:`add_theme_color_override` or via the Inspector dock. @@ -3064,7 +3064,7 @@ Removes a local override for a theme :ref:`Color` with the specifie .. rst-class:: classref-method -|void| **remove_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme constant with the specified ``name`` previously added by :ref:`add_theme_constant_override` or via the Inspector dock. @@ -3076,7 +3076,7 @@ Removes a local override for a theme constant with the specified ``name`` previo .. rst-class:: classref-method -|void| **remove_theme_font_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_font_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme :ref:`Font` with the specified ``name`` previously added by :ref:`add_theme_font_override` or via the Inspector dock. @@ -3088,7 +3088,7 @@ Removes a local override for a theme :ref:`Font` with the specified .. rst-class:: classref-method -|void| **remove_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme font size with the specified ``name`` previously added by :ref:`add_theme_font_size_override` or via the Inspector dock. @@ -3100,7 +3100,7 @@ Removes a local override for a theme font size with the specified ``name`` previ .. rst-class:: classref-method -|void| **remove_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme icon with the specified ``name`` previously added by :ref:`add_theme_icon_override` or via the Inspector dock. @@ -3112,7 +3112,7 @@ Removes a local override for a theme icon with the specified ``name`` previously .. rst-class:: classref-method -|void| **remove_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme :ref:`StyleBox` with the specified ``name`` previously added by :ref:`add_theme_stylebox_override` or via the Inspector dock. @@ -3124,7 +3124,7 @@ Removes a local override for a theme :ref:`StyleBox` with the sp .. rst-class:: classref-method -|void| **reset_size**\ (\ ) +|void| **reset_size**\ (\ ) :ref:`🔗` Resets the size to :ref:`get_combined_minimum_size`. This is equivalent to calling ``set_size(Vector2())`` (or any size below the minimum). @@ -3136,7 +3136,7 @@ Resets the size to :ref:`get_combined_minimum_size`, anchor\: :ref:`float`, keep_offset\: :ref:`bool` = false, push_opposite_anchor\: :ref:`bool` = true\ ) +|void| **set_anchor**\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, keep_offset\: :ref:`bool` = false, push_opposite_anchor\: :ref:`bool` = true\ ) :ref:`🔗` Sets the anchor for the specified :ref:`Side` to ``anchor``. A setter method for :ref:`anchor_bottom`, :ref:`anchor_left`, :ref:`anchor_right` and :ref:`anchor_top`. @@ -3152,7 +3152,7 @@ If ``push_opposite_anchor`` is ``true`` and the opposite anchor overlaps this an .. rst-class:: classref-method -|void| **set_anchor_and_offset**\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, offset\: :ref:`float`, push_opposite_anchor\: :ref:`bool` = false\ ) +|void| **set_anchor_and_offset**\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, offset\: :ref:`float`, push_opposite_anchor\: :ref:`bool` = false\ ) :ref:`🔗` Works the same as :ref:`set_anchor`, but instead of ``keep_offset`` argument and automatic update of offset, it allows to set the offset yourself (see :ref:`set_offset`). @@ -3164,7 +3164,7 @@ Works the same as :ref:`set_anchor`, but instea .. rst-class:: classref-method -|void| **set_anchors_and_offsets_preset**\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) +|void| **set_anchors_and_offsets_preset**\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) :ref:`🔗` Sets both anchor preset and offset preset. See :ref:`set_anchors_preset` and :ref:`set_offsets_preset`. @@ -3176,7 +3176,7 @@ Sets both anchor preset and offset preset. See :ref:`set_anchors_preset`, keep_offsets\: :ref:`bool` = false\ ) +|void| **set_anchors_preset**\ (\ preset\: :ref:`LayoutPreset`, keep_offsets\: :ref:`bool` = false\ ) :ref:`🔗` Sets the anchors to a ``preset`` from :ref:`LayoutPreset` enum. This is the code equivalent to using the Layout menu in the 2D editor. @@ -3190,7 +3190,7 @@ If ``keep_offsets`` is ``true``, control's position will also be updated. .. rst-class:: classref-method -|void| **set_begin**\ (\ position\: :ref:`Vector2`\ ) +|void| **set_begin**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Sets :ref:`offset_left` and :ref:`offset_top` at the same time. Equivalent of changing :ref:`position`. @@ -3202,7 +3202,7 @@ Sets :ref:`offset_left` and :ref:`offset_top .. rst-class:: classref-method -|void| **set_drag_forwarding**\ (\ drag_func\: :ref:`Callable`, can_drop_func\: :ref:`Callable`, drop_func\: :ref:`Callable`\ ) +|void| **set_drag_forwarding**\ (\ drag_func\: :ref:`Callable`, can_drop_func\: :ref:`Callable`, drop_func\: :ref:`Callable`\ ) :ref:`🔗` Forwards the handling of this control's :ref:`_get_drag_data`, :ref:`_can_drop_data` and :ref:`_drop_data` virtual functions to delegate callables. @@ -3218,7 +3218,7 @@ The function format for each callable should be exactly the same as the virtual .. rst-class:: classref-method -|void| **set_drag_preview**\ (\ control\: :ref:`Control`\ ) +|void| **set_drag_preview**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Shows the given control at the mouse pointer. A good time to call this method is in :ref:`_get_drag_data`. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. @@ -3262,7 +3262,7 @@ Shows the given control at the mouse pointer. A good time to call this method is .. rst-class:: classref-method -|void| **set_end**\ (\ position\: :ref:`Vector2`\ ) +|void| **set_end**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Sets :ref:`offset_right` and :ref:`offset_bottom` at the same time. @@ -3274,7 +3274,7 @@ Sets :ref:`offset_right` and :ref:`offset_b .. rst-class:: classref-method -|void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) +|void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) :ref:`🔗` Sets the focus neighbor for the specified :ref:`Side` to the **Control** at ``neighbor`` node path. A setter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. @@ -3286,7 +3286,7 @@ Sets the focus neighbor for the specified :ref:`Side` to .. rst-class:: classref-method -|void| **set_global_position**\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) +|void| **set_global_position**\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) :ref:`🔗` Sets the :ref:`global_position` to given ``position``. @@ -3300,7 +3300,7 @@ If ``keep_offsets`` is ``true``, control's anchors will be updated instead of of .. rst-class:: classref-method -|void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) +|void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the offset for the specified :ref:`Side` to ``offset``. A setter method for :ref:`offset_bottom`, :ref:`offset_left`, :ref:`offset_right` and :ref:`offset_top`. @@ -3312,7 +3312,7 @@ Sets the offset for the specified :ref:`Side` to ``offse .. rst-class:: classref-method -|void| **set_offsets_preset**\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) +|void| **set_offsets_preset**\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) :ref:`🔗` Sets the offsets to a ``preset`` from :ref:`LayoutPreset` enum. This is the code equivalent to using the Layout menu in the 2D editor. @@ -3328,7 +3328,7 @@ Use parameter ``margin`` to determine the gap between the **Control** and the ed .. rst-class:: classref-method -|void| **set_position**\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) +|void| **set_position**\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) :ref:`🔗` Sets the :ref:`position` to given ``position``. @@ -3342,7 +3342,7 @@ If ``keep_offsets`` is ``true``, control's anchors will be updated instead of of .. rst-class:: classref-method -|void| **set_size**\ (\ size\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) +|void| **set_size**\ (\ size\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) :ref:`🔗` Sets the size (see :ref:`size`). @@ -3356,7 +3356,7 @@ If ``keep_offsets`` is ``true``, control's anchors will be updated instead of of .. rst-class:: classref-method -|void| **update_minimum_size**\ (\ ) +|void| **update_minimum_size**\ (\ ) :ref:`🔗` Invalidates the size cache in this node and in parent nodes up to top level. Intended to be used with :ref:`get_minimum_size` when the return value is changed. Setting :ref:`custom_minimum_size` directly calls this method automatically. @@ -3368,7 +3368,7 @@ Invalidates the size cache in this node and in parent nodes up to top level. Int .. rst-class:: classref-method -|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) +|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Moves the mouse cursor to ``position``, relative to :ref:`position` of this **Control**. diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 54142e2699b..c7cfd07a7e6 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedVector2Array` **points** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **points** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_point_cloud**\ (\ point_cloud\: :ref:`PackedVector2Array`\ ) +|void| **set_point_cloud**\ (\ point_cloud\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Based on the set of points provided, this assigns the :ref:`points` property using the convex hull algorithm, removing all unneeded points. See :ref:`Geometry2D.convex_hull` for details. diff --git a/classes/class_convexpolygonshape3d.rst b/classes/class_convexpolygonshape3d.rst index 5bc1b5db046..bf5a6e176cd 100644 --- a/classes/class_convexpolygonshape3d.rst +++ b/classes/class_convexpolygonshape3d.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedVector3Array` **points** = ``PackedVector3Array()`` +:ref:`PackedVector3Array` **points** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 77337f111e1..62f7351a226 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -213,7 +213,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. @@ -230,7 +230,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawOrder**: +enum **DrawOrder**: :ref:`🔗` .. _class_CPUParticles2D_constant_DRAW_ORDER_INDEX: @@ -256,7 +256,7 @@ Particles are drawn in order of remaining lifetime. In other words, the particle .. rst-class:: classref-enumeration -enum **Parameter**: +enum **Parameter**: :ref:`🔗` .. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY: @@ -370,7 +370,7 @@ Represents the size of the :ref:`Parameter` enum. .. rst-class:: classref-enumeration -enum **ParticleFlags**: +enum **ParticleFlags**: :ref:`🔗` .. _class_CPUParticles2D_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY: @@ -412,7 +412,7 @@ Represents the size of the :ref:`ParticleFlags` .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT: @@ -483,7 +483,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **amount** = ``8`` +:ref:`int` **amount** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -500,7 +500,7 @@ Number of particles emitted in one emission cycle. .. rst-class:: classref-property -:ref:`Curve` **angle_curve** +:ref:`Curve` **angle_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -517,7 +517,7 @@ Each particle's rotation will be animated along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **angle_max** = ``0.0`` +:ref:`float` **angle_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -534,7 +534,7 @@ Maximum initial rotation applied to each particle, in degrees. .. rst-class:: classref-property -:ref:`float` **angle_min** = ``0.0`` +:ref:`float` **angle_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -551,7 +551,7 @@ Minimum equivalent of :ref:`angle_max`. .. rst-class:: classref-property -:ref:`Curve` **angular_velocity_curve** +:ref:`Curve` **angular_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -568,7 +568,7 @@ Each particle's angular velocity will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **angular_velocity_max** = ``0.0`` +:ref:`float` **angular_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -585,7 +585,7 @@ Maximum initial angular velocity (rotation speed) applied to each particle in *d .. rst-class:: classref-property -:ref:`float` **angular_velocity_min** = ``0.0`` +:ref:`float` **angular_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -602,7 +602,7 @@ Minimum equivalent of :ref:`angular_velocity_max` **anim_offset_curve** +:ref:`Curve` **anim_offset_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -619,7 +619,7 @@ Each particle's animation offset will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **anim_offset_max** = ``0.0`` +:ref:`float` **anim_offset_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -636,7 +636,7 @@ Maximum animation offset that corresponds to frame index in the texture. ``0`` i .. rst-class:: classref-property -:ref:`float` **anim_offset_min** = ``0.0`` +:ref:`float` **anim_offset_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -653,7 +653,7 @@ Minimum equivalent of :ref:`anim_offset_max` **anim_speed_curve** +:ref:`Curve` **anim_speed_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -670,7 +670,7 @@ Each particle's animation speed will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **anim_speed_max** = ``0.0`` +:ref:`float` **anim_speed_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -689,7 +689,7 @@ With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMate .. rst-class:: classref-property -:ref:`float` **anim_speed_min** = ``0.0`` +:ref:`float` **anim_speed_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -706,7 +706,7 @@ Minimum equivalent of :ref:`anim_speed_max` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -723,7 +723,7 @@ Each particle's initial color. If :ref:`texture` **color_initial_ramp** +:ref:`Gradient` **color_initial_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -740,7 +740,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D` **color_ramp** +:ref:`Gradient` **color_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -757,7 +757,7 @@ Each particle's color will vary along this :ref:`Gradient` (mult .. rst-class:: classref-property -:ref:`Curve` **damping_curve** +:ref:`Curve` **damping_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -774,7 +774,7 @@ Damping will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **damping_max** = ``0.0`` +:ref:`float` **damping_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -791,7 +791,7 @@ The maximum rate at which particles lose velocity. For example value of ``100`` .. rst-class:: classref-property -:ref:`float` **damping_min** = ``0.0`` +:ref:`float` **damping_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -808,7 +808,7 @@ Minimum equivalent of :ref:`damping_max` **direction** = ``Vector2(1, 0)`` +:ref:`Vector2` **direction** = ``Vector2(1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -825,7 +825,7 @@ Unit vector specifying the particles' emission direction. .. rst-class:: classref-property -:ref:`DrawOrder` **draw_order** = ``0`` +:ref:`DrawOrder` **draw_order** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -842,7 +842,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`PackedColorArray` **emission_colors** +:ref:`PackedColorArray` **emission_colors** :ref:`🔗` .. rst-class:: classref-property-setget @@ -861,7 +861,7 @@ Sets the :ref:`Color`\ s to modulate particles by when using :ref:` .. rst-class:: classref-property -:ref:`PackedVector2Array` **emission_normals** +:ref:`PackedVector2Array` **emission_normals** :ref:`🔗` .. rst-class:: classref-property-setget @@ -880,7 +880,7 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH .. rst-class:: classref-property -:ref:`PackedVector2Array` **emission_points** +:ref:`PackedVector2Array` **emission_points** :ref:`🔗` .. rst-class:: classref-property-setget @@ -899,7 +899,7 @@ Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_PO .. rst-class:: classref-property -:ref:`Vector2` **emission_rect_extents** +:ref:`Vector2` **emission_rect_extents** :ref:`🔗` .. rst-class:: classref-property-setget @@ -916,7 +916,7 @@ The rectangle's extents if :ref:`emission_shape` **emission_shape** = ``0`` +:ref:`EmissionShape` **emission_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -933,7 +933,7 @@ Particles will be emitted inside this region. See :ref:`EmissionShape` **emission_sphere_radius** +:ref:`float` **emission_sphere_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -950,7 +950,7 @@ The sphere's radius if :ref:`emission_shape` **emitting** = ``true`` +:ref:`bool` **emitting** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -967,7 +967,7 @@ If ``true``, particles are being emitted. :ref:`emitting` **explosiveness** = ``0.0`` +:ref:`float` **explosiveness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -984,7 +984,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t .. rst-class:: classref-property -:ref:`int` **fixed_fps** = ``0`` +:ref:`int` **fixed_fps** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1001,7 +1001,7 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property -:ref:`bool` **fract_delta** = ``true`` +:ref:`bool` **fract_delta** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1018,7 +1018,7 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property -:ref:`Vector2` **gravity** = ``Vector2(0, 980)`` +:ref:`Vector2` **gravity** = ``Vector2(0, 980)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1035,7 +1035,7 @@ Gravity applied to every particle. .. rst-class:: classref-property -:ref:`Curve` **hue_variation_curve** +:ref:`Curve` **hue_variation_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1052,7 +1052,7 @@ Each particle's hue will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **hue_variation_max** = ``0.0`` +:ref:`float` **hue_variation_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1069,7 +1069,7 @@ Maximum initial hue variation applied to each particle. It will shift the partic .. rst-class:: classref-property -:ref:`float` **hue_variation_min** = ``0.0`` +:ref:`float` **hue_variation_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1086,7 +1086,7 @@ Minimum equivalent of :ref:`hue_variation_max` **initial_velocity_max** = ``0.0`` +:ref:`float` **initial_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1103,7 +1103,7 @@ Maximum initial velocity magnitude for each particle. Direction comes from :ref: .. rst-class:: classref-property -:ref:`float` **initial_velocity_min** = ``0.0`` +:ref:`float` **initial_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1120,7 +1120,7 @@ Minimum equivalent of :ref:`initial_velocity_max` **lifetime** = ``1.0`` +:ref:`float` **lifetime** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1137,7 +1137,7 @@ Amount of time each particle will exist. .. rst-class:: classref-property -:ref:`float` **lifetime_randomness** = ``0.0`` +:ref:`float` **lifetime_randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1154,7 +1154,7 @@ Particle lifetime randomness ratio. .. rst-class:: classref-property -:ref:`Curve` **linear_accel_curve** +:ref:`Curve` **linear_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1171,7 +1171,7 @@ Each particle's linear acceleration will vary along this :ref:`Curve` **linear_accel_max** = ``0.0`` +:ref:`float` **linear_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1188,7 +1188,7 @@ Maximum linear acceleration applied to each particle in the direction of motion. .. rst-class:: classref-property -:ref:`float` **linear_accel_min** = ``0.0`` +:ref:`float` **linear_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1205,7 +1205,7 @@ Minimum equivalent of :ref:`linear_accel_max` **local_coords** = ``false`` +:ref:`bool` **local_coords** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1222,7 +1222,7 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property -:ref:`bool` **one_shot** = ``false`` +:ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1239,7 +1239,7 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi .. rst-class:: classref-property -:ref:`Curve` **orbit_velocity_curve** +:ref:`Curve` **orbit_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1256,7 +1256,7 @@ Each particle's orbital velocity will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **orbit_velocity_max** = ``0.0`` +:ref:`float` **orbit_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1273,7 +1273,7 @@ Maximum orbital velocity applied to each particle. Makes the particles circle ar .. rst-class:: classref-property -:ref:`float` **orbit_velocity_min** = ``0.0`` +:ref:`float` **orbit_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1290,7 +1290,7 @@ Minimum equivalent of :ref:`orbit_velocity_max` **particle_flag_align_y** = ``false`` +:ref:`bool` **particle_flag_align_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1307,7 +1307,7 @@ Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-property -:ref:`float` **preprocess** = ``0.0`` +:ref:`float` **preprocess** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1324,7 +1324,7 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property -:ref:`Curve` **radial_accel_curve** +:ref:`Curve` **radial_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1341,7 +1341,7 @@ Each particle's radial acceleration will vary along this :ref:`Curve` **radial_accel_max** = ``0.0`` +:ref:`float` **radial_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1358,7 +1358,7 @@ Maximum radial acceleration applied to each particle. Makes particle accelerate .. rst-class:: classref-property -:ref:`float` **radial_accel_min** = ``0.0`` +:ref:`float` **radial_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1375,7 +1375,7 @@ Minimum equivalent of :ref:`radial_accel_max` **randomness** = ``0.0`` +:ref:`float` **randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1392,7 +1392,7 @@ Emission lifetime randomness ratio. .. rst-class:: classref-property -:ref:`Curve` **scale_amount_curve** +:ref:`Curve` **scale_amount_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1409,7 +1409,7 @@ Each particle's scale will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **scale_amount_max** = ``1.0`` +:ref:`float` **scale_amount_max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1426,7 +1426,7 @@ Maximum initial scale applied to each particle. .. rst-class:: classref-property -:ref:`float` **scale_amount_min** = ``1.0`` +:ref:`float` **scale_amount_min** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1443,7 +1443,7 @@ Minimum equivalent of :ref:`scale_amount_max` **scale_curve_x** +:ref:`Curve` **scale_curve_x** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1462,7 +1462,7 @@ Each particle's horizontal scale will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`Curve` **scale_curve_y** +:ref:`Curve` **scale_curve_y** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1481,7 +1481,7 @@ Each particle's vertical scale will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1498,7 +1498,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. rst-class:: classref-property -:ref:`bool` **split_scale** = ``false`` +:ref:`bool` **split_scale** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1515,7 +1515,7 @@ If ``true``, the scale curve will be split into x and y components. See :ref:`sc .. rst-class:: classref-property -:ref:`float` **spread** = ``45.0`` +:ref:`float` **spread** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1532,7 +1532,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-property -:ref:`Curve` **tangential_accel_curve** +:ref:`Curve` **tangential_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1549,7 +1549,7 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` **tangential_accel_max** = ``0.0`` +:ref:`float` **tangential_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1566,7 +1566,7 @@ Maximum tangential acceleration applied to each particle. Tangential acceleratio .. rst-class:: classref-property -:ref:`float` **tangential_accel_min** = ``0.0`` +:ref:`float` **tangential_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1583,7 +1583,7 @@ Minimum equivalent of :ref:`tangential_accel_max` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1605,7 +1605,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) :ref:`🔗` Sets this node's properties to match a given :ref:`GPUParticles2D` node with an assigned :ref:`ParticleProcessMaterial`. @@ -1617,7 +1617,7 @@ Sets this node's properties to match a given :ref:`GPUParticles2D` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1629,7 +1629,7 @@ Returns the :ref:`Curve` of the parameter specified by :ref:`Parame .. rst-class:: classref-method -:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the maximum value range for the given parameter. @@ -1641,7 +1641,7 @@ Returns the maximum value range for the given parameter. .. rst-class:: classref-method -:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the minimum value range for the given parameter. @@ -1653,7 +1653,7 @@ Returns the minimum value range for the given parameter. .. rst-class:: classref-method -:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| +:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` Returns the enabled state of the given flag (see :ref:`ParticleFlags` for options). @@ -1665,7 +1665,7 @@ Returns the enabled state of the given flag (see :ref:`ParticleFlags` Restarts the particle emitter. @@ -1677,7 +1677,7 @@ Restarts the particle emitter. .. rst-class:: classref-method -|void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +|void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) :ref:`🔗` Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1689,7 +1689,7 @@ Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter .. rst-class:: classref-method -|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the maximum value for the given parameter. @@ -1701,7 +1701,7 @@ Sets the maximum value for the given parameter. .. rst-class:: classref-method -|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the minimum value for the given parameter. @@ -1713,7 +1713,7 @@ Sets the minimum value for the given parameter. .. rst-class:: classref-method -|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` Enables or disables the given flag (see :ref:`ParticleFlags` for options). diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index a5c71b3f5cc..ba08e373997 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -231,7 +231,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. @@ -248,7 +248,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawOrder**: +enum **DrawOrder**: :ref:`🔗` .. _class_CPUParticles3D_constant_DRAW_ORDER_INDEX: @@ -282,7 +282,7 @@ Particles are drawn in order of depth. .. rst-class:: classref-enumeration -enum **Parameter**: +enum **Parameter**: :ref:`🔗` .. _class_CPUParticles3D_constant_PARAM_INITIAL_LINEAR_VELOCITY: @@ -396,7 +396,7 @@ Represents the size of the :ref:`Parameter` enum. .. rst-class:: classref-enumeration -enum **ParticleFlags**: +enum **ParticleFlags**: :ref:`🔗` .. _class_CPUParticles3D_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY: @@ -438,7 +438,7 @@ Represents the size of the :ref:`ParticleFlags` .. _class_CPUParticles3D_constant_EMISSION_SHAPE_POINT: @@ -517,7 +517,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **amount** = ``8`` +:ref:`int` **amount** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -534,7 +534,7 @@ Number of particles emitted in one emission cycle. .. rst-class:: classref-property -:ref:`Curve` **angle_curve** +:ref:`Curve` **angle_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -551,7 +551,7 @@ Each particle's rotation will be animated along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **angle_max** = ``0.0`` +:ref:`float` **angle_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -568,7 +568,7 @@ Maximum angle. .. rst-class:: classref-property -:ref:`float` **angle_min** = ``0.0`` +:ref:`float` **angle_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -585,7 +585,7 @@ Minimum angle. .. rst-class:: classref-property -:ref:`Curve` **angular_velocity_curve** +:ref:`Curve` **angular_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -602,7 +602,7 @@ Each particle's angular velocity (rotation speed) will vary along this :ref:`Cur .. rst-class:: classref-property -:ref:`float` **angular_velocity_max** = ``0.0`` +:ref:`float` **angular_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -619,7 +619,7 @@ Maximum initial angular velocity (rotation speed) applied to each particle in *d .. rst-class:: classref-property -:ref:`float` **angular_velocity_min** = ``0.0`` +:ref:`float` **angular_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -636,7 +636,7 @@ Minimum initial angular velocity (rotation speed) applied to each particle in *d .. rst-class:: classref-property -:ref:`Curve` **anim_offset_curve** +:ref:`Curve` **anim_offset_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -653,7 +653,7 @@ Each particle's animation offset will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **anim_offset_max** = ``0.0`` +:ref:`float` **anim_offset_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -670,7 +670,7 @@ Maximum animation offset. .. rst-class:: classref-property -:ref:`float` **anim_offset_min** = ``0.0`` +:ref:`float` **anim_offset_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -687,7 +687,7 @@ Minimum animation offset. .. rst-class:: classref-property -:ref:`Curve` **anim_speed_curve** +:ref:`Curve` **anim_speed_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -704,7 +704,7 @@ Each particle's animation speed will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **anim_speed_max** = ``0.0`` +:ref:`float` **anim_speed_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -721,7 +721,7 @@ Maximum particle animation speed. .. rst-class:: classref-property -:ref:`float` **anim_speed_min** = ``0.0`` +:ref:`float` **anim_speed_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -738,7 +738,7 @@ Minimum particle animation speed. .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -757,7 +757,7 @@ Each particle's initial color. .. rst-class:: classref-property -:ref:`Gradient` **color_initial_ramp** +:ref:`Gradient` **color_initial_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -776,7 +776,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D` **color_ramp** +:ref:`Gradient` **color_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -795,7 +795,7 @@ Each particle's color will vary along this :ref:`GradientTexture1D` **damping_curve** +:ref:`Curve` **damping_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -812,7 +812,7 @@ Damping will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **damping_max** = ``0.0`` +:ref:`float` **damping_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -829,7 +829,7 @@ Maximum damping. .. rst-class:: classref-property -:ref:`float` **damping_min** = ``0.0`` +:ref:`float` **damping_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -846,7 +846,7 @@ Minimum damping. .. rst-class:: classref-property -:ref:`Vector3` **direction** = ``Vector3(1, 0, 0)`` +:ref:`Vector3` **direction** = ``Vector3(1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -863,7 +863,7 @@ Unit vector specifying the particles' emission direction. .. rst-class:: classref-property -:ref:`DrawOrder` **draw_order** = ``0`` +:ref:`DrawOrder` **draw_order** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -880,7 +880,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`Vector3` **emission_box_extents** +:ref:`Vector3` **emission_box_extents** :ref:`🔗` .. rst-class:: classref-property-setget @@ -897,7 +897,7 @@ The rectangle's extents if :ref:`emission_shape` **emission_colors** = ``PackedColorArray()`` +:ref:`PackedColorArray` **emission_colors** = ``PackedColorArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -918,7 +918,7 @@ Sets the :ref:`Color`\ s to modulate particles by when using :ref:` .. rst-class:: classref-property -:ref:`PackedVector3Array` **emission_normals** +:ref:`PackedVector3Array` **emission_normals** :ref:`🔗` .. rst-class:: classref-property-setget @@ -937,7 +937,7 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH .. rst-class:: classref-property -:ref:`PackedVector3Array` **emission_points** +:ref:`PackedVector3Array` **emission_points** :ref:`🔗` .. rst-class:: classref-property-setget @@ -956,7 +956,7 @@ Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_PO .. rst-class:: classref-property -:ref:`Vector3` **emission_ring_axis** +:ref:`Vector3` **emission_ring_axis** :ref:`🔗` .. rst-class:: classref-property-setget @@ -973,7 +973,7 @@ The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_ring_height** +:ref:`float` **emission_ring_height** :ref:`🔗` .. rst-class:: classref-property-setget @@ -990,7 +990,7 @@ The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_ring_inner_radius** +:ref:`float` **emission_ring_inner_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1007,7 +1007,7 @@ The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_ring_radius** +:ref:`float` **emission_ring_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1024,7 +1024,7 @@ The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_shape** = ``0`` +:ref:`EmissionShape` **emission_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1041,7 +1041,7 @@ Particles will be emitted inside this region. See :ref:`EmissionShape` **emission_sphere_radius** +:ref:`float` **emission_sphere_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1058,7 +1058,7 @@ The sphere's radius if :ref:`EmissionShape` i .. rst-class:: classref-property -:ref:`bool` **emitting** = ``true`` +:ref:`bool` **emitting** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1075,7 +1075,7 @@ If ``true``, particles are being emitted. :ref:`emitting` **explosiveness** = ``0.0`` +:ref:`float` **explosiveness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1092,7 +1092,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t .. rst-class:: classref-property -:ref:`int` **fixed_fps** = ``0`` +:ref:`int` **fixed_fps** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1109,7 +1109,7 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property -:ref:`float` **flatness** = ``0.0`` +:ref:`float` **flatness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1126,7 +1126,7 @@ Amount of :ref:`spread` in Y/Z plane. A va .. rst-class:: classref-property -:ref:`bool` **fract_delta** = ``true`` +:ref:`bool` **fract_delta** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1143,7 +1143,7 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property -:ref:`Vector3` **gravity** = ``Vector3(0, -9.8, 0)`` +:ref:`Vector3` **gravity** = ``Vector3(0, -9.8, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1160,7 +1160,7 @@ Gravity applied to every particle. .. rst-class:: classref-property -:ref:`Curve` **hue_variation_curve** +:ref:`Curve` **hue_variation_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1177,7 +1177,7 @@ Each particle's hue will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **hue_variation_max** = ``0.0`` +:ref:`float` **hue_variation_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1194,7 +1194,7 @@ Maximum hue variation. .. rst-class:: classref-property -:ref:`float` **hue_variation_min** = ``0.0`` +:ref:`float` **hue_variation_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1211,7 +1211,7 @@ Minimum hue variation. .. rst-class:: classref-property -:ref:`float` **initial_velocity_max** = ``0.0`` +:ref:`float` **initial_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1228,7 +1228,7 @@ Maximum value of the initial velocity. .. rst-class:: classref-property -:ref:`float` **initial_velocity_min** = ``0.0`` +:ref:`float` **initial_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1245,7 +1245,7 @@ Minimum value of the initial velocity. .. rst-class:: classref-property -:ref:`float` **lifetime** = ``1.0`` +:ref:`float` **lifetime** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1262,7 +1262,7 @@ Amount of time each particle will exist. .. rst-class:: classref-property -:ref:`float` **lifetime_randomness** = ``0.0`` +:ref:`float` **lifetime_randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1279,7 +1279,7 @@ Particle lifetime randomness ratio. .. rst-class:: classref-property -:ref:`Curve` **linear_accel_curve** +:ref:`Curve` **linear_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1296,7 +1296,7 @@ Each particle's linear acceleration will vary along this :ref:`Curve` **linear_accel_max** = ``0.0`` +:ref:`float` **linear_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1313,7 +1313,7 @@ Maximum linear acceleration. .. rst-class:: classref-property -:ref:`float` **linear_accel_min** = ``0.0`` +:ref:`float` **linear_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1330,7 +1330,7 @@ Minimum linear acceleration. .. rst-class:: classref-property -:ref:`bool` **local_coords** = ``false`` +:ref:`bool` **local_coords** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1347,7 +1347,7 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1364,7 +1364,7 @@ The :ref:`Mesh` used for each particle. If ``null``, particles will .. rst-class:: classref-property -:ref:`bool` **one_shot** = ``false`` +:ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1381,7 +1381,7 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi .. rst-class:: classref-property -:ref:`Curve` **orbit_velocity_curve** +:ref:`Curve` **orbit_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1398,7 +1398,7 @@ Each particle's orbital velocity will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **orbit_velocity_max** +:ref:`float` **orbit_velocity_max** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1415,7 +1415,7 @@ Maximum orbit velocity. .. rst-class:: classref-property -:ref:`float` **orbit_velocity_min** +:ref:`float` **orbit_velocity_min** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1432,7 +1432,7 @@ Minimum orbit velocity. .. rst-class:: classref-property -:ref:`bool` **particle_flag_align_y** = ``false`` +:ref:`bool` **particle_flag_align_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1449,7 +1449,7 @@ Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-property -:ref:`bool` **particle_flag_disable_z** = ``false`` +:ref:`bool` **particle_flag_disable_z** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1466,7 +1466,7 @@ If ``true``, particles will not move on the Z axis. .. rst-class:: classref-property -:ref:`bool` **particle_flag_rotate_y** = ``false`` +:ref:`bool` **particle_flag_rotate_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1483,7 +1483,7 @@ If ``true``, particles rotate around Y axis by :ref:`angle_min` **preprocess** = ``0.0`` +:ref:`float` **preprocess** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1500,7 +1500,7 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property -:ref:`Curve` **radial_accel_curve** +:ref:`Curve` **radial_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1517,7 +1517,7 @@ Each particle's radial acceleration will vary along this :ref:`Curve` **radial_accel_max** = ``0.0`` +:ref:`float` **radial_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1534,7 +1534,7 @@ Maximum radial acceleration. .. rst-class:: classref-property -:ref:`float` **radial_accel_min** = ``0.0`` +:ref:`float` **radial_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1551,7 +1551,7 @@ Minimum radial acceleration. .. rst-class:: classref-property -:ref:`float` **randomness** = ``0.0`` +:ref:`float` **randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1568,7 +1568,7 @@ Emission lifetime randomness ratio. .. rst-class:: classref-property -:ref:`Curve` **scale_amount_curve** +:ref:`Curve` **scale_amount_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1585,7 +1585,7 @@ Each particle's scale will vary along this :ref:`Curve`. .. rst-class:: classref-property -:ref:`float` **scale_amount_max** = ``1.0`` +:ref:`float` **scale_amount_max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1602,7 +1602,7 @@ Maximum scale. .. rst-class:: classref-property -:ref:`float` **scale_amount_min** = ``1.0`` +:ref:`float` **scale_amount_min** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1619,7 +1619,7 @@ Minimum scale. .. rst-class:: classref-property -:ref:`Curve` **scale_curve_x** +:ref:`Curve` **scale_curve_x** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1636,7 +1636,7 @@ Curve for the scale over life, along the x axis. .. rst-class:: classref-property -:ref:`Curve` **scale_curve_y** +:ref:`Curve` **scale_curve_y** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1653,7 +1653,7 @@ Curve for the scale over life, along the y axis. .. rst-class:: classref-property -:ref:`Curve` **scale_curve_z** +:ref:`Curve` **scale_curve_z** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1670,7 +1670,7 @@ Curve for the scale over life, along the z axis. .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1687,7 +1687,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. rst-class:: classref-property -:ref:`bool` **split_scale** = ``false`` +:ref:`bool` **split_scale** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1704,7 +1704,7 @@ If set to ``true``, three different scale curves can be specified, one per scale .. rst-class:: classref-property -:ref:`float` **spread** = ``45.0`` +:ref:`float` **spread** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1721,7 +1721,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-property -:ref:`Curve` **tangential_accel_curve** +:ref:`Curve` **tangential_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1738,7 +1738,7 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` **tangential_accel_max** = ``0.0`` +:ref:`float` **tangential_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1755,7 +1755,7 @@ Maximum tangent acceleration. .. rst-class:: classref-property -:ref:`float` **tangential_accel_min** = ``0.0`` +:ref:`float` **tangential_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1772,7 +1772,7 @@ Minimum tangent acceleration. .. rst-class:: classref-property -:ref:`AABB` **visibility_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **visibility_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1796,7 +1796,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) :ref:`🔗` Sets this node's properties to match a given :ref:`GPUParticles3D` node with an assigned :ref:`ParticleProcessMaterial`. @@ -1808,7 +1808,7 @@ Sets this node's properties to match a given :ref:`GPUParticles3D` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1820,7 +1820,7 @@ Returns the :ref:`Curve` of the parameter specified by :ref:`Parame .. rst-class:: classref-method -:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the maximum value range for the given parameter. @@ -1832,7 +1832,7 @@ Returns the maximum value range for the given parameter. .. rst-class:: classref-method -:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the minimum value range for the given parameter. @@ -1844,7 +1844,7 @@ Returns the minimum value range for the given parameter. .. rst-class:: classref-method -:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| +:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` Returns the enabled state of the given particle flag (see :ref:`ParticleFlags` for options). @@ -1856,7 +1856,7 @@ Returns the enabled state of the given particle flag (see :ref:`ParticleFlags` Restarts the particle emitter. @@ -1868,7 +1868,7 @@ Restarts the particle emitter. .. rst-class:: classref-method -|void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +|void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) :ref:`🔗` Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1880,7 +1880,7 @@ Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter .. rst-class:: classref-method -|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the maximum value for the given parameter. @@ -1892,7 +1892,7 @@ Sets the maximum value for the given parameter. .. rst-class:: classref-method -|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the minimum value for the given parameter. @@ -1904,7 +1904,7 @@ Sets the minimum value for the given parameter. .. rst-class:: classref-method -|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` Enables or disables the given particle flag (see :ref:`ParticleFlags` for options). diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index 2ce93963d1f..83c6e1f6124 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -134,7 +134,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **constant_time_compare**\ (\ trusted\: :ref:`PackedByteArray`, received\: :ref:`PackedByteArray`\ ) +:ref:`bool` **constant_time_compare**\ (\ trusted\: :ref:`PackedByteArray`, received\: :ref:`PackedByteArray`\ ) :ref:`🔗` Compares two :ref:`PackedByteArray`\ s for equality without leaking timing information in order to prevent timing attacks. @@ -148,7 +148,7 @@ See `this blog post ` **decrypt**\ (\ key\: :ref:`CryptoKey`, ciphertext\: :ref:`PackedByteArray`\ ) +:ref:`PackedByteArray` **decrypt**\ (\ key\: :ref:`CryptoKey`, ciphertext\: :ref:`PackedByteArray`\ ) :ref:`🔗` Decrypt the given ``ciphertext`` with the provided private ``key``. @@ -162,7 +162,7 @@ Decrypt the given ``ciphertext`` with the provided private ``key``. .. rst-class:: classref-method -:ref:`PackedByteArray` **encrypt**\ (\ key\: :ref:`CryptoKey`, plaintext\: :ref:`PackedByteArray`\ ) +:ref:`PackedByteArray` **encrypt**\ (\ key\: :ref:`CryptoKey`, plaintext\: :ref:`PackedByteArray`\ ) :ref:`🔗` Encrypt the given ``plaintext`` with the provided public ``key``. @@ -176,7 +176,7 @@ Encrypt the given ``plaintext`` with the provided public ``key``. .. rst-class:: classref-method -:ref:`PackedByteArray` **generate_random_bytes**\ (\ size\: :ref:`int`\ ) +:ref:`PackedByteArray` **generate_random_bytes**\ (\ size\: :ref:`int`\ ) :ref:`🔗` Generates a :ref:`PackedByteArray` of cryptographically secure random bytes with given ``size``. @@ -188,7 +188,7 @@ Generates a :ref:`PackedByteArray` of cryptographically s .. rst-class:: classref-method -:ref:`CryptoKey` **generate_rsa**\ (\ size\: :ref:`int`\ ) +:ref:`CryptoKey` **generate_rsa**\ (\ size\: :ref:`int`\ ) :ref:`🔗` Generates an RSA :ref:`CryptoKey` that can be used for creating self-signed certificates and passed to :ref:`StreamPeerTLS.accept_stream`. @@ -200,7 +200,7 @@ Generates an RSA :ref:`CryptoKey` that can be used for creating .. rst-class:: classref-method -:ref:`X509Certificate` **generate_self_signed_certificate**\ (\ key\: :ref:`CryptoKey`, issuer_name\: :ref:`String` = "CN=myserver,O=myorganisation,C=IT", not_before\: :ref:`String` = "20140101000000", not_after\: :ref:`String` = "20340101000000"\ ) +:ref:`X509Certificate` **generate_self_signed_certificate**\ (\ key\: :ref:`CryptoKey`, issuer_name\: :ref:`String` = "CN=myserver,O=myorganisation,C=IT", not_before\: :ref:`String` = "20140101000000", not_after\: :ref:`String` = "20340101000000"\ ) :ref:`🔗` Generates a self-signed :ref:`X509Certificate` from the given :ref:`CryptoKey` and ``issuer_name``. The certificate validity will be defined by ``not_before`` and ``not_after`` (first valid date and last valid date). The ``issuer_name`` must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). @@ -235,7 +235,7 @@ A small example to generate an RSA key and an X509 self-signed certificate. .. rst-class:: classref-method -:ref:`PackedByteArray` **hmac_digest**\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`, msg\: :ref:`PackedByteArray`\ ) +:ref:`PackedByteArray` **hmac_digest**\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`, msg\: :ref:`PackedByteArray`\ ) :ref:`🔗` Generates an `HMAC `__ digest of ``msg`` using ``key``. The ``hash_type`` parameter is the hashing algorithm that is used for the inner and outer hashes. @@ -249,7 +249,7 @@ Currently, only :ref:`HashingContext.HASH_SHA256` **sign**\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) +:ref:`PackedByteArray` **sign**\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) :ref:`🔗` Sign a given ``hash`` of type ``hash_type`` with the provided private ``key``. @@ -261,7 +261,7 @@ Sign a given ``hash`` of type ``hash_type`` with the provided private ``key``. .. rst-class:: classref-method -:ref:`bool` **verify**\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, signature\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) +:ref:`bool` **verify**\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, signature\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) :ref:`🔗` Verify that a given ``signature`` for ``hash`` of type ``hash_type`` against the provided public ``key``. diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index 8265b624274..f774b09048e 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -63,7 +63,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_public_only**\ (\ ) |const| +:ref:`bool` **is_public_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this CryptoKey only has the public part, and not the private one. @@ -75,7 +75,7 @@ Returns ``true`` if this CryptoKey only has the public part, and not the private .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) :ref:`🔗` Loads a key from ``path``. If ``public_only`` is ``true``, only the public key will be loaded. @@ -89,7 +89,7 @@ Loads a key from ``path``. If ``public_only`` is ``true``, only the public key w .. rst-class:: classref-method -:ref:`Error` **load_from_string**\ (\ string_key\: :ref:`String`, public_only\: :ref:`bool` = false\ ) +:ref:`Error` **load_from_string**\ (\ string_key\: :ref:`String`, public_only\: :ref:`bool` = false\ ) :ref:`🔗` Loads a key from the given ``string_key``. If ``public_only`` is ``true``, only the public key will be loaded. @@ -101,7 +101,7 @@ Loads a key from the given ``string_key``. If ``public_only`` is ``true``, only .. rst-class:: classref-method -:ref:`Error` **save**\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) +:ref:`Error` **save**\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) :ref:`🔗` Saves a key to the given ``path``. If ``public_only`` is ``true``, only the public key will be saved. @@ -115,7 +115,7 @@ Saves a key to the given ``path``. If ``public_only`` is ``true``, only the publ .. rst-class:: classref-method -:ref:`String` **save_to_string**\ (\ public_only\: :ref:`bool` = false\ ) +:ref:`String` **save_to_string**\ (\ public_only\: :ref:`bool` = false\ ) :ref:`🔗` Returns a string containing the key in PEM format. If ``public_only`` is ``true``, only the public key will be included. diff --git a/classes/class_csgbox3d.rst b/classes/class_csgbox3d.rst index 7b82511c0e8..a06d3d965eb 100644 --- a/classes/class_csgbox3d.rst +++ b/classes/class_csgbox3d.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -74,7 +74,7 @@ The material used to render the box. .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csgcylinder3d.rst b/classes/class_csgcylinder3d.rst index e9afb94ede4..79dd0d5f1c1 100644 --- a/classes/class_csgcylinder3d.rst +++ b/classes/class_csgcylinder3d.rst @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **cone** = ``false`` +:ref:`bool` **cone** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -82,7 +82,7 @@ If ``true`` a cone is created, the :ref:`radius` **height** = ``2.0`` +:ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ The height of the cylinder. .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ The material used to render the cylinder. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The radius of the cylinder. .. rst-class:: classref-property -:ref:`int` **sides** = ``8`` +:ref:`int` **sides** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ The number of sides of the cylinder, the higher this number the more detail ther .. rst-class:: classref-property -:ref:`bool` **smooth_faces** = ``true`` +:ref:`bool` **smooth_faces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csgmesh3d.rst b/classes/class_csgmesh3d.rst index e8edd4c7803..e8b2f250ec7 100644 --- a/classes/class_csgmesh3d.rst +++ b/classes/class_csgmesh3d.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -74,7 +74,7 @@ The :ref:`Material` used in drawing the CSG shape. .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csgpolygon3d.rst b/classes/class_csgpolygon3d.rst index d7fb20c7e96..178b904bc55 100644 --- a/classes/class_csgpolygon3d.rst +++ b/classes/class_csgpolygon3d.rst @@ -85,7 +85,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_CSGPolygon3D_constant_MODE_DEPTH: @@ -119,7 +119,7 @@ The :ref:`polygon` shape is extruded along .. rst-class:: classref-enumeration -enum **PathRotation**: +enum **PathRotation**: :ref:`🔗` .. _class_CSGPolygon3D_constant_PATH_ROTATION_POLYGON: @@ -157,7 +157,7 @@ The :ref:`polygon` shape follows the path a .. rst-class:: classref-enumeration -enum **PathIntervalType**: +enum **PathIntervalType**: :ref:`🔗` .. _class_CSGPolygon3D_constant_PATH_INTERVAL_DISTANCE: @@ -188,7 +188,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **depth** = ``1.0`` +:ref:`float` **depth** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ When :ref:`mode` is :ref:`MODE_DEPTH` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ Material to use for the resulting mesh. The UV maps the top half of the material .. rst-class:: classref-property -:ref:`Mode` **mode** = ``0`` +:ref:`Mode` **mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ The :ref:`mode` used to extrude the :ref:`poly .. rst-class:: classref-property -:ref:`bool` **path_continuous_u** +:ref:`bool` **path_continuous_u** :ref:`🔗` .. rst-class:: classref-property-setget @@ -256,7 +256,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_interval** +:ref:`float` **path_interval** :ref:`🔗` .. rst-class:: classref-property-setget @@ -273,7 +273,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_interval_type** +:ref:`PathIntervalType` **path_interval_type** :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_joined** +:ref:`bool` **path_joined** :ref:`🔗` .. rst-class:: classref-property-setget @@ -307,7 +307,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_local** +:ref:`bool` **path_local** :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_node** +:ref:`NodePath` **path_node** :ref:`🔗` .. rst-class:: classref-property-setget @@ -341,7 +341,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_rotation** +:ref:`PathRotation` **path_rotation** :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_simplify_angle** +:ref:`float` **path_simplify_angle** :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **path_u_distance** +:ref:`float` **path_u_distance** :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ When :ref:`mode` is :ref:`MODE_PATH` **polygon** = ``PackedVector2Array(0, 0, 0, 1, 1, 1, 1, 0)`` +:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array(0, 0, 0, 1, 1, 1, 1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -413,7 +413,7 @@ The point array that defines the 2D polygon that is extruded. This can be a conv .. rst-class:: classref-property -:ref:`bool` **smooth_faces** = ``false`` +:ref:`bool` **smooth_faces** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -430,7 +430,7 @@ If ``true``, applies smooth shading to the extrusions. .. rst-class:: classref-property -:ref:`float` **spin_degrees** +:ref:`float` **spin_degrees** :ref:`🔗` .. rst-class:: classref-property-setget @@ -447,7 +447,7 @@ When :ref:`mode` is :ref:`MODE_SPIN` **spin_sides** +:ref:`int` **spin_sides** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csgprimitive3d.rst b/classes/class_csgprimitive3d.rst index c036e90f731..5d758d8f506 100644 --- a/classes/class_csgprimitive3d.rst +++ b/classes/class_csgprimitive3d.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **flip_faces** = ``false`` +:ref:`bool` **flip_faces** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index ae60a33eaed..428dd5dca83 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -91,7 +91,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operation**: +enum **Operation**: :ref:`🔗` .. _class_CSGShape3D_constant_OPERATION_UNION: @@ -130,7 +130,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **calculate_tangents** = ``true`` +:ref:`bool` **calculate_tangents** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ Calculate tangents for the CSG shape which allows the use of normal maps. This i .. rst-class:: classref-property -:ref:`int` **collision_layer** = ``1`` +:ref:`int` **collision_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ A contact is detected if object A is in any of the layers that object B scans, o .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ The physics layers this CSG shape scans for collisions. Only effective if :ref:` .. rst-class:: classref-property -:ref:`float` **collision_priority** = ``1.0`` +:ref:`float` **collision_priority** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ The priority used to solve colliding when occurring penetration. Only effective .. rst-class:: classref-property -:ref:`Operation` **operation** = ``0`` +:ref:`Operation` **operation** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ The operation that is performed on this shape. This is ignored for the first CSG .. rst-class:: classref-property -:ref:`float` **snap** = ``0.001`` +:ref:`float` **snap** = ``0.001`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ Snap makes the mesh vertices snap to a given distance so that the faces of two m .. rst-class:: classref-property -:ref:`bool` **use_collision** = ``false`` +:ref:`bool` **use_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -270,7 +270,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -282,7 +282,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_meshes**\ (\ ) |const| +:ref:`Array` **get_meshes**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` with two elements, the first is the :ref:`Transform3D` of this node and the second is the root :ref:`Mesh` of this node. Only works when this node is the root shape. @@ -294,7 +294,7 @@ Returns an :ref:`Array` with two elements, the first is the :ref:`T .. rst-class:: classref-method -:ref:`bool` **is_root_shape**\ (\ ) |const| +:ref:`bool` **is_root_shape**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this is a root shape and is thus the object that is rendered. @@ -306,7 +306,7 @@ Returns ``true`` if this is a root shape and is thus the object that is rendered .. rst-class:: classref-method -|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -318,7 +318,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_csgsphere3d.rst b/classes/class_csgsphere3d.rst index b76dc6fe068..cf5011badc8 100644 --- a/classes/class_csgsphere3d.rst +++ b/classes/class_csgsphere3d.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ The material used to render the sphere. .. rst-class:: classref-property -:ref:`int` **radial_segments** = ``12`` +:ref:`int` **radial_segments** = ``12`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ Number of vertical slices for the sphere. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ Radius of the sphere. .. rst-class:: classref-property -:ref:`int` **rings** = ``6`` +:ref:`int` **rings** = ``6`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ Number of horizontal slices for the sphere. .. rst-class:: classref-property -:ref:`bool` **smooth_faces** = ``true`` +:ref:`bool` **smooth_faces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csgtorus3d.rst b/classes/class_csgtorus3d.rst index be9dde794f2..010ed505b96 100644 --- a/classes/class_csgtorus3d.rst +++ b/classes/class_csgtorus3d.rst @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **inner_radius** = ``0.5`` +:ref:`float` **inner_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -82,7 +82,7 @@ The inner radius of the torus. .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ The material used to render the torus. .. rst-class:: classref-property -:ref:`float` **outer_radius** = ``1.0`` +:ref:`float` **outer_radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ The outer radius of the torus. .. rst-class:: classref-property -:ref:`int` **ring_sides** = ``6`` +:ref:`int` **ring_sides** = ``6`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The number of edges each ring of the torus is constructed of. .. rst-class:: classref-property -:ref:`int` **sides** = ``8`` +:ref:`int` **sides** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ The number of slices the torus is constructed of. .. rst-class:: classref-property -:ref:`bool` **smooth_faces** = ``true`` +:ref:`bool` **smooth_faces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 6577e00e58d..ea053a09609 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -21,8 +21,6 @@ Description This class represents a C# script. It is the C# equivalent of the :ref:`GDScript` class and is only available in Mono-enabled Godot builds. -See also :ref:`GodotSharp`. - .. rst-class:: classref-introduction-group Tutorials @@ -55,7 +53,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **new**\ (\ ...\ ) |vararg| +:ref:`Variant` **new**\ (\ ...\ ) |vararg| :ref:`🔗` Returns a new instance of the script. diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index a3ee8cc9050..df1ea1f20ad 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderCubemap`). diff --git a/classes/class_cubemaparray.rst b/classes/class_cubemaparray.rst index 6dd21ae46a2..ccca8bd0f94 100644 --- a/classes/class_cubemaparray.rst +++ b/classes/class_cubemaparray.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderCubemapArray`). diff --git a/classes/class_curve.rst b/classes/class_curve.rst index e1109ce8d8e..6171c0afbc7 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -100,7 +100,7 @@ Signals .. rst-class:: classref-signal -**range_changed**\ (\ ) +**range_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`max_value` or :ref:`min_value` is changed. @@ -117,7 +117,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TangentMode**: +enum **TangentMode**: :ref:`🔗` .. _class_Curve_constant_TANGENT_FREE: @@ -156,7 +156,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bake_resolution** = ``100`` +:ref:`int` **bake_resolution** = ``100`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ The number of points to include in the baked (i.e. cached) curve data. .. rst-class:: classref-property -:ref:`float` **max_value** = ``1.0`` +:ref:`float` **max_value** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ The maximum value the curve can reach. .. rst-class:: classref-property -:ref:`float` **min_value** = ``0.0`` +:ref:`float` **min_value** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -207,7 +207,7 @@ The minimum value the curve can reach. .. rst-class:: classref-property -:ref:`int` **point_count** = ``0`` +:ref:`int` **point_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -229,7 +229,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_point**\ (\ position\: :ref:`Vector2`, left_tangent\: :ref:`float` = 0, right_tangent\: :ref:`float` = 0, left_mode\: :ref:`TangentMode` = 0, right_mode\: :ref:`TangentMode` = 0\ ) +:ref:`int` **add_point**\ (\ position\: :ref:`Vector2`, left_tangent\: :ref:`float` = 0, right_tangent\: :ref:`float` = 0, left_mode\: :ref:`TangentMode` = 0, right_mode\: :ref:`TangentMode` = 0\ ) :ref:`🔗` Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LINEAR`, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to :ref:`TANGENT_FREE`. @@ -241,7 +241,7 @@ Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LIN .. rst-class:: classref-method -|void| **bake**\ (\ ) +|void| **bake**\ (\ ) :ref:`🔗` Recomputes the baked cache of points for the curve. @@ -253,7 +253,7 @@ Recomputes the baked cache of points for the curve. .. rst-class:: classref-method -|void| **clean_dupes**\ (\ ) +|void| **clean_dupes**\ (\ ) :ref:`🔗` Removes duplicate points, i.e. points that are less than 0.00001 units (engine epsilon value) away from their neighbor on the curve. @@ -265,7 +265,7 @@ Removes duplicate points, i.e. points that are less than 0.00001 units (engine e .. rst-class:: classref-method -|void| **clear_points**\ (\ ) +|void| **clear_points**\ (\ ) :ref:`🔗` Removes all points from the curve. @@ -277,7 +277,7 @@ Removes all points from the curve. .. rst-class:: classref-method -:ref:`TangentMode` **get_point_left_mode**\ (\ index\: :ref:`int`\ ) |const| +:ref:`TangentMode` **get_point_left_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the left :ref:`TangentMode` for the point at ``index``. @@ -289,7 +289,7 @@ Returns the left :ref:`TangentMode` for the point at ``i .. rst-class:: classref-method -:ref:`float` **get_point_left_tangent**\ (\ index\: :ref:`int`\ ) |const| +:ref:`float` **get_point_left_tangent**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the left tangent angle (in degrees) for the point at ``index``. @@ -301,7 +301,7 @@ Returns the left tangent angle (in degrees) for the point at ``index``. .. rst-class:: classref-method -:ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the curve coordinates for the point at ``index``. @@ -313,7 +313,7 @@ Returns the curve coordinates for the point at ``index``. .. rst-class:: classref-method -:ref:`TangentMode` **get_point_right_mode**\ (\ index\: :ref:`int`\ ) |const| +:ref:`TangentMode` **get_point_right_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the right :ref:`TangentMode` for the point at ``index``. @@ -325,7 +325,7 @@ Returns the right :ref:`TangentMode` for the point at `` .. rst-class:: classref-method -:ref:`float` **get_point_right_tangent**\ (\ index\: :ref:`int`\ ) |const| +:ref:`float` **get_point_right_tangent**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the right tangent angle (in degrees) for the point at ``index``. @@ -337,7 +337,7 @@ Returns the right tangent angle (in degrees) for the point at ``index``. .. rst-class:: classref-method -|void| **remove_point**\ (\ index\: :ref:`int`\ ) +|void| **remove_point**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes the point at ``index`` from the curve. @@ -349,7 +349,7 @@ Removes the point at ``index`` from the curve. .. rst-class:: classref-method -:ref:`float` **sample**\ (\ offset\: :ref:`float`\ ) |const| +:ref:`float` **sample**\ (\ offset\: :ref:`float`\ ) |const| :ref:`🔗` Returns the Y value for the point that would exist at the X position ``offset`` along the curve. @@ -361,7 +361,7 @@ Returns the Y value for the point that would exist at the X position ``offset`` .. rst-class:: classref-method -:ref:`float` **sample_baked**\ (\ offset\: :ref:`float`\ ) |const| +:ref:`float` **sample_baked**\ (\ offset\: :ref:`float`\ ) |const| :ref:`🔗` Returns the Y value for the point that would exist at the X position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked. @@ -373,7 +373,7 @@ Returns the Y value for the point that would exist at the X position ``offset`` .. rst-class:: classref-method -|void| **set_point_left_mode**\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) +|void| **set_point_left_mode**\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) :ref:`🔗` Sets the left :ref:`TangentMode` for the point at ``index`` to ``mode``. @@ -385,7 +385,7 @@ Sets the left :ref:`TangentMode` for the point at ``inde .. rst-class:: classref-method -|void| **set_point_left_tangent**\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) +|void| **set_point_left_tangent**\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) :ref:`🔗` Sets the left tangent angle for the point at ``index`` to ``tangent``. @@ -397,7 +397,7 @@ Sets the left tangent angle for the point at ``index`` to ``tangent``. .. rst-class:: classref-method -:ref:`int` **set_point_offset**\ (\ index\: :ref:`int`, offset\: :ref:`float`\ ) +:ref:`int` **set_point_offset**\ (\ index\: :ref:`int`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the offset from ``0.5``. @@ -409,7 +409,7 @@ Sets the offset from ``0.5``. .. rst-class:: classref-method -|void| **set_point_right_mode**\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) +|void| **set_point_right_mode**\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) :ref:`🔗` Sets the right :ref:`TangentMode` for the point at ``index`` to ``mode``. @@ -421,7 +421,7 @@ Sets the right :ref:`TangentMode` for the point at ``ind .. rst-class:: classref-method -|void| **set_point_right_tangent**\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) +|void| **set_point_right_tangent**\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) :ref:`🔗` Sets the right tangent angle for the point at ``index`` to ``tangent``. @@ -433,7 +433,7 @@ Sets the right tangent angle for the point at ``index`` to ``tangent``. .. rst-class:: classref-method -|void| **set_point_value**\ (\ index\: :ref:`int`, y\: :ref:`float`\ ) +|void| **set_point_value**\ (\ index\: :ref:`int`, y\: :ref:`float`\ ) :ref:`🔗` Assigns the vertical position ``y`` to the point at ``index``. diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 0155f97be39..fda17462067 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -98,7 +98,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bake_interval** = ``5.0`` +:ref:`float` **bake_interval** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ The distance in pixels between two adjacent cached points. Changing it forces th .. rst-class:: classref-property -:ref:`int` **point_count** = ``0`` +:ref:`int` **point_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_point**\ (\ position\: :ref:`Vector2`, in\: :ref:`Vector2` = Vector2(0, 0), out\: :ref:`Vector2` = Vector2(0, 0), index\: :ref:`int` = -1\ ) +|void| **add_point**\ (\ position\: :ref:`Vector2`, in\: :ref:`Vector2` = Vector2(0, 0), out\: :ref:`Vector2` = Vector2(0, 0), index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a point with the specified ``position`` relative to the curve's own position, with control points ``in`` and ``out``. Appends the new point at the end of the point list. @@ -151,7 +151,7 @@ If ``index`` is given, the new point is inserted before the existing point ident .. rst-class:: classref-method -|void| **clear_points**\ (\ ) +|void| **clear_points**\ (\ ) :ref:`🔗` Removes all points from the curve. @@ -163,7 +163,7 @@ Removes all points from the curve. .. rst-class:: classref-method -:ref:`float` **get_baked_length**\ (\ ) |const| +:ref:`float` **get_baked_length**\ (\ ) |const| :ref:`🔗` Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. @@ -175,7 +175,7 @@ Returns the total length of the curve, based on the cached points. Given enough .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_baked_points**\ (\ ) |const| +:ref:`PackedVector2Array` **get_baked_points**\ (\ ) |const| :ref:`🔗` Returns the cache of points as a :ref:`PackedVector2Array`. @@ -187,7 +187,7 @@ Returns the cache of points as a :ref:`PackedVector2Array` **get_closest_offset**\ (\ to_point\: :ref:`Vector2`\ ) |const| +:ref:`float` **get_closest_offset**\ (\ to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`sample_baked`. @@ -201,7 +201,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point**\ (\ to_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **get_closest_point**\ (\ to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the closest point on baked segments (in curve's local space) to ``to_point``. @@ -215,7 +215,7 @@ Returns the closest point on baked segments (in curve's local space) to ``to_poi .. rst-class:: classref-method -:ref:`Vector2` **get_point_in**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_point_in**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the control point leading to the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -227,7 +227,7 @@ Returns the position of the control point leading to the vertex ``idx``. The ret .. rst-class:: classref-method -:ref:`Vector2` **get_point_out**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_point_out**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the control point leading out of the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -239,7 +239,7 @@ Returns the position of the control point leading out of the vertex ``idx``. The .. rst-class:: classref-method -:ref:`Vector2` **get_point_position**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_point_position**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -251,7 +251,7 @@ Returns the position of the vertex ``idx``. If the index is out of bounds, the f .. rst-class:: classref-method -|void| **remove_point**\ (\ idx\: :ref:`int`\ ) +|void| **remove_point**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. @@ -263,7 +263,7 @@ Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx .. rst-class:: classref-method -:ref:`Vector2` **sample**\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| +:ref:`Vector2` **sample**\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| :ref:`🔗` Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, where ``t`` controls if the point is the first vertex (``t = 0.0``), the last vertex (``t = 1.0``), or in between. Values of ``t`` outside the range (``0.0 >= t <=1``) give strange, but predictable results. @@ -277,7 +277,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t .. rst-class:: classref-method -:ref:`Vector2` **sample_baked**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| +:ref:`Vector2` **sample_baked**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a point within the curve at position ``offset``, where ``offset`` is measured as a pixel distance along the curve. @@ -293,7 +293,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. rst-class:: classref-method -:ref:`Transform2D` **sample_baked_with_rotation**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| +:ref:`Transform2D` **sample_baked_with_rotation**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| :ref:`🔗` Similar to :ref:`sample_baked`, but returns :ref:`Transform2D` that includes a rotation along the curve, with :ref:`Transform2D.origin` as the point position and the :ref:`Transform2D.x` vector pointing in the direction of the path at that point. Returns an empty transform if the length of the curve is ``0``. @@ -314,7 +314,7 @@ Similar to :ref:`sample_baked`, but returns : .. rst-class:: classref-method -:ref:`Vector2` **samplef**\ (\ fofs\: :ref:`float`\ ) |const| +:ref:`Vector2` **samplef**\ (\ fofs\: :ref:`float`\ ) |const| :ref:`🔗` Returns the position at the vertex ``fofs``. It calls :ref:`sample` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. @@ -326,7 +326,7 @@ Returns the position at the vertex ``fofs``. It calls :ref:`sample`, position\: :ref:`Vector2`\ ) +|void| **set_point_in**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -338,7 +338,7 @@ Sets the position of the control point leading to the vertex ``idx``. If the ind .. rst-class:: classref-method -|void| **set_point_out**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) +|void| **set_point_out**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -350,7 +350,7 @@ Sets the position of the control point leading out of the vertex ``idx``. If the .. rst-class:: classref-method -|void| **set_point_position**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) +|void| **set_point_position**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. @@ -362,7 +362,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun .. rst-class:: classref-method -:ref:`PackedVector2Array` **tessellate**\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| +:ref:`PackedVector2Array` **tessellate**\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| :ref:`🔗` Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -380,7 +380,7 @@ This approximation makes straight segments between each point, then subdivides t .. rst-class:: classref-method -:ref:`PackedVector2Array` **tessellate_even_length**\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 20.0\ ) |const| +:ref:`PackedVector2Array` **tessellate_even_length**\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 20.0\ ) |const| :ref:`🔗` Returns a list of points along the curve, with almost uniform density. ``max_stages`` controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index f70d683d098..4b4c4b35538 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -110,7 +110,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bake_interval** = ``0.2`` +:ref:`float` **bake_interval** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ The distance in meters between two adjacent cached points. Changing it forces th .. rst-class:: classref-property -:ref:`int` **point_count** = ``0`` +:ref:`int` **point_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ The number of points describing the curve. .. rst-class:: classref-property -:ref:`bool` **up_vector_enabled** = ``true`` +:ref:`bool` **up_vector_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_point**\ (\ position\: :ref:`Vector3`, in\: :ref:`Vector3` = Vector3(0, 0, 0), out\: :ref:`Vector3` = Vector3(0, 0, 0), index\: :ref:`int` = -1\ ) +|void| **add_point**\ (\ position\: :ref:`Vector3`, in\: :ref:`Vector3` = Vector3(0, 0, 0), out\: :ref:`Vector3` = Vector3(0, 0, 0), index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a point with the specified ``position`` relative to the curve's own position, with control points ``in`` and ``out``. Appends the new point at the end of the point list. @@ -180,7 +180,7 @@ If ``index`` is given, the new point is inserted before the existing point ident .. rst-class:: classref-method -|void| **clear_points**\ (\ ) +|void| **clear_points**\ (\ ) :ref:`🔗` Removes all points from the curve. @@ -192,7 +192,7 @@ Removes all points from the curve. .. rst-class:: classref-method -:ref:`float` **get_baked_length**\ (\ ) |const| +:ref:`float` **get_baked_length**\ (\ ) |const| :ref:`🔗` Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. @@ -204,7 +204,7 @@ Returns the total length of the curve, based on the cached points. Given enough .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_baked_points**\ (\ ) |const| +:ref:`PackedVector3Array` **get_baked_points**\ (\ ) |const| :ref:`🔗` Returns the cache of points as a :ref:`PackedVector3Array`. @@ -216,7 +216,7 @@ Returns the cache of points as a :ref:`PackedVector3Array` **get_baked_tilts**\ (\ ) |const| +:ref:`PackedFloat32Array` **get_baked_tilts**\ (\ ) |const| :ref:`🔗` Returns the cache of tilts as a :ref:`PackedFloat32Array`. @@ -228,7 +228,7 @@ Returns the cache of tilts as a :ref:`PackedFloat32Array` **get_baked_up_vectors**\ (\ ) |const| +:ref:`PackedVector3Array` **get_baked_up_vectors**\ (\ ) |const| :ref:`🔗` Returns the cache of up vectors as a :ref:`PackedVector3Array`. @@ -242,7 +242,7 @@ If :ref:`up_vector_enabled` is ``false .. rst-class:: classref-method -:ref:`float` **get_closest_offset**\ (\ to_point\: :ref:`Vector3`\ ) |const| +:ref:`float` **get_closest_offset**\ (\ to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`sample_baked` or :ref:`sample_baked_up_vector`. @@ -256,7 +256,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. rst-class:: classref-method -:ref:`Vector3` **get_closest_point**\ (\ to_point\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **get_closest_point**\ (\ to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the closest point on baked segments (in curve's local space) to ``to_point``. @@ -270,7 +270,7 @@ Returns the closest point on baked segments (in curve's local space) to ``to_poi .. rst-class:: classref-method -:ref:`Vector3` **get_point_in**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_point_in**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the control point leading to the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -282,7 +282,7 @@ Returns the position of the control point leading to the vertex ``idx``. The ret .. rst-class:: classref-method -:ref:`Vector3` **get_point_out**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_point_out**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the control point leading out of the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -294,7 +294,7 @@ Returns the position of the control point leading out of the vertex ``idx``. The .. rst-class:: classref-method -:ref:`Vector3` **get_point_position**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_point_position**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -306,7 +306,7 @@ Returns the position of the vertex ``idx``. If the index is out of bounds, the f .. rst-class:: classref-method -:ref:`float` **get_point_tilt**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`float` **get_point_tilt**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``0``. @@ -318,7 +318,7 @@ Returns the tilt angle in radians for the point ``idx``. If the index is out of .. rst-class:: classref-method -|void| **remove_point**\ (\ idx\: :ref:`int`\ ) +|void| **remove_point**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. @@ -330,7 +330,7 @@ Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx .. rst-class:: classref-method -:ref:`Vector3` **sample**\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| +:ref:`Vector3` **sample**\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| :ref:`🔗` Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, where ``t`` controls if the point is the first vertex (``t = 0.0``), the last vertex (``t = 1.0``), or in between. Values of ``t`` outside the range (``0.0 >= t <=1``) give strange, but predictable results. @@ -344,7 +344,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t .. rst-class:: classref-method -:ref:`Vector3` **sample_baked**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| +:ref:`Vector3` **sample_baked**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a point within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the ``offset`` lies between, then interpolates the values. This interpolation is cubic if ``cubic`` is set to ``true``, or linear if set to ``false``. @@ -358,7 +358,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. rst-class:: classref-method -:ref:`Vector3` **sample_baked_up_vector**\ (\ offset\: :ref:`float`, apply_tilt\: :ref:`bool` = false\ ) |const| +:ref:`Vector3` **sample_baked_up_vector**\ (\ offset\: :ref:`float`, apply_tilt\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an up vector within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve. To do that, it finds the two cached up vectors where the ``offset`` lies between, then interpolates the values. If ``apply_tilt`` is ``true``, an interpolated tilt is applied to the interpolated up vector. @@ -372,7 +372,7 @@ If the curve has no up vectors, the function sends an error to the console, and .. rst-class:: classref-method -:ref:`Transform3D` **sample_baked_with_rotation**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false, apply_tilt\: :ref:`bool` = false\ ) |const| +:ref:`Transform3D` **sample_baked_with_rotation**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false, apply_tilt\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a :ref:`Transform3D` with ``origin`` as point position, ``basis.x`` as sideway vector, ``basis.y`` as up vector, ``basis.z`` as forward vector. When the curve length is 0, there is no reasonable way to calculate the rotation, all vectors aligned with global space axes. See also :ref:`sample_baked`. @@ -384,7 +384,7 @@ Returns a :ref:`Transform3D` with ``origin`` as point positio .. rst-class:: classref-method -:ref:`Vector3` **samplef**\ (\ fofs\: :ref:`float`\ ) |const| +:ref:`Vector3` **samplef**\ (\ fofs\: :ref:`float`\ ) |const| :ref:`🔗` Returns the position at the vertex ``fofs``. It calls :ref:`sample` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. @@ -396,7 +396,7 @@ Returns the position at the vertex ``fofs``. It calls :ref:`sample`, position\: :ref:`Vector3`\ ) +|void| **set_point_in**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -408,7 +408,7 @@ Sets the position of the control point leading to the vertex ``idx``. If the ind .. rst-class:: classref-method -|void| **set_point_out**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) +|void| **set_point_out**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -420,7 +420,7 @@ Sets the position of the control point leading out of the vertex ``idx``. If the .. rst-class:: classref-method -|void| **set_point_position**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) +|void| **set_point_position**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. @@ -432,7 +432,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun .. rst-class:: classref-method -|void| **set_point_tilt**\ (\ idx\: :ref:`int`, tilt\: :ref:`float`\ ) +|void| **set_point_tilt**\ (\ idx\: :ref:`int`, tilt\: :ref:`float`\ ) :ref:`🔗` Sets the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console. @@ -446,7 +446,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa .. rst-class:: classref-method -:ref:`PackedVector3Array` **tessellate**\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| +:ref:`PackedVector3Array` **tessellate**\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| :ref:`🔗` Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -464,7 +464,7 @@ This approximation makes straight segments between each point, then subdivides t .. rst-class:: classref-method -:ref:`PackedVector3Array` **tessellate_even_length**\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 0.2\ ) |const| +:ref:`PackedVector3Array` **tessellate_even_length**\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 0.2\ ) |const| :ref:`🔗` Returns a list of points along the curve, with almost uniform density. ``max_stages`` controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 26b7a18f9e8..0e23a5ef3c5 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -54,7 +54,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TextureMode**: +enum **TextureMode**: :ref:`🔗` .. _class_CurveTexture_constant_TEXTURE_MODE_RGB: @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Curve` **curve** +:ref:`Curve` **curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ The :ref:`Curve` that is rendered onto the texture. .. rst-class:: classref-property -:ref:`TextureMode` **texture_mode** = ``0`` +:ref:`TextureMode` **texture_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -119,7 +119,7 @@ The format the texture should be generated with. When passing a CurveTexture as .. rst-class:: classref-property -:ref:`int` **width** = ``256`` +:ref:`int` **width** = ``256`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_curvexyztexture.rst b/classes/class_curvexyztexture.rst index 01a55d98737..c86f9c8ec71 100644 --- a/classes/class_curvexyztexture.rst +++ b/classes/class_curvexyztexture.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Curve` **curve_x** +:ref:`Curve` **curve_x** :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ The :ref:`Curve` that is rendered onto the texture's red channel. .. rst-class:: classref-property -:ref:`Curve` **curve_y** +:ref:`Curve` **curve_y** :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The :ref:`Curve` that is rendered onto the texture's green channel. .. rst-class:: classref-property -:ref:`Curve` **curve_z** +:ref:`Curve` **curve_z** :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The :ref:`Curve` that is rendered onto the texture's blue channel. .. rst-class:: classref-property -:ref:`int` **width** = ``256`` +:ref:`int` **width** = ``256`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 6d1f4ba7213..89e42b5b7e1 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -58,7 +58,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bottom_radius** = ``0.5`` +:ref:`float` **bottom_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ Bottom radius of the cylinder. If set to ``0.0``, the bottom faces will not be g .. rst-class:: classref-property -:ref:`bool` **cap_bottom** = ``true`` +:ref:`bool` **cap_bottom** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ If ``true``, generates a cap at the bottom of the cylinder. This can be set to ` .. rst-class:: classref-property -:ref:`bool` **cap_top** = ``true`` +:ref:`bool` **cap_top** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ If ``true``, generates a cap at the top of the cylinder. This can be set to ``fa .. rst-class:: classref-property -:ref:`float` **height** = ``2.0`` +:ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Full height of the cylinder. .. rst-class:: classref-property -:ref:`int` **radial_segments** = ``64`` +:ref:`int` **radial_segments** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ Number of radial segments on the cylinder. Higher values result in a more detail .. rst-class:: classref-property -:ref:`int` **rings** = ``4`` +:ref:`int` **rings** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ Number of edge rings along the height of the cylinder. Changing :ref:`rings` **top_radius** = ``0.5`` +:ref:`float` **top_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_cylindershape3d.rst b/classes/class_cylindershape3d.rst index beefbec09c1..bd33d1a93ed 100644 --- a/classes/class_cylindershape3d.rst +++ b/classes/class_cylindershape3d.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``2.0`` +:ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ The cylinder's height. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index e72bda7c7df..768af8745a7 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **damping** = ``1.0`` +:ref:`float` **damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ The spring joint's damping ratio. A value between ``0`` and ``1``. When the two .. rst-class:: classref-property -:ref:`float` **length** = ``50.0`` +:ref:`float` **length** = ``50.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ The spring joint's maximum length. The two attached bodies cannot stretch it pas .. rst-class:: classref-property -:ref:`float` **rest_length** = ``0.0`` +:ref:`float` **rest_length** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ When the bodies attached to the spring joint move they stretch or squash it. The .. rst-class:: classref-property -:ref:`float` **stiffness** = ``20.0`` +:ref:`float` **stiffness** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_decal.rst b/classes/class_decal.rst index d18440b5557..67564ad0d47 100644 --- a/classes/class_decal.rst +++ b/classes/class_decal.rst @@ -101,7 +101,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DecalTexture**: +enum **DecalTexture**: :ref:`🔗` .. _class_Decal_constant_TEXTURE_ALBEDO: @@ -156,7 +156,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **albedo_mix** = ``1.0`` +:ref:`float` **albedo_mix** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ Blends the albedo :ref:`Color` of the decal with albedo :ref:`Color .. rst-class:: classref-property -:ref:`int` **cull_mask** = ``1048575`` +:ref:`int` **cull_mask** = ``1048575`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ Specifies which :ref:`VisualInstance3D.layers` **distance_fade_begin** = ``40.0`` +:ref:`float` **distance_fade_begin** = ``40.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -207,7 +207,7 @@ The distance from the camera at which the Decal begins to fade away (in 3D units .. rst-class:: classref-property -:ref:`bool` **distance_fade_enabled** = ``false`` +:ref:`bool` **distance_fade_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -224,7 +224,7 @@ If ``true``, decals will smoothly fade away when far from the active :ref:`Camer .. rst-class:: classref-property -:ref:`float` **distance_fade_length** = ``10.0`` +:ref:`float` **distance_fade_length** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ The distance over which the Decal fades (in 3D units). The Decal becomes slowly .. rst-class:: classref-property -:ref:`float` **emission_energy** = ``1.0`` +:ref:`float` **emission_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ Energy multiplier for the emission texture. This will make the decal emit light .. rst-class:: classref-property -:ref:`float` **lower_fade** = ``0.3`` +:ref:`float` **lower_fade** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -275,7 +275,7 @@ Sets the curve over which the decal will fade as the surface gets further from t .. rst-class:: classref-property -:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ Changes the :ref:`Color` of the Decal by multiplying the albedo and .. rst-class:: classref-property -:ref:`float` **normal_fade** = ``0.0`` +:ref:`float` **normal_fade** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -311,7 +311,7 @@ Fades the Decal if the angle between the Decal's :ref:`AABB` and the .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -330,7 +330,7 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property -:ref:`Texture2D` **texture_albedo** +:ref:`Texture2D` **texture_albedo** :ref:`🔗` .. rst-class:: classref-property-setget @@ -349,7 +349,7 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property -:ref:`Texture2D` **texture_emission** +:ref:`Texture2D` **texture_emission** :ref:`🔗` .. rst-class:: classref-property-setget @@ -368,7 +368,7 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property -:ref:`Texture2D` **texture_normal** +:ref:`Texture2D` **texture_normal** :ref:`🔗` .. rst-class:: classref-property-setget @@ -389,7 +389,7 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property -:ref:`Texture2D` **texture_orm** +:ref:`Texture2D` **texture_orm** :ref:`🔗` .. rst-class:: classref-property-setget @@ -410,7 +410,7 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property -:ref:`float` **upper_fade** = ``0.3`` +:ref:`float` **upper_fade** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -432,7 +432,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| +:ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| :ref:`🔗` Returns the :ref:`Texture2D` associated with the specified :ref:`DecalTexture`. This is a convenience method, in most cases you should access the texture directly. @@ -465,7 +465,7 @@ One case where this is better than accessing the texture directly is when you wa .. rst-class:: classref-method -|void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) +|void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the :ref:`Texture2D` associated with the specified :ref:`DecalTexture`. This is a convenience method, in most cases you should access the texture directly. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 14d037664e0..a0c65d2a9ff 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -291,7 +291,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Dictionary` **Dictionary**\ (\ ) +:ref:`Dictionary` **Dictionary**\ (\ ) :ref:`🔗` Constructs an empty **Dictionary**. @@ -318,7 +318,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the dictionary, removing all entries from it. @@ -330,7 +330,7 @@ Clears the dictionary, removing all entries from it. .. rst-class:: classref-method -:ref:`Dictionary` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| +:ref:`Dictionary` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| :ref:`🔗` Creates and returns a new copy of the dictionary. If ``deep`` is ``true``, inner **Dictionary** and :ref:`Array` keys and values are also copied, recursively. @@ -342,7 +342,7 @@ Creates and returns a new copy of the dictionary. If ``deep`` is ``true``, inner .. rst-class:: classref-method -:ref:`bool` **erase**\ (\ key\: :ref:`Variant`\ ) +:ref:`bool` **erase**\ (\ key\: :ref:`Variant`\ ) :ref:`🔗` Removes the dictionary entry by key, if it exists. Returns ``true`` if the given ``key`` existed in the dictionary, otherwise ``false``. @@ -356,7 +356,7 @@ Removes the dictionary entry by key, if it exists. Returns ``true`` if the given .. rst-class:: classref-method -:ref:`Variant` **find_key**\ (\ value\: :ref:`Variant`\ ) |const| +:ref:`Variant` **find_key**\ (\ value\: :ref:`Variant`\ ) |const| :ref:`🔗` Finds and returns the first key whose associated value is equal to ``value``, or ``null`` if it is not found. @@ -370,7 +370,7 @@ Finds and returns the first key whose associated value is equal to ``value``, or .. rst-class:: classref-method -:ref:`Variant` **get**\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) |const| +:ref:`Variant` **get**\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Returns the corresponding value for the given ``key`` in the dictionary. If the ``key`` does not exist, returns ``default``, or ``null`` if the parameter is omitted. @@ -382,7 +382,7 @@ Returns the corresponding value for the given ``key`` in the dictionary. If the .. rst-class:: classref-method -:ref:`Variant` **get_or_add**\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) +:ref:`Variant` **get_or_add**\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) :ref:`🔗` Gets a value and ensures the key is set. If the ``key`` exists in the dictionary, this behaves like :ref:`get`. Otherwise, the ``default`` value is inserted into the dictionary and returned. @@ -394,7 +394,7 @@ Gets a value and ensures the key is set. If the ``key`` exists in the dictionary .. rst-class:: classref-method -:ref:`bool` **has**\ (\ key\: :ref:`Variant`\ ) |const| +:ref:`bool` **has**\ (\ key\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns ``true`` if the dictionary contains an entry with the given ``key``. @@ -443,7 +443,7 @@ In GDScript, this is equivalent to the ``in`` operator: .. rst-class:: classref-method -:ref:`bool` **has_all**\ (\ keys\: :ref:`Array`\ ) |const| +:ref:`bool` **has_all**\ (\ keys\: :ref:`Array`\ ) |const| :ref:`🔗` Returns ``true`` if the dictionary contains all keys in the given ``keys`` array. @@ -460,7 +460,7 @@ Returns ``true`` if the dictionary contains all keys in the given ``keys`` array .. rst-class:: classref-method -:ref:`int` **hash**\ (\ ) |const| +:ref:`int` **hash**\ (\ ) |const| :ref:`🔗` Returns a hashed 32-bit integer value representing the dictionary contents. @@ -496,7 +496,7 @@ Returns a hashed 32-bit integer value representing the dictionary contents. .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the dictionary is empty (its size is ``0``). See also :ref:`size`. @@ -508,7 +508,7 @@ Returns ``true`` if the dictionary is empty (its size is ``0``). See also :ref:` .. rst-class:: classref-method -:ref:`bool` **is_read_only**\ (\ ) |const| +:ref:`bool` **is_read_only**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the dictionary is read-only. See :ref:`make_read_only`. Dictionaries are automatically read-only if declared with ``const`` keyword. @@ -520,7 +520,7 @@ Returns ``true`` if the dictionary is read-only. See :ref:`make_read_only` **keys**\ (\ ) |const| +:ref:`Array` **keys**\ (\ ) |const| :ref:`🔗` Returns the list of keys in the dictionary. @@ -532,7 +532,7 @@ Returns the list of keys in the dictionary. .. rst-class:: classref-method -|void| **make_read_only**\ (\ ) +|void| **make_read_only**\ (\ ) :ref:`🔗` Makes the dictionary read-only, i.e. disables modification of the dictionary's contents. Does not apply to nested content, e.g. content of nested dictionaries. @@ -544,7 +544,7 @@ Makes the dictionary read-only, i.e. disables modification of the dictionary's c .. rst-class:: classref-method -|void| **merge**\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) +|void| **merge**\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) :ref:`🔗` Adds entries from ``dictionary`` to this dictionary. By default, duplicate keys are not copied over, unless ``overwrite`` is ``true``. @@ -598,7 +598,7 @@ Adds entries from ``dictionary`` to this dictionary. By default, duplicate keys .. rst-class:: classref-method -:ref:`Dictionary` **merged**\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) |const| +:ref:`Dictionary` **merged**\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a copy of this dictionary merged with the other ``dictionary``. By default, duplicate keys are not copied over, unless ``overwrite`` is ``true``. See also :ref:`merge`. @@ -623,7 +623,7 @@ See also :ref:`merge`. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of entries in the dictionary. Empty dictionaries (``{ }``) always return ``0``. See also :ref:`is_empty`. @@ -635,7 +635,7 @@ Returns the number of entries in the dictionary. Empty dictionaries (``{ }``) al .. rst-class:: classref-method -:ref:`Array` **values**\ (\ ) |const| +:ref:`Array` **values**\ (\ ) |const| :ref:`🔗` Returns the list of values in this dictionary. @@ -652,7 +652,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Dictionary`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Dictionary`\ ) :ref:`🔗` Returns ``true`` if the two dictionaries do not contain the same keys and values. @@ -664,7 +664,7 @@ Returns ``true`` if the two dictionaries do not contain the same keys and values .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Dictionary`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Dictionary`\ ) :ref:`🔗` Returns ``true`` if the two dictionaries contain the same keys and values. The order of the entries does not matter. @@ -678,7 +678,7 @@ Returns ``true`` if the two dictionaries contain the same keys and values. The o .. rst-class:: classref-operator -:ref:`Variant` **operator []**\ (\ key\: :ref:`Variant`\ ) +:ref:`Variant` **operator []**\ (\ key\: :ref:`Variant`\ ) :ref:`🔗` Returns the corresponding value for the given ``key`` in the dictionary. If the entry does not exist, fails and returns ``null``. For safe access, use :ref:`get` or :ref:`has`. diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index 57735366cc9..dbbf6e29252 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -199,7 +199,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **include_hidden** +:ref:`bool` **include_hidden** :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Affects :ref:`list_dir_begin`, :ref:`get_ .. rst-class:: classref-property -:ref:`bool` **include_navigational** +:ref:`bool` **include_navigational** :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **change_dir**\ (\ to_dir\: :ref:`String`\ ) +:ref:`Error` **change_dir**\ (\ to_dir\: :ref:`String`\ ) :ref:`🔗` Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``). @@ -258,7 +258,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **copy**\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) +:ref:`Error` **copy**\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) :ref:`🔗` Copies the ``from`` file to the ``to`` destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. @@ -274,7 +274,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **copy_absolute**\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) |static| +:ref:`Error` **copy_absolute**\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) |static| :ref:`🔗` Static version of :ref:`copy`. Supports only absolute paths. @@ -286,7 +286,7 @@ Static version of :ref:`copy`. Supports only absolu .. rst-class:: classref-method -:ref:`Error` **create_link**\ (\ source\: :ref:`String`, target\: :ref:`String`\ ) +:ref:`Error` **create_link**\ (\ source\: :ref:`String`, target\: :ref:`String`\ ) :ref:`🔗` Creates symbolic link between files or folders. @@ -302,7 +302,7 @@ Creates symbolic link between files or folders. .. rst-class:: classref-method -:ref:`bool` **current_is_dir**\ (\ ) |const| +:ref:`bool` **current_is_dir**\ (\ ) |const| :ref:`🔗` Returns whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). @@ -314,7 +314,7 @@ Returns whether the current item processed with the last :ref:`get_next` **dir_exists**\ (\ path\: :ref:`String`\ ) +:ref:`bool` **dir_exists**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. @@ -326,7 +326,7 @@ Returns whether the target directory exists. The argument can be relative to the .. rst-class:: classref-method -:ref:`bool` **dir_exists_absolute**\ (\ path\: :ref:`String`\ ) |static| +:ref:`bool` **dir_exists_absolute**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Static version of :ref:`dir_exists`. Supports only absolute paths. @@ -338,7 +338,7 @@ Static version of :ref:`dir_exists`. Supports .. rst-class:: classref-method -:ref:`bool` **file_exists**\ (\ path\: :ref:`String`\ ) +:ref:`bool` **file_exists**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. @@ -352,7 +352,7 @@ For a static equivalent, use :ref:`FileAccess.file_exists` **get_current_dir**\ (\ include_drive\: :ref:`bool` = true\ ) |const| +:ref:`String` **get_current_dir**\ (\ include_drive\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). @@ -364,7 +364,7 @@ Returns the absolute path to the currently opened directory (e.g. ``res://folder .. rst-class:: classref-method -:ref:`int` **get_current_drive**\ (\ ) +:ref:`int` **get_current_drive**\ (\ ) :ref:`🔗` Returns the currently opened directory's drive index. See :ref:`get_drive_name` to convert returned index to the name of the drive. @@ -376,7 +376,7 @@ Returns the currently opened directory's drive index. See :ref:`get_drive_name` **get_directories**\ (\ ) +:ref:`PackedStringArray` **get_directories**\ (\ ) :ref:`🔗` Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding files. The array is sorted alphabetically. @@ -390,7 +390,7 @@ Affected by :ref:`include_hidden` and : .. rst-class:: classref-method -:ref:`PackedStringArray` **get_directories_at**\ (\ path\: :ref:`String`\ ) |static| +:ref:`PackedStringArray` **get_directories_at**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding files, at the given ``path``. The array is sorted alphabetically. @@ -404,7 +404,7 @@ Use :ref:`get_directories` if you want m .. rst-class:: classref-method -:ref:`int` **get_drive_count**\ (\ ) |static| +:ref:`int` **get_drive_count**\ (\ ) |static| :ref:`🔗` On Windows, returns the number of drives (partitions) mounted on the current filesystem. @@ -422,7 +422,7 @@ On other platforms, the method returns 0. .. rst-class:: classref-method -:ref:`String` **get_drive_name**\ (\ idx\: :ref:`int`\ ) |static| +:ref:`String` **get_drive_name**\ (\ idx\: :ref:`int`\ ) |static| :ref:`🔗` On Windows, returns the name of the drive (partition) passed as an argument (e.g. ``C:``). @@ -440,7 +440,7 @@ On other platforms, or if the requested drive does not exist, the method returns .. rst-class:: classref-method -:ref:`PackedStringArray` **get_files**\ (\ ) +:ref:`PackedStringArray` **get_files**\ (\ ) :ref:`🔗` Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding directories. The array is sorted alphabetically. @@ -456,7 +456,7 @@ Affected by :ref:`include_hidden`. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_files_at**\ (\ path\: :ref:`String`\ ) |static| +:ref:`PackedStringArray` **get_files_at**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding directories, at the given ``path``. The array is sorted alphabetically. @@ -470,7 +470,7 @@ Use :ref:`get_files` if you want more control .. rst-class:: classref-method -:ref:`String` **get_next**\ (\ ) +:ref:`String` **get_next**\ (\ ) :ref:`🔗` Returns the next element (file or directory) in the current directory. @@ -484,7 +484,7 @@ The name of the file or directory is returned (and not its full path). Once the .. rst-class:: classref-method -:ref:`Error` **get_open_error**\ (\ ) |static| +:ref:`Error` **get_open_error**\ (\ ) |static| :ref:`🔗` Returns the result of the last :ref:`open` call in the current thread. @@ -496,7 +496,7 @@ Returns the result of the last :ref:`open` call in .. rst-class:: classref-method -:ref:`int` **get_space_left**\ (\ ) +:ref:`int` **get_space_left**\ (\ ) :ref:`🔗` Returns the available space on the current directory's disk, in bytes. Returns ``0`` if the platform-specific method to query the available space fails. @@ -508,7 +508,7 @@ Returns the available space on the current directory's disk, in bytes. Returns ` .. rst-class:: classref-method -:ref:`bool` **is_case_sensitive**\ (\ path\: :ref:`String`\ ) |const| +:ref:`bool` **is_case_sensitive**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the file system or directory use case sensitive file names. @@ -522,7 +522,7 @@ Returns ``true`` if the file system or directory use case sensitive file names. .. rst-class:: classref-method -:ref:`bool` **is_link**\ (\ path\: :ref:`String`\ ) +:ref:`bool` **is_link**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if the file or directory is a symbolic link, directory junction, or other reparse point. @@ -536,7 +536,7 @@ Returns ``true`` if the file or directory is a symbolic link, directory junction .. rst-class:: classref-method -:ref:`Error` **list_dir_begin**\ (\ ) +:ref:`Error` **list_dir_begin**\ (\ ) :ref:`🔗` Initializes the stream used to list all files and directories using the :ref:`get_next` function, closing the currently opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. @@ -552,7 +552,7 @@ Affected by :ref:`include_hidden` and : .. rst-class:: classref-method -|void| **list_dir_end**\ (\ ) +|void| **list_dir_end**\ (\ ) :ref:`🔗` Closes the current stream opened with :ref:`list_dir_begin` (whether it has been fully processed with :ref:`get_next` does not matter). @@ -564,7 +564,7 @@ Closes the current stream opened with :ref:`list_dir_begin` **make_dir**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **make_dir**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). @@ -578,7 +578,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **make_dir_absolute**\ (\ path\: :ref:`String`\ ) |static| +:ref:`Error` **make_dir_absolute**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Static version of :ref:`make_dir`. Supports only absolute paths. @@ -590,7 +590,7 @@ Static version of :ref:`make_dir`. Supports onl .. rst-class:: classref-method -:ref:`Error` **make_dir_recursive**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **make_dir_recursive**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Creates a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. @@ -604,7 +604,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **make_dir_recursive_absolute**\ (\ path\: :ref:`String`\ ) |static| +:ref:`Error` **make_dir_recursive_absolute**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Static version of :ref:`make_dir_recursive`. Supports only absolute paths. @@ -616,7 +616,7 @@ Static version of :ref:`make_dir_recursive` **open**\ (\ path\: :ref:`String`\ ) |static| +:ref:`DirAccess` **open**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Creates a new **DirAccess** object and opens an existing directory of the filesystem. The ``path`` argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``). @@ -630,7 +630,7 @@ Returns ``null`` if opening the directory failed. You can use :ref:`get_open_err .. rst-class:: classref-method -:ref:`String` **read_link**\ (\ path\: :ref:`String`\ ) +:ref:`String` **read_link**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns target of the symbolic link. @@ -644,7 +644,7 @@ Returns target of the symbolic link. .. rst-class:: classref-method -:ref:`Error` **remove**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **remove**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Permanently deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. @@ -660,7 +660,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **remove_absolute**\ (\ path\: :ref:`String`\ ) |static| +:ref:`Error` **remove_absolute**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Static version of :ref:`remove`. Supports only absolute paths. @@ -672,7 +672,7 @@ Static version of :ref:`remove`. Supports only ab .. rst-class:: classref-method -:ref:`Error` **rename**\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) +:ref:`Error` **rename**\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) :ref:`🔗` Renames (move) the ``from`` file or directory to the ``to`` destination. Both arguments should be paths to files or directories, either relative or absolute. If the destination file or directory exists and is not access-protected, it will be overwritten. @@ -686,7 +686,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **rename_absolute**\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) |static| +:ref:`Error` **rename_absolute**\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) |static| :ref:`🔗` Static version of :ref:`rename`. Supports only absolute paths. diff --git a/classes/class_directionallight2d.rst b/classes/class_directionallight2d.rst index bf7c6ebe4bc..cf3a13a4e31 100644 --- a/classes/class_directionallight2d.rst +++ b/classes/class_directionallight2d.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``0.0`` +:ref:`float` **height** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -77,7 +77,7 @@ The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to .. rst-class:: classref-property -:ref:`float` **max_distance** = ``10000.0`` +:ref:`float` **max_distance** = ``10000.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_directionallight3d.rst b/classes/class_directionallight3d.rst index beb06d0d0bd..4417533af2d 100644 --- a/classes/class_directionallight3d.rst +++ b/classes/class_directionallight3d.rst @@ -74,7 +74,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ShadowMode**: +enum **ShadowMode**: :ref:`🔗` .. _class_DirectionalLight3D_constant_SHADOW_ORTHOGONAL: @@ -108,7 +108,7 @@ Splits the view frustum in 4 areas, each with its own shadow map. This is the sl .. rst-class:: classref-enumeration -enum **SkyMode**: +enum **SkyMode**: :ref:`🔗` .. _class_DirectionalLight3D_constant_SKY_MODE_LIGHT_AND_SKY: @@ -147,7 +147,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **directional_shadow_blend_splits** = ``false`` +:ref:`bool` **directional_shadow_blend_splits** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ If ``true``, shadow detail is sacrificed in exchange for smoother transitions be .. rst-class:: classref-property -:ref:`float` **directional_shadow_fade_start** = ``0.8`` +:ref:`float` **directional_shadow_fade_start** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ Proportion of :ref:`directional_shadow_max_distance` **directional_shadow_max_distance** = ``100.0`` +:ref:`float` **directional_shadow_max_distance** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ The maximum distance for shadow splits. Increasing this value will make directio .. rst-class:: classref-property -:ref:`ShadowMode` **directional_shadow_mode** = ``2`` +:ref:`ShadowMode` **directional_shadow_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ The light's shadow rendering algorithm. See :ref:`ShadowMode` **directional_shadow_pancake_size** = ``20.0`` +:ref:`float` **directional_shadow_pancake_size** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -232,7 +232,7 @@ Sets the size of the directional shadow pancake. The pancake offsets the start o .. rst-class:: classref-property -:ref:`float` **directional_shadow_split_1** = ``0.1`` +:ref:`float` **directional_shadow_split_1** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -249,7 +249,7 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow .. rst-class:: classref-property -:ref:`float` **directional_shadow_split_2** = ``0.2`` +:ref:`float` **directional_shadow_split_2** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -266,7 +266,7 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado .. rst-class:: classref-property -:ref:`float` **directional_shadow_split_3** = ``0.5`` +:ref:`float` **directional_shadow_split_3** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -283,7 +283,7 @@ The distance from shadow split 2 to split 3. Relative to :ref:`directional_shado .. rst-class:: classref-property -:ref:`SkyMode` **sky_mode** = ``0`` +:ref:`SkyMode` **sky_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index ab9ca0a92e1..069dc41ba27 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -204,6 +204,8 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_window_transparency_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | @@ -406,7 +408,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Feature**: +enum **Feature**: :ref:`🔗` .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU: @@ -618,7 +620,7 @@ Display server supports spawning dialogs for selecting files or directories usin .. rst-class:: classref-enumeration -enum **MouseMode**: +enum **MouseMode**: :ref:`🔗` .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE: @@ -670,7 +672,7 @@ Confines the mouse cursor to the game window, and make it hidden. .. rst-class:: classref-enumeration -enum **ScreenOrientation**: +enum **ScreenOrientation**: :ref:`🔗` .. _class_DisplayServer_constant_SCREEN_LANDSCAPE: @@ -736,7 +738,7 @@ Automatic landscape or portrait orientation (default or reverse depending on sen .. rst-class:: classref-enumeration -enum **VirtualKeyboardType**: +enum **VirtualKeyboardType**: :ref:`🔗` .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT: @@ -812,7 +814,7 @@ Virtual keyboard with additional keys to assist with typing URLs. .. rst-class:: classref-enumeration -enum **CursorShape**: +enum **CursorShape**: :ref:`🔗` .. _class_DisplayServer_constant_CURSOR_ARROW: @@ -966,7 +968,7 @@ Represents the size of the :ref:`CursorShape` en .. rst-class:: classref-enumeration -enum **FileDialogMode**: +enum **FileDialogMode**: :ref:`🔗` .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE: @@ -1016,7 +1018,7 @@ The native file dialog will warn when a file exists. .. rst-class:: classref-enumeration -enum **WindowMode**: +enum **WindowMode**: :ref:`🔗` .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED: @@ -1084,7 +1086,7 @@ Full screen window covers the entire display area of a screen and has no border .. rst-class:: classref-enumeration -enum **WindowFlags**: +enum **WindowFlags**: :ref:`🔗` .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED: @@ -1118,7 +1120,7 @@ The window is floating on top of all other windows. This flag is ignored for ful The window background can be transparent. -\ **Note:** This flag has no effect if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed` is set to ``false``. +\ **Note:** This flag has no effect if :ref:`is_window_transparency_available` returns ``false``. \ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities. @@ -1176,7 +1178,7 @@ Max value of the :ref:`WindowFlags`. .. rst-class:: classref-enumeration -enum **WindowEvent**: +enum **WindowEvent**: :ref:`🔗` .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER: @@ -1256,7 +1258,7 @@ Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXT .. rst-class:: classref-enumeration -enum **VSyncMode**: +enum **VSyncMode**: :ref:`🔗` .. _class_DisplayServer_constant_VSYNC_DISABLED: @@ -1300,7 +1302,7 @@ Although not guaranteed, the images can be rendered as fast as possible, which m .. rst-class:: classref-enumeration -enum **HandleType**: +enum **HandleType**: :ref:`🔗` .. _class_DisplayServer_constant_DISPLAY_HANDLE: @@ -1370,7 +1372,7 @@ OpenGL context (only with the GL Compatibility renderer): .. rst-class:: classref-enumeration -enum **TTSUtteranceEvent**: +enum **TTSUtteranceEvent**: :ref:`🔗` .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED: @@ -1417,7 +1419,7 @@ Constants .. rst-class:: classref-constant -**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` +**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`🔗` Represents the screen containing the mouse pointer. @@ -1427,7 +1429,7 @@ Represents the screen containing the mouse pointer. .. rst-class:: classref-constant -**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` +**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`🔗` Represents the screen containing the window with the keyboard focus. @@ -1437,7 +1439,7 @@ Represents the screen containing the window with the keyboard focus. .. rst-class:: classref-constant -**SCREEN_PRIMARY** = ``-2`` +**SCREEN_PRIMARY** = ``-2`` :ref:`🔗` Represents the primary screen. @@ -1447,7 +1449,7 @@ Represents the primary screen. .. rst-class:: classref-constant -**SCREEN_OF_MAIN_WINDOW** = ``-1`` +**SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`🔗` Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens. @@ -1457,7 +1459,7 @@ Represents the screen where the main window is located. This is usually the defa .. rst-class:: classref-constant -**MAIN_WINDOW_ID** = ``0`` +**MAIN_WINDOW_ID** = ``0`` :ref:`🔗` The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``. @@ -1465,7 +1467,7 @@ The ID of the main window spawned by the engine, which can be passed to methods .. rst-class:: classref-constant -**INVALID_WINDOW_ID** = ``-1`` +**INVALID_WINDOW_ID** = ``-1`` :ref:`🔗` The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result. @@ -1473,7 +1475,7 @@ The ID that refers to a nonexistent window. This is returned by some **DisplaySe .. rst-class:: classref-constant -**INVALID_INDICATOR_ID** = ``-1`` +**INVALID_INDICATOR_ID** = ``-1`` :ref:`🔗` The ID that refers to a nonexistent application status indicator. @@ -1490,7 +1492,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **clipboard_get**\ (\ ) |const| +:ref:`String` **clipboard_get**\ (\ ) |const| :ref:`🔗` Returns the user's clipboard as a string if possible. @@ -1502,7 +1504,7 @@ Returns the user's clipboard as a string if possible. .. rst-class:: classref-method -:ref:`Image` **clipboard_get_image**\ (\ ) |const| +:ref:`Image` **clipboard_get_image**\ (\ ) |const| :ref:`🔗` Returns the user's clipboard as an image if possible. @@ -1514,7 +1516,7 @@ Returns the user's clipboard as an image if possible. .. rst-class:: classref-method -:ref:`String` **clipboard_get_primary**\ (\ ) |const| +:ref:`String` **clipboard_get_primary**\ (\ ) |const| :ref:`🔗` Returns the user's `primary `__ clipboard as a string if possible. This is the clipboard that is set when the user selects text in any application, rather than when pressing :kbd:`Ctrl + C`. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism. @@ -1528,7 +1530,7 @@ Returns the user's `primary ` **clipboard_has**\ (\ ) |const| +:ref:`bool` **clipboard_has**\ (\ ) |const| :ref:`🔗` Returns ``true`` if there is a text content on the user's clipboard. @@ -1540,7 +1542,7 @@ Returns ``true`` if there is a text content on the user's clipboard. .. rst-class:: classref-method -:ref:`bool` **clipboard_has_image**\ (\ ) |const| +:ref:`bool` **clipboard_has_image**\ (\ ) |const| :ref:`🔗` Returns ``true`` if there is an image content on the user's clipboard. @@ -1552,7 +1554,7 @@ Returns ``true`` if there is an image content on the user's clipboard. .. rst-class:: classref-method -|void| **clipboard_set**\ (\ clipboard\: :ref:`String`\ ) +|void| **clipboard_set**\ (\ clipboard\: :ref:`String`\ ) :ref:`🔗` Sets the user's clipboard content to the given string. @@ -1564,7 +1566,7 @@ Sets the user's clipboard content to the given string. .. rst-class:: classref-method -|void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String`\ ) +|void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String`\ ) :ref:`🔗` Sets the user's `primary `__ clipboard content to the given string. This is the clipboard that is set when the user selects text in any application, rather than when pressing :kbd:`Ctrl + C`. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism. @@ -1578,10 +1580,12 @@ Sets the user's `primary ` **create_status_indicator**\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) +:ref:`int` **create_status_indicator**\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) :ref:`🔗` Creates a new application status indicator with the specified icon, tooltip, and activation callback. +\ ``callback`` should take two arguments: the pressed mouse button (one of the :ref:`MouseButton` constants) and the click position in screen coordinates (a :ref:`Vector2i`). + .. rst-class:: classref-item-separator ---- @@ -1590,7 +1594,7 @@ Creates a new application status indicator with the specified icon, tooltip, and .. rst-class:: classref-method -:ref:`CursorShape` **cursor_get_shape**\ (\ ) |const| +:ref:`CursorShape` **cursor_get_shape**\ (\ ) |const| :ref:`🔗` Returns the default mouse cursor shape set by :ref:`cursor_set_shape`. @@ -1602,7 +1606,7 @@ Returns the default mouse cursor shape set by :ref:`cursor_set_shape`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **cursor_set_custom_image**\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Sets a custom mouse cursor image for the given ``shape``. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance. @@ -1616,7 +1620,7 @@ Sets a custom mouse cursor image for the given ``shape``. This means the user's .. rst-class:: classref-method -|void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape`\ ) +|void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape`\ ) :ref:`🔗` Sets the default mouse cursor shape. The cursor's appearance will vary depending on the user's operating system and mouse cursor theme. See also :ref:`cursor_get_shape` and :ref:`cursor_set_custom_image`. @@ -1628,7 +1632,7 @@ Sets the default mouse cursor shape. The cursor's appearance will vary depending .. rst-class:: classref-method -|void| **delete_status_indicator**\ (\ id\: :ref:`int`\ ) +|void| **delete_status_indicator**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the application status indicator. @@ -1640,7 +1644,7 @@ Removes the application status indicator. .. rst-class:: classref-method -:ref:`Error` **dialog_input_text**\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) +:ref:`Error` **dialog_input_text**\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) :ref:`🔗` Shows a text input dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`String` parameter which contains the text field's contents. @@ -1654,7 +1658,7 @@ Shows a text input dialog which uses the operating system's native look-and-feel .. rst-class:: classref-method -:ref:`Error` **dialog_show**\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) +:ref:`Error` **dialog_show**\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` Shows a text dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`int` parameter which corresponds to the index of the pressed button. @@ -1668,7 +1672,7 @@ Shows a text dialog which uses the operating system's native look-and-feel. ``ca .. rst-class:: classref-method -|void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int`\ ) +|void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int`\ ) :ref:`🔗` Allows the ``process_id`` PID to steal focus from this window. In other words, this disables the operating system's focus stealing protection for the specified PID. @@ -1682,7 +1686,7 @@ Allows the ``process_id`` PID to steal focus from this window. In other words, t .. rst-class:: classref-method -:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) +:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` Displays OS native dialog for selecting files or directories in the file system. @@ -1708,7 +1712,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt .. rst-class:: classref-method -:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) +:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) :ref:`🔗` Displays OS native dialog for selecting files or directories in the file system with additional user selectable options. @@ -1742,7 +1746,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt .. rst-class:: classref-method -|void| **force_process_and_drop_events**\ (\ ) +|void| **force_process_and_drop_events**\ (\ ) :ref:`🔗` Forces window manager processing while ignoring all :ref:`InputEvent`\ s. See also :ref:`process_events`. @@ -1756,7 +1760,7 @@ Forces window manager processing while ignoring all :ref:`InputEvent` **get_accent_color**\ (\ ) |const| +:ref:`Color` **get_accent_color**\ (\ ) |const| :ref:`🔗` Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown. @@ -1770,7 +1774,7 @@ Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is .. rst-class:: classref-method -:ref:`Color` **get_base_color**\ (\ ) |const| +:ref:`Color` **get_base_color**\ (\ ) |const| :ref:`🔗` Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown. @@ -1784,7 +1788,7 @@ Returns the OS theme base color (default control background). Returns ``Color(0, .. rst-class:: classref-method -:ref:`Array`\[:ref:`Rect2`\] **get_display_cutouts**\ (\ ) |const| +:ref:`Array`\[:ref:`Rect2`\] **get_display_cutouts**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` of :ref:`Rect2`, each of which is the bounding rectangle for a display cutout or notch. These are non-functional areas on edge-to-edge screens used by cameras and sensors. Returns an empty array if the device does not have cutouts. See also :ref:`get_display_safe_area`. @@ -1798,7 +1802,7 @@ Returns an :ref:`Array` of :ref:`Rect2`, each of which .. rst-class:: classref-method -:ref:`Rect2i` **get_display_safe_area**\ (\ ) |const| +:ref:`Rect2i` **get_display_safe_area**\ (\ ) |const| :ref:`🔗` Returns the unobscured area of the display where interactive controls should be rendered. See also :ref:`get_display_cutouts`. @@ -1810,7 +1814,7 @@ Returns the unobscured area of the display where interactive controls should be .. rst-class:: classref-method -:ref:`int` **get_keyboard_focus_screen**\ (\ ) |const| +:ref:`int` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`🔗` Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window. @@ -1822,7 +1826,7 @@ Returns the index of the screen containing the window with the keyboard focus, o .. rst-class:: classref-method -:ref:`String` **get_name**\ (\ ) |const| +:ref:`String` **get_name**\ (\ ) |const| :ref:`🔗` Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (currently X11 and Wayland). @@ -1836,7 +1840,7 @@ The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux .. rst-class:: classref-method -:ref:`int` **get_primary_screen**\ (\ ) |const| +:ref:`int` **get_primary_screen**\ (\ ) |const| :ref:`🔗` Returns index of the primary screen. @@ -1848,7 +1852,7 @@ Returns index of the primary screen. .. rst-class:: classref-method -:ref:`int` **get_screen_count**\ (\ ) |const| +:ref:`int` **get_screen_count**\ (\ ) |const| :ref:`🔗` Returns the number of displays available. @@ -1860,7 +1864,7 @@ Returns the number of displays available. .. rst-class:: classref-method -:ref:`int` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| +:ref:`int` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns index of the screen which contains specified rectangle. @@ -1872,7 +1876,7 @@ Returns index of the screen which contains specified rectangle. .. rst-class:: classref-method -:ref:`bool` **get_swap_cancel_ok**\ (\ ) +:ref:`bool` **get_swap_cancel_ok**\ (\ ) :ref:`🔗` Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in dialogs. This is enabled by default on Windows to follow interface conventions, and be toggled by changing :ref:`ProjectSettings.gui/common/swap_cancel_ok`. @@ -1886,7 +1890,7 @@ Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in di .. rst-class:: classref-method -:ref:`int` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the ID of the window at the specified screen ``position`` (in pixels). On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this: @@ -1907,7 +1911,7 @@ Returns the ID of the window at the specified screen ``position`` (in pixels). O .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_window_list**\ (\ ) |const| +:ref:`PackedInt32Array` **get_window_list**\ (\ ) |const| :ref:`🔗` Returns the list of Godot window IDs belonging to this process. @@ -1921,7 +1925,7 @@ Returns the list of Godot window IDs belonging to this process. .. rst-class:: classref-method -:ref:`int` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -1953,7 +1957,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -1985,7 +1989,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2017,7 +2021,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2051,7 +2055,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2083,7 +2087,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2119,7 +2123,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2153,7 +2157,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_separator**\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_separator**\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2181,7 +2185,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. rst-class:: classref-method -:ref:`int` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) +:ref:`int` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2209,7 +2213,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. rst-class:: classref-method -|void| **global_menu_clear**\ (\ menu_root\: :ref:`String`\ ) +|void| **global_menu_clear**\ (\ menu_root\: :ref:`String`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2235,7 +2239,7 @@ Removes all items from the global menu with ID ``menu_root``. .. rst-class:: classref-method -:ref:`Key` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`Key` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2251,7 +2255,7 @@ Returns the accelerator of the item at index ``idx``. Accelerators are special c .. rst-class:: classref-method -:ref:`Callable` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`Callable` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2267,7 +2271,7 @@ Returns the callback of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String`\ ) |const| +:ref:`int` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2283,7 +2287,7 @@ Returns number of items in the global menu with ID ``menu_root``. .. rst-class:: classref-method -:ref:`Texture2D` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2299,7 +2303,7 @@ Returns the icon of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`int` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2315,7 +2319,7 @@ Returns the horizontal offset of the item at the given ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| +:ref:`int` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2331,7 +2335,7 @@ Returns the index of the item with the specified ``tag``. Indices are automatica .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| +:ref:`int` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2347,7 +2351,7 @@ Returns the index of the item with the specified ``text``. Indices are automatic .. rst-class:: classref-method -:ref:`Callable` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`Callable` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2363,7 +2367,7 @@ Returns the callback of the item accelerator at index ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`int` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2379,7 +2383,7 @@ Returns number of states of a multistate item. See :ref:`global_menu_add_multist .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`int` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2395,7 +2399,7 @@ Returns the state of a multistate item. See :ref:`global_menu_add_multistate_ite .. rst-class:: classref-method -:ref:`String` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`String` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2411,7 +2415,7 @@ Returns the submenu ID of the item at index ``idx``. See :ref:`global_menu_add_s .. rst-class:: classref-method -:ref:`Variant` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`Variant` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2427,7 +2431,7 @@ Returns the metadata of the specified item, which might be of any type. You can .. rst-class:: classref-method -:ref:`String` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`String` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2443,7 +2447,7 @@ Returns the text of the item at index ``idx``. .. rst-class:: classref-method -:ref:`String` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`String` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2459,7 +2463,7 @@ Returns the tooltip associated with the specified index ``idx``. .. rst-class:: classref-method -:ref:`Dictionary` **global_menu_get_system_menu_roots**\ (\ ) |const| +:ref:`Dictionary` **global_menu_get_system_menu_roots**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2475,7 +2479,7 @@ Returns Dictionary of supported system menu IDs and names. .. rst-class:: classref-method -:ref:`bool` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2491,7 +2495,7 @@ Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if .. rst-class:: classref-method -:ref:`bool` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2507,7 +2511,7 @@ Returns ``true`` if the item at index ``idx`` is checked. .. rst-class:: classref-method -:ref:`bool` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2525,7 +2529,7 @@ See :ref:`global_menu_set_item_disabled` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2543,7 +2547,7 @@ See :ref:`global_menu_set_item_hidden` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2561,7 +2565,7 @@ Returns ``true`` if the item at index ``idx`` has radio button-style checkabilit .. rst-class:: classref-method -|void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) +|void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2579,7 +2583,7 @@ Removes the item at index ``idx`` from the global menu ``menu_root``. .. rst-class:: classref-method -|void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) +|void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2595,7 +2599,7 @@ Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single : .. rst-class:: classref-method -|void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) +|void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2613,7 +2617,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when an item .. rst-class:: classref-method -|void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) +|void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2629,7 +2633,7 @@ Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the ty .. rst-class:: classref-method -|void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) +|void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2645,7 +2649,7 @@ Sets the checkstate status of the item at index ``idx``. .. rst-class:: classref-method -|void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2661,7 +2665,7 @@ Enables/disables the item at index ``idx``. When it is disabled, it can't be sel .. rst-class:: classref-method -|void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) +|void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2677,7 +2681,7 @@ Hides/shows the item at index ``idx``. When it is hidden, an item does not appea .. rst-class:: classref-method -|void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) +|void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2695,7 +2699,7 @@ Sets the callback of the item at index ``idx``. The callback is emitted when an .. rst-class:: classref-method -|void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2713,7 +2717,7 @@ Replaces the :ref:`Texture2D` icon of the specified ``idx``. .. rst-class:: classref-method -|void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) +|void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2729,7 +2733,7 @@ Sets the horizontal offset of the item at the given ``idx``. .. rst-class:: classref-method -|void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) +|void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2747,7 +2751,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when its acc .. rst-class:: classref-method -|void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) +|void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2763,7 +2767,7 @@ Sets number of state of a multistate item. See :ref:`global_menu_add_multistate_ .. rst-class:: classref-method -|void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) +|void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2781,7 +2785,7 @@ Sets the type of the item at the specified index ``idx`` to radio button. If ``f .. rst-class:: classref-method -|void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) +|void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2797,7 +2801,7 @@ Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) +|void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2813,7 +2817,7 @@ Sets the submenu of the item at index ``idx``. The submenu is the ID of a global .. rst-class:: classref-method -|void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) +|void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2829,7 +2833,7 @@ Sets the metadata of an item, which may be of any type. You can later get it wit .. rst-class:: classref-method -|void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) +|void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2845,7 +2849,7 @@ Sets the text of the item at index ``idx``. .. rst-class:: classref-method -|void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. @@ -2861,11 +2865,11 @@ Sets the :ref:`String` tooltip of the item at the specified index .. rst-class:: classref-method -|void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) +|void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) :ref:`🔗` **Deprecated:** Use :ref:`NativeMenu` or :ref:`PopupMenu` instead. -Registers callables to emit when the menu is respectively about to show or closed. +Registers callables to emit when the menu is respectively about to show or closed. Callback methods should have zero arguments. .. rst-class:: classref-item-separator @@ -2875,7 +2879,7 @@ Registers callables to emit when the menu is respectively about to show or close .. rst-class:: classref-method -:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise. @@ -2887,7 +2891,7 @@ Returns ``true`` if the specified ``feature`` is supported by the current **Disp .. rst-class:: classref-method -|void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) +|void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) :ref:`🔗` Sets native help system search callbacks. @@ -2905,7 +2909,7 @@ Sets native help system search callbacks. .. rst-class:: classref-method -:ref:`Vector2i` **ime_get_selection**\ (\ ) |const| +:ref:`Vector2i` **ime_get_selection**\ (\ ) |const| :ref:`🔗` Returns the text selection in the `Input Method Editor `__ composition string, with the :ref:`Vector2i`'s ``x`` component being the caret position and ``y`` being the length of the selection. @@ -2919,7 +2923,7 @@ Returns the text selection in the `Input Method Editor ` **ime_get_text**\ (\ ) |const| +:ref:`String` **ime_get_text**\ (\ ) |const| :ref:`🔗` Returns the composition string contained within the `Input Method Editor `__ window. @@ -2933,7 +2937,7 @@ Returns the composition string contained within the `Input Method Editor ` **is_dark_mode**\ (\ ) |const| +:ref:`bool` **is_dark_mode**\ (\ ) |const| :ref:`🔗` Returns ``true`` if OS is using dark mode. @@ -2947,7 +2951,7 @@ Returns ``true`` if OS is using dark mode. .. rst-class:: classref-method -:ref:`bool` **is_dark_mode_supported**\ (\ ) |const| +:ref:`bool` **is_dark_mode_supported**\ (\ ) |const| :ref:`🔗` Returns ``true`` if OS supports dark mode. @@ -2961,7 +2965,7 @@ Returns ``true`` if OS supports dark mode. .. rst-class:: classref-method -:ref:`bool` **is_touchscreen_available**\ (\ ) |const| +:ref:`bool` **is_touchscreen_available**\ (\ ) |const| :ref:`🔗` Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Web platform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse` is ``true``. @@ -2969,11 +2973,23 @@ Returns ``true`` if touch events are available (Android or iOS), the capability ---- +.. _class_DisplayServer_method_is_window_transparency_available: + +.. rst-class:: classref-method + +:ref:`bool` **is_window_transparency_available**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if the window background can be made transparent. This method returns ``false`` if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed` is set to ``false``, or if transparency is not supported by the renderer or OS compositor. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_keyboard_get_current_layout: .. rst-class:: classref-method -:ref:`int` **keyboard_get_current_layout**\ (\ ) |const| +:ref:`int` **keyboard_get_current_layout**\ (\ ) |const| :ref:`🔗` Returns active keyboard layout index. @@ -2987,7 +3003,7 @@ Returns active keyboard layout index. .. rst-class:: classref-method -:ref:`Key` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key`\ ) |const| +:ref:`Key` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key`\ ) |const| :ref:`🔗` Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout. @@ -3001,7 +3017,7 @@ Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout .. rst-class:: classref-method -:ref:`Key` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key`\ ) |const| +:ref:`Key` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key`\ ) |const| :ref:`🔗` Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout. @@ -3015,7 +3031,7 @@ Converts a physical (US QWERTY) ``keycode`` to localized label printed on the ke .. rst-class:: classref-method -:ref:`int` **keyboard_get_layout_count**\ (\ ) |const| +:ref:`int` **keyboard_get_layout_count**\ (\ ) |const| :ref:`🔗` Returns the number of keyboard layouts. @@ -3029,7 +3045,7 @@ Returns the number of keyboard layouts. .. rst-class:: classref-method -:ref:`String` **keyboard_get_layout_language**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **keyboard_get_layout_language**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``. @@ -3043,7 +3059,7 @@ Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``in .. rst-class:: classref-method -:ref:`String` **keyboard_get_layout_name**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **keyboard_get_layout_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the localized name of the keyboard layout at position ``index``. @@ -3057,7 +3073,7 @@ Returns the localized name of the keyboard layout at position ``index``. .. rst-class:: classref-method -|void| **keyboard_set_current_layout**\ (\ index\: :ref:`int`\ ) +|void| **keyboard_set_current_layout**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Sets the active keyboard layout. @@ -3071,7 +3087,7 @@ Sets the active keyboard layout. .. rst-class:: classref-method -|bitfield|\[:ref:`MouseButtonMask`\] **mouse_get_button_state**\ (\ ) |const| +|bitfield|\[:ref:`MouseButtonMask`\] **mouse_get_button_state**\ (\ ) |const| :ref:`🔗` Returns the current state of mouse buttons (whether each button is pressed) as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to :ref:`Input.get_mouse_button_mask`. @@ -3083,7 +3099,7 @@ Returns the current state of mouse buttons (whether each button is pressed) as a .. rst-class:: classref-method -:ref:`MouseMode` **mouse_get_mode**\ (\ ) |const| +:ref:`MouseMode` **mouse_get_mode**\ (\ ) |const| :ref:`🔗` Returns the current mouse mode. See also :ref:`mouse_set_mode`. @@ -3095,7 +3111,7 @@ Returns the current mouse mode. See also :ref:`mouse_set_mode` **mouse_get_position**\ (\ ) |const| +:ref:`Vector2i` **mouse_get_position**\ (\ ) |const| :ref:`🔗` Returns the mouse cursor's current position in screen coordinates. @@ -3107,7 +3123,7 @@ Returns the mouse cursor's current position in screen coordinates. .. rst-class:: classref-method -|void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode`\ ) +|void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode`\ ) :ref:`🔗` Sets the current mouse mode. See also :ref:`mouse_get_mode`. @@ -3119,7 +3135,7 @@ Sets the current mouse mode. See also :ref:`mouse_get_mode` Perform window manager processing, including input flushing. See also :ref:`force_process_and_drop_events`, :ref:`Input.flush_buffered_events` and :ref:`Input.use_accumulated_input`. @@ -3131,7 +3147,7 @@ Perform window manager processing, including input flushing. See also :ref:`forc .. rst-class:: classref-method -:ref:`int` **screen_get_dpi**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`int` **screen_get_dpi**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the dots per inch density of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW` (the default value), a screen with the main window will be used. @@ -3158,7 +3174,7 @@ Returns the dots per inch density of the specified screen. If ``screen`` is :ref .. rst-class:: classref-method -:ref:`Image` **screen_get_image**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`Image` **screen_get_image**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns screenshot of the ``screen``. @@ -3174,7 +3190,7 @@ Returns screenshot of the ``screen``. .. rst-class:: classref-method -:ref:`float` **screen_get_max_scale**\ (\ ) |const| +:ref:`float` **screen_get_max_scale**\ (\ ) |const| :ref:`🔗` Returns the greatest scale factor of all screens. @@ -3190,7 +3206,7 @@ Returns the greatest scale factor of all screens. .. rst-class:: classref-method -:ref:`ScreenOrientation` **screen_get_orientation**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`ScreenOrientation` **screen_get_orientation**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation`. @@ -3204,7 +3220,7 @@ Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientat .. rst-class:: classref-method -:ref:`Color` **screen_get_pixel**\ (\ position\: :ref:`Vector2i`\ ) |const| +:ref:`Color` **screen_get_pixel**\ (\ position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns color of the display pixel at the ``position``. @@ -3220,7 +3236,7 @@ Returns color of the display pixel at the ``position``. .. rst-class:: classref-method -:ref:`Vector2i` **screen_get_position**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`Vector2i` **screen_get_position**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the screen's top-left corner position in pixels. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this: @@ -3245,7 +3261,7 @@ See also :ref:`screen_get_size`. .. rst-class:: classref-method -:ref:`float` **screen_get_refresh_rate**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`float` **screen_get_refresh_rate**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the current refresh rate of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW` (the default value), a screen with the main window will be used. @@ -3267,7 +3283,7 @@ To fallback to a default refresh rate if the method fails, try: .. rst-class:: classref-method -:ref:`float` **screen_get_scale**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`float` **screen_get_scale**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the scale factor of the specified screen by index. @@ -3285,7 +3301,7 @@ Returns the scale factor of the specified screen by index. .. rst-class:: classref-method -:ref:`Vector2i` **screen_get_size**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`Vector2i` **screen_get_size**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the screen's size in pixels. See also :ref:`screen_get_position` and :ref:`screen_get_usable_rect`. @@ -3297,7 +3313,7 @@ Returns the screen's size in pixels. See also :ref:`screen_get_position` **screen_get_usable_rect**\ (\ screen\: :ref:`int` = -1\ ) |const| +:ref:`Rect2i` **screen_get_usable_rect**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the portion of the screen that is not obstructed by a status bar in pixels. See also :ref:`screen_get_size`. @@ -3309,7 +3325,7 @@ Returns the portion of the screen that is not obstructed by a status bar in pixe .. rst-class:: classref-method -:ref:`bool` **screen_is_kept_on**\ (\ ) |const| +:ref:`bool` **screen_is_kept_on**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_set_keep_on`. @@ -3321,7 +3337,7 @@ Returns ``true`` if the screen should never be turned off by the operating syste .. rst-class:: classref-method -|void| **screen_set_keep_on**\ (\ enable\: :ref:`bool`\ ) +|void| **screen_set_keep_on**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_is_kept_on`. @@ -3333,7 +3349,7 @@ Sets whether the screen should never be turned off by the operating system's pow .. rst-class:: classref-method -|void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) +|void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) :ref:`🔗` Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation`. @@ -3347,7 +3363,7 @@ Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation`\ ) +|void| **set_icon**\ (\ image\: :ref:`Image`\ ) :ref:`🔗` Sets the window icon (usually displayed in the top-left corner) with an :ref:`Image`. To use icons in the operating system's native format, use :ref:`set_native_icon` instead. @@ -3361,7 +3377,7 @@ Sets the window icon (usually displayed in the top-left corner) with an :ref:`Im .. rst-class:: classref-method -|void| **set_native_icon**\ (\ filename\: :ref:`String`\ ) +|void| **set_native_icon**\ (\ filename\: :ref:`String`\ ) :ref:`🔗` Sets the window icon (usually displayed in the top-left corner) in the operating system's *native* format. The file at ``filename`` must be in ``.ico`` format on Windows or ``.icns`` on macOS. By using specially crafted ``.ico`` or ``.icns`` icons, :ref:`set_native_icon` allows specifying different icons depending on the size the icon is displayed at. This size is determined by the operating system and user preferences (including the display scale factor). To use icons in other formats, use :ref:`set_icon` instead. @@ -3375,7 +3391,7 @@ Sets the window icon (usually displayed in the top-left corner) in the operating .. rst-class:: classref-method -|void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable`\ ) +|void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments. @@ -3389,7 +3405,7 @@ Sets the ``callable`` that should be called when system theme settings are chang .. rst-class:: classref-method -:ref:`Rect2` **status_indicator_get_rect**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Rect2` **status_indicator_get_rect**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the rectangle for the given status indicator ``id`` in screen coordinates. If the status indicator is not visible, returns an empty :ref:`Rect2`. @@ -3403,9 +3419,9 @@ Returns the rectangle for the given status indicator ``id`` in screen coordinate .. rst-class:: classref-method -|void| **status_indicator_set_callback**\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) +|void| **status_indicator_set_callback**\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` -Sets the application status indicator activation callback. +Sets the application status indicator activation callback. ``callback`` should take two arguments: :ref:`int` mouse button index (one of :ref:`MouseButton` values) and :ref:`Vector2i` click position in screen coordinates. \ **Note:** This method is implemented on macOS and Windows. @@ -3417,7 +3433,7 @@ Sets the application status indicator activation callback. .. rst-class:: classref-method -|void| **status_indicator_set_icon**\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **status_indicator_set_icon**\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the application status indicator icon. @@ -3431,7 +3447,7 @@ Sets the application status indicator icon. .. rst-class:: classref-method -|void| **status_indicator_set_menu**\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) +|void| **status_indicator_set_menu**\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) :ref:`🔗` Sets the application status indicator native popup menu. @@ -3449,7 +3465,7 @@ Sets the application status indicator native popup menu. .. rst-class:: classref-method -|void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the application status indicator tooltip. @@ -3463,7 +3479,7 @@ Sets the application status indicator tooltip. .. rst-class:: classref-method -:ref:`String` **tablet_get_current_driver**\ (\ ) |const| +:ref:`String` **tablet_get_current_driver**\ (\ ) |const| :ref:`🔗` Returns current active tablet driver name. @@ -3477,7 +3493,7 @@ Returns current active tablet driver name. .. rst-class:: classref-method -:ref:`int` **tablet_get_driver_count**\ (\ ) |const| +:ref:`int` **tablet_get_driver_count**\ (\ ) |const| :ref:`🔗` Returns the total number of available tablet drivers. @@ -3491,7 +3507,7 @@ Returns the total number of available tablet drivers. .. rst-class:: classref-method -:ref:`String` **tablet_get_driver_name**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **tablet_get_driver_name**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tablet driver name for the given index. @@ -3505,7 +3521,7 @@ Returns the tablet driver name for the given index. .. rst-class:: classref-method -|void| **tablet_set_current_driver**\ (\ name\: :ref:`String`\ ) +|void| **tablet_set_current_driver**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Set active tablet driver name. @@ -3527,7 +3543,7 @@ Supported drivers: .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **tts_get_voices**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **tts_get_voices**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` of voice information dictionaries. @@ -3553,7 +3569,7 @@ Note that Godot depends on system libraries for text-to-speech functionality. Th .. rst-class:: classref-method -:ref:`PackedStringArray` **tts_get_voices_for_language**\ (\ language\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **tts_get_voices_for_language**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` Returns an :ref:`PackedStringArray` of voice identifiers for the ``language``. @@ -3569,7 +3585,7 @@ Returns an :ref:`PackedStringArray` of voice identifier .. rst-class:: classref-method -:ref:`bool` **tts_is_paused**\ (\ ) |const| +:ref:`bool` **tts_is_paused**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the synthesizer is in a paused state. @@ -3585,7 +3601,7 @@ Returns ``true`` if the synthesizer is in a paused state. .. rst-class:: classref-method -:ref:`bool` **tts_is_speaking**\ (\ ) |const| +:ref:`bool` **tts_is_speaking**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue. @@ -3601,7 +3617,7 @@ Returns ``true`` if the synthesizer is generating speech, or have utterance wait .. rst-class:: classref-method -|void| **tts_pause**\ (\ ) +|void| **tts_pause**\ (\ ) :ref:`🔗` Puts the synthesizer into a paused state. @@ -3617,7 +3633,7 @@ Puts the synthesizer into a paused state. .. rst-class:: classref-method -|void| **tts_resume**\ (\ ) +|void| **tts_resume**\ (\ ) :ref:`🔗` Resumes the synthesizer if it was paused. @@ -3633,7 +3649,7 @@ Resumes the synthesizer if it was paused. .. rst-class:: classref-method -|void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) +|void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) :ref:`🔗` Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary. @@ -3655,7 +3671,7 @@ Adds a callback, which is called when the utterance has started, finished, cance .. rst-class:: classref-method -|void| **tts_speak**\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) +|void| **tts_speak**\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) :ref:`🔗` Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first. @@ -3685,7 +3701,7 @@ Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is clear .. rst-class:: classref-method -|void| **tts_stop**\ (\ ) +|void| **tts_stop**\ (\ ) :ref:`🔗` Stops synthesis in progress and removes all utterances from the queue. @@ -3701,7 +3717,7 @@ Stops synthesis in progress and removes all utterances from the queue. .. rst-class:: classref-method -:ref:`int` **virtual_keyboard_get_height**\ (\ ) |const| +:ref:`int` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`🔗` Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden. @@ -3713,7 +3729,7 @@ Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyb .. rst-class:: classref-method -|void| **virtual_keyboard_hide**\ (\ ) +|void| **virtual_keyboard_hide**\ (\ ) :ref:`🔗` Hides the virtual keyboard if it is shown, does nothing otherwise. @@ -3725,7 +3741,7 @@ Hides the virtual keyboard if it is shown, does nothing otherwise. .. rst-class:: classref-method -|void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) +|void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) :ref:`🔗` Shows the virtual keyboard if the platform has one. @@ -3751,7 +3767,7 @@ Shows the virtual keyboard if the platform has one. .. rst-class:: classref-method -|void| **warp_mouse**\ (\ position\: :ref:`Vector2i`\ ) +|void| **warp_mouse**\ (\ position\: :ref:`Vector2i`\ ) :ref:`🔗` Sets the mouse cursor position to the given ``position`` relative to an origin at the upper left corner of the currently focused game Window Manager window. @@ -3765,7 +3781,7 @@ Sets the mouse cursor position to the given ``position`` relative to an origin a .. rst-class:: classref-method -:ref:`bool` **window_can_draw**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`bool` **window_can_draw**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns ``true`` if anything can be drawn in the window specified by ``window_id``, ``false`` otherwise. Using the ``--disable-render-loop`` command line argument or a headless build will return ``false``. @@ -3777,7 +3793,7 @@ Returns ``true`` if anything can be drawn in the window specified by ``window_id .. rst-class:: classref-method -:ref:`int` **window_get_active_popup**\ (\ ) |const| +:ref:`int` **window_get_active_popup**\ (\ ) |const| :ref:`🔗` Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID` if there is none. @@ -3789,7 +3805,7 @@ Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`int` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the :ref:`Object.get_instance_id` of the :ref:`Window` the ``window_id`` is attached to. @@ -3801,7 +3817,7 @@ Returns the :ref:`Object.get_instance_id` o .. rst-class:: classref-method -:ref:`int` **window_get_current_screen**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`int` **window_get_current_screen**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the screen the window specified by ``window_id`` is currently positioned on. If the screen overlaps multiple displays, the screen where the window's center is located is returned. See also :ref:`window_set_current_screen`. @@ -3813,7 +3829,7 @@ Returns the screen the window specified by ``window_id`` is currently positioned .. rst-class:: classref-method -:ref:`bool` **window_get_flag**\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| +:ref:`bool` **window_get_flag**\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the current value of the given window's ``flag``. @@ -3825,7 +3841,7 @@ Returns the current value of the given window's ``flag``. .. rst-class:: classref-method -:ref:`Vector2i` **window_get_max_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_max_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size`. @@ -3837,7 +3853,7 @@ Returns the window's maximum size (in pixels). See also :ref:`window_set_max_siz .. rst-class:: classref-method -:ref:`Vector2i` **window_get_min_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_min_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size`. @@ -3849,7 +3865,7 @@ Returns the window's minimum size (in pixels). See also :ref:`window_set_min_siz .. rst-class:: classref-method -:ref:`WindowMode` **window_get_mode**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`WindowMode` **window_get_mode**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the mode of the given window. @@ -3861,7 +3877,7 @@ Returns the mode of the given window. .. rst-class:: classref-method -:ref:`int` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| +:ref:`int` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns internal structure pointers for use in plugins. @@ -3875,7 +3891,7 @@ Returns internal structure pointers for use in plugins. .. rst-class:: classref-method -:ref:`Rect2i` **window_get_popup_safe_rect**\ (\ window\: :ref:`int`\ ) |const| +:ref:`Rect2i` **window_get_popup_safe_rect**\ (\ window\: :ref:`int`\ ) |const| :ref:`🔗` Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. @@ -3887,7 +3903,7 @@ Returns the bounding box of control, or menu item that was used to open the popu .. rst-class:: classref-method -:ref:`Vector2i` **window_get_position**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_position**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the position of the client area of the given window on the screen. @@ -3899,7 +3915,7 @@ Returns the position of the client area of the given window on the screen. .. rst-class:: classref-method -:ref:`Vector2i` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the position of the given window on the screen including the borders drawn by the operating system. See also :ref:`window_get_position`. @@ -3911,7 +3927,7 @@ Returns the position of the given window on the screen including the borders dra .. rst-class:: classref-method -:ref:`Vector3i` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector3i` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns left margins (``x``), right margins (``y``) and height (``z``) of the title that are safe to use (contains no buttons or other elements) when :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` flag is set. @@ -3923,7 +3939,7 @@ Returns left margins (``x``), right margins (``y``) and height (``z``) of the ti .. rst-class:: classref-method -:ref:`Vector2i` **window_get_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the size of the window specified by ``window_id`` (in pixels), excluding the borders drawn by the operating system. This is also called the "client area". See also :ref:`window_get_size_with_decorations`, :ref:`window_set_size` and :ref:`window_get_position`. @@ -3935,7 +3951,7 @@ Returns the size of the window specified by ``window_id`` (in pixels), excluding .. rst-class:: classref-method -:ref:`Vector2i` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the size of the window specified by ``window_id`` (in pixels), including the borders drawn by the operating system. See also :ref:`window_get_size`. @@ -3947,7 +3963,7 @@ Returns the size of the window specified by ``window_id`` (in pixels), including .. rst-class:: classref-method -:ref:`Vector2i` **window_get_title_size**\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| +:ref:`Vector2i` **window_get_title_size**\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the estimated window title bar size (including text and window buttons) for the window specified by ``window_id`` (in pixels). This method does not change the window title. @@ -3961,7 +3977,7 @@ Returns the estimated window title bar size (including text and window buttons) .. rst-class:: classref-method -:ref:`VSyncMode` **window_get_vsync_mode**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`VSyncMode` **window_get_vsync_mode**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the V-Sync mode of the given window. @@ -3973,7 +3989,7 @@ Returns the V-Sync mode of the given window. .. rst-class:: classref-method -:ref:`bool` **window_is_focused**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`bool` **window_is_focused**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns ``true`` if the window specified by ``window_id`` is focused. @@ -3985,7 +4001,7 @@ Returns ``true`` if the window specified by ``window_id`` is focused. .. rst-class:: classref-method -:ref:`bool` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int` = 0\ ) |const| +:ref:`bool` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns ``true`` if the given window can be maximized (the maximize button is enabled). @@ -3997,7 +4013,7 @@ Returns ``true`` if the given window can be maximized (the maximize button is en .. rst-class:: classref-method -:ref:`bool` **window_maximize_on_title_dbl_click**\ (\ ) |const| +:ref:`bool` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗` Returns ``true``, if double-click on a window title should maximize it. @@ -4011,7 +4027,7 @@ Returns ``true``, if double-click on a window title should maximize it. .. rst-class:: classref-method -:ref:`bool` **window_minimize_on_title_dbl_click**\ (\ ) |const| +:ref:`bool` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗` Returns ``true``, if double-click on a window title should minimize it. @@ -4025,7 +4041,7 @@ Returns ``true``, if double-click on a window title should minimize it. .. rst-class:: classref-method -|void| **window_move_to_foreground**\ (\ window_id\: :ref:`int` = 0\ ) +|void| **window_move_to_foreground**\ (\ window_id\: :ref:`int` = 0\ ) :ref:`🔗` Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows. @@ -4037,7 +4053,7 @@ Moves the window specified by ``window_id`` to the foreground, so that it is vis .. rst-class:: classref-method -|void| **window_request_attention**\ (\ window_id\: :ref:`int` = 0\ ) +|void| **window_request_attention**\ (\ window_id\: :ref:`int` = 0\ ) :ref:`🔗` Makes the window specified by ``window_id`` request attention, which is materialized by the window title and taskbar entry blinking until the window is focused. This usually has no visible effect if the window is currently focused. The exact behavior varies depending on the operating system. @@ -4049,7 +4065,7 @@ Makes the window specified by ``window_id`` request attention, which is material .. rst-class:: classref-method -|void| **window_set_current_screen**\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_current_screen**\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Moves the window specified by ``window_id`` to the specified ``screen``. See also :ref:`window_get_current_screen`. @@ -4061,9 +4077,9 @@ Moves the window specified by ``window_id`` to the specified ``screen``. See als .. rst-class:: classref-method -|void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` -Sets the ``callback`` that should be called when files are dropped from the operating system's file manager to the window specified by ``window_id``. +Sets the ``callback`` that should be called when files are dropped from the operating system's file manager to the window specified by ``window_id``. ``callback`` should take one :ref:`PackedStringArray` argument, which is the list of dropped files. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window` node will override its default implementation, which can introduce bugs. @@ -4077,7 +4093,7 @@ Sets the ``callback`` that should be called when files are dropped from the oper .. rst-class:: classref-method -|void| **window_set_exclusive**\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) +|void| **window_set_exclusive**\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, this window will always stay on top of its parent window, parent window will ignore input while this window is opened. @@ -4093,7 +4109,7 @@ If set to ``true``, this window will always stay on top of its parent window, pa .. rst-class:: classref-method -|void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Enables or disables the given window's given ``flag``. See :ref:`WindowFlags` for possible values and their behavior. @@ -4105,7 +4121,7 @@ Enables or disables the given window's given ``flag``. See :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_ime_active**\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets whether `Input Method Editor `__ should be enabled for the window specified by ``window_id``. See also :ref:`window_set_ime_position`. @@ -4117,7 +4133,7 @@ Sets whether `Input Method Editor `_ .. rst-class:: classref-method -|void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the position of the `Input Method Editor `__ popup for the specified ``window_id``. Only effective if :ref:`window_set_ime_active` was set to ``true`` for the specified ``window_id``. @@ -4129,7 +4145,7 @@ Sets the position of the `Input Method Editor `, window_id\: :ref:`int` = 0\ ) +|void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the ``callback`` that should be called when any :ref:`InputEvent` is sent to the window specified by ``window_id``. @@ -4143,7 +4159,7 @@ Sets the ``callback`` that should be called when any :ref:`InputEvent`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``. @@ -4157,7 +4173,7 @@ Sets the ``callback`` that should be called when text is entered using the virtu .. rst-class:: classref-method -|void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_max_size`. @@ -4173,7 +4189,7 @@ Sets the maximum size of the window specified by ``window_id`` in pixels. Normal .. rst-class:: classref-method -|void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the minimum size for the given window to ``min_size`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_min_size`. @@ -4191,7 +4207,7 @@ Sets the minimum size for the given window to ``min_size`` in pixels. Normally, .. rst-class:: classref-method -|void| **window_set_mode**\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_mode**\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets window mode for the given window to ``mode``. See :ref:`WindowMode` for possible values and how each mode behaves. @@ -4205,7 +4221,7 @@ Sets window mode for the given window to ``mode``. See :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. @@ -4250,7 +4266,7 @@ Passing an empty array will disable passthrough support (all mouse events will b .. rst-class:: classref-method -|void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) +|void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) :ref:`🔗` Sets the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. Clicking this area will not auto-close this popup. @@ -4262,7 +4278,7 @@ Sets the bounding box of control, or menu item that was used to open the popup w .. rst-class:: classref-method -|void| **window_set_position**\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_position**\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the position of the given window to ``position``. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this: @@ -4289,7 +4305,7 @@ See also :ref:`window_get_position`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized. @@ -4303,7 +4319,7 @@ Sets the ``callback`` that will be called when the window specified by ``window_ .. rst-class:: classref-method -|void| **window_set_size**\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_size**\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the size of the given window to ``size`` (in pixels). See also :ref:`window_get_size` and :ref:`window_get_position`. @@ -4317,7 +4333,7 @@ Sets the size of the given window to ``size`` (in pixels). See also :ref:`window .. rst-class:: classref-method -|void| **window_set_title**\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_title**\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the title of the given window to ``title``. @@ -4333,7 +4349,7 @@ Sets the title of the given window to ``title``. .. rst-class:: classref-method -|void| **window_set_transient**\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) +|void| **window_set_transient**\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) :ref:`🔗` Sets window transient parent. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. @@ -4349,7 +4365,7 @@ Sets window transient parent. Transient window is will be destroyed with its tra .. rst-class:: classref-method -|void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the V-Sync mode of the given window. See also :ref:`ProjectSettings.display/window/vsync/vsync_mode`. @@ -4367,7 +4383,7 @@ Depending on the platform and used renderer, the engine will fall back to :ref:` .. rst-class:: classref-method -|void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` When :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` flag is set, set offset to the center of the first titlebar button. @@ -4381,7 +4397,7 @@ When :ref:`WINDOW_FLAG_EXTEND_TO_TITLE`, window_id\: :ref:`int` = 0\ ) +|void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``. diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index 74a94d766b0..bbbe7efd6fe 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -199,7 +199,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **setup**\ (\ server_options\: :ref:`TLSOptions`\ ) +:ref:`Error` **setup**\ (\ server_options\: :ref:`TLSOptions`\ ) :ref:`🔗` Setup the DTLS server to use the given ``server_options``. See :ref:`TLSOptions.server`. @@ -211,7 +211,7 @@ Setup the DTLS server to use the given ``server_options``. See :ref:`TLSOptions. .. rst-class:: classref-method -:ref:`PacketPeerDTLS` **take_connection**\ (\ udp_peer\: :ref:`PacketPeerUDP`\ ) +:ref:`PacketPeerDTLS` **take_connection**\ (\ udp_peer\: :ref:`PacketPeerUDP`\ ) :ref:`🔗` Try to initiate the DTLS handshake with the given ``udp_peer`` which must be already connected (see :ref:`PacketPeerUDP.connect_to_host`). diff --git a/classes/class_editorcommandpalette.rst b/classes/class_editorcommandpalette.rst index 420e377ac40..51fb64593ee 100644 --- a/classes/class_editorcommandpalette.rst +++ b/classes/class_editorcommandpalette.rst @@ -83,7 +83,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_command**\ (\ command_name\: :ref:`String`, key_name\: :ref:`String`, binded_callable\: :ref:`Callable`, shortcut_text\: :ref:`String` = "None"\ ) +|void| **add_command**\ (\ command_name\: :ref:`String`, key_name\: :ref:`String`, binded_callable\: :ref:`Callable`, shortcut_text\: :ref:`String` = "None"\ ) :ref:`🔗` Adds a custom command to EditorCommandPalette. @@ -103,7 +103,7 @@ Adds a custom command to EditorCommandPalette. .. rst-class:: classref-method -|void| **remove_command**\ (\ key_name\: :ref:`String`\ ) +|void| **remove_command**\ (\ key_name\: :ref:`String`\ ) :ref:`🔗` Removes the custom command from EditorCommandPalette. diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index 99c51ec7989..d2904a43374 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_capture**\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| +:ref:`bool` **_capture**\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to process incoming messages. The ``session_id`` is the ID of the :ref:`EditorDebuggerSession` that received the message (which you can retrieve via :ref:`get_session`). @@ -111,7 +111,7 @@ Override this method to process incoming messages. The ``session_id`` is the ID .. rst-class:: classref-method -:ref:`bool` **_has_capture**\ (\ capture\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_has_capture**\ (\ capture\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Override this method to enable receiving messages from the debugger. If ``capture`` is "my_message" then messages starting with "my_message:" will be passes to the :ref:`_capture` method. @@ -123,7 +123,7 @@ Override this method to enable receiving messages from the debugger. If ``captur .. rst-class:: classref-method -|void| **_setup_session**\ (\ session_id\: :ref:`int`\ ) |virtual| +|void| **_setup_session**\ (\ session_id\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to be notified whenever a new :ref:`EditorDebuggerSession` is created (the session may be inactive during this stage). @@ -135,7 +135,7 @@ Override this method to be notified whenever a new :ref:`EditorDebuggerSession` **get_session**\ (\ id\: :ref:`int`\ ) +:ref:`EditorDebuggerSession` **get_session**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`EditorDebuggerSession` with the given ``id``. @@ -147,7 +147,7 @@ Returns the :ref:`EditorDebuggerSession` with the g .. rst-class:: classref-method -:ref:`Array` **get_sessions**\ (\ ) +:ref:`Array` **get_sessions**\ (\ ) :ref:`🔗` Returns an array of :ref:`EditorDebuggerSession` currently available to this debugger plugin. diff --git a/classes/class_editordebuggersession.rst b/classes/class_editordebuggersession.rst index 01440cb0765..d4e13fa6771 100644 --- a/classes/class_editordebuggersession.rst +++ b/classes/class_editordebuggersession.rst @@ -60,7 +60,7 @@ Signals .. rst-class:: classref-signal -**breaked**\ (\ can_debug\: :ref:`bool`\ ) +**breaked**\ (\ can_debug\: :ref:`bool`\ ) :ref:`🔗` Emitted when the attached remote instance enters a break state. If ``can_debug`` is ``true``, the remote instance will enter the debug loop. @@ -72,7 +72,7 @@ Emitted when the attached remote instance enters a break state. If ``can_debug`` .. rst-class:: classref-signal -**continued**\ (\ ) +**continued**\ (\ ) :ref:`🔗` Emitted when the attached remote instance exits a break state. @@ -84,7 +84,7 @@ Emitted when the attached remote instance exits a break state. .. rst-class:: classref-signal -**started**\ (\ ) +**started**\ (\ ) :ref:`🔗` Emitted when a remote instance is attached to this session (i.e. the session becomes active). @@ -96,7 +96,7 @@ Emitted when a remote instance is attached to this session (i.e. the session bec .. rst-class:: classref-signal -**stopped**\ (\ ) +**stopped**\ (\ ) :ref:`🔗` Emitted when a remote instance is detached from this session (i.e. the session becomes inactive). @@ -113,7 +113,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_session_tab**\ (\ control\: :ref:`Control`\ ) +|void| **add_session_tab**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Adds the given ``control`` to the debug session UI in the debugger bottom panel. @@ -125,7 +125,7 @@ Adds the given ``control`` to the debug session UI in the debugger bottom panel. .. rst-class:: classref-method -:ref:`bool` **is_active**\ (\ ) +:ref:`bool` **is_active**\ (\ ) :ref:`🔗` Returns ``true`` if the debug session is currently attached to a remote instance. @@ -137,7 +137,7 @@ Returns ``true`` if the debug session is currently attached to a remote instance .. rst-class:: classref-method -:ref:`bool` **is_breaked**\ (\ ) +:ref:`bool` **is_breaked**\ (\ ) :ref:`🔗` Returns ``true`` if the attached remote instance is currently in the debug loop. @@ -149,7 +149,7 @@ Returns ``true`` if the attached remote instance is currently in the debug loop. .. rst-class:: classref-method -:ref:`bool` **is_debuggable**\ (\ ) +:ref:`bool` **is_debuggable**\ (\ ) :ref:`🔗` Returns ``true`` if the attached remote instance can be debugged. @@ -161,7 +161,7 @@ Returns ``true`` if the attached remote instance can be debugged. .. rst-class:: classref-method -|void| **remove_session_tab**\ (\ control\: :ref:`Control`\ ) +|void| **remove_session_tab**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Removes the given ``control`` from the debug session UI in the debugger bottom panel. @@ -173,7 +173,7 @@ Removes the given ``control`` from the debug session UI in the debugger bottom p .. rst-class:: classref-method -|void| **send_message**\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) +|void| **send_message**\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) :ref:`🔗` Sends the given ``message`` to the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineDebugger` for how to retrieve those messages. @@ -185,7 +185,7 @@ Sends the given ``message`` to the attached remote instance, optionally passing .. rst-class:: classref-method -|void| **toggle_profiler**\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) +|void| **toggle_profiler**\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) :ref:`🔗` Toggle the given ``profiler`` on the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineProfiler` for more details. diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 912f05a21a2..a72b7d160f8 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_os_name**\ (\ ) |const| +:ref:`String` **get_os_name**\ (\ ) |const| :ref:`🔗` Returns the name of the export operating system handled by this **EditorExportPlatform** class, as a friendly string. Possible return values are ``Windows``, ``Linux``, ``macOS``, ``Android``, ``iOS``, and ``Web``. diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 2afe2440cc6..488ba86bfac 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -434,7 +434,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **apk_expansion/SALT** +:ref:`String` **apk_expansion/SALT** :ref:`🔗` Array of random bytes that the licensing Policy uses to create an `Obfuscator `__. @@ -446,7 +446,7 @@ Array of random bytes that the licensing Policy uses to create an `Obfuscator ` **apk_expansion/enable** +:ref:`bool` **apk_expansion/enable** :ref:`🔗` If ``true``, project resources are stored in the separate APK expansion file, instead of the APK. @@ -460,7 +460,7 @@ If ``true``, project resources are stored in the separate APK expansion file, in .. rst-class:: classref-property -:ref:`String` **apk_expansion/public_key** +:ref:`String` **apk_expansion/public_key** :ref:`🔗` Base64 encoded RSA public key for your publisher account, available from the profile page on the "Google Play Console". @@ -472,7 +472,7 @@ Base64 encoded RSA public key for your publisher account, available from the pro .. rst-class:: classref-property -:ref:`bool` **architectures/arm64-v8a** +:ref:`bool` **architectures/arm64-v8a** :ref:`🔗` If ``true``, ``arm64`` binaries are included into exported project. @@ -484,7 +484,7 @@ If ``true``, ``arm64`` binaries are included into exported project. .. rst-class:: classref-property -:ref:`bool` **architectures/armeabi-v7a** +:ref:`bool` **architectures/armeabi-v7a** :ref:`🔗` If ``true``, ``arm32`` binaries are included into exported project. @@ -496,7 +496,7 @@ If ``true``, ``arm32`` binaries are included into exported project. .. rst-class:: classref-property -:ref:`bool` **architectures/x86** +:ref:`bool` **architectures/x86** :ref:`🔗` If ``true``, ``x86_32`` binaries are included into exported project. @@ -508,7 +508,7 @@ If ``true``, ``x86_32`` binaries are included into exported project. .. rst-class:: classref-property -:ref:`bool` **architectures/x86_64** +:ref:`bool` **architectures/x86_64** :ref:`🔗` If ``true``, ``x86_64`` binaries are included into exported project. @@ -520,7 +520,7 @@ If ``true``, ``x86_64`` binaries are included into exported project. .. rst-class:: classref-property -:ref:`String` **command_line/extra_args** +:ref:`String` **command_line/extra_args** :ref:`🔗` A list of additional command line arguments, separated by space, which the exported project will receive when started. @@ -532,7 +532,7 @@ A list of additional command line arguments, separated by space, which the expor .. rst-class:: classref-property -:ref:`String` **custom_template/debug** +:ref:`String` **custom_template/debug** :ref:`🔗` Path to an APK file to use as a custom export template for debug exports. If left empty, default template is used. @@ -546,7 +546,7 @@ Path to an APK file to use as a custom export template for debug exports. If lef .. rst-class:: classref-property -:ref:`String` **custom_template/release** +:ref:`String` **custom_template/release** :ref:`🔗` Path to an APK file to use as a custom export template for release exports. If left empty, default template is used. @@ -560,7 +560,7 @@ Path to an APK file to use as a custom export template for release exports. If l .. rst-class:: classref-property -:ref:`String` **gradle_build/android_source_template** +:ref:`String` **gradle_build/android_source_template** :ref:`🔗` Path to a ZIP file holding the source for the export template used in a Gradle build. If left empty, the default template is used. @@ -572,7 +572,7 @@ Path to a ZIP file holding the source for the export template used in a Gradle b .. rst-class:: classref-property -:ref:`bool` **gradle_build/compress_native_libraries** +:ref:`bool` **gradle_build/compress_native_libraries** :ref:`🔗` If ``true``, native libraries are compressed when performing a Gradle build. @@ -586,7 +586,7 @@ If ``true``, native libraries are compressed when performing a Gradle build. .. rst-class:: classref-property -:ref:`int` **gradle_build/export_format** +:ref:`int` **gradle_build/export_format** :ref:`🔗` Application export format (\*.apk or \*.aab). @@ -598,7 +598,7 @@ Application export format (\*.apk or \*.aab). .. rst-class:: classref-property -:ref:`String` **gradle_build/gradle_build_directory** +:ref:`String` **gradle_build/gradle_build_directory** :ref:`🔗` Path to the Gradle build directory. If left empty, then ``res://android`` will be used. @@ -610,7 +610,7 @@ Path to the Gradle build directory. If left empty, then ``res://android`` will b .. rst-class:: classref-property -:ref:`String` **gradle_build/min_sdk** +:ref:`String` **gradle_build/min_sdk** :ref:`🔗` Minimum Android API level required for the application to run (used during Gradle build). See `android:minSdkVersion `__. @@ -622,7 +622,7 @@ Minimum Android API level required for the application to run (used during Gradl .. rst-class:: classref-property -:ref:`String` **gradle_build/target_sdk** +:ref:`String` **gradle_build/target_sdk** :ref:`🔗` The Android API level on which the application is designed to run (used during Gradle build). See `android:targetSdkVersion `__. @@ -634,7 +634,7 @@ The Android API level on which the application is designed to run (used during G .. rst-class:: classref-property -:ref:`bool` **gradle_build/use_gradle_build** +:ref:`bool` **gradle_build/use_gradle_build** :ref:`🔗` If ``true``, Gradle build is used instead of pre-built APK. @@ -646,7 +646,7 @@ If ``true``, Gradle build is used instead of pre-built APK. .. rst-class:: classref-property -:ref:`bool` **graphics/opengl_debug** +:ref:`bool` **graphics/opengl_debug** :ref:`🔗` If ``true``, OpenGL ES debug context will be created (additional runtime checking, validation, and logging). @@ -658,7 +658,7 @@ If ``true``, OpenGL ES debug context will be created (additional runtime checkin .. rst-class:: classref-property -:ref:`String` **keystore/debug** +:ref:`String` **keystore/debug** :ref:`🔗` Path of the debug keystore file. @@ -674,7 +674,7 @@ Fallbacks to ``EditorSettings.export/android/debug_keystore`` if empty. .. rst-class:: classref-property -:ref:`String` **keystore/debug_password** +:ref:`String` **keystore/debug_password** :ref:`🔗` Password for the debug keystore file. @@ -690,7 +690,7 @@ Fallbacks to ``EditorSettings.export/android/debug_keystore_pass`` if both it an .. rst-class:: classref-property -:ref:`String` **keystore/debug_user** +:ref:`String` **keystore/debug_user** :ref:`🔗` User name for the debug keystore file. @@ -706,7 +706,7 @@ Fallbacks to ``EditorSettings.export/android/debug_keystore_user`` if both it an .. rst-class:: classref-property -:ref:`String` **keystore/release** +:ref:`String` **keystore/release** :ref:`🔗` Path of the release keystore file. @@ -720,7 +720,7 @@ Can be overridden with the environment variable ``GODOT_ANDROID_KEYSTORE_RELEASE .. rst-class:: classref-property -:ref:`String` **keystore/release_password** +:ref:`String` **keystore/release_password** :ref:`🔗` Password for the release keystore file. @@ -734,7 +734,7 @@ Can be overridden with the environment variable ``GODOT_ANDROID_KEYSTORE_RELEASE .. rst-class:: classref-property -:ref:`String` **keystore/release_user** +:ref:`String` **keystore/release_user** :ref:`🔗` User name for the release keystore file. @@ -748,7 +748,7 @@ Can be overridden with the environment variable ``GODOT_ANDROID_KEYSTORE_RELEASE .. rst-class:: classref-property -:ref:`String` **launcher_icons/adaptive_background_432x432** +:ref:`String` **launcher_icons/adaptive_background_432x432** :ref:`🔗` Background layer of the application adaptive icon file. See `Design adaptive icons `__. @@ -760,7 +760,7 @@ Background layer of the application adaptive icon file. See `Design adaptive ico .. rst-class:: classref-property -:ref:`String` **launcher_icons/adaptive_foreground_432x432** +:ref:`String` **launcher_icons/adaptive_foreground_432x432** :ref:`🔗` Foreground layer of the application adaptive icon file. See `Design adaptive icons `__. @@ -772,7 +772,7 @@ Foreground layer of the application adaptive icon file. See `Design adaptive ico .. rst-class:: classref-property -:ref:`String` **launcher_icons/main_192x192** +:ref:`String` **launcher_icons/main_192x192** :ref:`🔗` Application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. @@ -784,7 +784,7 @@ Application icon file. If left empty, it will fallback to :ref:`ProjectSettings. .. rst-class:: classref-property -:ref:`int` **package/app_category** +:ref:`int` **package/app_category** :ref:`🔗` Application category for the Google Play Store. Only define this if your application fits one of the categories well. See `android:appCategory `__. @@ -796,7 +796,7 @@ Application category for the Google Play Store. Only define this if your applica .. rst-class:: classref-property -:ref:`bool` **package/exclude_from_recents** +:ref:`bool` **package/exclude_from_recents** :ref:`🔗` If ``true``, task initiated by main activity will be excluded from the list of recently used applications. See `android:excludeFromRecents `__. @@ -808,7 +808,7 @@ If ``true``, task initiated by main activity will be excluded from the list of r .. rst-class:: classref-property -:ref:`String` **package/name** +:ref:`String` **package/name** :ref:`🔗` Name of the application. @@ -820,7 +820,7 @@ Name of the application. .. rst-class:: classref-property -:ref:`bool` **package/retain_data_on_uninstall** +:ref:`bool` **package/retain_data_on_uninstall** :ref:`🔗` If ``true``, when the user uninstalls an app, a prompt to keep the app's data will be shown. See `android:hasFragileUserData `__. @@ -832,7 +832,7 @@ If ``true``, when the user uninstalls an app, a prompt to keep the app's data wi .. rst-class:: classref-property -:ref:`bool` **package/show_as_launcher_app** +:ref:`bool` **package/show_as_launcher_app** :ref:`🔗` If ``true``, the user will be able to set this app as the system launcher in Android preferences. @@ -844,7 +844,7 @@ If ``true``, the user will be able to set this app as the system launcher in And .. rst-class:: classref-property -:ref:`bool` **package/show_in_android_tv** +:ref:`bool` **package/show_in_android_tv** :ref:`🔗` If ``true``, this app will show in Android TV launcher UI. @@ -856,7 +856,7 @@ If ``true``, this app will show in Android TV launcher UI. .. rst-class:: classref-property -:ref:`bool` **package/show_in_app_library** +:ref:`bool` **package/show_in_app_library** :ref:`🔗` If ``true``, this app will show in the device's app library. @@ -870,7 +870,7 @@ If ``true``, this app will show in the device's app library. .. rst-class:: classref-property -:ref:`bool` **package/signed** +:ref:`bool` **package/signed** :ref:`🔗` If ``true``, package signing is enabled. @@ -882,7 +882,7 @@ If ``true``, package signing is enabled. .. rst-class:: classref-property -:ref:`String` **package/unique_name** +:ref:`String` **package/unique_name** :ref:`🔗` Unique application identifier in a reverse-DNS format. The reverse DNS format should preferably match a domain name you control, but this is not strictly required. For instance, if you own ``example.com``, your package unique name should preferably be of the form ``com.example.mygame``. This identifier can only contain lowercase alphanumeric characters (``a-z``, and ``0-9``), underscores (``_``), and periods (``.``). Each component of the reverse DNS format must start with a letter: for instance, ``com.example.8game`` is not valid. @@ -900,7 +900,7 @@ If ``$genname`` is present in the value, it will be replaced by the project name .. rst-class:: classref-property -:ref:`bool` **permissions/access_checkin_properties** +:ref:`bool` **permissions/access_checkin_properties** :ref:`🔗` Allows read/write access to the "properties" table in the checkin database. See `ACCESS_CHECKIN_PROPERTIES `__. @@ -912,7 +912,7 @@ Allows read/write access to the "properties" table in the checkin database. See .. rst-class:: classref-property -:ref:`bool` **permissions/access_coarse_location** +:ref:`bool` **permissions/access_coarse_location** :ref:`🔗` Allows access to the approximate location information. See `ACCESS_COARSE_LOCATION `__. @@ -924,7 +924,7 @@ Allows access to the approximate location information. See `ACCESS_COARSE_LOCATI .. rst-class:: classref-property -:ref:`bool` **permissions/access_fine_location** +:ref:`bool` **permissions/access_fine_location** :ref:`🔗` Allows access to the precise location information. See `ACCESS_FINE_LOCATION `__. @@ -936,7 +936,7 @@ Allows access to the precise location information. See `ACCESS_FINE_LOCATION ` **permissions/access_location_extra_commands** +:ref:`bool` **permissions/access_location_extra_commands** :ref:`🔗` Allows access to the extra location provider commands. See `ACCESS_LOCATION_EXTRA_COMMANDS `__. @@ -948,7 +948,7 @@ Allows access to the extra location provider commands. See `ACCESS_LOCATION_EXTR .. rst-class:: classref-property -:ref:`bool` **permissions/access_mock_location** +:ref:`bool` **permissions/access_mock_location** :ref:`🔗` Allows an application to create mock location providers for testing. @@ -960,7 +960,7 @@ Allows an application to create mock location providers for testing. .. rst-class:: classref-property -:ref:`bool` **permissions/access_network_state** +:ref:`bool` **permissions/access_network_state** :ref:`🔗` Allows access to the information about networks. See `ACCESS_NETWORK_STATE `__. @@ -972,7 +972,7 @@ Allows access to the information about networks. See `ACCESS_NETWORK_STATE ` **permissions/access_surface_flinger** +:ref:`bool` **permissions/access_surface_flinger** :ref:`🔗` Allows an application to use SurfaceFlinger's low level features. @@ -984,7 +984,7 @@ Allows an application to use SurfaceFlinger's low level features. .. rst-class:: classref-property -:ref:`bool` **permissions/access_wifi_state** +:ref:`bool` **permissions/access_wifi_state** :ref:`🔗` Allows access to the information about Wi-Fi networks. See `ACCESS_WIFI_STATE `__. @@ -996,7 +996,7 @@ Allows access to the information about Wi-Fi networks. See `ACCESS_WIFI_STATE ` **permissions/account_manager** +:ref:`bool` **permissions/account_manager** :ref:`🔗` Allows applications to call into AccountAuthenticators. See `ACCOUNT_MANAGER `__. @@ -1008,7 +1008,7 @@ Allows applications to call into AccountAuthenticators. See `ACCOUNT_MANAGER ` **permissions/add_voicemail** +:ref:`bool` **permissions/add_voicemail** :ref:`🔗` Allows an application to add voicemails into the system. See `ADD_VOICEMAIL `__. @@ -1020,7 +1020,7 @@ Allows an application to add voicemails into the system. See `ADD_VOICEMAIL ` **permissions/authenticate_accounts** +:ref:`bool` **permissions/authenticate_accounts** :ref:`🔗` Allows an application to act as an AccountAuthenticator for the AccountManager. @@ -1032,7 +1032,7 @@ Allows an application to act as an AccountAuthenticator for the AccountManager. .. rst-class:: classref-property -:ref:`bool` **permissions/battery_stats** +:ref:`bool` **permissions/battery_stats** :ref:`🔗` Allows an application to collect battery statistics. See `BATTERY_STATS `__. @@ -1044,7 +1044,7 @@ Allows an application to collect battery statistics. See `BATTERY_STATS ` **permissions/bind_accessibility_service** +:ref:`bool` **permissions/bind_accessibility_service** :ref:`🔗` Must be required by an AccessibilityService, to ensure that only the system can bind to it. See `BIND_ACCESSIBILITY_SERVICE `__. @@ -1056,7 +1056,7 @@ Must be required by an AccessibilityService, to ensure that only the system can .. rst-class:: classref-property -:ref:`bool` **permissions/bind_appwidget** +:ref:`bool` **permissions/bind_appwidget** :ref:`🔗` Allows an application to tell the AppWidget service which application can access AppWidget's data. See `BIND_APPWIDGET `__. @@ -1068,7 +1068,7 @@ Allows an application to tell the AppWidget service which application can access .. rst-class:: classref-property -:ref:`bool` **permissions/bind_device_admin** +:ref:`bool` **permissions/bind_device_admin** :ref:`🔗` Must be required by device administration receiver, to ensure that only the system can interact with it. See `BIND_DEVICE_ADMIN `__. @@ -1080,7 +1080,7 @@ Must be required by device administration receiver, to ensure that only the syst .. rst-class:: classref-property -:ref:`bool` **permissions/bind_input_method** +:ref:`bool` **permissions/bind_input_method** :ref:`🔗` Must be required by an InputMethodService, to ensure that only the system can bind to it. See `BIND_INPUT_METHOD `__. @@ -1092,7 +1092,7 @@ Must be required by an InputMethodService, to ensure that only the system can bi .. rst-class:: classref-property -:ref:`bool` **permissions/bind_nfc_service** +:ref:`bool` **permissions/bind_nfc_service** :ref:`🔗` Must be required by a HostApduService or OffHostApduService to ensure that only the system can bind to it. See `BIND_NFC_SERVICE `__. @@ -1104,7 +1104,7 @@ Must be required by a HostApduService or OffHostApduService to ensure that only .. rst-class:: classref-property -:ref:`bool` **permissions/bind_notification_listener_service** +:ref:`bool` **permissions/bind_notification_listener_service** :ref:`🔗` Must be required by a NotificationListenerService, to ensure that only the system can bind to it. See `BIND_NOTIFICATION_LISTENER_SERVICE `__. @@ -1116,7 +1116,7 @@ Must be required by a NotificationListenerService, to ensure that only the syste .. rst-class:: classref-property -:ref:`bool` **permissions/bind_print_service** +:ref:`bool` **permissions/bind_print_service** :ref:`🔗` Must be required by a PrintService, to ensure that only the system can bind to it. See `BIND_PRINT_SERVICE `__. @@ -1128,7 +1128,7 @@ Must be required by a PrintService, to ensure that only the system can bind to i .. rst-class:: classref-property -:ref:`bool` **permissions/bind_remoteviews** +:ref:`bool` **permissions/bind_remoteviews** :ref:`🔗` Must be required by a RemoteViewsService, to ensure that only the system can bind to it. See `BIND_REMOTEVIEWS `__. @@ -1140,7 +1140,7 @@ Must be required by a RemoteViewsService, to ensure that only the system can bin .. rst-class:: classref-property -:ref:`bool` **permissions/bind_text_service** +:ref:`bool` **permissions/bind_text_service** :ref:`🔗` Must be required by a TextService (e.g. SpellCheckerService) to ensure that only the system can bind to it. See `BIND_TEXT_SERVICE `__. @@ -1152,7 +1152,7 @@ Must be required by a TextService (e.g. SpellCheckerService) to ensure that only .. rst-class:: classref-property -:ref:`bool` **permissions/bind_vpn_service** +:ref:`bool` **permissions/bind_vpn_service** :ref:`🔗` Must be required by a VpnService, to ensure that only the system can bind to it. See `BIND_VPN_SERVICE `__. @@ -1164,7 +1164,7 @@ Must be required by a VpnService, to ensure that only the system can bind to it. .. rst-class:: classref-property -:ref:`bool` **permissions/bind_wallpaper** +:ref:`bool` **permissions/bind_wallpaper** :ref:`🔗` Must be required by a WallpaperService, to ensure that only the system can bind to it. See `BIND_WALLPAPER `__. @@ -1176,7 +1176,7 @@ Must be required by a WallpaperService, to ensure that only the system can bind .. rst-class:: classref-property -:ref:`bool` **permissions/bluetooth** +:ref:`bool` **permissions/bluetooth** :ref:`🔗` Allows applications to connect to paired bluetooth devices. See `BLUETOOTH `__. @@ -1188,7 +1188,7 @@ Allows applications to connect to paired bluetooth devices. See `BLUETOOTH ` **permissions/bluetooth_admin** +:ref:`bool` **permissions/bluetooth_admin** :ref:`🔗` Allows applications to discover and pair bluetooth devices. See `BLUETOOTH_ADMIN `__. @@ -1200,7 +1200,7 @@ Allows applications to discover and pair bluetooth devices. See `BLUETOOTH_ADMIN .. rst-class:: classref-property -:ref:`bool` **permissions/bluetooth_privileged** +:ref:`bool` **permissions/bluetooth_privileged** :ref:`🔗` Allows applications to pair bluetooth devices without user interaction, and to allow or disallow phonebook access or message access. See `BLUETOOTH_PRIVILEGED `__. @@ -1212,7 +1212,7 @@ Allows applications to pair bluetooth devices without user interaction, and to a .. rst-class:: classref-property -:ref:`bool` **permissions/brick** +:ref:`bool` **permissions/brick** :ref:`🔗` Required to be able to disable the device (very dangerous!). @@ -1224,7 +1224,7 @@ Required to be able to disable the device (very dangerous!). .. rst-class:: classref-property -:ref:`bool` **permissions/broadcast_package_removed** +:ref:`bool` **permissions/broadcast_package_removed** :ref:`🔗` Allows an application to broadcast a notification that an application package has been removed. See `BROADCAST_PACKAGE_REMOVED `__. @@ -1236,7 +1236,7 @@ Allows an application to broadcast a notification that an application package ha .. rst-class:: classref-property -:ref:`bool` **permissions/broadcast_sms** +:ref:`bool` **permissions/broadcast_sms** :ref:`🔗` Allows an application to broadcast an SMS receipt notification. See `BROADCAST_SMS `__. @@ -1248,7 +1248,7 @@ Allows an application to broadcast an SMS receipt notification. See `BROADCAST_S .. rst-class:: classref-property -:ref:`bool` **permissions/broadcast_sticky** +:ref:`bool` **permissions/broadcast_sticky** :ref:`🔗` Allows an application to broadcast sticky intents. See `BROADCAST_STICKY `__. @@ -1260,7 +1260,7 @@ Allows an application to broadcast sticky intents. See `BROADCAST_STICKY ` **permissions/broadcast_wap_push** +:ref:`bool` **permissions/broadcast_wap_push** :ref:`🔗` Allows an application to broadcast a WAP PUSH receipt notification. See `BROADCAST_WAP_PUSH `__. @@ -1272,7 +1272,7 @@ Allows an application to broadcast a WAP PUSH receipt notification. See `BROADCA .. rst-class:: classref-property -:ref:`bool` **permissions/call_phone** +:ref:`bool` **permissions/call_phone** :ref:`🔗` Allows an application to initiate a phone call without going through the Dialer user interface. See `CALL_PHONE `__. @@ -1284,7 +1284,7 @@ Allows an application to initiate a phone call without going through the Dialer .. rst-class:: classref-property -:ref:`bool` **permissions/call_privileged** +:ref:`bool` **permissions/call_privileged** :ref:`🔗` Allows an application to call any phone number, including emergency numbers, without going through the Dialer user interface. See `CALL_PRIVILEGED `__. @@ -1296,7 +1296,7 @@ Allows an application to call any phone number, including emergency numbers, wit .. rst-class:: classref-property -:ref:`bool` **permissions/camera** +:ref:`bool` **permissions/camera** :ref:`🔗` Required to be able to access the camera device. See `CAMERA `__. @@ -1308,7 +1308,7 @@ Required to be able to access the camera device. See `CAMERA ` **permissions/capture_audio_output** +:ref:`bool` **permissions/capture_audio_output** :ref:`🔗` Allows an application to capture audio output. See `CAPTURE_AUDIO_OUTPUT `__. @@ -1320,7 +1320,7 @@ Allows an application to capture audio output. See `CAPTURE_AUDIO_OUTPUT ` **permissions/capture_secure_video_output** +:ref:`bool` **permissions/capture_secure_video_output** :ref:`🔗` Allows an application to capture secure video output. @@ -1332,7 +1332,7 @@ Allows an application to capture secure video output. .. rst-class:: classref-property -:ref:`bool` **permissions/capture_video_output** +:ref:`bool` **permissions/capture_video_output** :ref:`🔗` Allows an application to capture video output. @@ -1344,7 +1344,7 @@ Allows an application to capture video output. .. rst-class:: classref-property -:ref:`bool` **permissions/change_component_enabled_state** +:ref:`bool` **permissions/change_component_enabled_state** :ref:`🔗` Allows an application to change whether an application component (other than its own) is enabled or not. See `CHANGE_COMPONENT_ENABLED_STATE `__. @@ -1356,7 +1356,7 @@ Allows an application to change whether an application component (other than its .. rst-class:: classref-property -:ref:`bool` **permissions/change_configuration** +:ref:`bool` **permissions/change_configuration** :ref:`🔗` Allows an application to modify the current configuration, such as locale. See `CHANGE_CONFIGURATION `__. @@ -1368,7 +1368,7 @@ Allows an application to modify the current configuration, such as locale. See ` .. rst-class:: classref-property -:ref:`bool` **permissions/change_network_state** +:ref:`bool` **permissions/change_network_state** :ref:`🔗` Allows applications to change network connectivity state. See `CHANGE_NETWORK_STATE `__. @@ -1380,7 +1380,7 @@ Allows applications to change network connectivity state. See `CHANGE_NETWORK_ST .. rst-class:: classref-property -:ref:`bool` **permissions/change_wifi_multicast_state** +:ref:`bool` **permissions/change_wifi_multicast_state** :ref:`🔗` Allows applications to enter Wi-Fi Multicast mode. See `CHANGE_WIFI_MULTICAST_STATE `__. @@ -1392,7 +1392,7 @@ Allows applications to enter Wi-Fi Multicast mode. See `CHANGE_WIFI_MULTICAST_ST .. rst-class:: classref-property -:ref:`bool` **permissions/change_wifi_state** +:ref:`bool` **permissions/change_wifi_state** :ref:`🔗` Allows applications to change Wi-Fi connectivity state. See `CHANGE_WIFI_STATE `__. @@ -1404,7 +1404,7 @@ Allows applications to change Wi-Fi connectivity state. See `CHANGE_WIFI_STATE < .. rst-class:: classref-property -:ref:`bool` **permissions/clear_app_cache** +:ref:`bool` **permissions/clear_app_cache** :ref:`🔗` Allows an application to clear the caches of all installed applications on the device. See `CLEAR_APP_CACHE `__. @@ -1416,7 +1416,7 @@ Allows an application to clear the caches of all installed applications on the d .. rst-class:: classref-property -:ref:`bool` **permissions/clear_app_user_data** +:ref:`bool` **permissions/clear_app_user_data** :ref:`🔗` Allows an application to clear user data. @@ -1428,7 +1428,7 @@ Allows an application to clear user data. .. rst-class:: classref-property -:ref:`bool` **permissions/control_location_updates** +:ref:`bool` **permissions/control_location_updates** :ref:`🔗` Allows enabling/disabling location update notifications from the radio. See `CONTROL_LOCATION_UPDATES `__. @@ -1440,7 +1440,7 @@ Allows enabling/disabling location update notifications from the radio. See `CON .. rst-class:: classref-property -:ref:`PackedStringArray` **permissions/custom_permissions** +:ref:`PackedStringArray` **permissions/custom_permissions** :ref:`🔗` Array of custom permission strings. @@ -1454,7 +1454,7 @@ Array of custom permission strings. .. rst-class:: classref-property -:ref:`bool` **permissions/delete_cache_files** +:ref:`bool` **permissions/delete_cache_files** :ref:`🔗` **Deprecated:** This property may be changed or removed in future versions. @@ -1466,7 +1466,7 @@ Array of custom permission strings. .. rst-class:: classref-property -:ref:`bool` **permissions/delete_packages** +:ref:`bool` **permissions/delete_packages** :ref:`🔗` Allows an application to delete packages. See `DELETE_PACKAGES `__. @@ -1478,7 +1478,7 @@ Allows an application to delete packages. See `DELETE_PACKAGES ` **permissions/device_power** +:ref:`bool` **permissions/device_power** :ref:`🔗` Allows low-level access to power management. @@ -1490,7 +1490,7 @@ Allows low-level access to power management. .. rst-class:: classref-property -:ref:`bool` **permissions/diagnostic** +:ref:`bool` **permissions/diagnostic** :ref:`🔗` Allows applications to RW to diagnostic resources. See `DIAGNOSTIC `__. @@ -1502,7 +1502,7 @@ Allows applications to RW to diagnostic resources. See `DIAGNOSTIC ` **permissions/disable_keyguard** +:ref:`bool` **permissions/disable_keyguard** :ref:`🔗` Allows applications to disable the keyguard if it is not secure. See `DISABLE_KEYGUARD `__. @@ -1514,7 +1514,7 @@ Allows applications to disable the keyguard if it is not secure. See `DISABLE_KE .. rst-class:: classref-property -:ref:`bool` **permissions/dump** +:ref:`bool` **permissions/dump** :ref:`🔗` Allows an application to retrieve state dump information from system services. See `DUMP `__. @@ -1526,7 +1526,7 @@ Allows an application to retrieve state dump information from system services. S .. rst-class:: classref-property -:ref:`bool` **permissions/expand_status_bar** +:ref:`bool` **permissions/expand_status_bar** :ref:`🔗` Allows an application to expand or collapse the status bar. See `EXPAND_STATUS_BAR `__. @@ -1538,7 +1538,7 @@ Allows an application to expand or collapse the status bar. See `EXPAND_STATUS_B .. rst-class:: classref-property -:ref:`bool` **permissions/factory_test** +:ref:`bool` **permissions/factory_test** :ref:`🔗` Run as a manufacturer test application, running as the root user. See `FACTORY_TEST `__. @@ -1550,7 +1550,7 @@ Run as a manufacturer test application, running as the root user. See `FACTORY_T .. rst-class:: classref-property -:ref:`bool` **permissions/flashlight** +:ref:`bool` **permissions/flashlight** :ref:`🔗` Allows access to the flashlight. @@ -1562,7 +1562,7 @@ Allows access to the flashlight. .. rst-class:: classref-property -:ref:`bool` **permissions/force_back** +:ref:`bool` **permissions/force_back** :ref:`🔗` Allows an application to force a BACK operation on whatever is the top activity. @@ -1574,7 +1574,7 @@ Allows an application to force a BACK operation on whatever is the top activity. .. rst-class:: classref-property -:ref:`bool` **permissions/get_accounts** +:ref:`bool` **permissions/get_accounts** :ref:`🔗` Allows access to the list of accounts in the Accounts Service. See `GET_ACCOUNTS `__. @@ -1586,7 +1586,7 @@ Allows access to the list of accounts in the Accounts Service. See `GET_ACCOUNTS .. rst-class:: classref-property -:ref:`bool` **permissions/get_package_size** +:ref:`bool` **permissions/get_package_size** :ref:`🔗` Allows an application to find out the space used by any package. See `GET_PACKAGE_SIZE `__. @@ -1598,7 +1598,7 @@ Allows an application to find out the space used by any package. See `GET_PACKAG .. rst-class:: classref-property -:ref:`bool` **permissions/get_tasks** +:ref:`bool` **permissions/get_tasks** :ref:`🔗` **Deprecated:** Deprecated in API level 21. @@ -1610,7 +1610,7 @@ Allows an application to find out the space used by any package. See `GET_PACKAG .. rst-class:: classref-property -:ref:`bool` **permissions/get_top_activity_info** +:ref:`bool` **permissions/get_top_activity_info** :ref:`🔗` Allows an application to retrieve private information about the current top activity. @@ -1622,7 +1622,7 @@ Allows an application to retrieve private information about the current top acti .. rst-class:: classref-property -:ref:`bool` **permissions/global_search** +:ref:`bool` **permissions/global_search** :ref:`🔗` Used on content providers to allow the global search system to access their data. See `GLOBAL_SEARCH `__. @@ -1634,7 +1634,7 @@ Used on content providers to allow the global search system to access their data .. rst-class:: classref-property -:ref:`bool` **permissions/hardware_test** +:ref:`bool` **permissions/hardware_test** :ref:`🔗` Allows access to hardware peripherals. @@ -1646,7 +1646,7 @@ Allows access to hardware peripherals. .. rst-class:: classref-property -:ref:`bool` **permissions/inject_events** +:ref:`bool` **permissions/inject_events** :ref:`🔗` Allows an application to inject user events (keys, touch, trackball) into the event stream and deliver them to ANY window. @@ -1658,7 +1658,7 @@ Allows an application to inject user events (keys, touch, trackball) into the ev .. rst-class:: classref-property -:ref:`bool` **permissions/install_location_provider** +:ref:`bool` **permissions/install_location_provider** :ref:`🔗` Allows an application to install a location provider into the Location Manager. See `INSTALL_LOCATION_PROVIDER `__. @@ -1670,7 +1670,7 @@ Allows an application to install a location provider into the Location Manager. .. rst-class:: classref-property -:ref:`bool` **permissions/install_packages** +:ref:`bool` **permissions/install_packages** :ref:`🔗` Allows an application to install packages. See `INSTALL_PACKAGES `__. @@ -1682,7 +1682,7 @@ Allows an application to install packages. See `INSTALL_PACKAGES ` **permissions/install_shortcut** +:ref:`bool` **permissions/install_shortcut** :ref:`🔗` Allows an application to install a shortcut in Launcher. See `INSTALL_SHORTCUT `__. @@ -1694,7 +1694,7 @@ Allows an application to install a shortcut in Launcher. See `INSTALL_SHORTCUT < .. rst-class:: classref-property -:ref:`bool` **permissions/internal_system_window** +:ref:`bool` **permissions/internal_system_window** :ref:`🔗` Allows an application to open windows that are for use by parts of the system user interface. @@ -1706,7 +1706,7 @@ Allows an application to open windows that are for use by parts of the system us .. rst-class:: classref-property -:ref:`bool` **permissions/internet** +:ref:`bool` **permissions/internet** :ref:`🔗` Allows applications to open network sockets. See `INTERNET `__. @@ -1718,7 +1718,7 @@ Allows applications to open network sockets. See `INTERNET ` **permissions/kill_background_processes** +:ref:`bool` **permissions/kill_background_processes** :ref:`🔗` Allows an application to call ActivityManager.killBackgroundProcesses(String). See `KILL_BACKGROUND_PROCESSES `__. @@ -1730,7 +1730,7 @@ Allows an application to call ActivityManager.killBackgroundProcesses(String). S .. rst-class:: classref-property -:ref:`bool` **permissions/location_hardware** +:ref:`bool` **permissions/location_hardware** :ref:`🔗` Allows an application to use location features in hardware, such as the geofencing api. See `LOCATION_HARDWARE `__. @@ -1742,7 +1742,7 @@ Allows an application to use location features in hardware, such as the geofenci .. rst-class:: classref-property -:ref:`bool` **permissions/manage_accounts** +:ref:`bool` **permissions/manage_accounts** :ref:`🔗` Allows an application to manage the list of accounts in the AccountManager. @@ -1754,7 +1754,7 @@ Allows an application to manage the list of accounts in the AccountManager. .. rst-class:: classref-property -:ref:`bool` **permissions/manage_app_tokens** +:ref:`bool` **permissions/manage_app_tokens** :ref:`🔗` Allows an application to manage (create, destroy, Z-order) application tokens in the window manager. @@ -1766,7 +1766,7 @@ Allows an application to manage (create, destroy, Z-order) application tokens in .. rst-class:: classref-property -:ref:`bool` **permissions/manage_documents** +:ref:`bool` **permissions/manage_documents** :ref:`🔗` Allows an application to manage access to documents, usually as part of a document picker. See `MANAGE_DOCUMENTS `__. @@ -1778,7 +1778,7 @@ Allows an application to manage access to documents, usually as part of a docume .. rst-class:: classref-property -:ref:`bool` **permissions/manage_external_storage** +:ref:`bool` **permissions/manage_external_storage** :ref:`🔗` Allows an application a broad access to external storage in scoped storage. See `MANAGE_EXTERNAL_STORAGE `__. @@ -1790,7 +1790,7 @@ Allows an application a broad access to external storage in scoped storage. See .. rst-class:: classref-property -:ref:`bool` **permissions/master_clear** +:ref:`bool` **permissions/master_clear** :ref:`🔗` See `MASTER_CLEAR `__. @@ -1802,7 +1802,7 @@ See `MASTER_CLEAR ` **permissions/media_content_control** +:ref:`bool` **permissions/media_content_control** :ref:`🔗` Allows an application to know what content is playing and control its playback. See `MEDIA_CONTENT_CONTROL `__. @@ -1814,7 +1814,7 @@ Allows an application to know what content is playing and control its playback. .. rst-class:: classref-property -:ref:`bool` **permissions/modify_audio_settings** +:ref:`bool` **permissions/modify_audio_settings** :ref:`🔗` Allows an application to modify global audio settings. See `MODIFY_AUDIO_SETTINGS `__. @@ -1826,7 +1826,7 @@ Allows an application to modify global audio settings. See `MODIFY_AUDIO_SETTING .. rst-class:: classref-property -:ref:`bool` **permissions/modify_phone_state** +:ref:`bool` **permissions/modify_phone_state** :ref:`🔗` Allows modification of the telephony state - power on, mmi, etc. Does not include placing calls. See `MODIFY_PHONE_STATE `__. @@ -1838,7 +1838,7 @@ Allows modification of the telephony state - power on, mmi, etc. Does not includ .. rst-class:: classref-property -:ref:`bool` **permissions/mount_format_filesystems** +:ref:`bool` **permissions/mount_format_filesystems** :ref:`🔗` Allows formatting file systems for removable storage. See `MOUNT_FORMAT_FILESYSTEMS `__. @@ -1850,7 +1850,7 @@ Allows formatting file systems for removable storage. See `MOUNT_FORMAT_FILESYST .. rst-class:: classref-property -:ref:`bool` **permissions/mount_unmount_filesystems** +:ref:`bool` **permissions/mount_unmount_filesystems** :ref:`🔗` Allows mounting and unmounting file systems for removable storage. See `MOUNT_UNMOUNT_FILESYSTEMS `__. @@ -1862,7 +1862,7 @@ Allows mounting and unmounting file systems for removable storage. See `MOUNT_UN .. rst-class:: classref-property -:ref:`bool` **permissions/nfc** +:ref:`bool` **permissions/nfc** :ref:`🔗` Allows applications to perform I/O operations over NFC. See `NFC `__. @@ -1874,7 +1874,7 @@ Allows applications to perform I/O operations over NFC. See `NFC ` **permissions/persistent_activity** +:ref:`bool` **permissions/persistent_activity** :ref:`🔗` **Deprecated:** Deprecated in API level 15. @@ -1888,7 +1888,7 @@ Allows an application to make its activities persistent. .. rst-class:: classref-property -:ref:`bool` **permissions/post_notifications** +:ref:`bool` **permissions/post_notifications** :ref:`🔗` Allows an application to post notifications. Added in API level 33. See `Notification runtime permission `__. @@ -1900,7 +1900,7 @@ Allows an application to post notifications. Added in API level 33. See `Notific .. rst-class:: classref-property -:ref:`bool` **permissions/process_outgoing_calls** +:ref:`bool` **permissions/process_outgoing_calls** :ref:`🔗` **Deprecated:** Deprecated in API level 29. @@ -1914,7 +1914,7 @@ Allows an application to see the number being dialed during an outgoing call wit .. rst-class:: classref-property -:ref:`bool` **permissions/read_calendar** +:ref:`bool` **permissions/read_calendar** :ref:`🔗` Allows an application to read the user's calendar data. See `READ_CALENDAR `__. @@ -1926,7 +1926,7 @@ Allows an application to read the user's calendar data. See `READ_CALENDAR ` **permissions/read_call_log** +:ref:`bool` **permissions/read_call_log** :ref:`🔗` Allows an application to read the user's call log. See `READ_CALL_LOG `__. @@ -1938,7 +1938,7 @@ Allows an application to read the user's call log. See `READ_CALL_LOG ` **permissions/read_contacts** +:ref:`bool` **permissions/read_contacts** :ref:`🔗` Allows an application to read the user's contacts data. See `READ_CONTACTS `__. @@ -1950,7 +1950,7 @@ Allows an application to read the user's contacts data. See `READ_CONTACTS ` **permissions/read_external_storage** +:ref:`bool` **permissions/read_external_storage** :ref:`🔗` **Deprecated:** Deprecated in API level 33. @@ -1964,7 +1964,7 @@ Allows an application to read from external storage. See `READ_EXTERNAL_STORAGE .. rst-class:: classref-property -:ref:`bool` **permissions/read_frame_buffer** +:ref:`bool` **permissions/read_frame_buffer** :ref:`🔗` Allows an application to take screen shots and more generally get access to the frame buffer data. @@ -1976,7 +1976,7 @@ Allows an application to take screen shots and more generally get access to the .. rst-class:: classref-property -:ref:`bool` **permissions/read_history_bookmarks** +:ref:`bool` **permissions/read_history_bookmarks** :ref:`🔗` Allows an application to read (but not write) the user's browsing history and bookmarks. @@ -1988,7 +1988,7 @@ Allows an application to read (but not write) the user's browsing history and bo .. rst-class:: classref-property -:ref:`bool` **permissions/read_input_state** +:ref:`bool` **permissions/read_input_state** :ref:`🔗` **Deprecated:** Deprecated in API level 16. @@ -2000,7 +2000,7 @@ Allows an application to read (but not write) the user's browsing history and bo .. rst-class:: classref-property -:ref:`bool` **permissions/read_logs** +:ref:`bool` **permissions/read_logs** :ref:`🔗` Allows an application to read the low-level system log files. See `READ_LOGS `__. @@ -2012,7 +2012,7 @@ Allows an application to read the low-level system log files. See `READ_LOGS ` **permissions/read_phone_state** +:ref:`bool` **permissions/read_phone_state** :ref:`🔗` Allows read only access to phone state. See `READ_PHONE_STATE `__. @@ -2024,7 +2024,7 @@ Allows read only access to phone state. See `READ_PHONE_STATE ` **permissions/read_profile** +:ref:`bool` **permissions/read_profile** :ref:`🔗` Allows an application to read the user's personal profile data. @@ -2036,7 +2036,7 @@ Allows an application to read the user's personal profile data. .. rst-class:: classref-property -:ref:`bool` **permissions/read_sms** +:ref:`bool` **permissions/read_sms** :ref:`🔗` Allows an application to read SMS messages. See `READ_SMS `__. @@ -2048,7 +2048,7 @@ Allows an application to read SMS messages. See `READ_SMS ` **permissions/read_social_stream** +:ref:`bool` **permissions/read_social_stream** :ref:`🔗` Allows an application to read from the user's social stream. @@ -2060,7 +2060,7 @@ Allows an application to read from the user's social stream. .. rst-class:: classref-property -:ref:`bool` **permissions/read_sync_settings** +:ref:`bool` **permissions/read_sync_settings** :ref:`🔗` Allows applications to read the sync settings. See `READ_SYNC_SETTINGS `__. @@ -2072,7 +2072,7 @@ Allows applications to read the sync settings. See `READ_SYNC_SETTINGS ` **permissions/read_sync_stats** +:ref:`bool` **permissions/read_sync_stats** :ref:`🔗` Allows applications to read the sync stats. See `READ_SYNC_STATS `__. @@ -2084,7 +2084,7 @@ Allows applications to read the sync stats. See `READ_SYNC_STATS ` **permissions/read_user_dictionary** +:ref:`bool` **permissions/read_user_dictionary** :ref:`🔗` Allows an application to read the user dictionary. @@ -2096,7 +2096,7 @@ Allows an application to read the user dictionary. .. rst-class:: classref-property -:ref:`bool` **permissions/reboot** +:ref:`bool` **permissions/reboot** :ref:`🔗` Required to be able to reboot the device. See `REBOOT `__. @@ -2108,7 +2108,7 @@ Required to be able to reboot the device. See `REBOOT ` **permissions/receive_boot_completed** +:ref:`bool` **permissions/receive_boot_completed** :ref:`🔗` Allows an application to receive the Intent.ACTION_BOOT_COMPLETED that is broadcast after the system finishes booting. See `RECEIVE_BOOT_COMPLETED `__. @@ -2120,7 +2120,7 @@ Allows an application to receive the Intent.ACTION_BOOT_COMPLETED that is broadc .. rst-class:: classref-property -:ref:`bool` **permissions/receive_mms** +:ref:`bool` **permissions/receive_mms** :ref:`🔗` Allows an application to monitor incoming MMS messages. See `RECEIVE_MMS `__. @@ -2132,7 +2132,7 @@ Allows an application to monitor incoming MMS messages. See `RECEIVE_MMS ` **permissions/receive_sms** +:ref:`bool` **permissions/receive_sms** :ref:`🔗` Allows an application to receive SMS messages. See `RECEIVE_SMS `__. @@ -2144,7 +2144,7 @@ Allows an application to receive SMS messages. See `RECEIVE_SMS ` **permissions/receive_wap_push** +:ref:`bool` **permissions/receive_wap_push** :ref:`🔗` Allows an application to receive WAP push messages. See `RECEIVE_WAP_PUSH `__. @@ -2156,7 +2156,7 @@ Allows an application to receive WAP push messages. See `RECEIVE_WAP_PUSH ` **permissions/record_audio** +:ref:`bool` **permissions/record_audio** :ref:`🔗` Allows an application to record audio. See `RECORD_AUDIO `__. @@ -2168,7 +2168,7 @@ Allows an application to record audio. See `RECORD_AUDIO ` **permissions/reorder_tasks** +:ref:`bool` **permissions/reorder_tasks** :ref:`🔗` Allows an application to change the Z-order of tasks. See `REORDER_TASKS `__. @@ -2180,7 +2180,7 @@ Allows an application to change the Z-order of tasks. See `REORDER_TASKS ` **permissions/restart_packages** +:ref:`bool` **permissions/restart_packages** :ref:`🔗` **Deprecated:** Deprecated in API level 15. @@ -2192,7 +2192,7 @@ Allows an application to change the Z-order of tasks. See `REORDER_TASKS ` **permissions/send_respond_via_message** +:ref:`bool` **permissions/send_respond_via_message** :ref:`🔗` Allows an application (Phone) to send a request to other applications to handle the respond-via-message action during incoming calls. See `SEND_RESPOND_VIA_MESSAGE `__. @@ -2204,7 +2204,7 @@ Allows an application (Phone) to send a request to other applications to handle .. rst-class:: classref-property -:ref:`bool` **permissions/send_sms** +:ref:`bool` **permissions/send_sms** :ref:`🔗` Allows an application to send SMS messages. See `SEND_SMS `__. @@ -2216,7 +2216,7 @@ Allows an application to send SMS messages. See `SEND_SMS ` **permissions/set_activity_watcher** +:ref:`bool` **permissions/set_activity_watcher** :ref:`🔗` Allows an application to watch and control how activities are started globally in the system. @@ -2228,7 +2228,7 @@ Allows an application to watch and control how activities are started globally i .. rst-class:: classref-property -:ref:`bool` **permissions/set_alarm** +:ref:`bool` **permissions/set_alarm** :ref:`🔗` Allows an application to broadcast an Intent to set an alarm for the user. See `SET_ALARM `__. @@ -2240,7 +2240,7 @@ Allows an application to broadcast an Intent to set an alarm for the user. See ` .. rst-class:: classref-property -:ref:`bool` **permissions/set_always_finish** +:ref:`bool` **permissions/set_always_finish** :ref:`🔗` Allows an application to control whether activities are immediately finished when put in the background. See `SET_ALWAYS_FINISH `__. @@ -2252,7 +2252,7 @@ Allows an application to control whether activities are immediately finished whe .. rst-class:: classref-property -:ref:`bool` **permissions/set_animation_scale** +:ref:`bool` **permissions/set_animation_scale** :ref:`🔗` Allows to modify the global animation scaling factor. See `SET_ANIMATION_SCALE `__. @@ -2264,7 +2264,7 @@ Allows to modify the global animation scaling factor. See `SET_ANIMATION_SCALE < .. rst-class:: classref-property -:ref:`bool` **permissions/set_debug_app** +:ref:`bool` **permissions/set_debug_app** :ref:`🔗` Configure an application for debugging. See `SET_DEBUG_APP `__. @@ -2276,7 +2276,7 @@ Configure an application for debugging. See `SET_DEBUG_APP ` **permissions/set_orientation** +:ref:`bool` **permissions/set_orientation** :ref:`🔗` Allows low-level access to setting the orientation (actually rotation) of the screen. @@ -2288,7 +2288,7 @@ Allows low-level access to setting the orientation (actually rotation) of the sc .. rst-class:: classref-property -:ref:`bool` **permissions/set_pointer_speed** +:ref:`bool` **permissions/set_pointer_speed** :ref:`🔗` Allows low-level access to setting the pointer speed. @@ -2300,7 +2300,7 @@ Allows low-level access to setting the pointer speed. .. rst-class:: classref-property -:ref:`bool` **permissions/set_preferred_applications** +:ref:`bool` **permissions/set_preferred_applications** :ref:`🔗` **Deprecated:** Deprecated in API level 15. @@ -2312,7 +2312,7 @@ Allows low-level access to setting the pointer speed. .. rst-class:: classref-property -:ref:`bool` **permissions/set_process_limit** +:ref:`bool` **permissions/set_process_limit** :ref:`🔗` Allows an application to set the maximum number of (not needed) application processes that can be running. See `SET_PROCESS_LIMIT `__. @@ -2324,7 +2324,7 @@ Allows an application to set the maximum number of (not needed) application proc .. rst-class:: classref-property -:ref:`bool` **permissions/set_time** +:ref:`bool` **permissions/set_time** :ref:`🔗` Allows applications to set the system time directly. See `SET_TIME `__. @@ -2336,7 +2336,7 @@ Allows applications to set the system time directly. See `SET_TIME ` **permissions/set_time_zone** +:ref:`bool` **permissions/set_time_zone** :ref:`🔗` Allows applications to set the system time zone directly. See `SET_TIME_ZONE `__. @@ -2348,7 +2348,7 @@ Allows applications to set the system time zone directly. See `SET_TIME_ZONE ` **permissions/set_wallpaper** +:ref:`bool` **permissions/set_wallpaper** :ref:`🔗` Allows applications to set the wallpaper. See `SET_WALLPAPER `__. @@ -2360,7 +2360,7 @@ Allows applications to set the wallpaper. See `SET_WALLPAPER ` **permissions/set_wallpaper_hints** +:ref:`bool` **permissions/set_wallpaper_hints** :ref:`🔗` Allows applications to set the wallpaper hints. See `SET_WALLPAPER_HINTS `__. @@ -2372,7 +2372,7 @@ Allows applications to set the wallpaper hints. See `SET_WALLPAPER_HINTS ` **permissions/signal_persistent_processes** +:ref:`bool` **permissions/signal_persistent_processes** :ref:`🔗` Allow an application to request that a signal be sent to all persistent processes. See `SIGNAL_PERSISTENT_PROCESSES `__. @@ -2384,7 +2384,7 @@ Allow an application to request that a signal be sent to all persistent processe .. rst-class:: classref-property -:ref:`bool` **permissions/status_bar** +:ref:`bool` **permissions/status_bar** :ref:`🔗` Allows an application to open, close, or disable the status bar and its icons. See `STATUS_BAR `__. @@ -2396,7 +2396,7 @@ Allows an application to open, close, or disable the status bar and its icons. S .. rst-class:: classref-property -:ref:`bool` **permissions/subscribed_feeds_read** +:ref:`bool` **permissions/subscribed_feeds_read** :ref:`🔗` Allows an application to allow access the subscribed feeds ContentProvider. @@ -2408,7 +2408,7 @@ Allows an application to allow access the subscribed feeds ContentProvider. .. rst-class:: classref-property -:ref:`bool` **permissions/subscribed_feeds_write** +:ref:`bool` **permissions/subscribed_feeds_write** :ref:`🔗` **Deprecated:** This property may be changed or removed in future versions. @@ -2420,7 +2420,7 @@ Allows an application to allow access the subscribed feeds ContentProvider. .. rst-class:: classref-property -:ref:`bool` **permissions/system_alert_window** +:ref:`bool` **permissions/system_alert_window** :ref:`🔗` Allows an app to create windows using the type WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY, shown on top of all other apps. See `SYSTEM_ALERT_WINDOW `__. @@ -2432,7 +2432,7 @@ Allows an app to create windows using the type WindowManager.LayoutParams.TYPE_A .. rst-class:: classref-property -:ref:`bool` **permissions/transmit_ir** +:ref:`bool` **permissions/transmit_ir** :ref:`🔗` Allows using the device's IR transmitter, if available. See `TRANSMIT_IR `__. @@ -2444,7 +2444,7 @@ Allows using the device's IR transmitter, if available. See `TRANSMIT_IR ` **permissions/uninstall_shortcut** +:ref:`bool` **permissions/uninstall_shortcut** :ref:`🔗` **Deprecated:** This property may be changed or removed in future versions. @@ -2456,7 +2456,7 @@ Allows using the device's IR transmitter, if available. See `TRANSMIT_IR ` **permissions/update_device_stats** +:ref:`bool` **permissions/update_device_stats** :ref:`🔗` Allows an application to update device statistics. See `UPDATE_DEVICE_STATS `__. @@ -2468,7 +2468,7 @@ Allows an application to update device statistics. See `UPDATE_DEVICE_STATS ` **permissions/use_credentials** +:ref:`bool` **permissions/use_credentials** :ref:`🔗` Allows an application to request authtokens from the AccountManager. @@ -2480,7 +2480,7 @@ Allows an application to request authtokens from the AccountManager. .. rst-class:: classref-property -:ref:`bool` **permissions/use_sip** +:ref:`bool` **permissions/use_sip** :ref:`🔗` Allows an application to use SIP service. See `USE_SIP `__. @@ -2492,7 +2492,7 @@ Allows an application to use SIP service. See `USE_SIP ` **permissions/vibrate** +:ref:`bool` **permissions/vibrate** :ref:`🔗` Allows access to the vibrator. See `VIBRATE `__. @@ -2504,7 +2504,7 @@ Allows access to the vibrator. See `VIBRATE ` **permissions/wake_lock** +:ref:`bool` **permissions/wake_lock** :ref:`🔗` Allows using PowerManager WakeLocks to keep processor from sleeping or screen from dimming. See `WAKE_LOCK `__. @@ -2516,7 +2516,7 @@ Allows using PowerManager WakeLocks to keep processor from sleeping or screen fr .. rst-class:: classref-property -:ref:`bool` **permissions/write_apn_settings** +:ref:`bool` **permissions/write_apn_settings** :ref:`🔗` Allows applications to write the apn settings and read sensitive fields of an existing apn settings like user and password. See `WRITE_APN_SETTINGS `__. @@ -2528,7 +2528,7 @@ Allows applications to write the apn settings and read sensitive fields of an ex .. rst-class:: classref-property -:ref:`bool` **permissions/write_calendar** +:ref:`bool` **permissions/write_calendar** :ref:`🔗` Allows an application to write the user's calendar data. See `WRITE_CALENDAR `__. @@ -2540,7 +2540,7 @@ Allows an application to write the user's calendar data. See `WRITE_CALENDAR ` **permissions/write_call_log** +:ref:`bool` **permissions/write_call_log** :ref:`🔗` Allows an application to write (but not read) the user's call log data. See `WRITE_CALL_LOG `__. @@ -2552,7 +2552,7 @@ Allows an application to write (but not read) the user's call log data. See `WRI .. rst-class:: classref-property -:ref:`bool` **permissions/write_contacts** +:ref:`bool` **permissions/write_contacts** :ref:`🔗` Allows an application to write the user's contacts data. See `WRITE_CONTACTS `__. @@ -2564,7 +2564,7 @@ Allows an application to write the user's contacts data. See `WRITE_CONTACTS ` **permissions/write_external_storage** +:ref:`bool` **permissions/write_external_storage** :ref:`🔗` Allows an application to write to external storage. See `WRITE_EXTERNAL_STORAGE `__. @@ -2576,7 +2576,7 @@ Allows an application to write to external storage. See `WRITE_EXTERNAL_STORAGE .. rst-class:: classref-property -:ref:`bool` **permissions/write_gservices** +:ref:`bool` **permissions/write_gservices** :ref:`🔗` Allows an application to modify the Google service map. See `WRITE_GSERVICES `__. @@ -2588,7 +2588,7 @@ Allows an application to modify the Google service map. See `WRITE_GSERVICES ` **permissions/write_history_bookmarks** +:ref:`bool` **permissions/write_history_bookmarks** :ref:`🔗` Allows an application to write (but not read) the user's browsing history and bookmarks. @@ -2600,7 +2600,7 @@ Allows an application to write (but not read) the user's browsing history and bo .. rst-class:: classref-property -:ref:`bool` **permissions/write_profile** +:ref:`bool` **permissions/write_profile** :ref:`🔗` Allows an application to write (but not read) the user's personal profile data. @@ -2612,7 +2612,7 @@ Allows an application to write (but not read) the user's personal profile data. .. rst-class:: classref-property -:ref:`bool` **permissions/write_secure_settings** +:ref:`bool` **permissions/write_secure_settings** :ref:`🔗` Allows an application to read or write the secure system settings. See `WRITE_SECURE_SETTINGS `__. @@ -2624,7 +2624,7 @@ Allows an application to read or write the secure system settings. See `WRITE_SE .. rst-class:: classref-property -:ref:`bool` **permissions/write_settings** +:ref:`bool` **permissions/write_settings** :ref:`🔗` Allows an application to read or write the system settings. See `WRITE_SETTINGS `__. @@ -2636,7 +2636,7 @@ Allows an application to read or write the system settings. See `WRITE_SETTINGS .. rst-class:: classref-property -:ref:`bool` **permissions/write_sms** +:ref:`bool` **permissions/write_sms** :ref:`🔗` Allows an application to write SMS messages. @@ -2648,7 +2648,7 @@ Allows an application to write SMS messages. .. rst-class:: classref-property -:ref:`bool` **permissions/write_social_stream** +:ref:`bool` **permissions/write_social_stream** :ref:`🔗` Allows an application to write (but not read) the user's social stream data. @@ -2660,7 +2660,7 @@ Allows an application to write (but not read) the user's social stream data. .. rst-class:: classref-property -:ref:`bool` **permissions/write_sync_settings** +:ref:`bool` **permissions/write_sync_settings** :ref:`🔗` Allows applications to write the sync settings. See `WRITE_SYNC_SETTINGS `__. @@ -2672,7 +2672,7 @@ Allows applications to write the sync settings. See `WRITE_SYNC_SETTINGS ` **permissions/write_user_dictionary** +:ref:`bool` **permissions/write_user_dictionary** :ref:`🔗` Allows an application to write to the user dictionary. @@ -2684,7 +2684,7 @@ Allows an application to write to the user dictionary. .. rst-class:: classref-property -:ref:`bool` **screen/immersive_mode** +:ref:`bool` **screen/immersive_mode** :ref:`🔗` If ``true``, hides navigation and status bar. @@ -2696,7 +2696,7 @@ If ``true``, hides navigation and status bar. .. rst-class:: classref-property -:ref:`bool` **screen/support_large** +:ref:`bool` **screen/support_large** :ref:`🔗` Indicates whether the application supports larger screen form-factors. @@ -2708,7 +2708,7 @@ Indicates whether the application supports larger screen form-factors. .. rst-class:: classref-property -:ref:`bool` **screen/support_normal** +:ref:`bool` **screen/support_normal** :ref:`🔗` Indicates whether an application supports the "normal" screen form-factors. @@ -2720,7 +2720,7 @@ Indicates whether an application supports the "normal" screen form-factors. .. rst-class:: classref-property -:ref:`bool` **screen/support_small** +:ref:`bool` **screen/support_small** :ref:`🔗` Indicates whether the application supports smaller screen form-factors. @@ -2732,7 +2732,7 @@ Indicates whether the application supports smaller screen form-factors. .. rst-class:: classref-property -:ref:`bool` **screen/support_xlarge** +:ref:`bool` **screen/support_xlarge** :ref:`🔗` Indicates whether the application supports extra large screen form-factors. @@ -2744,7 +2744,7 @@ Indicates whether the application supports extra large screen form-factors. .. rst-class:: classref-property -:ref:`bool` **user_data_backup/allow** +:ref:`bool` **user_data_backup/allow** :ref:`🔗` If ``true``, allows the application to participate in the backup and restore infrastructure. @@ -2756,7 +2756,7 @@ If ``true``, allows the application to participate in the backup and restore inf .. rst-class:: classref-property -:ref:`int` **version/code** +:ref:`int` **version/code** :ref:`🔗` Machine-readable application version. This must be incremented for every new release pushed to the Play Store. @@ -2768,7 +2768,7 @@ Machine-readable application version. This must be incremented for every new rel .. rst-class:: classref-property -:ref:`String` **version/name** +:ref:`String` **version/name** :ref:`🔗` Application version visible to the user. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. @@ -2780,7 +2780,7 @@ Application version visible to the user. Falls back to :ref:`ProjectSettings.app .. rst-class:: classref-property -:ref:`int` **xr_features/xr_mode** +:ref:`int` **xr_features/xr_mode** :ref:`🔗` The extended reality (XR) mode for this application. diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index 98080c05b5c..4f7df4bd8e0 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -438,7 +438,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **application/additional_plist_content** +:ref:`String` **application/additional_plist_content** :ref:`🔗` Additional data added to the root ```` section of the `Info.plist `__ file. The value should be an XML section with pairs of key-value elements, e.g.: @@ -455,7 +455,7 @@ Additional data added to the root ```` section of the `Info.plist ` **application/app_store_team_id** +:ref:`String` **application/app_store_team_id** :ref:`🔗` Apple Team ID, unique 10-character string. To locate your Team ID check "Membership details" section in your Apple developer account dashboard, or "Organizational Unit" of your code signing certificate. See `Locate your Team ID `__. @@ -467,7 +467,7 @@ Apple Team ID, unique 10-character string. To locate your Team ID check "Members .. rst-class:: classref-property -:ref:`String` **application/bundle_identifier** +:ref:`String` **application/bundle_identifier** :ref:`🔗` Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``). @@ -479,7 +479,7 @@ Unique application identifier in a reverse-DNS format, can only contain alphanum .. rst-class:: classref-property -:ref:`String` **application/code_sign_identity_debug** +:ref:`String` **application/code_sign_identity_debug** :ref:`🔗` The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export. @@ -491,7 +491,7 @@ The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for de .. rst-class:: classref-property -:ref:`String` **application/code_sign_identity_release** +:ref:`String` **application/code_sign_identity_release** :ref:`🔗` The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export. @@ -503,7 +503,7 @@ The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for re .. rst-class:: classref-property -:ref:`bool` **application/delete_old_export_files_unconditionally** +:ref:`bool` **application/delete_old_export_files_unconditionally** :ref:`🔗` If ``true``, existing "project name" and "project name.xcodeproj" in the export destination directory will be unconditionally deleted during export. @@ -515,7 +515,7 @@ If ``true``, existing "project name" and "project name.xcodeproj" in the export .. rst-class:: classref-property -:ref:`int` **application/export_method_debug** +:ref:`int` **application/export_method_debug** :ref:`🔗` Application distribution target (debug export). @@ -527,7 +527,7 @@ Application distribution target (debug export). .. rst-class:: classref-property -:ref:`int` **application/export_method_release** +:ref:`int` **application/export_method_release** :ref:`🔗` Application distribution target (release export). @@ -539,7 +539,7 @@ Application distribution target (release export). .. rst-class:: classref-property -:ref:`bool` **application/export_project_only** +:ref:`bool` **application/export_project_only** :ref:`🔗` If ``true``, exports iOS project files without building an XCArchive or ``.ipa`` file. If ``false``, exports iOS project files and builds an XCArchive and ``.ipa`` file at the same time. When combining Godot with Fastlane or other build pipelines, you may want to set this to ``true``. @@ -551,7 +551,7 @@ If ``true``, exports iOS project files without building an XCArchive or ``.ipa`` .. rst-class:: classref-property -:ref:`int` **application/icon_interpolation** +:ref:`int` **application/icon_interpolation** :ref:`🔗` Interpolation method used to resize application icon. @@ -563,7 +563,7 @@ Interpolation method used to resize application icon. .. rst-class:: classref-property -:ref:`String` **application/min_ios_version** +:ref:`String` **application/min_ios_version** :ref:`🔗` Minimum version of iOS required for this application to run in the ``major.minor.patch`` or ``major.minor`` format, can only contain numeric characters (``0-9``) and periods (``.``). @@ -575,7 +575,7 @@ Minimum version of iOS required for this application to run in the ``major.minor .. rst-class:: classref-property -:ref:`String` **application/provisioning_profile_uuid_debug** +:ref:`String` **application/provisioning_profile_uuid_debug** :ref:`🔗` UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles `__. @@ -589,7 +589,7 @@ Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE .. rst-class:: classref-property -:ref:`String` **application/provisioning_profile_uuid_release** +:ref:`String` **application/provisioning_profile_uuid_release** :ref:`🔗` UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles `__. @@ -603,7 +603,7 @@ Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE .. rst-class:: classref-property -:ref:`String` **application/short_version** +:ref:`String` **application/short_version** :ref:`🔗` Application version visible to the user, can only contain numeric characters (``0-9``) and periods (``.``). Falls back to :ref:`ProjectSettings.application/config/version` if left empty. @@ -615,7 +615,7 @@ Application version visible to the user, can only contain numeric characters (`` .. rst-class:: classref-property -:ref:`String` **application/signature** +:ref:`String` **application/signature** :ref:`🔗` A four-character creator code that is specific to the bundle. Optional. @@ -627,7 +627,7 @@ A four-character creator code that is specific to the bundle. Optional. .. rst-class:: classref-property -:ref:`int` **application/targeted_device_family** +:ref:`int` **application/targeted_device_family** :ref:`🔗` Supported device family. @@ -639,7 +639,7 @@ Supported device family. .. rst-class:: classref-property -:ref:`String` **application/version** +:ref:`String` **application/version** :ref:`🔗` Machine-readable application version, in the ``major.minor.patch`` format, can only contain numeric characters (``0-9``) and periods (``.``). This must be incremented on every new release pushed to the App Store. @@ -651,7 +651,7 @@ Machine-readable application version, in the ``major.minor.patch`` format, can o .. rst-class:: classref-property -:ref:`bool` **architectures/arm64** +:ref:`bool` **architectures/arm64** :ref:`🔗` If ``true``, ``arm64`` binaries are included into exported project. @@ -663,7 +663,7 @@ If ``true``, ``arm64`` binaries are included into exported project. .. rst-class:: classref-property -:ref:`bool` **capabilities/access_wifi** +:ref:`bool` **capabilities/access_wifi** :ref:`🔗` If ``true``, networking features related to Wi-Fi access are enabled. See `Required Device Capabilities `__. @@ -675,7 +675,7 @@ If ``true``, networking features related to Wi-Fi access are enabled. See `Requi .. rst-class:: classref-property -:ref:`bool` **capabilities/performance_a12** +:ref:`bool` **capabilities/performance_a12** :ref:`🔗` Requires the graphics performance and features of the A12 Bionic and later chips (devices supporting all Vulkan renderer features). @@ -689,7 +689,7 @@ Enabling this option limits supported devices to: iPhone XS, iPhone XR, iPad Min .. rst-class:: classref-property -:ref:`bool` **capabilities/performance_gaming_tier** +:ref:`bool` **capabilities/performance_gaming_tier** :ref:`🔗` Requires the graphics performance and features of the A17 Pro and later chips. @@ -703,7 +703,7 @@ Enabling this option limits supported devices to: iPhone 15 Pro and newer. .. rst-class:: classref-property -:ref:`bool` **capabilities/push_notifications** +:ref:`bool` **capabilities/push_notifications** :ref:`🔗` If ``true``, push notifications are enabled. See `Required Device Capabilities `__. @@ -715,7 +715,7 @@ If ``true``, push notifications are enabled. See `Required Device Capabilities < .. rst-class:: classref-property -:ref:`String` **custom_template/debug** +:ref:`String` **custom_template/debug** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -727,7 +727,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`String` **custom_template/release** +:ref:`String` **custom_template/release** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -739,7 +739,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`String` **icons/app_store_1024x1024** +:ref:`String` **icons/app_store_1024x1024** :ref:`🔗` App Store application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -751,7 +751,7 @@ App Store application icon file. If left empty, it will fallback to :ref:`Projec .. rst-class:: classref-property -:ref:`String` **icons/ipad_76x76** +:ref:`String` **icons/ipad_76x76** :ref:`🔗` Home screen application icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -763,7 +763,7 @@ Home screen application icon file on iPad (1x DPI). If left empty, it will fallb .. rst-class:: classref-property -:ref:`String` **icons/ipad_152x152** +:ref:`String` **icons/ipad_152x152** :ref:`🔗` Home screen application icon file on iPad (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -775,7 +775,7 @@ Home screen application icon file on iPad (2x DPI). If left empty, it will fallb .. rst-class:: classref-property -:ref:`String` **icons/ipad_167x167** +:ref:`String` **icons/ipad_167x167** :ref:`🔗` Home screen application icon file on iPad (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -787,7 +787,7 @@ Home screen application icon file on iPad (3x DPI). If left empty, it will fallb .. rst-class:: classref-property -:ref:`String` **icons/iphone_120x120** +:ref:`String` **icons/iphone_120x120** :ref:`🔗` Home screen application icon file on iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -799,7 +799,7 @@ Home screen application icon file on iPhone (2x DPI). If left empty, it will fal .. rst-class:: classref-property -:ref:`String` **icons/iphone_180x180** +:ref:`String` **icons/iphone_180x180** :ref:`🔗` Home screen application icon file on iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -811,7 +811,7 @@ Home screen application icon file on iPhone (3x DPI). If left empty, it will fal .. rst-class:: classref-property -:ref:`String` **icons/notification_40x40** +:ref:`String` **icons/notification_40x40** :ref:`🔗` Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -823,7 +823,7 @@ Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallb .. rst-class:: classref-property -:ref:`String` **icons/notification_60x60** +:ref:`String` **icons/notification_60x60** :ref:`🔗` Notification icon file on iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -835,7 +835,7 @@ Notification icon file on iPhone (3x DPI). If left empty, it will fallback to :r .. rst-class:: classref-property -:ref:`String` **icons/settings_58x58** +:ref:`String` **icons/settings_58x58** :ref:`🔗` Application settings icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -847,7 +847,7 @@ Application settings icon file on iPad and iPhone (2x DPI). If left empty, it wi .. rst-class:: classref-property -:ref:`String` **icons/settings_87x87** +:ref:`String` **icons/settings_87x87** :ref:`🔗` Application settings icon file on iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -859,7 +859,7 @@ Application settings icon file on iPhone (3x DPI). If left empty, it will fallba .. rst-class:: classref-property -:ref:`String` **icons/spotlight_40x40** +:ref:`String` **icons/spotlight_40x40** :ref:`🔗` Spotlight icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -871,7 +871,7 @@ Spotlight icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`P .. rst-class:: classref-property -:ref:`String` **icons/spotlight_80x80** +:ref:`String` **icons/spotlight_80x80** :ref:`🔗` Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. @@ -883,7 +883,7 @@ Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback .. rst-class:: classref-property -:ref:`int` **privacy/active_keyboard_access_reasons** +:ref:`int` **privacy/active_keyboard_access_reasons** :ref:`🔗` The reasons your app use active keyboard API. See `Describing use of required reason API `__. @@ -895,7 +895,7 @@ The reasons your app use active keyboard API. See `Describing use of required re .. rst-class:: classref-property -:ref:`String` **privacy/camera_usage_description** +:ref:`String` **privacy/camera_usage_description** :ref:`🔗` A message displayed when requesting access to the device's camera (in English). @@ -907,7 +907,7 @@ A message displayed when requesting access to the device's camera (in English). .. rst-class:: classref-property -:ref:`Dictionary` **privacy/camera_usage_description_localized** +:ref:`Dictionary` **privacy/camera_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the device's camera (localized). @@ -919,7 +919,7 @@ A message displayed when requesting access to the device's camera (localized). .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/advertising_data/collected** +:ref:`bool` **privacy/collected_data/advertising_data/collected** :ref:`🔗` Indicates whether your app collects advertising data. @@ -931,7 +931,7 @@ Indicates whether your app collects advertising data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** +:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** :ref:`🔗` The reasons your app collects advertising data. See `Describing data use in privacy manifests `__. @@ -943,7 +943,7 @@ The reasons your app collects advertising data. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** +:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** :ref:`🔗` Indicates whether your app links advertising data to the user's identity. @@ -955,7 +955,7 @@ Indicates whether your app links advertising data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses advertising data for tracking. @@ -967,7 +967,7 @@ Indicates whether your app uses advertising data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/audio_data/collected** +:ref:`bool` **privacy/collected_data/audio_data/collected** :ref:`🔗` Indicates whether your app collects audio data data. @@ -979,7 +979,7 @@ Indicates whether your app collects audio data data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/audio_data/collection_purposes** +:ref:`int` **privacy/collected_data/audio_data/collection_purposes** :ref:`🔗` The reasons your app collects audio data. See `Describing data use in privacy manifests `__. @@ -991,7 +991,7 @@ The reasons your app collects audio data. See `Describing data use in privacy ma .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** +:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** :ref:`🔗` Indicates whether your app links audio data data to the user's identity. @@ -1003,7 +1003,7 @@ Indicates whether your app links audio data data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses audio data data for tracking. @@ -1015,7 +1015,7 @@ Indicates whether your app uses audio data data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/browsing_history/collected** +:ref:`bool` **privacy/collected_data/browsing_history/collected** :ref:`🔗` Indicates whether your app collects browsing history. @@ -1027,7 +1027,7 @@ Indicates whether your app collects browsing history. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** +:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** :ref:`🔗` The reasons your app collects browsing history. See `Describing data use in privacy manifests `__. @@ -1039,7 +1039,7 @@ The reasons your app collects browsing history. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** +:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** :ref:`🔗` Indicates whether your app links browsing history to the user's identity. @@ -1051,7 +1051,7 @@ Indicates whether your app links browsing history to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** +:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses browsing history for tracking. @@ -1063,7 +1063,7 @@ Indicates whether your app uses browsing history for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/coarse_location/collected** +:ref:`bool` **privacy/collected_data/coarse_location/collected** :ref:`🔗` Indicates whether your app collects coarse location data. @@ -1075,7 +1075,7 @@ Indicates whether your app collects coarse location data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** +:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** :ref:`🔗` The reasons your app collects coarse location data. See `Describing data use in privacy manifests `__. @@ -1087,7 +1087,7 @@ The reasons your app collects coarse location data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** +:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** :ref:`🔗` Indicates whether your app links coarse location data to the user's identity. @@ -1099,7 +1099,7 @@ Indicates whether your app links coarse location data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** +:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** :ref:`🔗` Indicates whether your app uses coarse location data for tracking. @@ -1111,7 +1111,7 @@ Indicates whether your app uses coarse location data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/contacts/collected** +:ref:`bool` **privacy/collected_data/contacts/collected** :ref:`🔗` Indicates whether your app collects contacts. @@ -1123,7 +1123,7 @@ Indicates whether your app collects contacts. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/contacts/collection_purposes** +:ref:`int` **privacy/collected_data/contacts/collection_purposes** :ref:`🔗` The reasons your app collects contacts. See `Describing data use in privacy manifests `__. @@ -1135,7 +1135,7 @@ The reasons your app collects contacts. See `Describing data use in privacy mani .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/contacts/linked_to_user** +:ref:`bool` **privacy/collected_data/contacts/linked_to_user** :ref:`🔗` Indicates whether your app links contacts to the user's identity. @@ -1147,7 +1147,7 @@ Indicates whether your app links contacts to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** +:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** :ref:`🔗` Indicates whether your app uses contacts for tracking. @@ -1159,7 +1159,7 @@ Indicates whether your app uses contacts for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/crash_data/collected** +:ref:`bool` **privacy/collected_data/crash_data/collected** :ref:`🔗` Indicates whether your app collects crash data. @@ -1171,7 +1171,7 @@ Indicates whether your app collects crash data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/crash_data/collection_purposes** +:ref:`int` **privacy/collected_data/crash_data/collection_purposes** :ref:`🔗` The reasons your app collects crash data. See `Describing data use in privacy manifests `__. @@ -1183,7 +1183,7 @@ The reasons your app collects crash data. See `Describing data use in privacy ma .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** +:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** :ref:`🔗` Indicates whether your app links crash data to the user's identity. @@ -1195,7 +1195,7 @@ Indicates whether your app links crash data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses crash data for tracking. @@ -1207,7 +1207,7 @@ Indicates whether your app uses crash data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/credit_info/collected** +:ref:`bool` **privacy/collected_data/credit_info/collected** :ref:`🔗` Indicates whether your app collects credit information. @@ -1219,7 +1219,7 @@ Indicates whether your app collects credit information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/credit_info/collection_purposes** +:ref:`int` **privacy/collected_data/credit_info/collection_purposes** :ref:`🔗` The reasons your app collects credit information. See `Describing data use in privacy manifests `__. @@ -1231,7 +1231,7 @@ The reasons your app collects credit information. See `Describing data use in pr .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** +:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** :ref:`🔗` Indicates whether your app links credit information to the user's identity. @@ -1243,7 +1243,7 @@ Indicates whether your app links credit information to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses credit information for tracking. @@ -1255,7 +1255,7 @@ Indicates whether your app uses credit information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/customer_support/collected** +:ref:`bool` **privacy/collected_data/customer_support/collected** :ref:`🔗` Indicates whether your app collects customer support data. @@ -1267,7 +1267,7 @@ Indicates whether your app collects customer support data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/customer_support/collection_purposes** +:ref:`int` **privacy/collected_data/customer_support/collection_purposes** :ref:`🔗` The reasons your app collects customer support data. See `Describing data use in privacy manifests `__. @@ -1279,7 +1279,7 @@ The reasons your app collects customer support data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** +:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** :ref:`🔗` Indicates whether your app links customer support data to the user's identity. @@ -1291,7 +1291,7 @@ Indicates whether your app links customer support data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** +:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** :ref:`🔗` Indicates whether your app uses customer support data for tracking. @@ -1303,7 +1303,7 @@ Indicates whether your app uses customer support data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/device_id/collected** +:ref:`bool` **privacy/collected_data/device_id/collected** :ref:`🔗` Indicates whether your app collects device IDs. @@ -1315,7 +1315,7 @@ Indicates whether your app collects device IDs. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/device_id/collection_purposes** +:ref:`int` **privacy/collected_data/device_id/collection_purposes** :ref:`🔗` The reasons your app collects device IDs. See `Describing data use in privacy manifests `__. @@ -1327,7 +1327,7 @@ The reasons your app collects device IDs. See `Describing data use in privacy ma .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/device_id/linked_to_user** +:ref:`bool` **privacy/collected_data/device_id/linked_to_user** :ref:`🔗` Indicates whether your app links device IDs to the user's identity. @@ -1339,7 +1339,7 @@ Indicates whether your app links device IDs to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** +:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** :ref:`🔗` Indicates whether your app uses device IDs for tracking. @@ -1351,7 +1351,7 @@ Indicates whether your app uses device IDs for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/email_address/collected** +:ref:`bool` **privacy/collected_data/email_address/collected** :ref:`🔗` Indicates whether your app collects email address. @@ -1363,7 +1363,7 @@ Indicates whether your app collects email address. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/email_address/collection_purposes** +:ref:`int` **privacy/collected_data/email_address/collection_purposes** :ref:`🔗` The reasons your app collects email address. See `Describing data use in privacy manifests `__. @@ -1375,7 +1375,7 @@ The reasons your app collects email address. See `Describing data use in privacy .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/email_address/linked_to_user** +:ref:`bool` **privacy/collected_data/email_address/linked_to_user** :ref:`🔗` Indicates whether your app links email address to the user's identity. @@ -1387,7 +1387,7 @@ Indicates whether your app links email address to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** +:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** :ref:`🔗` Indicates whether your app uses email address for tracking. @@ -1399,7 +1399,7 @@ Indicates whether your app uses email address for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** +:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** :ref:`🔗` Indicates whether your app collects emails or text messages. @@ -1411,7 +1411,7 @@ Indicates whether your app collects emails or text messages. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** +:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** :ref:`🔗` The reasons your app collects emails or text messages. See `Describing data use in privacy manifests `__. @@ -1423,7 +1423,7 @@ The reasons your app collects emails or text messages. See `Describing data use .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** +:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** :ref:`🔗` Indicates whether your app links emails or text messages to the user's identity. @@ -1435,7 +1435,7 @@ Indicates whether your app links emails or text messages to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** +:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** :ref:`🔗` Indicates whether your app uses emails or text messages for tracking. @@ -1447,7 +1447,7 @@ Indicates whether your app uses emails or text messages for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/environment_scanning/collected** +:ref:`bool` **privacy/collected_data/environment_scanning/collected** :ref:`🔗` Indicates whether your app collects environment scanning data. @@ -1459,7 +1459,7 @@ Indicates whether your app collects environment scanning data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** +:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** :ref:`🔗` The reasons your app collects environment scanning data. See `Describing data use in privacy manifests `__. @@ -1471,7 +1471,7 @@ The reasons your app collects environment scanning data. See `Describing data us .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** +:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** :ref:`🔗` Indicates whether your app links environment scanning data to the user's identity. @@ -1483,7 +1483,7 @@ Indicates whether your app links environment scanning data to the user's identit .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** +:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** :ref:`🔗` Indicates whether your app uses environment scanning data for tracking. @@ -1495,7 +1495,7 @@ Indicates whether your app uses environment scanning data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/fitness/collected** +:ref:`bool` **privacy/collected_data/fitness/collected** :ref:`🔗` Indicates whether your app collects fitness and exercise data. @@ -1507,7 +1507,7 @@ Indicates whether your app collects fitness and exercise data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/fitness/collection_purposes** +:ref:`int` **privacy/collected_data/fitness/collection_purposes** :ref:`🔗` The reasons your app collects fitness and exercise data. See `Describing data use in privacy manifests `__. @@ -1519,7 +1519,7 @@ The reasons your app collects fitness and exercise data. See `Describing data us .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/fitness/linked_to_user** +:ref:`bool` **privacy/collected_data/fitness/linked_to_user** :ref:`🔗` Indicates whether your app links fitness and exercise data to the user's identity. @@ -1531,7 +1531,7 @@ Indicates whether your app links fitness and exercise data to the user's identit .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** +:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** :ref:`🔗` Indicates whether your app uses fitness and exercise data for tracking. @@ -1543,7 +1543,7 @@ Indicates whether your app uses fitness and exercise data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/gameplay_content/collected** +:ref:`bool` **privacy/collected_data/gameplay_content/collected** :ref:`🔗` Indicates whether your app collects gameplay content. @@ -1555,7 +1555,7 @@ Indicates whether your app collects gameplay content. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** +:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** :ref:`🔗` The reasons your app collects gameplay content. See `Describing data use in privacy manifests `__. @@ -1567,7 +1567,7 @@ The reasons your app collects gameplay content. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** +:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** :ref:`🔗` Indicates whether your app links gameplay content to the user's identity. @@ -1579,7 +1579,7 @@ Indicates whether your app links gameplay content to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** +:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** :ref:`🔗` Indicates whether your app uses gameplay content for tracking. @@ -1591,7 +1591,7 @@ Indicates whether your app uses gameplay content for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/hands/collected** +:ref:`bool` **privacy/collected_data/hands/collected** :ref:`🔗` Indicates whether your app collects user's hand structure and hand movements. @@ -1603,7 +1603,7 @@ Indicates whether your app collects user's hand structure and hand movements. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/hands/collection_purposes** +:ref:`int` **privacy/collected_data/hands/collection_purposes** :ref:`🔗` The reasons your app collects user's hand structure and hand movements. See `Describing data use in privacy manifests `__. @@ -1615,7 +1615,7 @@ The reasons your app collects user's hand structure and hand movements. See `Des .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/hands/linked_to_user** +:ref:`bool` **privacy/collected_data/hands/linked_to_user** :ref:`🔗` Indicates whether your app links user's hand structure and hand movements to the user's identity. @@ -1627,7 +1627,7 @@ Indicates whether your app links user's hand structure and hand movements to the .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/hands/used_for_tracking** +:ref:`bool` **privacy/collected_data/hands/used_for_tracking** :ref:`🔗` Indicates whether your app uses user's hand structure and hand movements for tracking. @@ -1639,7 +1639,7 @@ Indicates whether your app uses user's hand structure and hand movements for tra .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/head/collected** +:ref:`bool` **privacy/collected_data/head/collected** :ref:`🔗` Indicates whether your app collects user's head movement. @@ -1651,7 +1651,7 @@ Indicates whether your app collects user's head movement. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/head/collection_purposes** +:ref:`int` **privacy/collected_data/head/collection_purposes** :ref:`🔗` The reasons your app collects user's head movement. See `Describing data use in privacy manifests `__. @@ -1663,7 +1663,7 @@ The reasons your app collects user's head movement. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/head/linked_to_user** +:ref:`bool` **privacy/collected_data/head/linked_to_user** :ref:`🔗` Indicates whether your app links user's head movement to the user's identity. @@ -1675,7 +1675,7 @@ Indicates whether your app links user's head movement to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/head/used_for_tracking** +:ref:`bool` **privacy/collected_data/head/used_for_tracking** :ref:`🔗` Indicates whether your app uses user's head movement for tracking. @@ -1687,7 +1687,7 @@ Indicates whether your app uses user's head movement for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/health/collected** +:ref:`bool` **privacy/collected_data/health/collected** :ref:`🔗` Indicates whether your app collects health and medical data. @@ -1699,7 +1699,7 @@ Indicates whether your app collects health and medical data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/health/collection_purposes** +:ref:`int` **privacy/collected_data/health/collection_purposes** :ref:`🔗` The reasons your app collects health and medical data. See `Describing data use in privacy manifests `__. @@ -1711,7 +1711,7 @@ The reasons your app collects health and medical data. See `Describing data use .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/health/linked_to_user** +:ref:`bool` **privacy/collected_data/health/linked_to_user** :ref:`🔗` Indicates whether your app links health and medical data to the user's identity. @@ -1723,7 +1723,7 @@ Indicates whether your app links health and medical data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/health/used_for_tracking** +:ref:`bool` **privacy/collected_data/health/used_for_tracking** :ref:`🔗` Indicates whether your app uses health and medical data for tracking. @@ -1735,7 +1735,7 @@ Indicates whether your app uses health and medical data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/name/collected** +:ref:`bool` **privacy/collected_data/name/collected** :ref:`🔗` Indicates whether your app collects user's name. @@ -1747,7 +1747,7 @@ Indicates whether your app collects user's name. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/name/collection_purposes** +:ref:`int` **privacy/collected_data/name/collection_purposes** :ref:`🔗` The reasons your app collects user's name. See `Describing data use in privacy manifests `__. @@ -1759,7 +1759,7 @@ The reasons your app collects user's name. See `Describing data use in privacy m .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/name/linked_to_user** +:ref:`bool` **privacy/collected_data/name/linked_to_user** :ref:`🔗` Indicates whether your app links user's name to the user's identity. @@ -1771,7 +1771,7 @@ Indicates whether your app links user's name to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/name/used_for_tracking** +:ref:`bool` **privacy/collected_data/name/used_for_tracking** :ref:`🔗` Indicates whether your app uses user's name for tracking. @@ -1783,7 +1783,7 @@ Indicates whether your app uses user's name for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_contact_info/collected** +:ref:`bool` **privacy/collected_data/other_contact_info/collected** :ref:`🔗` Indicates whether your app collects any other contact information. @@ -1795,7 +1795,7 @@ Indicates whether your app collects any other contact information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** +:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** :ref:`🔗` The reasons your app collects any other contact information. See `Describing data use in privacy manifests `__. @@ -1807,7 +1807,7 @@ The reasons your app collects any other contact information. See `Describing dat .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** +:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** :ref:`🔗` Indicates whether your app links any other contact information to the user's identity. @@ -1819,7 +1819,7 @@ Indicates whether your app links any other contact information to the user's ide .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other contact information for tracking. @@ -1831,7 +1831,7 @@ Indicates whether your app uses any other contact information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_data_types/collected** +:ref:`bool` **privacy/collected_data/other_data_types/collected** :ref:`🔗` Indicates whether your app collects any other data. @@ -1843,7 +1843,7 @@ Indicates whether your app collects any other data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** +:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** :ref:`🔗` The reasons your app collects any other data. See `Describing data use in privacy manifests `__. @@ -1855,7 +1855,7 @@ The reasons your app collects any other data. See `Describing data use in privac .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** +:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** :ref:`🔗` Indicates whether your app links any other data to the user's identity. @@ -1867,7 +1867,7 @@ Indicates whether your app links any other data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other data for tracking. @@ -1879,7 +1879,7 @@ Indicates whether your app uses any other data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** +:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** :ref:`🔗` Indicates whether your app collects any other diagnostic data. @@ -1891,7 +1891,7 @@ Indicates whether your app collects any other diagnostic data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** +:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** :ref:`🔗` The reasons your app collects any other diagnostic data. See `Describing data use in privacy manifests `__. @@ -1903,7 +1903,7 @@ The reasons your app collects any other diagnostic data. See `Describing data us .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** +:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** :ref:`🔗` Indicates whether your app links any other diagnostic data to the user's identity. @@ -1915,7 +1915,7 @@ Indicates whether your app links any other diagnostic data to the user's identit .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other diagnostic data for tracking. @@ -1927,7 +1927,7 @@ Indicates whether your app uses any other diagnostic data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_financial_info/collected** +:ref:`bool` **privacy/collected_data/other_financial_info/collected** :ref:`🔗` Indicates whether your app collects any other financial information. @@ -1939,7 +1939,7 @@ Indicates whether your app collects any other financial information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** +:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** :ref:`🔗` The reasons your app collects any other financial information. See `Describing data use in privacy manifests `__. @@ -1951,7 +1951,7 @@ The reasons your app collects any other financial information. See `Describing d .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** +:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** :ref:`🔗` Indicates whether your app links any other financial information to the user's identity. @@ -1963,7 +1963,7 @@ Indicates whether your app links any other financial information to the user's i .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other financial information for tracking. @@ -1975,7 +1975,7 @@ Indicates whether your app uses any other financial information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_usage_data/collected** +:ref:`bool` **privacy/collected_data/other_usage_data/collected** :ref:`🔗` Indicates whether your app collects any other usage data. @@ -1987,7 +1987,7 @@ Indicates whether your app collects any other usage data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** +:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** :ref:`🔗` The reasons your app collects any other usage data. See `Describing data use in privacy manifests `__. @@ -1999,7 +1999,7 @@ The reasons your app collects any other usage data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** +:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** :ref:`🔗` Indicates whether your app links any other usage data to the user's identity. @@ -2011,7 +2011,7 @@ Indicates whether your app links any other usage data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other usage data for tracking. @@ -2023,7 +2023,7 @@ Indicates whether your app uses any other usage data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_user_content/collected** +:ref:`bool` **privacy/collected_data/other_user_content/collected** :ref:`🔗` Indicates whether your app collects any other user generated content. @@ -2035,7 +2035,7 @@ Indicates whether your app collects any other user generated content. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** +:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** :ref:`🔗` The reasons your app collects any other user generated content. See `Describing data use in privacy manifests `__. @@ -2047,7 +2047,7 @@ The reasons your app collects any other user generated content. See `Describing .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** +:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** :ref:`🔗` Indicates whether your app links any other user generated content to the user's identity. @@ -2059,7 +2059,7 @@ Indicates whether your app links any other user generated content to the user's .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other user generated content for tracking. @@ -2071,7 +2071,7 @@ Indicates whether your app uses any other user generated content for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/payment_info/collected** +:ref:`bool` **privacy/collected_data/payment_info/collected** :ref:`🔗` Indicates whether your app collects payment information. @@ -2083,7 +2083,7 @@ Indicates whether your app collects payment information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/payment_info/collection_purposes** +:ref:`int` **privacy/collected_data/payment_info/collection_purposes** :ref:`🔗` The reasons your app collects payment information. See `Describing data use in privacy manifests `__. @@ -2095,7 +2095,7 @@ The reasons your app collects payment information. See `Describing data use in p .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** +:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** :ref:`🔗` Indicates whether your app links payment information to the user's identity. @@ -2107,7 +2107,7 @@ Indicates whether your app links payment information to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses payment information for tracking. @@ -2119,7 +2119,7 @@ Indicates whether your app uses payment information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/performance_data/collected** +:ref:`bool` **privacy/collected_data/performance_data/collected** :ref:`🔗` Indicates whether your app collects performance data. @@ -2131,7 +2131,7 @@ Indicates whether your app collects performance data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/performance_data/collection_purposes** +:ref:`int` **privacy/collected_data/performance_data/collection_purposes** :ref:`🔗` The reasons your app collects performance data. See `Describing data use in privacy manifests `__. @@ -2143,7 +2143,7 @@ The reasons your app collects performance data. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** +:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** :ref:`🔗` Indicates whether your app links performance data to the user's identity. @@ -2155,7 +2155,7 @@ Indicates whether your app links performance data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses performance data for tracking. @@ -2167,7 +2167,7 @@ Indicates whether your app uses performance data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/phone_number/collected** +:ref:`bool` **privacy/collected_data/phone_number/collected** :ref:`🔗` Indicates whether your app collects phone number. @@ -2179,7 +2179,7 @@ Indicates whether your app collects phone number. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/phone_number/collection_purposes** +:ref:`int` **privacy/collected_data/phone_number/collection_purposes** :ref:`🔗` The reasons your app collects phone number. See `Describing data use in privacy manifests `__. @@ -2191,7 +2191,7 @@ The reasons your app collects phone number. See `Describing data use in privacy .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** +:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** :ref:`🔗` Indicates whether your app links phone number to the user's identity. @@ -2203,7 +2203,7 @@ Indicates whether your app links phone number to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** +:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** :ref:`🔗` Indicates whether your app uses phone number for tracking. @@ -2215,7 +2215,7 @@ Indicates whether your app uses phone number for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/photos_or_videos/collected** +:ref:`bool` **privacy/collected_data/photos_or_videos/collected** :ref:`🔗` Indicates whether your app collects photos or videos. @@ -2227,7 +2227,7 @@ Indicates whether your app collects photos or videos. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** +:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** :ref:`🔗` The reasons your app collects photos or videos. See `Describing data use in privacy manifests `__. @@ -2239,7 +2239,7 @@ The reasons your app collects photos or videos. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** +:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** :ref:`🔗` Indicates whether your app links photos or videos to the user's identity. @@ -2251,7 +2251,7 @@ Indicates whether your app links photos or videos to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** +:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** :ref:`🔗` Indicates whether your app uses photos or videos for tracking. @@ -2263,7 +2263,7 @@ Indicates whether your app uses photos or videos for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/physical_address/collected** +:ref:`bool` **privacy/collected_data/physical_address/collected** :ref:`🔗` Indicates whether your app collects physical address. @@ -2275,7 +2275,7 @@ Indicates whether your app collects physical address. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/physical_address/collection_purposes** +:ref:`int` **privacy/collected_data/physical_address/collection_purposes** :ref:`🔗` The reasons your app collects physical address. See `Describing data use in privacy manifests `__. @@ -2287,7 +2287,7 @@ The reasons your app collects physical address. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** +:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** :ref:`🔗` Indicates whether your app links physical address to the user's identity. @@ -2299,7 +2299,7 @@ Indicates whether your app links physical address to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** +:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** :ref:`🔗` Indicates whether your app uses physical address for tracking. @@ -2311,7 +2311,7 @@ Indicates whether your app uses physical address for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/precise_location/collected** +:ref:`bool` **privacy/collected_data/precise_location/collected** :ref:`🔗` Indicates whether your app collects precise location data. @@ -2323,7 +2323,7 @@ Indicates whether your app collects precise location data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/precise_location/collection_purposes** +:ref:`int` **privacy/collected_data/precise_location/collection_purposes** :ref:`🔗` The reasons your app collects precise location data. See `Describing data use in privacy manifests `__. @@ -2335,7 +2335,7 @@ The reasons your app collects precise location data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** +:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** :ref:`🔗` Indicates whether your app links precise location data to the user's identity. @@ -2347,7 +2347,7 @@ Indicates whether your app links precise location data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** +:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** :ref:`🔗` Indicates whether your app uses precise location data for tracking. @@ -2359,7 +2359,7 @@ Indicates whether your app uses precise location data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/product_interaction/collected** +:ref:`bool` **privacy/collected_data/product_interaction/collected** :ref:`🔗` Indicates whether your app collects product interaction data. @@ -2371,7 +2371,7 @@ Indicates whether your app collects product interaction data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** +:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** :ref:`🔗` The reasons your app collects product interaction data. See `Describing data use in privacy manifests `__. @@ -2383,7 +2383,7 @@ The reasons your app collects product interaction data. See `Describing data use .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** +:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** :ref:`🔗` Indicates whether your app links product interaction data to the user's identity. @@ -2395,7 +2395,7 @@ Indicates whether your app links product interaction data to the user's identity .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** +:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** :ref:`🔗` Indicates whether your app uses product interaction data for tracking. @@ -2407,7 +2407,7 @@ Indicates whether your app uses product interaction data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/purchase_history/collected** +:ref:`bool` **privacy/collected_data/purchase_history/collected** :ref:`🔗` Indicates whether your app collects purchase history. @@ -2419,7 +2419,7 @@ Indicates whether your app collects purchase history. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** +:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** :ref:`🔗` The reasons your app collects purchase history. See `Describing data use in privacy manifests `__. @@ -2431,7 +2431,7 @@ The reasons your app collects purchase history. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** +:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** :ref:`🔗` Indicates whether your app links purchase history to the user's identity. @@ -2443,7 +2443,7 @@ Indicates whether your app links purchase history to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** +:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses purchase history for tracking. @@ -2455,7 +2455,7 @@ Indicates whether your app uses purchase history for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/collected** +:ref:`bool` **privacy/collected_data/search_hhistory/collected** :ref:`🔗` Indicates whether your app collects search history. @@ -2467,7 +2467,7 @@ Indicates whether your app collects search history. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** +:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** :ref:`🔗` The reasons your app collects search history. See `Describing data use in privacy manifests `__. @@ -2479,7 +2479,7 @@ The reasons your app collects search history. See `Describing data use in privac .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** +:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** :ref:`🔗` Indicates whether your app links search history to the user's identity. @@ -2491,7 +2491,7 @@ Indicates whether your app links search history to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** +:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** :ref:`🔗` Indicates whether your app uses search history for tracking. @@ -2503,7 +2503,7 @@ Indicates whether your app uses search history for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/sensitive_info/collected** +:ref:`bool` **privacy/collected_data/sensitive_info/collected** :ref:`🔗` Indicates whether your app collects sensitive user information. @@ -2515,7 +2515,7 @@ Indicates whether your app collects sensitive user information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** +:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** :ref:`🔗` The reasons your app collects sensitive user information. See `Describing data use in privacy manifests `__. @@ -2527,7 +2527,7 @@ The reasons your app collects sensitive user information. See `Describing data u .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** +:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** :ref:`🔗` Indicates whether your app links sensitive user information to the user's identity. @@ -2539,7 +2539,7 @@ Indicates whether your app links sensitive user information to the user's identi .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses sensitive user information for tracking. @@ -2551,7 +2551,7 @@ Indicates whether your app uses sensitive user information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/user_id/collected** +:ref:`bool` **privacy/collected_data/user_id/collected** :ref:`🔗` Indicates whether your app collects user IDs. @@ -2563,7 +2563,7 @@ Indicates whether your app collects user IDs. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/user_id/collection_purposes** +:ref:`int` **privacy/collected_data/user_id/collection_purposes** :ref:`🔗` The reasons your app collects user IDs. See `Describing data use in privacy manifests `__. @@ -2575,7 +2575,7 @@ The reasons your app collects user IDs. See `Describing data use in privacy mani .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/user_id/linked_to_user** +:ref:`bool` **privacy/collected_data/user_id/linked_to_user** :ref:`🔗` Indicates whether your app links user IDs to the user's identity. @@ -2587,7 +2587,7 @@ Indicates whether your app links user IDs to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** +:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** :ref:`🔗` Indicates whether your app uses user IDs for tracking. @@ -2599,7 +2599,7 @@ Indicates whether your app uses user IDs for tracking. .. rst-class:: classref-property -:ref:`int` **privacy/disk_space_access_reasons** +:ref:`int` **privacy/disk_space_access_reasons** :ref:`🔗` The reasons your app use free disk space API. See `Describing use of required reason API `__. @@ -2611,7 +2611,7 @@ The reasons your app use free disk space API. See `Describing use of required re .. rst-class:: classref-property -:ref:`int` **privacy/file_timestamp_access_reasons** +:ref:`int` **privacy/file_timestamp_access_reasons** :ref:`🔗` The reasons your app use file timestamp/metadata API. See `Describing use of required reason API `__. @@ -2623,7 +2623,7 @@ The reasons your app use file timestamp/metadata API. See `Describing use of req .. rst-class:: classref-property -:ref:`String` **privacy/microphone_usage_description** +:ref:`String` **privacy/microphone_usage_description** :ref:`🔗` A message displayed when requesting access to the device's microphone (in English). @@ -2635,7 +2635,7 @@ A message displayed when requesting access to the device's microphone (in Englis .. rst-class:: classref-property -:ref:`Dictionary` **privacy/microphone_usage_description_localized** +:ref:`Dictionary` **privacy/microphone_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the device's microphone (localized). @@ -2647,7 +2647,7 @@ A message displayed when requesting access to the device's microphone (localized .. rst-class:: classref-property -:ref:`String` **privacy/photolibrary_usage_description** +:ref:`String` **privacy/photolibrary_usage_description** :ref:`🔗` A message displayed when requesting access to the user's photo library (in English). @@ -2659,7 +2659,7 @@ A message displayed when requesting access to the user's photo library (in Engli .. rst-class:: classref-property -:ref:`Dictionary` **privacy/photolibrary_usage_description_localized** +:ref:`Dictionary` **privacy/photolibrary_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's photo library (localized). @@ -2671,7 +2671,7 @@ A message displayed when requesting access to the user's photo library (localize .. rst-class:: classref-property -:ref:`int` **privacy/system_boot_time_access_reasons** +:ref:`int` **privacy/system_boot_time_access_reasons** :ref:`🔗` The reasons your app use system boot time / absolute time API. See `Describing use of required reason API `__. @@ -2683,7 +2683,7 @@ The reasons your app use system boot time / absolute time API. See `Describing u .. rst-class:: classref-property -:ref:`PackedStringArray` **privacy/tracking_domains** +:ref:`PackedStringArray` **privacy/tracking_domains** :ref:`🔗` The list of internet domains your app connects to that engage in tracking. See `Privacy manifest files `__. @@ -2697,7 +2697,7 @@ The list of internet domains your app connects to that engage in tracking. See ` .. rst-class:: classref-property -:ref:`bool` **privacy/tracking_enabled** +:ref:`bool` **privacy/tracking_enabled** :ref:`🔗` Indicates whether your app uses data for tracking. See `Privacy manifest files `__. @@ -2709,7 +2709,7 @@ Indicates whether your app uses data for tracking. See `Privacy manifest files < .. rst-class:: classref-property -:ref:`int` **privacy/user_defaults_access_reasons** +:ref:`int` **privacy/user_defaults_access_reasons** :ref:`🔗` The reasons your app use user defaults API. See `Describing use of required reason API `__. @@ -2721,7 +2721,7 @@ The reasons your app use user defaults API. See `Describing use of required reas .. rst-class:: classref-property -:ref:`Color` **storyboard/custom_bg_color** +:ref:`Color` **storyboard/custom_bg_color** :ref:`🔗` A custom background color of the storyboard launch screen. @@ -2733,7 +2733,7 @@ A custom background color of the storyboard launch screen. .. rst-class:: classref-property -:ref:`String` **storyboard/custom_image@2x** +:ref:`String` **storyboard/custom_image@2x** :ref:`🔗` Application launch screen image file (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image`. @@ -2745,7 +2745,7 @@ Application launch screen image file (2x DPI). If left empty, it will fallback t .. rst-class:: classref-property -:ref:`String` **storyboard/custom_image@3x** +:ref:`String` **storyboard/custom_image@3x** :ref:`🔗` Application launch screen image file (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image`. @@ -2757,7 +2757,7 @@ Application launch screen image file (3x DPI). If left empty, it will fallback t .. rst-class:: classref-property -:ref:`int` **storyboard/image_scale_mode** +:ref:`int` **storyboard/image_scale_mode** :ref:`🔗` Launch screen image scaling mode. @@ -2769,7 +2769,7 @@ Launch screen image scaling mode. .. rst-class:: classref-property -:ref:`bool` **storyboard/use_custom_bg_color** +:ref:`bool` **storyboard/use_custom_bg_color** :ref:`🔗` If ``true``, :ref:`storyboard/custom_bg_color` is used as a launch screen background color, otherwise ``application/boot_splash/bg_color`` project setting is used. @@ -2781,7 +2781,7 @@ If ``true``, :ref:`storyboard/custom_bg_color` **user_data/accessible_from_files_app** +:ref:`bool` **user_data/accessible_from_files_app** :ref:`🔗` If ``true``, the app "Documents" folder can be accessed via "Files" app. See `LSSupportsOpeningDocumentsInPlace `__. @@ -2793,7 +2793,7 @@ If ``true``, the app "Documents" folder can be accessed via "Files" app. See `LS .. rst-class:: classref-property -:ref:`bool` **user_data/accessible_from_itunes_sharing** +:ref:`bool` **user_data/accessible_from_itunes_sharing** :ref:`🔗` If ``true``, the app "Documents" folder can be accessed via iTunes file sharing. See `UIFileSharingEnabled `__. diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst index 8a95d635071..d0ecbaff8a5 100644 --- a/classes/class_editorexportplatformlinuxbsd.rst +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **binary_format/architecture** +:ref:`String` **binary_format/architecture** :ref:`🔗` Application executable architecture. @@ -88,7 +88,7 @@ Official export templates include ``x86_32`` and ``x86_64`` binaries only. .. rst-class:: classref-property -:ref:`bool` **binary_format/embed_pck** +:ref:`bool` **binary_format/embed_pck** :ref:`🔗` If ``true``, project resources are embedded into the executable. @@ -100,7 +100,7 @@ If ``true``, project resources are embedded into the executable. .. rst-class:: classref-property -:ref:`String` **custom_template/debug** +:ref:`String` **custom_template/debug** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -112,7 +112,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`String` **custom_template/release** +:ref:`String` **custom_template/release** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -124,7 +124,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`int` **debug/export_console_wrapper** +:ref:`int` **debug/export_console_wrapper** :ref:`🔗` If ``true``, a console wrapper is exported alongside the main executable, which allows running the project with enabled console output. @@ -136,7 +136,7 @@ If ``true``, a console wrapper is exported alongside the main executable, which .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/cleanup_script** +:ref:`String` **ssh_remote_deploy/cleanup_script** :ref:`🔗` Script code to execute on the remote host when app is finished. @@ -158,7 +158,7 @@ The following variables can be used in the script: .. rst-class:: classref-property -:ref:`bool` **ssh_remote_deploy/enabled** +:ref:`bool` **ssh_remote_deploy/enabled** :ref:`🔗` Enables remote deploy using SSH/SCP. @@ -170,7 +170,7 @@ Enables remote deploy using SSH/SCP. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/extra_args_scp** +:ref:`String` **ssh_remote_deploy/extra_args_scp** :ref:`🔗` Array of the additional command line arguments passed to the SCP. @@ -182,7 +182,7 @@ Array of the additional command line arguments passed to the SCP. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/extra_args_ssh** +:ref:`String` **ssh_remote_deploy/extra_args_ssh** :ref:`🔗` Array of the additional command line arguments passed to the SSH. @@ -194,7 +194,7 @@ Array of the additional command line arguments passed to the SSH. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/host** +:ref:`String` **ssh_remote_deploy/host** :ref:`🔗` Remote host SSH user name and address, in ``user@address`` format. @@ -206,7 +206,7 @@ Remote host SSH user name and address, in ``user@address`` format. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/port** +:ref:`String` **ssh_remote_deploy/port** :ref:`🔗` Remote host SSH port number. @@ -218,7 +218,7 @@ Remote host SSH port number. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/run_script** +:ref:`String` **ssh_remote_deploy/run_script** :ref:`🔗` Script code to execute on the remote host when running the app. @@ -240,7 +240,7 @@ The following variables can be used in the script: .. rst-class:: classref-property -:ref:`bool` **texture_format/etc2_astc** +:ref:`bool` **texture_format/etc2_astc** :ref:`🔗` If ``true``, project textures are exported in the ETC2/ASTC format. @@ -252,7 +252,7 @@ If ``true``, project textures are exported in the ETC2/ASTC format. .. rst-class:: classref-property -:ref:`bool` **texture_format/s3tc_bptc** +:ref:`bool` **texture_format/s3tc_bptc** :ref:`🔗` If ``true``, project textures are exported in the S3TC/BPTC format. diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index 9b477bee865..33dbdf9f98f 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -512,7 +512,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **application/additional_plist_content** +:ref:`String` **application/additional_plist_content** :ref:`🔗` Additional data added to the root ```` section of the `Info.plist `__ file. The value should be an XML section with pairs of key-value elements, e.g.: @@ -529,7 +529,7 @@ Additional data added to the root ```` section of the `Info.plist ` **application/app_category** +:ref:`String` **application/app_category** :ref:`🔗` Application category for the App Store. @@ -541,7 +541,7 @@ Application category for the App Store. .. rst-class:: classref-property -:ref:`String` **application/bundle_identifier** +:ref:`String` **application/bundle_identifier** :ref:`🔗` Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``). @@ -553,7 +553,7 @@ Unique application identifier in a reverse-DNS format, can only contain alphanum .. rst-class:: classref-property -:ref:`String` **application/copyright** +:ref:`String` **application/copyright** :ref:`🔗` Copyright notice for the bundle visible to the user (in English). @@ -565,7 +565,7 @@ Copyright notice for the bundle visible to the user (in English). .. rst-class:: classref-property -:ref:`Dictionary` **application/copyright_localized** +:ref:`Dictionary` **application/copyright_localized** :ref:`🔗` Copyright notice for the bundle visible to the user (localized). @@ -577,7 +577,7 @@ Copyright notice for the bundle visible to the user (localized). .. rst-class:: classref-property -:ref:`int` **application/export_angle** +:ref:`int` **application/export_angle** :ref:`🔗` If set to ``1``, ANGLE libraries are exported with the exported application. If set to ``0``, ANGLE libraries are exported only if :ref:`ProjectSettings.rendering/gl_compatibility/driver` is set to ``"opengl3_angle"``. @@ -589,7 +589,7 @@ If set to ``1``, ANGLE libraries are exported with the exported application. If .. rst-class:: classref-property -:ref:`String` **application/icon** +:ref:`String` **application/icon** :ref:`🔗` Application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/macos_native_icon`, and then to :ref:`ProjectSettings.application/config/icon`. @@ -601,7 +601,7 @@ Application icon file. If left empty, it will fallback to :ref:`ProjectSettings. .. rst-class:: classref-property -:ref:`int` **application/icon_interpolation** +:ref:`int` **application/icon_interpolation** :ref:`🔗` Interpolation method used to resize application icon. @@ -613,7 +613,7 @@ Interpolation method used to resize application icon. .. rst-class:: classref-property -:ref:`String` **application/min_macos_version** +:ref:`String` **application/min_macos_version** :ref:`🔗` Minimum version of macOS required for this application to run in the ``major.minor.patch`` or ``major.minor`` format, can only contain numeric characters (``0-9``) and periods (``.``). @@ -625,7 +625,7 @@ Minimum version of macOS required for this application to run in the ``major.min .. rst-class:: classref-property -:ref:`String` **application/short_version** +:ref:`String` **application/short_version** :ref:`🔗` Application version visible to the user, can only contain numeric characters (``0-9``) and periods (``.``). Falls back to :ref:`ProjectSettings.application/config/version` if left empty. @@ -637,7 +637,7 @@ Application version visible to the user, can only contain numeric characters (`` .. rst-class:: classref-property -:ref:`String` **application/signature** +:ref:`String` **application/signature** :ref:`🔗` A four-character creator code that is specific to the bundle. Optional. @@ -649,7 +649,7 @@ A four-character creator code that is specific to the bundle. Optional. .. rst-class:: classref-property -:ref:`String` **application/version** +:ref:`String` **application/version** :ref:`🔗` Machine-readable application version, in the ``major.minor.patch`` format, can only contain numeric characters (``0-9``) and periods (``.``). This must be incremented on every new release pushed to the App Store. @@ -661,7 +661,7 @@ Machine-readable application version, in the ``major.minor.patch`` format, can o .. rst-class:: classref-property -:ref:`String` **binary_format/architecture** +:ref:`String` **binary_format/architecture** :ref:`🔗` Application executable architecture. @@ -677,7 +677,7 @@ Official export templates include ``universal`` binaries only. .. rst-class:: classref-property -:ref:`String` **codesign/apple_team_id** +:ref:`String` **codesign/apple_team_id** :ref:`🔗` Apple Team ID, unique 10-character string. To locate your Team ID check "Membership details" section in your Apple developer account dashboard, or "Organizational Unit" of your code signing certificate. See `Locate your Team ID `__. @@ -689,7 +689,7 @@ Apple Team ID, unique 10-character string. To locate your Team ID check "Members .. rst-class:: classref-property -:ref:`String` **codesign/certificate_file** +:ref:`String` **codesign/certificate_file** :ref:`🔗` PKCS #12 certificate file used to sign ``.app`` bundle. @@ -703,7 +703,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_CODESIGN_CERTIFICA .. rst-class:: classref-property -:ref:`String` **codesign/certificate_password** +:ref:`String` **codesign/certificate_password** :ref:`🔗` Password for the certificate file used to sign ``.app`` bundle. @@ -717,7 +717,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_CODESIGN_CERTIFICA .. rst-class:: classref-property -:ref:`int` **codesign/codesign** +:ref:`int` **codesign/codesign** :ref:`🔗` Tool to use for code signing. @@ -729,7 +729,7 @@ Tool to use for code signing. .. rst-class:: classref-property -:ref:`PackedStringArray` **codesign/custom_options** +:ref:`PackedStringArray` **codesign/custom_options** :ref:`🔗` Array of the additional command line arguments passed to the code signing tool. @@ -743,7 +743,7 @@ Array of the additional command line arguments passed to the code signing tool. .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/address_book** +:ref:`bool` **codesign/entitlements/address_book** :ref:`🔗` Enable to allow access to contacts in the user's address book, if it's enabled you should also provide usage message in the :ref:`privacy/address_book_usage_description` option. See `com.apple.security.personal-information.addressbook `__. @@ -755,7 +755,7 @@ Enable to allow access to contacts in the user's address book, if it's enabled y .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/allow_dyld_environment_variables** +:ref:`bool` **codesign/entitlements/allow_dyld_environment_variables** :ref:`🔗` Allows app to use dynamic linker environment variables to inject code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-dyld-environment-variables `__. @@ -767,7 +767,7 @@ Allows app to use dynamic linker environment variables to inject code. If you ar .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/allow_jit_code_execution** +:ref:`bool` **codesign/entitlements/allow_jit_code_execution** :ref:`🔗` Allows creating writable and executable memory for JIT code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-jit `__. @@ -779,7 +779,7 @@ Allows creating writable and executable memory for JIT code. If you are using ad .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/allow_unsigned_executable_memory** +:ref:`bool` **codesign/entitlements/allow_unsigned_executable_memory** :ref:`🔗` Allows creating writable and executable memory without JIT restrictions. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-unsigned-executable-memory `__. @@ -791,7 +791,7 @@ Allows creating writable and executable memory without JIT restrictions. If you .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/app_sandbox/device_bluetooth** +:ref:`bool` **codesign/entitlements/app_sandbox/device_bluetooth** :ref:`🔗` Enable to allow app to interact with Bluetooth devices. This entitlement is required to use wireless controllers. See `com.apple.security.device.bluetooth `__. @@ -803,7 +803,7 @@ Enable to allow app to interact with Bluetooth devices. This entitlement is requ .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/app_sandbox/device_usb** +:ref:`bool` **codesign/entitlements/app_sandbox/device_usb** :ref:`🔗` Enable to allow app to interact with USB devices. This entitlement is required to use wired controllers. See `com.apple.security.device.usb `__. @@ -815,7 +815,7 @@ Enable to allow app to interact with USB devices. This entitlement is required t .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/app_sandbox/enabled** +:ref:`bool` **codesign/entitlements/app_sandbox/enabled** :ref:`🔗` Enables App Sandbox. The App Sandbox restricts access to user data, networking, and devices. Sandboxed apps can't access most of the file system, can't use custom file dialogs and execute binaries outside the .app bundle. See `App Sandbox `__. @@ -829,7 +829,7 @@ Enables App Sandbox. The App Sandbox restricts access to user data, networking, .. rst-class:: classref-property -:ref:`int` **codesign/entitlements/app_sandbox/files_downloads** +:ref:`int` **codesign/entitlements/app_sandbox/files_downloads** :ref:`🔗` Allows read or write access to the user's "Downloads" folder. See `com.apple.security.files.downloads.read-write `__. @@ -841,7 +841,7 @@ Allows read or write access to the user's "Downloads" folder. See `com.apple.sec .. rst-class:: classref-property -:ref:`int` **codesign/entitlements/app_sandbox/files_movies** +:ref:`int` **codesign/entitlements/app_sandbox/files_movies** :ref:`🔗` Allows read or write access to the user's "Movies" folder. See `com.apple.security.files.movies.read-write `__. @@ -853,7 +853,7 @@ Allows read or write access to the user's "Movies" folder. See `com.apple.securi .. rst-class:: classref-property -:ref:`int` **codesign/entitlements/app_sandbox/files_music** +:ref:`int` **codesign/entitlements/app_sandbox/files_music** :ref:`🔗` Allows read or write access to the user's "Music" folder. See `com.apple.security.files.music.read-write `__. @@ -865,7 +865,7 @@ Allows read or write access to the user's "Music" folder. See `com.apple.securit .. rst-class:: classref-property -:ref:`int` **codesign/entitlements/app_sandbox/files_pictures** +:ref:`int` **codesign/entitlements/app_sandbox/files_pictures** :ref:`🔗` Allows read or write access to the user's "Pictures" folder. See `com.apple.security.files.pictures.read-write `__. @@ -877,7 +877,7 @@ Allows read or write access to the user's "Pictures" folder. See `com.apple.secu .. rst-class:: classref-property -:ref:`int` **codesign/entitlements/app_sandbox/files_user_selected** +:ref:`int` **codesign/entitlements/app_sandbox/files_user_selected** :ref:`🔗` Allows read or write access to the locations the user has selected using a native file dialog. See `com.apple.security.files.user-selected.read-write `__. @@ -889,7 +889,7 @@ Allows read or write access to the locations the user has selected using a nativ .. rst-class:: classref-property -:ref:`Array` **codesign/entitlements/app_sandbox/helper_executables** +:ref:`Array` **codesign/entitlements/app_sandbox/helper_executables** :ref:`🔗` List of helper executables to embedded to the app bundle. Sandboxed app are limited to execute only these executable. See `Embedding a command-line tool in a sandboxed app `__. @@ -901,7 +901,7 @@ List of helper executables to embedded to the app bundle. Sandboxed app are limi .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/app_sandbox/network_client** +:ref:`bool` **codesign/entitlements/app_sandbox/network_client** :ref:`🔗` Enable to allow app to establish outgoing network connections. See `com.apple.security.network.client `__. @@ -913,7 +913,7 @@ Enable to allow app to establish outgoing network connections. See `com.apple.se .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/app_sandbox/network_server** +:ref:`bool` **codesign/entitlements/app_sandbox/network_server** :ref:`🔗` Enable to allow app to listen for incoming network connections. See `com.apple.security.network.server `__. @@ -925,7 +925,7 @@ Enable to allow app to listen for incoming network connections. See `com.apple.s .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/apple_events** +:ref:`bool` **codesign/entitlements/apple_events** :ref:`🔗` Enable to allow app to send Apple events to other apps. See `com.apple.security.automation.apple-events `__. @@ -937,7 +937,7 @@ Enable to allow app to send Apple events to other apps. See `com.apple.security. .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/audio_input** +:ref:`bool` **codesign/entitlements/audio_input** :ref:`🔗` Enable if you need to use the microphone or other audio input sources, if it's enabled you should also provide usage message in the :ref:`privacy/microphone_usage_description` option. See `com.apple.security.device.audio-input `__. @@ -949,7 +949,7 @@ Enable if you need to use the microphone or other audio input sources, if it's e .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/calendars** +:ref:`bool` **codesign/entitlements/calendars** :ref:`🔗` Enable to allow access to the user's calendar, if it's enabled you should also provide usage message in the :ref:`privacy/calendar_usage_description` option. See `com.apple.security.personal-information.calendars `__. @@ -961,7 +961,7 @@ Enable to allow access to the user's calendar, if it's enabled you should also p .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/camera** +:ref:`bool` **codesign/entitlements/camera** :ref:`🔗` Enable if you need to use the camera, if it's enabled you should also provide usage message in the :ref:`privacy/camera_usage_description` option. See `com.apple.security.device.camera `__. @@ -973,7 +973,7 @@ Enable if you need to use the camera, if it's enabled you should also provide us .. rst-class:: classref-property -:ref:`String` **codesign/entitlements/custom_file** +:ref:`String` **codesign/entitlements/custom_file** :ref:`🔗` Custom entitlements ``.plist`` file, if specified the rest of entitlements in the export config are ignored. @@ -985,7 +985,7 @@ Custom entitlements ``.plist`` file, if specified the rest of entitlements in th .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/debugging** +:ref:`bool` **codesign/entitlements/debugging** :ref:`🔗` You can temporarily enable this entitlement to use native debugger (GDB, LLDB) with the exported app. This entitlement should be disabled for production export. See `Embedding a command-line tool in a sandboxed app `__. @@ -997,7 +997,7 @@ You can temporarily enable this entitlement to use native debugger (GDB, LLDB) w .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/disable_library_validation** +:ref:`bool` **codesign/entitlements/disable_library_validation** :ref:`🔗` Allows app to load arbitrary libraries and frameworks (not signed with the same Team ID as the main executable or by Apple). Enable it if you are using GDExtension add-ons or ad-hoc signing, or want to support user-provided external add-ons. See `com.apple.security.cs.disable-library-validation `__. @@ -1009,7 +1009,7 @@ Allows app to load arbitrary libraries and frameworks (not signed with the same .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/location** +:ref:`bool` **codesign/entitlements/location** :ref:`🔗` Enable if you need to use location information from Location Services, if it's enabled you should also provide usage message in the :ref:`privacy/location_usage_description` option. See `com.apple.security.personal-information.location `__. @@ -1021,7 +1021,7 @@ Enable if you need to use location information from Location Services, if it's e .. rst-class:: classref-property -:ref:`bool` **codesign/entitlements/photos_library** +:ref:`bool` **codesign/entitlements/photos_library** :ref:`🔗` Enable to allow access to the user's Photos library, if it's enabled you should also provide usage message in the :ref:`privacy/photos_library_usage_description` option. See `com.apple.security.personal-information.photos-library `__. @@ -1033,7 +1033,7 @@ Enable to allow access to the user's Photos library, if it's enabled you should .. rst-class:: classref-property -:ref:`String` **codesign/identity** +:ref:`String` **codesign/identity** :ref:`🔗` The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sign ``.app`` bundle. @@ -1045,7 +1045,7 @@ The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sig .. rst-class:: classref-property -:ref:`String` **codesign/installer_identity** +:ref:`String` **codesign/installer_identity** :ref:`🔗` The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sign ``.pkg`` installer package for App Store distribution, use ``3rd Party Mac Developer Installer: Name.`` identity. @@ -1057,7 +1057,7 @@ The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sig .. rst-class:: classref-property -:ref:`String` **codesign/provisioning_profile** +:ref:`String` **codesign/provisioning_profile** :ref:`🔗` Provisioning profile file downloaded from Apple developer account dashboard. See `Edit, download, or delete provisioning profiles `__. @@ -1071,7 +1071,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_CODESIGN_PROVISION .. rst-class:: classref-property -:ref:`String` **custom_template/debug** +:ref:`String` **custom_template/debug** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -1083,7 +1083,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`String` **custom_template/release** +:ref:`String` **custom_template/release** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -1095,7 +1095,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`int` **debug/export_console_wrapper** +:ref:`int` **debug/export_console_wrapper** :ref:`🔗` If enabled, a wrapper that can be used to run the application with console output is created alongside the exported application. @@ -1107,7 +1107,7 @@ If enabled, a wrapper that can be used to run the application with console outpu .. rst-class:: classref-property -:ref:`bool` **display/high_res** +:ref:`bool` **display/high_res** :ref:`🔗` If ``true``, the application is rendered at native display resolution, otherwise it is always rendered at loDPI resolution and upscaled by OS when required. @@ -1119,7 +1119,7 @@ If ``true``, the application is rendered at native display resolution, otherwise .. rst-class:: classref-property -:ref:`int` **export/distribution_type** +:ref:`int` **export/distribution_type** :ref:`🔗` Application distribution target. @@ -1131,7 +1131,7 @@ Application distribution target. .. rst-class:: classref-property -:ref:`String` **notarization/api_key** +:ref:`String` **notarization/api_key** :ref:`🔗` Apple App Store Connect API issuer key file. @@ -1145,7 +1145,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_API_K .. rst-class:: classref-property -:ref:`String` **notarization/api_key_id** +:ref:`String` **notarization/api_key_id** :ref:`🔗` Apple App Store Connect API issuer key ID. @@ -1159,7 +1159,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_API_K .. rst-class:: classref-property -:ref:`String` **notarization/api_uuid** +:ref:`String` **notarization/api_uuid** :ref:`🔗` Apple App Store Connect API issuer UUID. @@ -1173,7 +1173,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_API_U .. rst-class:: classref-property -:ref:`String` **notarization/apple_id_name** +:ref:`String` **notarization/apple_id_name** :ref:`🔗` Apple ID account name (email address). @@ -1187,7 +1187,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_APPLE .. rst-class:: classref-property -:ref:`String` **notarization/apple_id_password** +:ref:`String` **notarization/apple_id_password** :ref:`🔗` Apple ID app-specific password. @@ -1201,7 +1201,7 @@ Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_APPLE .. rst-class:: classref-property -:ref:`int` **notarization/notarization** +:ref:`int` **notarization/notarization** :ref:`🔗` Tool to use for notarization. @@ -1213,7 +1213,7 @@ Tool to use for notarization. .. rst-class:: classref-property -:ref:`String` **privacy/address_book_usage_description** +:ref:`String` **privacy/address_book_usage_description** :ref:`🔗` A message displayed when requesting access to the user's contacts (in English). @@ -1225,7 +1225,7 @@ A message displayed when requesting access to the user's contacts (in English). .. rst-class:: classref-property -:ref:`Dictionary` **privacy/address_book_usage_description_localized** +:ref:`Dictionary` **privacy/address_book_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's contacts (localized). @@ -1237,7 +1237,7 @@ A message displayed when requesting access to the user's contacts (localized). .. rst-class:: classref-property -:ref:`String` **privacy/calendar_usage_description** +:ref:`String` **privacy/calendar_usage_description** :ref:`🔗` A message displayed when requesting access to the user's calendar data (in English). @@ -1249,7 +1249,7 @@ A message displayed when requesting access to the user's calendar data (in Engli .. rst-class:: classref-property -:ref:`Dictionary` **privacy/calendar_usage_description_localized** +:ref:`Dictionary` **privacy/calendar_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's calendar data (localized). @@ -1261,7 +1261,7 @@ A message displayed when requesting access to the user's calendar data (localize .. rst-class:: classref-property -:ref:`String` **privacy/camera_usage_description** +:ref:`String` **privacy/camera_usage_description** :ref:`🔗` A message displayed when requesting access to the device's camera (in English). @@ -1273,7 +1273,7 @@ A message displayed when requesting access to the device's camera (in English). .. rst-class:: classref-property -:ref:`Dictionary` **privacy/camera_usage_description_localized** +:ref:`Dictionary` **privacy/camera_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the device's camera (localized). @@ -1285,7 +1285,7 @@ A message displayed when requesting access to the device's camera (localized). .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/advertising_data/collected** +:ref:`bool` **privacy/collected_data/advertising_data/collected** :ref:`🔗` Indicates whether your app collects advertising data. @@ -1297,7 +1297,7 @@ Indicates whether your app collects advertising data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** +:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** :ref:`🔗` The reasons your app collects advertising data. See `Describing data use in privacy manifests `__. @@ -1309,7 +1309,7 @@ The reasons your app collects advertising data. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** +:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** :ref:`🔗` Indicates whether your app links advertising data to the user's identity. @@ -1321,7 +1321,7 @@ Indicates whether your app links advertising data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses advertising data for tracking. @@ -1333,7 +1333,7 @@ Indicates whether your app uses advertising data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/audio_data/collected** +:ref:`bool` **privacy/collected_data/audio_data/collected** :ref:`🔗` Indicates whether your app collects audio data data. @@ -1345,7 +1345,7 @@ Indicates whether your app collects audio data data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/audio_data/collection_purposes** +:ref:`int` **privacy/collected_data/audio_data/collection_purposes** :ref:`🔗` The reasons your app collects audio data. See `Describing data use in privacy manifests `__. @@ -1357,7 +1357,7 @@ The reasons your app collects audio data. See `Describing data use in privacy ma .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** +:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** :ref:`🔗` Indicates whether your app links audio data data to the user's identity. @@ -1369,7 +1369,7 @@ Indicates whether your app links audio data data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses audio data data for tracking. @@ -1381,7 +1381,7 @@ Indicates whether your app uses audio data data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/browsing_history/collected** +:ref:`bool` **privacy/collected_data/browsing_history/collected** :ref:`🔗` Indicates whether your app collects browsing history. @@ -1393,7 +1393,7 @@ Indicates whether your app collects browsing history. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** +:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** :ref:`🔗` The reasons your app collects browsing history. See `Describing data use in privacy manifests `__. @@ -1405,7 +1405,7 @@ The reasons your app collects browsing history. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** +:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** :ref:`🔗` Indicates whether your app links browsing history to the user's identity. @@ -1417,7 +1417,7 @@ Indicates whether your app links browsing history to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** +:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses browsing history for tracking. @@ -1429,7 +1429,7 @@ Indicates whether your app uses browsing history for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/coarse_location/collected** +:ref:`bool` **privacy/collected_data/coarse_location/collected** :ref:`🔗` Indicates whether your app collects coarse location data. @@ -1441,7 +1441,7 @@ Indicates whether your app collects coarse location data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** +:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** :ref:`🔗` The reasons your app collects coarse location data. See `Describing data use in privacy manifests `__. @@ -1453,7 +1453,7 @@ The reasons your app collects coarse location data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** +:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** :ref:`🔗` Indicates whether your app links coarse location data to the user's identity. @@ -1465,7 +1465,7 @@ Indicates whether your app links coarse location data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** +:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** :ref:`🔗` Indicates whether your app uses coarse location data for tracking. @@ -1477,7 +1477,7 @@ Indicates whether your app uses coarse location data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/contacts/collected** +:ref:`bool` **privacy/collected_data/contacts/collected** :ref:`🔗` Indicates whether your app collects contacts. @@ -1489,7 +1489,7 @@ Indicates whether your app collects contacts. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/contacts/collection_purposes** +:ref:`int` **privacy/collected_data/contacts/collection_purposes** :ref:`🔗` The reasons your app collects contacts. See `Describing data use in privacy manifests `__. @@ -1501,7 +1501,7 @@ The reasons your app collects contacts. See `Describing data use in privacy mani .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/contacts/linked_to_user** +:ref:`bool` **privacy/collected_data/contacts/linked_to_user** :ref:`🔗` Indicates whether your app links contacts to the user's identity. @@ -1513,7 +1513,7 @@ Indicates whether your app links contacts to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** +:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** :ref:`🔗` Indicates whether your app uses contacts for tracking. @@ -1525,7 +1525,7 @@ Indicates whether your app uses contacts for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/crash_data/collected** +:ref:`bool` **privacy/collected_data/crash_data/collected** :ref:`🔗` Indicates whether your app collects crash data. @@ -1537,7 +1537,7 @@ Indicates whether your app collects crash data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/crash_data/collection_purposes** +:ref:`int` **privacy/collected_data/crash_data/collection_purposes** :ref:`🔗` The reasons your app collects crash data. See `Describing data use in privacy manifests `__. @@ -1549,7 +1549,7 @@ The reasons your app collects crash data. See `Describing data use in privacy ma .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** +:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** :ref:`🔗` Indicates whether your app links crash data to the user's identity. @@ -1561,7 +1561,7 @@ Indicates whether your app links crash data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses crash data for tracking. @@ -1573,7 +1573,7 @@ Indicates whether your app uses crash data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/credit_info/collected** +:ref:`bool` **privacy/collected_data/credit_info/collected** :ref:`🔗` Indicates whether your app collects credit information. @@ -1585,7 +1585,7 @@ Indicates whether your app collects credit information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/credit_info/collection_purposes** +:ref:`int` **privacy/collected_data/credit_info/collection_purposes** :ref:`🔗` The reasons your app collects credit information. See `Describing data use in privacy manifests `__. @@ -1597,7 +1597,7 @@ The reasons your app collects credit information. See `Describing data use in pr .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** +:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** :ref:`🔗` Indicates whether your app links credit information to the user's identity. @@ -1609,7 +1609,7 @@ Indicates whether your app links credit information to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses credit information for tracking. @@ -1621,7 +1621,7 @@ Indicates whether your app uses credit information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/customer_support/collected** +:ref:`bool` **privacy/collected_data/customer_support/collected** :ref:`🔗` Indicates whether your app collects customer support data. @@ -1633,7 +1633,7 @@ Indicates whether your app collects customer support data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/customer_support/collection_purposes** +:ref:`int` **privacy/collected_data/customer_support/collection_purposes** :ref:`🔗` The reasons your app collects customer support data. See `Describing data use in privacy manifests `__. @@ -1645,7 +1645,7 @@ The reasons your app collects customer support data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** +:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** :ref:`🔗` Indicates whether your app links customer support data to the user's identity. @@ -1657,7 +1657,7 @@ Indicates whether your app links customer support data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** +:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** :ref:`🔗` Indicates whether your app uses customer support data for tracking. @@ -1669,7 +1669,7 @@ Indicates whether your app uses customer support data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/device_id/collected** +:ref:`bool` **privacy/collected_data/device_id/collected** :ref:`🔗` Indicates whether your app collects device IDs. @@ -1681,7 +1681,7 @@ Indicates whether your app collects device IDs. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/device_id/collection_purposes** +:ref:`int` **privacy/collected_data/device_id/collection_purposes** :ref:`🔗` The reasons your app collects device IDs. See `Describing data use in privacy manifests `__. @@ -1693,7 +1693,7 @@ The reasons your app collects device IDs. See `Describing data use in privacy ma .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/device_id/linked_to_user** +:ref:`bool` **privacy/collected_data/device_id/linked_to_user** :ref:`🔗` Indicates whether your app links device IDs to the user's identity. @@ -1705,7 +1705,7 @@ Indicates whether your app links device IDs to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** +:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** :ref:`🔗` Indicates whether your app uses device IDs for tracking. @@ -1717,7 +1717,7 @@ Indicates whether your app uses device IDs for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/email_address/collected** +:ref:`bool` **privacy/collected_data/email_address/collected** :ref:`🔗` Indicates whether your app collects email address. @@ -1729,7 +1729,7 @@ Indicates whether your app collects email address. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/email_address/collection_purposes** +:ref:`int` **privacy/collected_data/email_address/collection_purposes** :ref:`🔗` The reasons your app collects email address. See `Describing data use in privacy manifests `__. @@ -1741,7 +1741,7 @@ The reasons your app collects email address. See `Describing data use in privacy .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/email_address/linked_to_user** +:ref:`bool` **privacy/collected_data/email_address/linked_to_user** :ref:`🔗` Indicates whether your app links email address to the user's identity. @@ -1753,7 +1753,7 @@ Indicates whether your app links email address to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** +:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** :ref:`🔗` Indicates whether your app uses email address for tracking. @@ -1765,7 +1765,7 @@ Indicates whether your app uses email address for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** +:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** :ref:`🔗` Indicates whether your app collects emails or text messages. @@ -1777,7 +1777,7 @@ Indicates whether your app collects emails or text messages. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** +:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** :ref:`🔗` The reasons your app collects emails or text messages. See `Describing data use in privacy manifests `__. @@ -1789,7 +1789,7 @@ The reasons your app collects emails or text messages. See `Describing data use .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** +:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** :ref:`🔗` Indicates whether your app links emails or text messages to the user's identity. @@ -1801,7 +1801,7 @@ Indicates whether your app links emails or text messages to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** +:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** :ref:`🔗` Indicates whether your app uses emails or text messages for tracking. @@ -1813,7 +1813,7 @@ Indicates whether your app uses emails or text messages for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/environment_scanning/collected** +:ref:`bool` **privacy/collected_data/environment_scanning/collected** :ref:`🔗` Indicates whether your app collects environment scanning data. @@ -1825,7 +1825,7 @@ Indicates whether your app collects environment scanning data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** +:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** :ref:`🔗` The reasons your app collects environment scanning data. See `Describing data use in privacy manifests `__. @@ -1837,7 +1837,7 @@ The reasons your app collects environment scanning data. See `Describing data us .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** +:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** :ref:`🔗` Indicates whether your app links environment scanning data to the user's identity. @@ -1849,7 +1849,7 @@ Indicates whether your app links environment scanning data to the user's identit .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** +:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** :ref:`🔗` Indicates whether your app uses environment scanning data for tracking. @@ -1861,7 +1861,7 @@ Indicates whether your app uses environment scanning data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/fitness/collected** +:ref:`bool` **privacy/collected_data/fitness/collected** :ref:`🔗` Indicates whether your app collects fitness and exercise data. @@ -1873,7 +1873,7 @@ Indicates whether your app collects fitness and exercise data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/fitness/collection_purposes** +:ref:`int` **privacy/collected_data/fitness/collection_purposes** :ref:`🔗` The reasons your app collects fitness and exercise data. See `Describing data use in privacy manifests `__. @@ -1885,7 +1885,7 @@ The reasons your app collects fitness and exercise data. See `Describing data us .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/fitness/linked_to_user** +:ref:`bool` **privacy/collected_data/fitness/linked_to_user** :ref:`🔗` Indicates whether your app links fitness and exercise data to the user's identity. @@ -1897,7 +1897,7 @@ Indicates whether your app links fitness and exercise data to the user's identit .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** +:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** :ref:`🔗` Indicates whether your app uses fitness and exercise data for tracking. @@ -1909,7 +1909,7 @@ Indicates whether your app uses fitness and exercise data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/gameplay_content/collected** +:ref:`bool` **privacy/collected_data/gameplay_content/collected** :ref:`🔗` Indicates whether your app collects gameplay content. @@ -1921,7 +1921,7 @@ Indicates whether your app collects gameplay content. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** +:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** :ref:`🔗` The reasons your app collects gameplay content. See `Describing data use in privacy manifests `__. @@ -1933,7 +1933,7 @@ The reasons your app collects gameplay content. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** +:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** :ref:`🔗` Indicates whether your app links gameplay content to the user's identity. @@ -1945,7 +1945,7 @@ Indicates whether your app links gameplay content to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** +:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** :ref:`🔗` Indicates whether your app uses gameplay content for tracking. @@ -1957,7 +1957,7 @@ Indicates whether your app uses gameplay content for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/hands/collected** +:ref:`bool` **privacy/collected_data/hands/collected** :ref:`🔗` Indicates whether your app collects user's hand structure and hand movements. @@ -1969,7 +1969,7 @@ Indicates whether your app collects user's hand structure and hand movements. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/hands/collection_purposes** +:ref:`int` **privacy/collected_data/hands/collection_purposes** :ref:`🔗` The reasons your app collects user's hand structure and hand movements. See `Describing data use in privacy manifests `__. @@ -1981,7 +1981,7 @@ The reasons your app collects user's hand structure and hand movements. See `Des .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/hands/linked_to_user** +:ref:`bool` **privacy/collected_data/hands/linked_to_user** :ref:`🔗` Indicates whether your app links user's hand structure and hand movements to the user's identity. @@ -1993,7 +1993,7 @@ Indicates whether your app links user's hand structure and hand movements to the .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/hands/used_for_tracking** +:ref:`bool` **privacy/collected_data/hands/used_for_tracking** :ref:`🔗` Indicates whether your app uses user's hand structure and hand movements for tracking. @@ -2005,7 +2005,7 @@ Indicates whether your app uses user's hand structure and hand movements for tra .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/head/collected** +:ref:`bool` **privacy/collected_data/head/collected** :ref:`🔗` Indicates whether your app collects user's head movement. @@ -2017,7 +2017,7 @@ Indicates whether your app collects user's head movement. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/head/collection_purposes** +:ref:`int` **privacy/collected_data/head/collection_purposes** :ref:`🔗` The reasons your app collects user's head movement. See `Describing data use in privacy manifests `__. @@ -2029,7 +2029,7 @@ The reasons your app collects user's head movement. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/head/linked_to_user** +:ref:`bool` **privacy/collected_data/head/linked_to_user** :ref:`🔗` Indicates whether your app links user's head movement to the user's identity. @@ -2041,7 +2041,7 @@ Indicates whether your app links user's head movement to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/head/used_for_tracking** +:ref:`bool` **privacy/collected_data/head/used_for_tracking** :ref:`🔗` Indicates whether your app uses user's head movement for tracking. @@ -2053,7 +2053,7 @@ Indicates whether your app uses user's head movement for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/health/collected** +:ref:`bool` **privacy/collected_data/health/collected** :ref:`🔗` Indicates whether your app collects health and medical data. @@ -2065,7 +2065,7 @@ Indicates whether your app collects health and medical data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/health/collection_purposes** +:ref:`int` **privacy/collected_data/health/collection_purposes** :ref:`🔗` The reasons your app collects health and medical data. See `Describing data use in privacy manifests `__. @@ -2077,7 +2077,7 @@ The reasons your app collects health and medical data. See `Describing data use .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/health/linked_to_user** +:ref:`bool` **privacy/collected_data/health/linked_to_user** :ref:`🔗` Indicates whether your app links health and medical data to the user's identity. @@ -2089,7 +2089,7 @@ Indicates whether your app links health and medical data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/health/used_for_tracking** +:ref:`bool` **privacy/collected_data/health/used_for_tracking** :ref:`🔗` Indicates whether your app uses health and medical data for tracking. @@ -2101,7 +2101,7 @@ Indicates whether your app uses health and medical data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/name/collected** +:ref:`bool` **privacy/collected_data/name/collected** :ref:`🔗` Indicates whether your app collects user's name. @@ -2113,7 +2113,7 @@ Indicates whether your app collects user's name. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/name/collection_purposes** +:ref:`int` **privacy/collected_data/name/collection_purposes** :ref:`🔗` The reasons your app collects user's name. See `Describing data use in privacy manifests `__. @@ -2125,7 +2125,7 @@ The reasons your app collects user's name. See `Describing data use in privacy m .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/name/linked_to_user** +:ref:`bool` **privacy/collected_data/name/linked_to_user** :ref:`🔗` Indicates whether your app links user's name to the user's identity. @@ -2137,7 +2137,7 @@ Indicates whether your app links user's name to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/name/used_for_tracking** +:ref:`bool` **privacy/collected_data/name/used_for_tracking** :ref:`🔗` Indicates whether your app uses user's name for tracking. @@ -2149,7 +2149,7 @@ Indicates whether your app uses user's name for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_contact_info/collected** +:ref:`bool` **privacy/collected_data/other_contact_info/collected** :ref:`🔗` Indicates whether your app collects any other contact information. @@ -2161,7 +2161,7 @@ Indicates whether your app collects any other contact information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** +:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** :ref:`🔗` The reasons your app collects any other contact information. See `Describing data use in privacy manifests `__. @@ -2173,7 +2173,7 @@ The reasons your app collects any other contact information. See `Describing dat .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** +:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** :ref:`🔗` Indicates whether your app links any other contact information to the user's identity. @@ -2185,7 +2185,7 @@ Indicates whether your app links any other contact information to the user's ide .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other contact information for tracking. @@ -2197,7 +2197,7 @@ Indicates whether your app uses any other contact information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_data_types/collected** +:ref:`bool` **privacy/collected_data/other_data_types/collected** :ref:`🔗` Indicates whether your app collects any other data. @@ -2209,7 +2209,7 @@ Indicates whether your app collects any other data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** +:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** :ref:`🔗` The reasons your app collects any other data. See `Describing data use in privacy manifests `__. @@ -2221,7 +2221,7 @@ The reasons your app collects any other data. See `Describing data use in privac .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** +:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** :ref:`🔗` Indicates whether your app links any other data to the user's identity. @@ -2233,7 +2233,7 @@ Indicates whether your app links any other data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other data for tracking. @@ -2245,7 +2245,7 @@ Indicates whether your app uses any other data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** +:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** :ref:`🔗` Indicates whether your app collects any other diagnostic data. @@ -2257,7 +2257,7 @@ Indicates whether your app collects any other diagnostic data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** +:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** :ref:`🔗` The reasons your app collects any other diagnostic data. See `Describing data use in privacy manifests `__. @@ -2269,7 +2269,7 @@ The reasons your app collects any other diagnostic data. See `Describing data us .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** +:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** :ref:`🔗` Indicates whether your app links any other diagnostic data to the user's identity. @@ -2281,7 +2281,7 @@ Indicates whether your app links any other diagnostic data to the user's identit .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other diagnostic data for tracking. @@ -2293,7 +2293,7 @@ Indicates whether your app uses any other diagnostic data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_financial_info/collected** +:ref:`bool` **privacy/collected_data/other_financial_info/collected** :ref:`🔗` Indicates whether your app collects any other financial information. @@ -2305,7 +2305,7 @@ Indicates whether your app collects any other financial information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** +:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** :ref:`🔗` The reasons your app collects any other financial information. See `Describing data use in privacy manifests `__. @@ -2317,7 +2317,7 @@ The reasons your app collects any other financial information. See `Describing d .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** +:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** :ref:`🔗` Indicates whether your app links any other financial information to the user's identity. @@ -2329,7 +2329,7 @@ Indicates whether your app links any other financial information to the user's i .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other financial information for tracking. @@ -2341,7 +2341,7 @@ Indicates whether your app uses any other financial information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_usage_data/collected** +:ref:`bool` **privacy/collected_data/other_usage_data/collected** :ref:`🔗` Indicates whether your app collects any other usage data. @@ -2353,7 +2353,7 @@ Indicates whether your app collects any other usage data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** +:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** :ref:`🔗` The reasons your app collects any other usage data. See `Describing data use in privacy manifests `__. @@ -2365,7 +2365,7 @@ The reasons your app collects any other usage data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** +:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** :ref:`🔗` Indicates whether your app links any other usage data to the user's identity. @@ -2377,7 +2377,7 @@ Indicates whether your app links any other usage data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other usage data for tracking. @@ -2389,7 +2389,7 @@ Indicates whether your app uses any other usage data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_user_content/collected** +:ref:`bool` **privacy/collected_data/other_user_content/collected** :ref:`🔗` Indicates whether your app collects any other user generated content. @@ -2401,7 +2401,7 @@ Indicates whether your app collects any other user generated content. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** +:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** :ref:`🔗` The reasons your app collects any other user generated content. See `Describing data use in privacy manifests `__. @@ -2413,7 +2413,7 @@ The reasons your app collects any other user generated content. See `Describing .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** +:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** :ref:`🔗` Indicates whether your app links any other user generated content to the user's identity. @@ -2425,7 +2425,7 @@ Indicates whether your app links any other user generated content to the user's .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** +:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** :ref:`🔗` Indicates whether your app uses any other user generated content for tracking. @@ -2437,7 +2437,7 @@ Indicates whether your app uses any other user generated content for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/payment_info/collected** +:ref:`bool` **privacy/collected_data/payment_info/collected** :ref:`🔗` Indicates whether your app collects payment information. @@ -2449,7 +2449,7 @@ Indicates whether your app collects payment information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/payment_info/collection_purposes** +:ref:`int` **privacy/collected_data/payment_info/collection_purposes** :ref:`🔗` The reasons your app collects payment information. See `Describing data use in privacy manifests `__. @@ -2461,7 +2461,7 @@ The reasons your app collects payment information. See `Describing data use in p .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** +:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** :ref:`🔗` Indicates whether your app links payment information to the user's identity. @@ -2473,7 +2473,7 @@ Indicates whether your app links payment information to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses payment information for tracking. @@ -2485,7 +2485,7 @@ Indicates whether your app uses payment information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/performance_data/collected** +:ref:`bool` **privacy/collected_data/performance_data/collected** :ref:`🔗` Indicates whether your app collects performance data. @@ -2497,7 +2497,7 @@ Indicates whether your app collects performance data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/performance_data/collection_purposes** +:ref:`int` **privacy/collected_data/performance_data/collection_purposes** :ref:`🔗` The reasons your app collects performance data. See `Describing data use in privacy manifests `__. @@ -2509,7 +2509,7 @@ The reasons your app collects performance data. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** +:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** :ref:`🔗` Indicates whether your app links performance data to the user's identity. @@ -2521,7 +2521,7 @@ Indicates whether your app links performance data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** +:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** :ref:`🔗` Indicates whether your app uses performance data for tracking. @@ -2533,7 +2533,7 @@ Indicates whether your app uses performance data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/phone_number/collected** +:ref:`bool` **privacy/collected_data/phone_number/collected** :ref:`🔗` Indicates whether your app collects phone number. @@ -2545,7 +2545,7 @@ Indicates whether your app collects phone number. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/phone_number/collection_purposes** +:ref:`int` **privacy/collected_data/phone_number/collection_purposes** :ref:`🔗` The reasons your app collects phone number. See `Describing data use in privacy manifests `__. @@ -2557,7 +2557,7 @@ The reasons your app collects phone number. See `Describing data use in privacy .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** +:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** :ref:`🔗` Indicates whether your app links phone number to the user's identity. @@ -2569,7 +2569,7 @@ Indicates whether your app links phone number to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** +:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** :ref:`🔗` Indicates whether your app uses phone number for tracking. @@ -2581,7 +2581,7 @@ Indicates whether your app uses phone number for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/photos_or_videos/collected** +:ref:`bool` **privacy/collected_data/photos_or_videos/collected** :ref:`🔗` Indicates whether your app collects photos or videos. @@ -2593,7 +2593,7 @@ Indicates whether your app collects photos or videos. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** +:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** :ref:`🔗` The reasons your app collects photos or videos. See `Describing data use in privacy manifests `__. @@ -2605,7 +2605,7 @@ The reasons your app collects photos or videos. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** +:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** :ref:`🔗` Indicates whether your app links photos or videos to the user's identity. @@ -2617,7 +2617,7 @@ Indicates whether your app links photos or videos to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** +:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** :ref:`🔗` Indicates whether your app uses photos or videos for tracking. @@ -2629,7 +2629,7 @@ Indicates whether your app uses photos or videos for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/physical_address/collected** +:ref:`bool` **privacy/collected_data/physical_address/collected** :ref:`🔗` Indicates whether your app collects physical address. @@ -2641,7 +2641,7 @@ Indicates whether your app collects physical address. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/physical_address/collection_purposes** +:ref:`int` **privacy/collected_data/physical_address/collection_purposes** :ref:`🔗` The reasons your app collects physical address. See `Describing data use in privacy manifests `__. @@ -2653,7 +2653,7 @@ The reasons your app collects physical address. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** +:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** :ref:`🔗` Indicates whether your app links physical address to the user's identity. @@ -2665,7 +2665,7 @@ Indicates whether your app links physical address to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** +:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** :ref:`🔗` Indicates whether your app uses physical address for tracking. @@ -2677,7 +2677,7 @@ Indicates whether your app uses physical address for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/precise_location/collected** +:ref:`bool` **privacy/collected_data/precise_location/collected** :ref:`🔗` Indicates whether your app collects precise location data. @@ -2689,7 +2689,7 @@ Indicates whether your app collects precise location data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/precise_location/collection_purposes** +:ref:`int` **privacy/collected_data/precise_location/collection_purposes** :ref:`🔗` The reasons your app collects precise location data. See `Describing data use in privacy manifests `__. @@ -2701,7 +2701,7 @@ The reasons your app collects precise location data. See `Describing data use in .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** +:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** :ref:`🔗` Indicates whether your app links precise location data to the user's identity. @@ -2713,7 +2713,7 @@ Indicates whether your app links precise location data to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** +:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** :ref:`🔗` Indicates whether your app uses precise location data for tracking. @@ -2725,7 +2725,7 @@ Indicates whether your app uses precise location data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/product_interaction/collected** +:ref:`bool` **privacy/collected_data/product_interaction/collected** :ref:`🔗` Indicates whether your app collects product interaction data. @@ -2737,7 +2737,7 @@ Indicates whether your app collects product interaction data. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** +:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** :ref:`🔗` The reasons your app collects product interaction data. See `Describing data use in privacy manifests `__. @@ -2749,7 +2749,7 @@ The reasons your app collects product interaction data. See `Describing data use .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** +:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** :ref:`🔗` Indicates whether your app links product interaction data to the user's identity. @@ -2761,7 +2761,7 @@ Indicates whether your app links product interaction data to the user's identity .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** +:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** :ref:`🔗` Indicates whether your app uses product interaction data for tracking. @@ -2773,7 +2773,7 @@ Indicates whether your app uses product interaction data for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/purchase_history/collected** +:ref:`bool` **privacy/collected_data/purchase_history/collected** :ref:`🔗` Indicates whether your app collects purchase history. @@ -2785,7 +2785,7 @@ Indicates whether your app collects purchase history. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** +:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** :ref:`🔗` The reasons your app collects purchase history. See `Describing data use in privacy manifests `__. @@ -2797,7 +2797,7 @@ The reasons your app collects purchase history. See `Describing data use in priv .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** +:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** :ref:`🔗` Indicates whether your app links purchase history to the user's identity. @@ -2809,7 +2809,7 @@ Indicates whether your app links purchase history to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** +:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses purchase history for tracking. @@ -2821,7 +2821,7 @@ Indicates whether your app uses purchase history for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/collected** +:ref:`bool` **privacy/collected_data/search_hhistory/collected** :ref:`🔗` Indicates whether your app collects search history. @@ -2833,7 +2833,7 @@ Indicates whether your app collects search history. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** +:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** :ref:`🔗` The reasons your app collects search history. See `Describing data use in privacy manifests `__. @@ -2845,7 +2845,7 @@ The reasons your app collects search history. See `Describing data use in privac .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** +:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** :ref:`🔗` Indicates whether your app links search history to the user's identity. @@ -2857,7 +2857,7 @@ Indicates whether your app links search history to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** +:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** :ref:`🔗` Indicates whether your app uses search history for tracking. @@ -2869,7 +2869,7 @@ Indicates whether your app uses search history for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/sensitive_info/collected** +:ref:`bool` **privacy/collected_data/sensitive_info/collected** :ref:`🔗` Indicates whether your app collects sensitive user information. @@ -2881,7 +2881,7 @@ Indicates whether your app collects sensitive user information. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** +:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** :ref:`🔗` The reasons your app collects sensitive user information. See `Describing data use in privacy manifests `__. @@ -2893,7 +2893,7 @@ The reasons your app collects sensitive user information. See `Describing data u .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** +:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** :ref:`🔗` Indicates whether your app links sensitive user information to the user's identity. @@ -2905,7 +2905,7 @@ Indicates whether your app links sensitive user information to the user's identi .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** +:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** :ref:`🔗` Indicates whether your app uses sensitive user information for tracking. @@ -2917,7 +2917,7 @@ Indicates whether your app uses sensitive user information for tracking. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/user_id/collected** +:ref:`bool` **privacy/collected_data/user_id/collected** :ref:`🔗` Indicates whether your app collects user IDs. @@ -2929,7 +2929,7 @@ Indicates whether your app collects user IDs. .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/user_id/collection_purposes** +:ref:`int` **privacy/collected_data/user_id/collection_purposes** :ref:`🔗` The reasons your app collects user IDs. See `Describing data use in privacy manifests `__. @@ -2941,7 +2941,7 @@ The reasons your app collects user IDs. See `Describing data use in privacy mani .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/user_id/linked_to_user** +:ref:`bool` **privacy/collected_data/user_id/linked_to_user** :ref:`🔗` Indicates whether your app links user IDs to the user's identity. @@ -2953,7 +2953,7 @@ Indicates whether your app links user IDs to the user's identity. .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** +:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** :ref:`🔗` Indicates whether your app uses user IDs for tracking. @@ -2965,7 +2965,7 @@ Indicates whether your app uses user IDs for tracking. .. rst-class:: classref-property -:ref:`String` **privacy/desktop_folder_usage_description** +:ref:`String` **privacy/desktop_folder_usage_description** :ref:`🔗` A message displayed when requesting access to the user's "Desktop" folder (in English). @@ -2977,7 +2977,7 @@ A message displayed when requesting access to the user's "Desktop" folder (in En .. rst-class:: classref-property -:ref:`Dictionary` **privacy/desktop_folder_usage_description_localized** +:ref:`Dictionary` **privacy/desktop_folder_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's "Desktop" folder (localized). @@ -2989,7 +2989,7 @@ A message displayed when requesting access to the user's "Desktop" folder (local .. rst-class:: classref-property -:ref:`String` **privacy/documents_folder_usage_description** +:ref:`String` **privacy/documents_folder_usage_description** :ref:`🔗` A message displayed when requesting access to the user's "Documents" folder (in English). @@ -3001,7 +3001,7 @@ A message displayed when requesting access to the user's "Documents" folder (in .. rst-class:: classref-property -:ref:`Dictionary` **privacy/documents_folder_usage_description_localized** +:ref:`Dictionary` **privacy/documents_folder_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's "Documents" folder (localized). @@ -3013,7 +3013,7 @@ A message displayed when requesting access to the user's "Documents" folder (loc .. rst-class:: classref-property -:ref:`String` **privacy/downloads_folder_usage_description** +:ref:`String` **privacy/downloads_folder_usage_description** :ref:`🔗` A message displayed when requesting access to the user's "Downloads" folder (in English). @@ -3025,7 +3025,7 @@ A message displayed when requesting access to the user's "Downloads" folder (in .. rst-class:: classref-property -:ref:`Dictionary` **privacy/downloads_folder_usage_description_localized** +:ref:`Dictionary` **privacy/downloads_folder_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's "Downloads" folder (localized). @@ -3037,7 +3037,7 @@ A message displayed when requesting access to the user's "Downloads" folder (loc .. rst-class:: classref-property -:ref:`String` **privacy/location_usage_description** +:ref:`String` **privacy/location_usage_description** :ref:`🔗` A message displayed when requesting access to the user's location information (in English). @@ -3049,7 +3049,7 @@ A message displayed when requesting access to the user's location information (i .. rst-class:: classref-property -:ref:`Dictionary` **privacy/location_usage_description_localized** +:ref:`Dictionary` **privacy/location_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's location information (localized). @@ -3061,7 +3061,7 @@ A message displayed when requesting access to the user's location information (l .. rst-class:: classref-property -:ref:`String` **privacy/microphone_usage_description** +:ref:`String` **privacy/microphone_usage_description** :ref:`🔗` A message displayed when requesting access to the device's microphone (in English). @@ -3073,7 +3073,7 @@ A message displayed when requesting access to the device's microphone (in Englis .. rst-class:: classref-property -:ref:`Dictionary` **privacy/microphone_usage_description_localized** +:ref:`Dictionary` **privacy/microphone_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the device's microphone (localized). @@ -3085,7 +3085,7 @@ A message displayed when requesting access to the device's microphone (localized .. rst-class:: classref-property -:ref:`String` **privacy/network_volumes_usage_description** +:ref:`String` **privacy/network_volumes_usage_description** :ref:`🔗` A message displayed when requesting access to the user's network drives (in English). @@ -3097,7 +3097,7 @@ A message displayed when requesting access to the user's network drives (in Engl .. rst-class:: classref-property -:ref:`Dictionary` **privacy/network_volumes_usage_description_localized** +:ref:`Dictionary` **privacy/network_volumes_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's network drives (localized). @@ -3109,7 +3109,7 @@ A message displayed when requesting access to the user's network drives (localiz .. rst-class:: classref-property -:ref:`String` **privacy/photos_library_usage_description** +:ref:`String` **privacy/photos_library_usage_description** :ref:`🔗` A message displayed when requesting access to the user's photo library (in English). @@ -3121,7 +3121,7 @@ A message displayed when requesting access to the user's photo library (in Engli .. rst-class:: classref-property -:ref:`Dictionary` **privacy/photos_library_usage_description_localized** +:ref:`Dictionary` **privacy/photos_library_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's photo library (localized). @@ -3133,7 +3133,7 @@ A message displayed when requesting access to the user's photo library (localize .. rst-class:: classref-property -:ref:`String` **privacy/removable_volumes_usage_description** +:ref:`String` **privacy/removable_volumes_usage_description** :ref:`🔗` A message displayed when requesting access to the user's removable drives (in English). @@ -3145,7 +3145,7 @@ A message displayed when requesting access to the user's removable drives (in En .. rst-class:: classref-property -:ref:`Dictionary` **privacy/removable_volumes_usage_description_localized** +:ref:`Dictionary` **privacy/removable_volumes_usage_description_localized** :ref:`🔗` A message displayed when requesting access to the user's removable drives (localized). @@ -3157,7 +3157,7 @@ A message displayed when requesting access to the user's removable drives (local .. rst-class:: classref-property -:ref:`PackedStringArray` **privacy/tracking_domains** +:ref:`PackedStringArray` **privacy/tracking_domains** :ref:`🔗` The list of internet domains your app connects to that engage in tracking. See `Privacy manifest files `__. @@ -3171,7 +3171,7 @@ The list of internet domains your app connects to that engage in tracking. See ` .. rst-class:: classref-property -:ref:`bool` **privacy/tracking_enabled** +:ref:`bool` **privacy/tracking_enabled** :ref:`🔗` Indicates whether your app uses data for tracking. See `Privacy manifest files `__. @@ -3183,7 +3183,7 @@ Indicates whether your app uses data for tracking. See `Privacy manifest files < .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/cleanup_script** +:ref:`String` **ssh_remote_deploy/cleanup_script** :ref:`🔗` Script code to execute on the remote host when app is finished. @@ -3205,7 +3205,7 @@ The following variables can be used in the script: .. rst-class:: classref-property -:ref:`bool` **ssh_remote_deploy/enabled** +:ref:`bool` **ssh_remote_deploy/enabled** :ref:`🔗` Enables remote deploy using SSH/SCP. @@ -3217,7 +3217,7 @@ Enables remote deploy using SSH/SCP. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/extra_args_scp** +:ref:`String` **ssh_remote_deploy/extra_args_scp** :ref:`🔗` Array of the additional command line arguments passed to the SCP. @@ -3229,7 +3229,7 @@ Array of the additional command line arguments passed to the SCP. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/extra_args_ssh** +:ref:`String` **ssh_remote_deploy/extra_args_ssh** :ref:`🔗` Array of the additional command line arguments passed to the SSH. @@ -3241,7 +3241,7 @@ Array of the additional command line arguments passed to the SSH. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/host** +:ref:`String` **ssh_remote_deploy/host** :ref:`🔗` Remote host SSH user name and address, in ``user@address`` format. @@ -3253,7 +3253,7 @@ Remote host SSH user name and address, in ``user@address`` format. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/port** +:ref:`String` **ssh_remote_deploy/port** :ref:`🔗` Remote host SSH port number. @@ -3265,7 +3265,7 @@ Remote host SSH port number. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/run_script** +:ref:`String` **ssh_remote_deploy/run_script** :ref:`🔗` Script code to execute on the remote host when running the app. @@ -3287,7 +3287,7 @@ The following variables can be used in the script: .. rst-class:: classref-property -:ref:`String` **xcode/platform_build** +:ref:`String` **xcode/platform_build** :ref:`🔗` macOS build number used to build application executable. @@ -3299,7 +3299,7 @@ macOS build number used to build application executable. .. rst-class:: classref-property -:ref:`String` **xcode/sdk_build** +:ref:`String` **xcode/sdk_build** :ref:`🔗` macOS SDK build number used to build application executable. @@ -3311,7 +3311,7 @@ macOS SDK build number used to build application executable. .. rst-class:: classref-property -:ref:`String` **xcode/sdk_name** +:ref:`String` **xcode/sdk_name** :ref:`🔗` macOS SDK name used to build application executable. @@ -3323,7 +3323,7 @@ macOS SDK name used to build application executable. .. rst-class:: classref-property -:ref:`String` **xcode/sdk_version** +:ref:`String` **xcode/sdk_version** :ref:`🔗` macOS SDK version used to build application executable in the ``major.minor`` format. @@ -3335,7 +3335,7 @@ macOS SDK version used to build application executable in the ``major.minor`` fo .. rst-class:: classref-property -:ref:`String` **xcode/xcode_build** +:ref:`String` **xcode/xcode_build** :ref:`🔗` Xcode build number used to build application executable. @@ -3347,7 +3347,7 @@ Xcode build number used to build application executable. .. rst-class:: classref-property -:ref:`String` **xcode/xcode_version** +:ref:`String` **xcode/xcode_version** :ref:`🔗` Xcode version used to build application executable. diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst index 4107f7b059c..e1dbc07c3e0 100644 --- a/classes/class_editorexportplatformweb.rst +++ b/classes/class_editorexportplatformweb.rst @@ -97,7 +97,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **custom_template/debug** +:ref:`String` **custom_template/debug** :ref:`🔗` File path to the custom export template used for debug builds. If left empty, the default template is used. @@ -109,7 +109,7 @@ File path to the custom export template used for debug builds. If left empty, th .. rst-class:: classref-property -:ref:`String` **custom_template/release** +:ref:`String` **custom_template/release** :ref:`🔗` File path to the custom export template used for release builds. If left empty, the default template is used. @@ -121,7 +121,7 @@ File path to the custom export template used for release builds. If left empty, .. rst-class:: classref-property -:ref:`int` **html/canvas_resize_policy** +:ref:`int` **html/canvas_resize_policy** :ref:`🔗` Determines how the canvas should be resized by Godot. @@ -139,7 +139,7 @@ Determines how the canvas should be resized by Godot. .. rst-class:: classref-property -:ref:`String` **html/custom_html_shell** +:ref:`String` **html/custom_html_shell** :ref:`🔗` The custom HTML page that wraps the exported web build. If left empty, the default HTML shell is used. @@ -153,7 +153,7 @@ For more information, see the :doc:`Customizing HTML5 Shell <../tutorials/platfo .. rst-class:: classref-property -:ref:`bool` **html/experimental_virtual_keyboard** +:ref:`bool` **html/experimental_virtual_keyboard** :ref:`🔗` **Experimental:** This property may be changed or removed in future versions. @@ -167,7 +167,7 @@ If ``true``, embeds support for a virtual keyboard into the web page, which is s .. rst-class:: classref-property -:ref:`bool` **html/export_icon** +:ref:`bool` **html/export_icon** :ref:`🔗` If ``true``, the project icon will be used as the favicon for this application's web page. @@ -179,7 +179,7 @@ If ``true``, the project icon will be used as the favicon for this application's .. rst-class:: classref-property -:ref:`bool` **html/focus_canvas_on_start** +:ref:`bool` **html/focus_canvas_on_start** :ref:`🔗` If ``true``, the canvas will be focused as soon as the application is loaded, if the browser window is already in focus. @@ -191,7 +191,7 @@ If ``true``, the canvas will be focused as soon as the application is loaded, if .. rst-class:: classref-property -:ref:`String` **html/head_include** +:ref:`String` **html/head_include** :ref:`🔗` Additional HTML tags to include inside the ````, such as ```` tags. @@ -205,7 +205,7 @@ Additional HTML tags to include inside the ````, such as ```` tags. .. rst-class:: classref-property -:ref:`Color` **progressive_web_app/background_color** +:ref:`Color` **progressive_web_app/background_color** :ref:`🔗` The background color used behind the web application. @@ -217,7 +217,7 @@ The background color used behind the web application. .. rst-class:: classref-property -:ref:`int` **progressive_web_app/display** +:ref:`int` **progressive_web_app/display** :ref:`🔗` The `display mode `__ to use for this progressive web application. Different browsers and platforms may not behave the same. @@ -237,7 +237,7 @@ The `display mode ` **progressive_web_app/enabled** +:ref:`bool` **progressive_web_app/enabled** :ref:`🔗` If ``true``, turns this web build into a `progressive web application `__ (PWA). @@ -249,7 +249,7 @@ If ``true``, turns this web build into a `progressive web application ` **progressive_web_app/ensure_cross_origin_isolation_headers** +:ref:`bool` **progressive_web_app/ensure_cross_origin_isolation_headers** :ref:`🔗` When enabled, the progressive web app will make sure that each request has cross-origin isolation headers (COEP/COOP). @@ -263,7 +263,7 @@ This can simplify the setup to serve the exported game. .. rst-class:: classref-property -:ref:`String` **progressive_web_app/icon_144x144** +:ref:`String` **progressive_web_app/icon_144x144** :ref:`🔗` File path to the smallest icon for this web application. If not defined, defaults to the project icon. @@ -277,7 +277,7 @@ File path to the smallest icon for this web application. If not defined, default .. rst-class:: classref-property -:ref:`String` **progressive_web_app/icon_180x180** +:ref:`String` **progressive_web_app/icon_180x180** :ref:`🔗` File path to the small icon for this web application. If not defined, defaults to the project icon. @@ -291,7 +291,7 @@ File path to the small icon for this web application. If not defined, defaults t .. rst-class:: classref-property -:ref:`String` **progressive_web_app/icon_512x512** +:ref:`String` **progressive_web_app/icon_512x512** :ref:`🔗` File path to the smallest icon for this web application. If not defined, defaults to the project icon. @@ -305,7 +305,7 @@ File path to the smallest icon for this web application. If not defined, default .. rst-class:: classref-property -:ref:`String` **progressive_web_app/offline_page** +:ref:`String` **progressive_web_app/offline_page** :ref:`🔗` The page to display, should the server hosting the page not be available. This page is saved in the client's machine. @@ -317,7 +317,7 @@ The page to display, should the server hosting the page not be available. This p .. rst-class:: classref-property -:ref:`int` **progressive_web_app/orientation** +:ref:`int` **progressive_web_app/orientation** :ref:`🔗` The orientation to use when the web application is run through a mobile device. @@ -335,7 +335,7 @@ The orientation to use when the web application is run through a mobile device. .. rst-class:: classref-property -:ref:`bool` **variant/extensions_support** +:ref:`bool` **variant/extensions_support** :ref:`🔗` If ``true`` enables :ref:`GDExtension` support for this web build. @@ -347,7 +347,7 @@ If ``true`` enables :ref:`GDExtension` support for this web b .. rst-class:: classref-property -:ref:`bool` **variant/thread_support** +:ref:`bool` **variant/thread_support** :ref:`🔗` If ``true``, the exported game will support threads. It requires `a "cross-origin isolated" website `__, which may be difficult to set up and is limited for security reasons (such as not being able to communicate with third-party websites). @@ -361,7 +361,7 @@ If ``false``, the exported game will not support threads. As a result, it is mor .. rst-class:: classref-property -:ref:`bool` **vram_texture_compression/for_desktop** +:ref:`bool` **vram_texture_compression/for_desktop** :ref:`🔗` If ``true``, allows textures to be optimized for desktop through the S3TC algorithm. @@ -373,7 +373,7 @@ If ``true``, allows textures to be optimized for desktop through the S3TC algori .. rst-class:: classref-property -:ref:`bool` **vram_texture_compression/for_mobile** +:ref:`bool` **vram_texture_compression/for_mobile** :ref:`🔗` If ``true`` allows textures to be optimized for mobile through the ETC2 algorithm. diff --git a/classes/class_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst index a9b220402cd..d87b04a1227 100644 --- a/classes/class_editorexportplatformwindows.rst +++ b/classes/class_editorexportplatformwindows.rst @@ -125,7 +125,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **application/company_name** +:ref:`String` **application/company_name** :ref:`🔗` Company that produced the application. Required. See `StringFileInfo `__. @@ -137,7 +137,7 @@ Company that produced the application. Required. See `StringFileInfo ` **application/console_wrapper_icon** +:ref:`String` **application/console_wrapper_icon** :ref:`🔗` Console wrapper icon file. If left empty, it will fallback to :ref:`application/icon`, then to :ref:`ProjectSettings.application/config/windows_native_icon`, and lastly, :ref:`ProjectSettings.application/config/icon`. @@ -149,7 +149,7 @@ Console wrapper icon file. If left empty, it will fallback to :ref:`application/ .. rst-class:: classref-property -:ref:`String` **application/copyright** +:ref:`String` **application/copyright** :ref:`🔗` Copyright notice for the bundle visible to the user. Optional. See `StringFileInfo `__. @@ -161,7 +161,7 @@ Copyright notice for the bundle visible to the user. Optional. See `StringFileIn .. rst-class:: classref-property -:ref:`bool` **application/d3d12_agility_sdk_multiarch** +:ref:`bool` **application/d3d12_agility_sdk_multiarch** :ref:`🔗` If ``true``, and :ref:`application/export_d3d12` is set, the Agility SDK DLLs will be stored in arch-specific subdirectories. @@ -173,7 +173,7 @@ If ``true``, and :ref:`application/export_d3d12` **application/export_angle** +:ref:`int` **application/export_angle** :ref:`🔗` If set to ``1``, ANGLE libraries are exported with the exported application. If set to ``0``, ANGLE libraries are exported only if :ref:`ProjectSettings.rendering/gl_compatibility/driver` is set to ``"opengl3_angle"``. @@ -185,7 +185,7 @@ If set to ``1``, ANGLE libraries are exported with the exported application. If .. rst-class:: classref-property -:ref:`int` **application/export_d3d12** +:ref:`int` **application/export_d3d12** :ref:`🔗` If set to ``1``, Direct3D 12 runtime (DXIL, Agility SDK, PIX) libraries are exported with the exported application. If set to ``0``, Direct3D 12 libraries are exported only if :ref:`ProjectSettings.rendering/rendering_device/driver` is set to ``"d3d12"``. @@ -197,7 +197,7 @@ If set to ``1``, Direct3D 12 runtime (DXIL, Agility SDK, PIX) libraries are expo .. rst-class:: classref-property -:ref:`String` **application/file_description** +:ref:`String` **application/file_description** :ref:`🔗` File description to be presented to users. Required. See `StringFileInfo `__. @@ -209,7 +209,7 @@ File description to be presented to users. Required. See `StringFileInfo ` **application/file_version** +:ref:`String` **application/file_version** :ref:`🔗` Version number of the file. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. See `StringFileInfo `__. @@ -221,7 +221,7 @@ Version number of the file. Falls back to :ref:`ProjectSettings.application/conf .. rst-class:: classref-property -:ref:`String` **application/icon** +:ref:`String` **application/icon** :ref:`🔗` Application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/windows_native_icon`, and then to :ref:`ProjectSettings.application/config/icon`. @@ -233,7 +233,7 @@ Application icon file. If left empty, it will fallback to :ref:`ProjectSettings. .. rst-class:: classref-property -:ref:`int` **application/icon_interpolation** +:ref:`int` **application/icon_interpolation** :ref:`🔗` Interpolation method used to resize application icon. @@ -245,7 +245,7 @@ Interpolation method used to resize application icon. .. rst-class:: classref-property -:ref:`bool` **application/modify_resources** +:ref:`bool` **application/modify_resources** :ref:`🔗` If enabled, icon and metadata of the exported executable is set according to the other ``application/*`` values. @@ -257,7 +257,7 @@ If enabled, icon and metadata of the exported executable is set according to the .. rst-class:: classref-property -:ref:`String` **application/product_name** +:ref:`String` **application/product_name** :ref:`🔗` Name of the application. Required. See `StringFileInfo `__. @@ -269,7 +269,7 @@ Name of the application. Required. See `StringFileInfo ` **application/product_version** +:ref:`String` **application/product_version** :ref:`🔗` Application version visible to the user. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. See `StringFileInfo `__. @@ -281,7 +281,7 @@ Application version visible to the user. Falls back to :ref:`ProjectSettings.app .. rst-class:: classref-property -:ref:`String` **application/trademarks** +:ref:`String` **application/trademarks** :ref:`🔗` Trademarks and registered trademarks that apply to the file. Optional. See `StringFileInfo `__. @@ -293,7 +293,7 @@ Trademarks and registered trademarks that apply to the file. Optional. See `Stri .. rst-class:: classref-property -:ref:`String` **binary_format/architecture** +:ref:`String` **binary_format/architecture** :ref:`🔗` Application executable architecture. @@ -309,7 +309,7 @@ Official export templates include ``x86_32`` and ``x86_64`` binaries only. .. rst-class:: classref-property -:ref:`bool` **binary_format/embed_pck** +:ref:`bool` **binary_format/embed_pck** :ref:`🔗` If ``true``, project resources are embedded into the executable. @@ -321,7 +321,7 @@ If ``true``, project resources are embedded into the executable. .. rst-class:: classref-property -:ref:`PackedStringArray` **codesign/custom_options** +:ref:`PackedStringArray` **codesign/custom_options** :ref:`🔗` Array of the additional command line arguments passed to the code signing tool. See `Sign Tool `__. @@ -335,7 +335,7 @@ Array of the additional command line arguments passed to the code signing tool. .. rst-class:: classref-property -:ref:`String` **codesign/description** +:ref:`String` **codesign/description** :ref:`🔗` Description of the signed content. See `Sign Tool `__. @@ -347,7 +347,7 @@ Description of the signed content. See `Sign Tool ` **codesign/digest_algorithm** +:ref:`int` **codesign/digest_algorithm** :ref:`🔗` Digest algorithm to use for creating signature. See `Sign Tool `__. @@ -359,7 +359,7 @@ Digest algorithm to use for creating signature. See `Sign Tool ` **codesign/enable** +:ref:`bool` **codesign/enable** :ref:`🔗` If ``true``, executable signing is enabled. @@ -371,7 +371,7 @@ If ``true``, executable signing is enabled. .. rst-class:: classref-property -:ref:`String` **codesign/identity** +:ref:`String` **codesign/identity** :ref:`🔗` PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if :ref:`codesign/identity_type` is set to "Use certificate store"). See `Sign Tool `__. @@ -385,7 +385,7 @@ Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_IDENTIT .. rst-class:: classref-property -:ref:`int` **codesign/identity_type** +:ref:`int` **codesign/identity_type** :ref:`🔗` Type of identity to use. See `Sign Tool `__. @@ -399,7 +399,7 @@ Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_IDENTIT .. rst-class:: classref-property -:ref:`String` **codesign/password** +:ref:`String` **codesign/password** :ref:`🔗` Password for the certificate file used to sign executable. See `Sign Tool `__. @@ -413,7 +413,7 @@ Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_PASSWOR .. rst-class:: classref-property -:ref:`bool` **codesign/timestamp** +:ref:`bool` **codesign/timestamp** :ref:`🔗` If ``true``, time-stamp is added to the signature. See `Sign Tool `__. @@ -425,7 +425,7 @@ If ``true``, time-stamp is added to the signature. See `Sign Tool ` **codesign/timestamp_server_url** +:ref:`String` **codesign/timestamp_server_url** :ref:`🔗` URL of the time stamp server. If left empty, the default server is used. See `Sign Tool `__. @@ -437,7 +437,7 @@ URL of the time stamp server. If left empty, the default server is used. See `Si .. rst-class:: classref-property -:ref:`String` **custom_template/debug** +:ref:`String` **custom_template/debug** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -449,7 +449,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`String` **custom_template/release** +:ref:`String` **custom_template/release** :ref:`🔗` Path to the custom export template. If left empty, default template is used. @@ -461,7 +461,7 @@ Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-property -:ref:`int` **debug/export_console_wrapper** +:ref:`int` **debug/export_console_wrapper** :ref:`🔗` If ``true``, a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output. @@ -473,7 +473,7 @@ If ``true``, a console wrapper executable is exported alongside the main executa .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/cleanup_script** +:ref:`String` **ssh_remote_deploy/cleanup_script** :ref:`🔗` Script code to execute on the remote host when app is finished. @@ -495,7 +495,7 @@ The following variables can be used in the script: .. rst-class:: classref-property -:ref:`bool` **ssh_remote_deploy/enabled** +:ref:`bool` **ssh_remote_deploy/enabled** :ref:`🔗` Enables remote deploy using SSH/SCP. @@ -507,7 +507,7 @@ Enables remote deploy using SSH/SCP. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/extra_args_scp** +:ref:`String` **ssh_remote_deploy/extra_args_scp** :ref:`🔗` Array of the additional command line arguments passed to the SCP. @@ -519,7 +519,7 @@ Array of the additional command line arguments passed to the SCP. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/extra_args_ssh** +:ref:`String` **ssh_remote_deploy/extra_args_ssh** :ref:`🔗` Array of the additional command line arguments passed to the SSH. @@ -531,7 +531,7 @@ Array of the additional command line arguments passed to the SSH. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/host** +:ref:`String` **ssh_remote_deploy/host** :ref:`🔗` Remote host SSH user name and address, in ``user@address`` format. @@ -543,7 +543,7 @@ Remote host SSH user name and address, in ``user@address`` format. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/port** +:ref:`String` **ssh_remote_deploy/port** :ref:`🔗` Remote host SSH port number. @@ -555,7 +555,7 @@ Remote host SSH port number. .. rst-class:: classref-property -:ref:`String` **ssh_remote_deploy/run_script** +:ref:`String` **ssh_remote_deploy/run_script** :ref:`🔗` Script code to execute on the remote host when running the app. @@ -577,7 +577,7 @@ The following variables can be used in the script: .. rst-class:: classref-property -:ref:`bool` **texture_format/etc2_astc** +:ref:`bool` **texture_format/etc2_astc** :ref:`🔗` If ``true``, project textures are exported in the ETC2/ASTC format. @@ -589,7 +589,7 @@ If ``true``, project textures are exported in the ETC2/ASTC format. .. rst-class:: classref-property -:ref:`bool` **texture_format/s3tc_bptc** +:ref:`bool` **texture_format/s3tc_bptc** :ref:`🔗` If ``true``, project textures are exported in the S3TC/BPTC format. diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index e9239426777..9bf24e20d1c 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_begin_customize_resources**\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| +:ref:`bool` **_begin_customize_resources**\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| :ref:`🔗` Return ``true`` if this plugin will customize resources based on the platform and features used. @@ -137,7 +137,7 @@ When enabled, :ref:`_get_customization_configuration_hash` **_begin_customize_scenes**\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| +:ref:`bool` **_begin_customize_scenes**\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| :ref:`🔗` Return true if this plugin will customize scenes based on the platform and features used. @@ -149,7 +149,7 @@ Return true if this plugin will customize scenes based on the platform and featu .. rst-class:: classref-method -:ref:`Resource` **_customize_resource**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| +:ref:`Resource` **_customize_resource**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| :ref:`🔗` Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return ``null``. @@ -165,7 +165,7 @@ Implementing this method is required if :ref:`_begin_customize_resources` **_customize_scene**\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| +:ref:`Node` **_customize_scene**\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| :ref:`🔗` Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return ``null``. If a new scene is returned, it is up to you to dispose of the old one. @@ -179,7 +179,7 @@ Implementing this method is required if :ref:`_begin_customize_scenes` This is called when the customization process for resources ends. @@ -191,7 +191,7 @@ This is called when the customization process for resources ends. .. rst-class:: classref-method -|void| **_end_customize_scenes**\ (\ ) |virtual| +|void| **_end_customize_scenes**\ (\ ) |virtual| :ref:`🔗` This is called when the customization process for scenes ends. @@ -203,7 +203,7 @@ This is called when the customization process for scenes ends. .. rst-class:: classref-method -|void| **_export_begin**\ (\ features\: :ref:`PackedStringArray`, is_debug\: :ref:`bool`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| +|void| **_export_begin**\ (\ features\: :ref:`PackedStringArray`, is_debug\: :ref:`bool`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| :ref:`🔗` Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. ``features`` is the list of features for the export, ``is_debug`` is ``true`` for debug builds, ``path`` is the target path for the exported project. ``flags`` is only used when running a runnable profile, e.g. when using native run on Android. @@ -215,7 +215,7 @@ Virtual method to be overridden by the user. It is called when the export starts .. rst-class:: classref-method -|void| **_export_end**\ (\ ) |virtual| +|void| **_export_end**\ (\ ) |virtual| :ref:`🔗` Virtual method to be overridden by the user. Called when the export is finished. @@ -227,7 +227,7 @@ Virtual method to be overridden by the user. Called when the export is finished. .. rst-class:: classref-method -|void| **_export_file**\ (\ path\: :ref:`String`, type\: :ref:`String`, features\: :ref:`PackedStringArray`\ ) |virtual| +|void| **_export_file**\ (\ path\: :ref:`String`, type\: :ref:`String`, features\: :ref:`PackedStringArray`\ ) |virtual| :ref:`🔗` Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. ``path`` is the path of the file, ``type`` is the :ref:`Resource` represented by the file (e.g. :ref:`PackedScene`) and ``features`` is the list of features for the export. @@ -241,7 +241,7 @@ Calling :ref:`skip` inside this callback w .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_android_dependencies**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_android_dependencies**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Virtual method to be overridden by the user. This is called to retrieve the set of Android dependencies provided by this plugin. Each returned Android dependency should have the format of an Android remote binary dependency: ``org.godot.example:my-plugin:0.0.0``\ @@ -257,7 +257,7 @@ For more information see `Android documentation on dependencies ` **_get_android_dependencies_maven_repos**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_android_dependencies_maven_repos**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Virtual method to be overridden by the user. This is called to retrieve the URLs of Maven repositories for the set of Android dependencies provided by this plugin. @@ -275,7 +275,7 @@ For more information see `Gradle documentation on dependency management ` **_get_android_libraries**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_android_libraries**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Virtual method to be overridden by the user. This is called to retrieve the local paths of the Android libraries archive (AAR) files provided by this plugin. @@ -291,7 +291,7 @@ Virtual method to be overridden by the user. This is called to retrieve the loca .. rst-class:: classref-method -:ref:`String` **_get_android_manifest_activity_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`String` **_get_android_manifest_activity_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Virtual method to be overridden by the user. This is used at export time to update the contents of the ``activity`` element in the generated Android manifest. @@ -305,7 +305,7 @@ Virtual method to be overridden by the user. This is used at export time to upda .. rst-class:: classref-method -:ref:`String` **_get_android_manifest_application_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`String` **_get_android_manifest_application_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Virtual method to be overridden by the user. This is used at export time to update the contents of the ``application`` element in the generated Android manifest. @@ -319,7 +319,7 @@ Virtual method to be overridden by the user. This is used at export time to upda .. rst-class:: classref-method -:ref:`String` **_get_android_manifest_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`String` **_get_android_manifest_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Virtual method to be overridden by the user. This is used at export time to update the contents of the ``manifest`` element in the generated Android manifest. @@ -333,7 +333,7 @@ Virtual method to be overridden by the user. This is used at export time to upda .. rst-class:: classref-method -:ref:`int` **_get_customization_configuration_hash**\ (\ ) |virtual| |const| +:ref:`int` **_get_customization_configuration_hash**\ (\ ) |virtual| |const| :ref:`🔗` Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations. @@ -347,7 +347,7 @@ Implementing this method is required if :ref:`_begin_customize_resources` **_get_export_features**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_export_features**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Return a :ref:`PackedStringArray` of additional features this preset, for the given ``platform``, should have. @@ -359,7 +359,7 @@ Return a :ref:`PackedStringArray` of additional feature .. rst-class:: classref-method -:ref:`String` **_get_export_option_warning**\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_get_export_option_warning**\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Check the requirements for the given ``option`` and return a non-empty warning string if they are not met. @@ -373,7 +373,7 @@ Check the requirements for the given ``option`` and return a non-empty warning s .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| :ref:`🔗` Return a list of export options that can be configured for this export plugin. @@ -393,7 +393,7 @@ Each element in the return value is a :ref:`Dictionary` with t .. rst-class:: classref-method -:ref:`Dictionary` **_get_export_options_overrides**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| +:ref:`Dictionary` **_get_export_options_overrides**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| :ref:`🔗` Return a :ref:`Dictionary` of override values for export options, that will be used instead of user-provided values. Overridden options will be hidden from the user interface. @@ -423,7 +423,7 @@ Return a :ref:`Dictionary` of override values for export optio .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting. @@ -437,7 +437,7 @@ Implementing this method is required. .. rst-class:: classref-method -:ref:`bool` **_should_update_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| +:ref:`bool` **_should_update_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| :ref:`🔗` Return ``true``, if the result of :ref:`_get_export_options` has changed and the export options of preset corresponding to ``platform`` should be updated. @@ -449,7 +449,7 @@ Return ``true``, if the result of :ref:`_get_export_options` **_supports_platform**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| +:ref:`bool` **_supports_platform**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| :ref:`🔗` Return ``true`` if the plugin supports the given ``platform``. @@ -461,7 +461,7 @@ Return ``true`` if the plugin supports the given ``platform``. .. rst-class:: classref-method -|void| **add_file**\ (\ path\: :ref:`String`, file\: :ref:`PackedByteArray`, remap\: :ref:`bool`\ ) +|void| **add_file**\ (\ path\: :ref:`String`, file\: :ref:`PackedByteArray`, remap\: :ref:`bool`\ ) :ref:`🔗` Adds a custom file to be exported. ``path`` is the virtual path that can be used to load the file, ``file`` is the binary data of the file. @@ -475,7 +475,7 @@ When called inside :ref:`_export_file`\ ) +|void| **add_ios_bundle_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Adds an iOS bundle file from the given ``path`` to the exported project. @@ -487,7 +487,7 @@ Adds an iOS bundle file from the given ``path`` to the exported project. .. rst-class:: classref-method -|void| **add_ios_cpp_code**\ (\ code\: :ref:`String`\ ) +|void| **add_ios_cpp_code**\ (\ code\: :ref:`String`\ ) :ref:`🔗` Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin. @@ -499,7 +499,7 @@ Adds a C++ code to the iOS export. The final code is created from the code appen .. rst-class:: classref-method -|void| **add_ios_embedded_framework**\ (\ path\: :ref:`String`\ ) +|void| **add_ios_embedded_framework**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. @@ -515,7 +515,7 @@ Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode .. rst-class:: classref-method -|void| **add_ios_framework**\ (\ path\: :ref:`String`\ ) +|void| **add_ios_framework**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project. @@ -527,7 +527,7 @@ Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Link .. rst-class:: classref-method -|void| **add_ios_linker_flags**\ (\ flags\: :ref:`String`\ ) +|void| **add_ios_linker_flags**\ (\ flags\: :ref:`String`\ ) :ref:`🔗` Adds linker flags for the iOS export. @@ -539,7 +539,7 @@ Adds linker flags for the iOS export. .. rst-class:: classref-method -|void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String`\ ) +|void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String`\ ) :ref:`🔗` Adds content for iOS Property List files. @@ -551,7 +551,7 @@ Adds content for iOS Property List files. .. rst-class:: classref-method -|void| **add_ios_project_static_lib**\ (\ path\: :ref:`String`\ ) +|void| **add_ios_project_static_lib**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Adds a static lib from the given ``path`` to the iOS project. @@ -563,7 +563,7 @@ Adds a static lib from the given ``path`` to the iOS project. .. rst-class:: classref-method -|void| **add_macos_plugin_file**\ (\ path\: :ref:`String`\ ) +|void| **add_macos_plugin_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Adds file or directory matching ``path`` to ``PlugIns`` directory of macOS app bundle. @@ -577,7 +577,7 @@ Adds file or directory matching ``path`` to ``PlugIns`` directory of macOS app b .. rst-class:: classref-method -|void| **add_shared_object**\ (\ path\: :ref:`String`, tags\: :ref:`PackedStringArray`, target\: :ref:`String`\ ) +|void| **add_shared_object**\ (\ path\: :ref:`String`, tags\: :ref:`PackedStringArray`, target\: :ref:`String`\ ) :ref:`🔗` Adds a shared object or a directory containing only shared objects with the given ``tags`` and destination ``path``. @@ -593,7 +593,7 @@ In case of a directory code-sign will error if you place non code object in dire .. rst-class:: classref-method -:ref:`Variant` **get_option**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_option**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the current value of an export option supplied by :ref:`_get_export_options`. @@ -605,9 +605,9 @@ Returns the current value of an export option supplied by :ref:`_get_export_opti .. rst-class:: classref-method -|void| **skip**\ (\ ) +|void| **skip**\ (\ ) :ref:`🔗` -To be called inside :ref:`_export_file`. Skips the current file, so it's not included in the export. +To be called inside :ref:`_export_file`, :ref:`_customize_resource`, or :ref:`_customize_scene`. Skips the current file, so it's not included in the export. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index a6273057000..3460c9359b8 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -68,7 +68,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Feature**: +enum **Feature**: :ref:`🔗` .. _class_EditorFeatureProfile_constant_FEATURE_3D: @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_feature_name**\ (\ feature\: :ref:`Feature`\ ) +:ref:`String` **get_feature_name**\ (\ feature\: :ref:`Feature`\ ) :ref:`🔗` Returns the specified ``feature``'s human-readable name. @@ -167,7 +167,7 @@ Returns the specified ``feature``'s human-readable name. .. rst-class:: classref-method -:ref:`bool` **is_class_disabled**\ (\ class_name\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_class_disabled**\ (\ class_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the class specified by ``class_name`` is disabled. When disabled, the class won't appear in the Create New Node dialog. @@ -179,7 +179,7 @@ Returns ``true`` if the class specified by ``class_name`` is disabled. When disa .. rst-class:: classref-method -:ref:`bool` **is_class_editor_disabled**\ (\ class_name\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_class_editor_disabled**\ (\ class_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if editing for the class specified by ``class_name`` is disabled. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class. @@ -191,7 +191,7 @@ Returns ``true`` if editing for the class specified by ``class_name`` is disable .. rst-class:: classref-method -:ref:`bool` **is_class_property_disabled**\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_class_property_disabled**\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if ``property`` is disabled in the class specified by ``class_name``. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by ``class_name``. @@ -203,7 +203,7 @@ Returns ``true`` if ``property`` is disabled in the class specified by ``class_n .. rst-class:: classref-method -:ref:`bool` **is_feature_disabled**\ (\ feature\: :ref:`Feature`\ ) |const| +:ref:`bool` **is_feature_disabled**\ (\ feature\: :ref:`Feature`\ ) |const| :ref:`🔗` Returns ``true`` if the ``feature`` is disabled. When a feature is disabled, it will disappear from the editor entirely. @@ -215,7 +215,7 @@ Returns ``true`` if the ``feature`` is disabled. When a feature is disabled, it .. rst-class:: classref-method -:ref:`Error` **load_from_file**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load_from_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's **Export** button or the :ref:`save_to_file` method. @@ -229,7 +229,7 @@ Loads an editor feature profile from a file. The file must follow the JSON forma .. rst-class:: classref-method -:ref:`Error` **save_to_file**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **save_to_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's **Import** button or the :ref:`load_from_file` method. @@ -243,7 +243,7 @@ Saves the editor feature profile to a file in JSON format. It can then be import .. rst-class:: classref-method -|void| **set_disable_class**\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) +|void| **set_disable_class**\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) :ref:`🔗` If ``disable`` is ``true``, disables the class specified by ``class_name``. When disabled, the class won't appear in the Create New Node dialog. @@ -255,7 +255,7 @@ If ``disable`` is ``true``, disables the class specified by ``class_name``. When .. rst-class:: classref-method -|void| **set_disable_class_editor**\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) +|void| **set_disable_class_editor**\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) :ref:`🔗` If ``disable`` is ``true``, disables editing for the class specified by ``class_name``. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class. @@ -267,7 +267,7 @@ If ``disable`` is ``true``, disables editing for the class specified by ``class_ .. rst-class:: classref-method -|void| **set_disable_class_property**\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`, disable\: :ref:`bool`\ ) +|void| **set_disable_class_property**\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`, disable\: :ref:`bool`\ ) :ref:`🔗` If ``disable`` is ``true``, disables editing for ``property`` in the class specified by ``class_name``. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by ``class_name``. @@ -279,7 +279,7 @@ If ``disable`` is ``true``, disables editing for ``property`` in the class speci .. rst-class:: classref-method -|void| **set_disable_feature**\ (\ feature\: :ref:`Feature`, disable\: :ref:`bool`\ ) +|void| **set_disable_feature**\ (\ feature\: :ref:`Feature`, disable\: :ref:`bool`\ ) :ref:`🔗` If ``disable`` is ``true``, disables the editor feature specified in ``feature``. When a feature is disabled, it will disappear from the editor entirely. diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 0cedd38b840..da7fd84486a 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -108,7 +108,7 @@ Signals .. rst-class:: classref-signal -**dir_selected**\ (\ dir\: :ref:`String`\ ) +**dir_selected**\ (\ dir\: :ref:`String`\ ) :ref:`🔗` Emitted when a directory is selected. @@ -120,7 +120,7 @@ Emitted when a directory is selected. .. rst-class:: classref-signal -**file_selected**\ (\ path\: :ref:`String`\ ) +**file_selected**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Emitted when a file is selected. @@ -132,7 +132,7 @@ Emitted when a file is selected. .. rst-class:: classref-signal -**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) +**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted when multiple files are selected. @@ -149,7 +149,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FileMode**: +enum **FileMode**: :ref:`🔗` .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILE: @@ -199,7 +199,7 @@ The **EditorFileDialog** can select only one file. Accepting the window will sav .. rst-class:: classref-enumeration -enum **Access**: +enum **Access**: :ref:`🔗` .. _class_EditorFileDialog_constant_ACCESS_RESOURCES: @@ -233,7 +233,7 @@ The **EditorFileDialog** can view the entire local file system. .. rst-class:: classref-enumeration -enum **DisplayMode**: +enum **DisplayMode**: :ref:`🔗` .. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS: @@ -264,7 +264,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Access` **access** = ``0`` +:ref:`Access` **access** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -281,7 +281,7 @@ The location from which the user may select a file, including ``res://``, ``user .. rst-class:: classref-property -:ref:`String` **current_dir** +:ref:`String` **current_dir** :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +298,7 @@ The currently occupied directory. .. rst-class:: classref-property -:ref:`String` **current_file** +:ref:`String` **current_file** :ref:`🔗` .. rst-class:: classref-property-setget @@ -315,7 +315,7 @@ The currently selected file. .. rst-class:: classref-property -:ref:`String` **current_path** +:ref:`String` **current_path** :ref:`🔗` .. rst-class:: classref-property-setget @@ -332,7 +332,7 @@ The file system path in the address bar. .. rst-class:: classref-property -:ref:`bool` **disable_overwrite_warning** = ``false`` +:ref:`bool` **disable_overwrite_warning** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -349,7 +349,7 @@ If ``true``, the **EditorFileDialog** will not warn the user before overwriting .. rst-class:: classref-property -:ref:`DisplayMode` **display_mode** = ``0`` +:ref:`DisplayMode` **display_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -366,7 +366,7 @@ The view format in which the **EditorFileDialog** displays resources to the user .. rst-class:: classref-property -:ref:`FileMode` **file_mode** = ``4`` +:ref:`FileMode` **file_mode** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -383,7 +383,7 @@ The dialog's open or save mode, which affects the selection behavior. See :ref:` .. rst-class:: classref-property -:ref:`PackedStringArray` **filters** = ``PackedStringArray()`` +:ref:`PackedStringArray` **filters** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -402,7 +402,7 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd .. rst-class:: classref-property -:ref:`int` **option_count** = ``0`` +:ref:`int` **option_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -419,7 +419,7 @@ The number of additional :ref:`OptionButton`\ s and :ref:`Ch .. rst-class:: classref-property -:ref:`bool` **show_hidden_files** = ``false`` +:ref:`bool` **show_hidden_files** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -441,7 +441,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) +|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) :ref:`🔗` Adds a comma-delimited file name ``filter`` option to the **EditorFileDialog** with an optional ``description``, which restricts what files can be picked. @@ -457,7 +457,7 @@ For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Sce .. rst-class:: classref-method -|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) +|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. @@ -471,7 +471,7 @@ Adds an additional :ref:`OptionButton` to the file dialog. I .. rst-class:: classref-method -|void| **add_side_menu**\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) +|void| **add_side_menu**\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) :ref:`🔗` Adds the given ``menu`` to the side of the file dialog with the given ``title`` text on top. Only one side menu is allowed. @@ -483,7 +483,7 @@ Adds the given ``menu`` to the side of the file dialog with the given ``title`` .. rst-class:: classref-method -|void| **clear_filters**\ (\ ) +|void| **clear_filters**\ (\ ) :ref:`🔗` Removes all filters except for "All Files (\*)". @@ -495,7 +495,7 @@ Removes all filters except for "All Files (\*)". .. rst-class:: classref-method -:ref:`LineEdit` **get_line_edit**\ (\ ) +:ref:`LineEdit` **get_line_edit**\ (\ ) :ref:`🔗` Returns the LineEdit for the selected file. @@ -509,7 +509,7 @@ Returns the LineEdit for the selected file. .. rst-class:: classref-method -:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| +:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -521,7 +521,7 @@ Returns the default value index of the :ref:`OptionButton` o .. rst-class:: classref-method -:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| +:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -533,7 +533,7 @@ Returns the name of the :ref:`OptionButton` or :ref:`CheckBo .. rst-class:: classref-method -:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| +:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of values of the :ref:`OptionButton` with index ``option``. @@ -545,7 +545,7 @@ Returns an array of values of the :ref:`OptionButton` with i .. rst-class:: classref-method -:ref:`Dictionary` **get_selected_options**\ (\ ) |const| +:ref:`Dictionary` **get_selected_options**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`Dictionary` keys are names and values are selected value indices. @@ -557,7 +557,7 @@ Returns a :ref:`Dictionary` with the selected values of the ad .. rst-class:: classref-method -:ref:`VBoxContainer` **get_vbox**\ (\ ) +:ref:`VBoxContainer` **get_vbox**\ (\ ) :ref:`🔗` Returns the :ref:`VBoxContainer` used to display the file system. @@ -571,7 +571,7 @@ Returns the :ref:`VBoxContainer` used to display the file s .. rst-class:: classref-method -|void| **invalidate**\ (\ ) +|void| **invalidate**\ (\ ) :ref:`🔗` Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update. @@ -583,7 +583,7 @@ Notify the **EditorFileDialog** that its view of the data is no longer accurate. .. rst-class:: classref-method -|void| **popup_file_dialog**\ (\ ) +|void| **popup_file_dialog**\ (\ ) :ref:`🔗` Shows the **EditorFileDialog** at the default size and position for file dialogs in the editor, and selects the file name if there is a current file. @@ -595,7 +595,7 @@ Shows the **EditorFileDialog** at the default size and position for file dialogs .. rst-class:: classref-method -|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) +|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -607,7 +607,7 @@ Sets the default value index of the :ref:`OptionButton` or : .. rst-class:: classref-method -|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -619,7 +619,7 @@ Sets the name of the :ref:`OptionButton` or :ref:`CheckBox`, values\: :ref:`PackedStringArray`\ ) +|void| **set_option_values**\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the option values of the :ref:`OptionButton` with index ``option``. diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 15d1f503ea3..b144a8ac710 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**filesystem_changed**\ (\ ) +**filesystem_changed**\ (\ ) :ref:`🔗` Emitted if the filesystem changed. @@ -76,7 +76,7 @@ Emitted if the filesystem changed. .. rst-class:: classref-signal -**resources_reimported**\ (\ resources\: :ref:`PackedStringArray`\ ) +**resources_reimported**\ (\ resources\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted if a resource is reimported. @@ -88,7 +88,7 @@ Emitted if a resource is reimported. .. rst-class:: classref-signal -**resources_reload**\ (\ resources\: :ref:`PackedStringArray`\ ) +**resources_reload**\ (\ resources\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted if at least one resource is reloaded when the filesystem is scanned. @@ -100,7 +100,7 @@ Emitted if at least one resource is reloaded when the filesystem is scanned. .. rst-class:: classref-signal -**script_classes_updated**\ (\ ) +**script_classes_updated**\ (\ ) :ref:`🔗` Emitted when the list of global script classes gets updated. @@ -112,7 +112,7 @@ Emitted when the list of global script classes gets updated. .. rst-class:: classref-signal -**sources_changed**\ (\ exist\: :ref:`bool`\ ) +**sources_changed**\ (\ exist\: :ref:`bool`\ ) :ref:`🔗` Emitted if the source of any imported file changed. @@ -129,7 +129,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_file_type**\ (\ path\: :ref:`String`\ ) |const| +:ref:`String` **get_file_type**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Returns the resource type of the file, given the full path. This returns a string such as ``"Resource"`` or ``"GDScript"``, *not* a file extension such as ``".gd"``. @@ -141,7 +141,7 @@ Returns the resource type of the file, given the full path. This returns a strin .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_filesystem**\ (\ ) +:ref:`EditorFileSystemDirectory` **get_filesystem**\ (\ ) :ref:`🔗` Gets the root directory object. @@ -153,7 +153,7 @@ Gets the root directory object. .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_filesystem_path**\ (\ path\: :ref:`String`\ ) +:ref:`EditorFileSystemDirectory` **get_filesystem_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns a view into the filesystem at ``path``. @@ -165,7 +165,7 @@ Returns a view into the filesystem at ``path``. .. rst-class:: classref-method -:ref:`float` **get_scanning_progress**\ (\ ) |const| +:ref:`float` **get_scanning_progress**\ (\ ) |const| :ref:`🔗` Returns the scan progress for 0 to 1 if the FS is being scanned. @@ -177,7 +177,7 @@ Returns the scan progress for 0 to 1 if the FS is being scanned. .. rst-class:: classref-method -:ref:`bool` **is_scanning**\ (\ ) |const| +:ref:`bool` **is_scanning**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the filesystem is being scanned. @@ -189,7 +189,7 @@ Returns ``true`` if the filesystem is being scanned. .. rst-class:: classref-method -|void| **reimport_files**\ (\ files\: :ref:`PackedStringArray`\ ) +|void| **reimport_files**\ (\ files\: :ref:`PackedStringArray`\ ) :ref:`🔗` Reimports a set of files. Call this if these files or their ``.import`` files were directly edited by script or an external program. @@ -205,7 +205,7 @@ If the file type changed or the file was newly created, use :ref:`update_file` Scan the filesystem for changes. @@ -217,7 +217,7 @@ Scan the filesystem for changes. .. rst-class:: classref-method -|void| **scan_sources**\ (\ ) +|void| **scan_sources**\ (\ ) :ref:`🔗` Check if the source of any imported resource changed. @@ -229,7 +229,7 @@ Check if the source of any imported resource changed. .. rst-class:: classref-method -|void| **update_file**\ (\ path\: :ref:`String`\ ) +|void| **update_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program. diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 1ae7ad0c4b7..421b8d2eeab 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **find_dir_index**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **find_dir_index**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the index of the directory with name ``name`` or ``-1`` if not found. @@ -84,7 +84,7 @@ Returns the index of the directory with name ``name`` or ``-1`` if not found. .. rst-class:: classref-method -:ref:`int` **find_file_index**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **find_file_index**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the index of the file with name ``name`` or ``-1`` if not found. @@ -96,7 +96,7 @@ Returns the index of the file with name ``name`` or ``-1`` if not found. .. rst-class:: classref-method -:ref:`String` **get_file**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_file**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the file at index ``idx``. @@ -108,7 +108,7 @@ Returns the name of the file at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_file_count**\ (\ ) |const| +:ref:`int` **get_file_count**\ (\ ) |const| :ref:`🔗` Returns the number of files in this directory. @@ -120,7 +120,7 @@ Returns the number of files in this directory. .. rst-class:: classref-method -:ref:`bool` **get_file_import_is_valid**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_file_import_is_valid**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the file at index ``idx`` imported properly. @@ -132,7 +132,7 @@ Returns ``true`` if the file at index ``idx`` imported properly. .. rst-class:: classref-method -:ref:`String` **get_file_path**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_file_path**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path to the file at index ``idx``. @@ -144,7 +144,7 @@ Returns the path to the file at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_file_script_class_extends**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_file_script_class_extends**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the base class of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. @@ -156,7 +156,7 @@ Returns the base class of the script class defined in the file at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_file_script_class_name**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_file_script_class_name**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. @@ -168,7 +168,7 @@ Returns the name of the script class defined in the file at index ``idx``. If th .. rst-class:: classref-method -:ref:`StringName` **get_file_type**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_file_type**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the resource type of the file at index ``idx``. This returns a string such as ``"Resource"`` or ``"GDScript"``, *not* a file extension such as ``".gd"``. @@ -180,7 +180,7 @@ Returns the resource type of the file at index ``idx``. This returns a string su .. rst-class:: classref-method -:ref:`String` **get_name**\ (\ ) +:ref:`String` **get_name**\ (\ ) :ref:`🔗` Returns the name of this directory. @@ -192,7 +192,7 @@ Returns the name of this directory. .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_parent**\ (\ ) +:ref:`EditorFileSystemDirectory` **get_parent**\ (\ ) :ref:`🔗` Returns the parent directory for this directory or ``null`` if called on a directory at ``res://`` or ``user://``. @@ -204,7 +204,7 @@ Returns the parent directory for this directory or ``null`` if called on a direc .. rst-class:: classref-method -:ref:`String` **get_path**\ (\ ) |const| +:ref:`String` **get_path**\ (\ ) |const| :ref:`🔗` Returns the path to this directory. @@ -216,7 +216,7 @@ Returns the path to this directory. .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_subdir**\ (\ idx\: :ref:`int`\ ) +:ref:`EditorFileSystemDirectory` **get_subdir**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns the subdirectory at index ``idx``. @@ -228,7 +228,7 @@ Returns the subdirectory at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_subdir_count**\ (\ ) |const| +:ref:`int` **get_subdir_count**\ (\ ) |const| :ref:`🔗` Returns the number of subdirectories in this directory. diff --git a/classes/class_editorfilesystemimportformatsupportquery.rst b/classes/class_editorfilesystemimportformatsupportquery.rst index aecd8f9b1c3..d92a013f3f7 100644 --- a/classes/class_editorfilesystemimportformatsupportquery.rst +++ b/classes/class_editorfilesystemimportformatsupportquery.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_file_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_file_extensions**\ (\ ) |virtual| |const| :ref:`🔗` Return the file extensions supported. @@ -62,7 +62,7 @@ Return the file extensions supported. .. rst-class:: classref-method -:ref:`bool` **_is_active**\ (\ ) |virtual| |const| +:ref:`bool` **_is_active**\ (\ ) |virtual| |const| :ref:`🔗` Return whether this importer is active. @@ -74,7 +74,7 @@ Return whether this importer is active. .. rst-class:: classref-method -:ref:`bool` **_query**\ (\ ) |virtual| |const| +:ref:`bool` **_query**\ (\ ) |virtual| |const| :ref:`🔗` Query support. Return false if import must not continue. diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 7ced4da7e69..cdebc608398 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -197,7 +197,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_import_threaded**\ (\ ) |virtual| |const| +:ref:`bool` **_can_import_threaded**\ (\ ) |virtual| |const| :ref:`🔗` Tells whether this importer can be run in parallel on threads, or, on the contrary, it's only safe for the editor to call it from the main thread, for one file at a time. @@ -211,7 +211,7 @@ If this method is not overridden, it will return ``true`` by default (i.e., safe .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_import_options**\ (\ path\: :ref:`String`, preset_index\: :ref:`int`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_import_options**\ (\ path\: :ref:`String`, preset_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: ``name``, ``default_value``, ``property_hint`` (optional), ``hint_string`` (optional), ``usage`` (optional). @@ -223,7 +223,7 @@ Gets the options and default values for the preset at this index. Returns an Arr .. rst-class:: classref-method -:ref:`int` **_get_import_order**\ (\ ) |virtual| |const| +:ref:`int` **_get_import_order**\ (\ ) |virtual| |const| :ref:`🔗` Gets the order of this importer to be run when importing resources. Importers with *lower* import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is ``0`` unless overridden by a specific importer. See :ref:`ImportOrder` for some predefined values. @@ -235,7 +235,7 @@ Gets the order of this importer to be run when importing resources. Importers wi .. rst-class:: classref-method -:ref:`String` **_get_importer_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_importer_name**\ (\ ) |virtual| |const| :ref:`🔗` Gets the unique name of the importer. @@ -247,7 +247,7 @@ Gets the unique name of the importer. .. rst-class:: classref-method -:ref:`bool` **_get_option_visibility**\ (\ path\: :ref:`String`, option_name\: :ref:`StringName`, options\: :ref:`Dictionary`\ ) |virtual| |const| +:ref:`bool` **_get_option_visibility**\ (\ path\: :ref:`String`, option_name\: :ref:`StringName`, options\: :ref:`Dictionary`\ ) |virtual| |const| :ref:`🔗` This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: @@ -288,7 +288,7 @@ Returns ``true`` to make all options always visible. .. rst-class:: classref-method -:ref:`int` **_get_preset_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_preset_count**\ (\ ) |virtual| |const| :ref:`🔗` Gets the number of initial presets defined by the plugin. Use :ref:`_get_import_options` to get the default options for the preset and :ref:`_get_preset_name` to get the name of the preset. @@ -300,7 +300,7 @@ Gets the number of initial presets defined by the plugin. Use :ref:`_get_import_ .. rst-class:: classref-method -:ref:`String` **_get_preset_name**\ (\ preset_index\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_get_preset_name**\ (\ preset_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Gets the name of the options preset at this index. @@ -312,7 +312,7 @@ Gets the name of the options preset at this index. .. rst-class:: classref-method -:ref:`float` **_get_priority**\ (\ ) |virtual| |const| +:ref:`float` **_get_priority**\ (\ ) |virtual| |const| :ref:`🔗` Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is ``1.0``. @@ -324,7 +324,7 @@ Gets the priority of this plugin for the recognized extension. Higher priority p .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| :ref:`🔗` Gets the list of file extensions to associate with this loader (case-insensitive). e.g. ``["obj"]``. @@ -336,7 +336,7 @@ Gets the list of file extensions to associate with this loader (case-insensitive .. rst-class:: classref-method -:ref:`String` **_get_resource_type**\ (\ ) |virtual| |const| +:ref:`String` **_get_resource_type**\ (\ ) |virtual| |const| :ref:`🔗` Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``"Animation"``. @@ -348,7 +348,7 @@ Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``" .. rst-class:: classref-method -:ref:`String` **_get_save_extension**\ (\ ) |virtual| |const| +:ref:`String` **_get_save_extension**\ (\ ) |virtual| |const| :ref:`🔗` Gets the extension used to save this resource in the ``.godot/imported`` directory (see :ref:`ProjectSettings.application/config/use_hidden_project_data_directory`). @@ -360,7 +360,7 @@ Gets the extension used to save this resource in the ``.godot/imported`` directo .. rst-class:: classref-method -:ref:`String` **_get_visible_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_visible_name**\ (\ ) |virtual| |const| :ref:`🔗` Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh". @@ -372,7 +372,7 @@ Gets the name to display in the import window. You should choose this name as a .. rst-class:: classref-method -:ref:`Error` **_import**\ (\ source_file\: :ref:`String`, save_path\: :ref:`String`, options\: :ref:`Dictionary`, platform_variants\: :ref:`Array`\[:ref:`String`\], gen_files\: :ref:`Array`\[:ref:`String`\]\ ) |virtual| |const| +:ref:`Error` **_import**\ (\ source_file\: :ref:`String`, save_path\: :ref:`String`, options\: :ref:`Dictionary`, platform_variants\: :ref:`Array`\[:ref:`String`\], gen_files\: :ref:`Array`\[:ref:`String`\]\ ) |virtual| |const| :ref:`🔗` Imports ``source_file`` into ``save_path`` with the import ``options`` specified. The ``platform_variants`` and ``gen_files`` arrays will be modified by this function. @@ -386,7 +386,7 @@ This method must be overridden to do the actual importing work. See this class' .. rst-class:: classref-method -:ref:`Error` **append_import_external_resource**\ (\ path\: :ref:`String`, custom_options\: :ref:`Dictionary` = {}, custom_importer\: :ref:`String` = "", generator_parameters\: :ref:`Variant` = null\ ) +:ref:`Error` **append_import_external_resource**\ (\ path\: :ref:`String`, custom_options\: :ref:`Dictionary` = {}, custom_importer\: :ref:`String` = "", generator_parameters\: :ref:`Variant` = null\ ) :ref:`🔗` This function can only be called during the :ref:`_import` callback and it allows manually importing resources from it. This is useful when the imported file generates external resources that require importing (as example, images). Custom parameters for the ".import" file can be passed via the ``custom_options``. Additionally, in cases where multiple importers can handle a file, the ``custom_importer`` ca be specified to force a specific one. This function performs a resource import and returns immediately with a success or error code. ``generator_parameters`` defines optional extra metadata which will be stored as ``generator_parameters`` in the ``remap`` section of the ``.import`` file, for example to store a md5 hash of the source data. diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 4e96955b726..66c9121f130 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -39,8 +39,6 @@ Properties .. table:: :widths: auto - +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | follow_focus | ``true`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`ScrollMode` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ @@ -72,7 +70,7 @@ Signals .. rst-class:: classref-signal -**edited_object_changed**\ (\ ) +**edited_object_changed**\ (\ ) :ref:`🔗` Emitted when the object being edited by the inspector has changed. @@ -84,7 +82,7 @@ Emitted when the object being edited by the inspector has changed. .. rst-class:: classref-signal -**object_id_selected**\ (\ id\: :ref:`int`\ ) +**object_id_selected**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when the Edit button of an :ref:`Object` has been pressed in the inspector. This is mainly used in the remote scene tree Inspector. @@ -96,7 +94,7 @@ Emitted when the Edit button of an :ref:`Object` has been pressed .. rst-class:: classref-signal -**property_deleted**\ (\ property\: :ref:`String`\ ) +**property_deleted**\ (\ property\: :ref:`String`\ ) :ref:`🔗` Emitted when a property is removed from the inspector. @@ -108,7 +106,7 @@ Emitted when a property is removed from the inspector. .. rst-class:: classref-signal -**property_edited**\ (\ property\: :ref:`String`\ ) +**property_edited**\ (\ property\: :ref:`String`\ ) :ref:`🔗` Emitted when a property is edited in the inspector. @@ -120,7 +118,7 @@ Emitted when a property is edited in the inspector. .. rst-class:: classref-signal -**property_keyed**\ (\ property\: :ref:`String`, value\: :ref:`Variant`, advance\: :ref:`bool`\ ) +**property_keyed**\ (\ property\: :ref:`String`, value\: :ref:`Variant`, advance\: :ref:`bool`\ ) :ref:`🔗` Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. @@ -132,7 +130,7 @@ Emitted when a property is keyed in the inspector. Properties can be keyed by cl .. rst-class:: classref-signal -**property_selected**\ (\ property\: :ref:`String`\ ) +**property_selected**\ (\ property\: :ref:`String`\ ) :ref:`🔗` Emitted when a property is selected in the inspector. @@ -144,7 +142,7 @@ Emitted when a property is selected in the inspector. .. rst-class:: classref-signal -**property_toggled**\ (\ property\: :ref:`String`, checked\: :ref:`bool`\ ) +**property_toggled**\ (\ property\: :ref:`String`, checked\: :ref:`bool`\ ) :ref:`🔗` Emitted when a boolean property is toggled in the inspector. @@ -158,7 +156,7 @@ Emitted when a boolean property is toggled in the inspector. .. rst-class:: classref-signal -**resource_selected**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) +**resource_selected**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) :ref:`🔗` Emitted when a resource is selected in the inspector. @@ -170,7 +168,7 @@ Emitted when a resource is selected in the inspector. .. rst-class:: classref-signal -**restart_requested**\ (\ ) +**restart_requested**\ (\ ) :ref:`🔗` Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings. @@ -187,7 +185,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **get_edited_object**\ (\ ) +:ref:`Object` **get_edited_object**\ (\ ) :ref:`🔗` Returns the object currently selected in this inspector. @@ -199,7 +197,7 @@ Returns the object currently selected in this inspector. .. rst-class:: classref-method -:ref:`String` **get_selected_path**\ (\ ) |const| +:ref:`String` **get_selected_path**\ (\ ) |const| :ref:`🔗` Gets the path of the currently selected property. diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 40a010ebb08..60aac61d85e 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -63,7 +63,7 @@ Methods +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_custom_control`\ (\ control\: :ref:`Control`\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_property_editor`\ (\ property\: :ref:`String`, editor\: :ref:`Control`, add_to_end\: :ref:`bool` = false\ ) | + | |void| | :ref:`add_property_editor`\ (\ property\: :ref:`String`, editor\: :ref:`Control`, add_to_end\: :ref:`bool` = false, label\: :ref:`String` = ""\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_property_editor_for_multiple_properties`\ (\ label\: :ref:`String`, properties\: :ref:`PackedStringArray`, editor\: :ref:`Control`\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,7 +81,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_handle**\ (\ object\: :ref:`Object`\ ) |virtual| |const| +:ref:`bool` **_can_handle**\ (\ object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if this object can be handled by this plugin. @@ -93,7 +93,7 @@ Returns ``true`` if this object can be handled by this plugin. .. rst-class:: classref-method -|void| **_parse_begin**\ (\ object\: :ref:`Object`\ ) |virtual| +|void| **_parse_begin**\ (\ object\: :ref:`Object`\ ) |virtual| :ref:`🔗` Called to allow adding controls at the beginning of the property list for ``object``. @@ -105,7 +105,7 @@ Called to allow adding controls at the beginning of the property list for ``obje .. rst-class:: classref-method -|void| **_parse_category**\ (\ object\: :ref:`Object`, category\: :ref:`String`\ ) |virtual| +|void| **_parse_category**\ (\ object\: :ref:`Object`, category\: :ref:`String`\ ) |virtual| :ref:`🔗` Called to allow adding controls at the beginning of a category in the property list for ``object``. @@ -117,7 +117,7 @@ Called to allow adding controls at the beginning of a category in the property l .. rst-class:: classref-method -|void| **_parse_end**\ (\ object\: :ref:`Object`\ ) |virtual| +|void| **_parse_end**\ (\ object\: :ref:`Object`\ ) |virtual| :ref:`🔗` Called to allow adding controls at the end of the property list for ``object``. @@ -129,7 +129,7 @@ Called to allow adding controls at the end of the property list for ``object``. .. rst-class:: classref-method -|void| **_parse_group**\ (\ object\: :ref:`Object`, group\: :ref:`String`\ ) |virtual| +|void| **_parse_group**\ (\ object\: :ref:`Object`, group\: :ref:`String`\ ) |virtual| :ref:`🔗` Called to allow adding controls at the beginning of a group or a sub-group in the property list for ``object``. @@ -141,7 +141,7 @@ Called to allow adding controls at the beginning of a group or a sub-group in th .. rst-class:: classref-method -:ref:`bool` **_parse_property**\ (\ object\: :ref:`Object`, type\: :ref:`Variant.Type`, name\: :ref:`String`, hint_type\: :ref:`PropertyHint`, hint_string\: :ref:`String`, usage_flags\: |bitfield|\[:ref:`PropertyUsageFlags`\], wide\: :ref:`bool`\ ) |virtual| +:ref:`bool` **_parse_property**\ (\ object\: :ref:`Object`, type\: :ref:`Variant.Type`, name\: :ref:`String`, hint_type\: :ref:`PropertyHint`, hint_string\: :ref:`String`, usage_flags\: |bitfield|\[:ref:`PropertyUsageFlags`\], wide\: :ref:`bool`\ ) |virtual| :ref:`🔗` Called to allow adding property-specific editors to the property list for ``object``. The added editor control must extend :ref:`EditorProperty`. Returning ``true`` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. @@ -153,7 +153,7 @@ Called to allow adding property-specific editors to the property list for ``obje .. rst-class:: classref-method -|void| **add_custom_control**\ (\ control\: :ref:`Control`\ ) +|void| **add_custom_control**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Adds a custom control, which is not necessarily a property editor. @@ -165,10 +165,14 @@ Adds a custom control, which is not necessarily a property editor. .. rst-class:: classref-method -|void| **add_property_editor**\ (\ property\: :ref:`String`, editor\: :ref:`Control`, add_to_end\: :ref:`bool` = false\ ) +|void| **add_property_editor**\ (\ property\: :ref:`String`, editor\: :ref:`Control`, add_to_end\: :ref:`bool` = false, label\: :ref:`String` = ""\ ) :ref:`🔗` Adds a property editor for an individual property. The ``editor`` control must extend :ref:`EditorProperty`. +There can be multiple property editors for a property. If ``add_to_end`` is ``true``, this newly added editor will be displayed after all the other editors of the property whose ``add_to_end`` is ``false``. For example, the editor uses this parameter to add an "Edit Region" button for :ref:`Sprite2D.region_rect` below the regular :ref:`Rect2` editor. + +\ ``label`` can be used to choose a custom label for the property editor in the inspector. If left empty, the label is computed from the name of the property instead. + .. rst-class:: classref-item-separator ---- @@ -177,7 +181,7 @@ Adds a property editor for an individual property. The ``editor`` control must e .. rst-class:: classref-method -|void| **add_property_editor_for_multiple_properties**\ (\ label\: :ref:`String`, properties\: :ref:`PackedStringArray`, editor\: :ref:`Control`\ ) +|void| **add_property_editor_for_multiple_properties**\ (\ label\: :ref:`String`, properties\: :ref:`PackedStringArray`, editor\: :ref:`Control`\ ) :ref:`🔗` Adds an editor that allows modifying multiple properties. The ``editor`` control must extend :ref:`EditorProperty`. diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 01fa5470d55..9b9d5d2618c 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -176,7 +176,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **distraction_free_mode** +:ref:`bool` **distraction_free_mode** :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ If ``true``, enables distraction-free mode which hides side docks to increase th .. rst-class:: classref-property -:ref:`bool` **movie_maker_enabled** +:ref:`bool` **movie_maker_enabled** :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **edit_node**\ (\ node\: :ref:`Node`\ ) +|void| **edit_node**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Edits the given :ref:`Node`. The node will be also selected if it's inside the scene tree. @@ -227,7 +227,7 @@ Edits the given :ref:`Node`. The node will be also selected if it's .. rst-class:: classref-method -|void| **edit_resource**\ (\ resource\: :ref:`Resource`\ ) +|void| **edit_resource**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` Edits the given :ref:`Resource`. If the resource is a :ref:`Script` you can also edit it with :ref:`edit_script` to specify the line and column position. @@ -239,7 +239,7 @@ Edits the given :ref:`Resource`. If the resource is a :ref:`Scri .. rst-class:: classref-method -|void| **edit_script**\ (\ script\: :ref:`Script`, line\: :ref:`int` = -1, column\: :ref:`int` = 0, grab_focus\: :ref:`bool` = true\ ) +|void| **edit_script**\ (\ script\: :ref:`Script`, line\: :ref:`int` = -1, column\: :ref:`int` = 0, grab_focus\: :ref:`bool` = true\ ) :ref:`🔗` Edits the given :ref:`Script`. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor. @@ -251,7 +251,7 @@ Edits the given :ref:`Script`. The line and column on which to ope .. rst-class:: classref-method -:ref:`Control` **get_base_control**\ (\ ) |const| +:ref:`Control` **get_base_control**\ (\ ) |const| :ref:`🔗` Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. @@ -265,7 +265,7 @@ Returns the main container of Godot editor's window. For example, you can use it .. rst-class:: classref-method -:ref:`EditorCommandPalette` **get_command_palette**\ (\ ) |const| +:ref:`EditorCommandPalette` **get_command_palette**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`EditorCommandPalette` instance. @@ -279,7 +279,7 @@ Returns the editor's :ref:`EditorCommandPalette` ins .. rst-class:: classref-method -:ref:`String` **get_current_directory**\ (\ ) |const| +:ref:`String` **get_current_directory**\ (\ ) |const| :ref:`🔗` Returns the current directory being viewed in the :ref:`FileSystemDock`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir` instead. @@ -291,7 +291,7 @@ Returns the current directory being viewed in the :ref:`FileSystemDock` **get_current_feature_profile**\ (\ ) |const| +:ref:`String` **get_current_feature_profile**\ (\ ) |const| :ref:`🔗` Returns the name of the currently activated feature profile. If the default profile is currently active, an empty string is returned instead. @@ -307,7 +307,7 @@ In order to get a reference to the :ref:`EditorFeatureProfile` **get_current_path**\ (\ ) |const| +:ref:`String` **get_current_path**\ (\ ) |const| :ref:`🔗` Returns the current path being viewed in the :ref:`FileSystemDock`. @@ -319,7 +319,7 @@ Returns the current path being viewed in the :ref:`FileSystemDock` **get_edited_scene_root**\ (\ ) |const| +:ref:`Node` **get_edited_scene_root**\ (\ ) |const| :ref:`🔗` Returns the edited (current) scene's root :ref:`Node`. @@ -331,7 +331,7 @@ Returns the edited (current) scene's root :ref:`Node`. .. rst-class:: classref-method -:ref:`VBoxContainer` **get_editor_main_screen**\ (\ ) |const| +:ref:`VBoxContainer` **get_editor_main_screen**\ (\ ) |const| :ref:`🔗` Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement :ref:`EditorPlugin._has_main_screen`. @@ -347,7 +347,7 @@ Returns the editor control responsible for main screen plugins and tools. Use it .. rst-class:: classref-method -:ref:`EditorPaths` **get_editor_paths**\ (\ ) |const| +:ref:`EditorPaths` **get_editor_paths**\ (\ ) |const| :ref:`🔗` Returns the :ref:`EditorPaths` singleton. @@ -359,7 +359,7 @@ Returns the :ref:`EditorPaths` singleton. .. rst-class:: classref-method -:ref:`float` **get_editor_scale**\ (\ ) |const| +:ref:`float` **get_editor_scale**\ (\ ) |const| :ref:`🔗` Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins. @@ -373,7 +373,7 @@ Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can b .. rst-class:: classref-method -:ref:`EditorSettings` **get_editor_settings**\ (\ ) |const| +:ref:`EditorSettings` **get_editor_settings**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`EditorSettings` instance. @@ -385,7 +385,7 @@ Returns the editor's :ref:`EditorSettings` instance. .. rst-class:: classref-method -:ref:`Theme` **get_editor_theme**\ (\ ) |const| +:ref:`Theme` **get_editor_theme**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`Theme`. @@ -399,7 +399,7 @@ Returns the editor's :ref:`Theme`. .. rst-class:: classref-method -:ref:`SubViewport` **get_editor_viewport_2d**\ (\ ) |const| +:ref:`SubViewport` **get_editor_viewport_2d**\ (\ ) |const| :ref:`🔗` Returns the 2D editor :ref:`SubViewport`. It does not have a camera. Instead, the view transforms are done directly and can be accessed with :ref:`Viewport.global_canvas_transform`. @@ -411,7 +411,7 @@ Returns the 2D editor :ref:`SubViewport`. It does not have a .. rst-class:: classref-method -:ref:`SubViewport` **get_editor_viewport_3d**\ (\ idx\: :ref:`int` = 0\ ) |const| +:ref:`SubViewport` **get_editor_viewport_3d**\ (\ idx\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the specified 3D editor :ref:`SubViewport`, from ``0`` to ``3``. The viewport can be used to access the active editor cameras with :ref:`Viewport.get_camera_3d`. @@ -423,7 +423,7 @@ Returns the specified 3D editor :ref:`SubViewport`, from ``0` .. rst-class:: classref-method -:ref:`FileSystemDock` **get_file_system_dock**\ (\ ) |const| +:ref:`FileSystemDock` **get_file_system_dock**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`FileSystemDock` instance. @@ -437,7 +437,7 @@ Returns the editor's :ref:`FileSystemDock` instance. .. rst-class:: classref-method -:ref:`EditorInspector` **get_inspector**\ (\ ) |const| +:ref:`EditorInspector` **get_inspector**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`EditorInspector` instance. @@ -451,7 +451,7 @@ Returns the editor's :ref:`EditorInspector` instance. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_open_scenes**\ (\ ) |const| +:ref:`PackedStringArray` **get_open_scenes**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` with the file paths of the currently opened scenes. @@ -463,7 +463,7 @@ Returns an :ref:`Array` with the file paths of the currently opened .. rst-class:: classref-method -:ref:`String` **get_playing_scene**\ (\ ) |const| +:ref:`String` **get_playing_scene**\ (\ ) |const| :ref:`🔗` Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. @@ -475,7 +475,7 @@ Returns the name of the scene that is being played. If no scene is currently bei .. rst-class:: classref-method -:ref:`EditorFileSystem` **get_resource_filesystem**\ (\ ) |const| +:ref:`EditorFileSystem` **get_resource_filesystem**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`EditorFileSystem` instance. @@ -487,7 +487,7 @@ Returns the editor's :ref:`EditorFileSystem` instance. .. rst-class:: classref-method -:ref:`EditorResourcePreview` **get_resource_previewer**\ (\ ) |const| +:ref:`EditorResourcePreview` **get_resource_previewer**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`EditorResourcePreview` instance. @@ -499,7 +499,7 @@ Returns the editor's :ref:`EditorResourcePreview` i .. rst-class:: classref-method -:ref:`ScriptEditor` **get_script_editor**\ (\ ) |const| +:ref:`ScriptEditor` **get_script_editor**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`ScriptEditor` instance. @@ -513,7 +513,7 @@ Returns the editor's :ref:`ScriptEditor` instance. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_selected_paths**\ (\ ) |const| +:ref:`PackedStringArray` **get_selected_paths**\ (\ ) |const| :ref:`🔗` Returns an array containing the paths of the currently selected files (and directories) in the :ref:`FileSystemDock`. @@ -525,7 +525,7 @@ Returns an array containing the paths of the currently selected files (and direc .. rst-class:: classref-method -:ref:`EditorSelection` **get_selection**\ (\ ) |const| +:ref:`EditorSelection` **get_selection**\ (\ ) |const| :ref:`🔗` Returns the editor's :ref:`EditorSelection` instance. @@ -537,7 +537,7 @@ Returns the editor's :ref:`EditorSelection` instance. .. rst-class:: classref-method -|void| **inspect_object**\ (\ object\: :ref:`Object`, for_property\: :ref:`String` = "", inspector_only\: :ref:`bool` = false\ ) +|void| **inspect_object**\ (\ object\: :ref:`Object`, for_property\: :ref:`String` = "", inspector_only\: :ref:`bool` = false\ ) :ref:`🔗` Shows the given property on the given ``object`` in the editor's Inspector dock. If ``inspector_only`` is ``true``, plugins will not attempt to edit ``object``. @@ -549,7 +549,7 @@ Shows the given property on the given ``object`` in the editor's Inspector dock. .. rst-class:: classref-method -:ref:`bool` **is_multi_window_enabled**\ (\ ) |const| +:ref:`bool` **is_multi_window_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if multiple window support is enabled in the editor. Multiple window support is enabled if *all* of these statements are true: @@ -567,7 +567,7 @@ Returns ``true`` if multiple window support is enabled in the editor. Multiple w .. rst-class:: classref-method -:ref:`bool` **is_playing_scene**\ (\ ) |const| +:ref:`bool` **is_playing_scene**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paused scenes are considered as being played. @@ -579,7 +579,7 @@ Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paus .. rst-class:: classref-method -:ref:`bool` **is_plugin_enabled**\ (\ plugin\: :ref:`String`\ ) |const| +:ref:`bool` **is_plugin_enabled**\ (\ plugin\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the same as its directory name. @@ -591,7 +591,7 @@ Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the .. rst-class:: classref-method -:ref:`Array`\[:ref:`Texture2D`\] **make_mesh_previews**\ (\ meshes\: :ref:`Array`\[:ref:`Mesh`\], preview_size\: :ref:`int`\ ) +:ref:`Array`\[:ref:`Texture2D`\] **make_mesh_previews**\ (\ meshes\: :ref:`Array`\[:ref:`Mesh`\], preview_size\: :ref:`int`\ ) :ref:`🔗` Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture2D`\ s. @@ -603,7 +603,7 @@ Returns mesh previews rendered at the given size as an :ref:`Array` .. rst-class:: classref-method -|void| **mark_scene_as_unsaved**\ (\ ) +|void| **mark_scene_as_unsaved**\ (\ ) :ref:`🔗` Marks the current scene tab as unsaved. @@ -615,7 +615,7 @@ Marks the current scene tab as unsaved. .. rst-class:: classref-method -|void| **open_scene_from_path**\ (\ scene_filepath\: :ref:`String`\ ) +|void| **open_scene_from_path**\ (\ scene_filepath\: :ref:`String`\ ) :ref:`🔗` Opens the scene at the given path. @@ -627,7 +627,7 @@ Opens the scene at the given path. .. rst-class:: classref-method -|void| **play_current_scene**\ (\ ) +|void| **play_current_scene**\ (\ ) :ref:`🔗` Plays the currently active scene. @@ -639,7 +639,7 @@ Plays the currently active scene. .. rst-class:: classref-method -|void| **play_custom_scene**\ (\ scene_filepath\: :ref:`String`\ ) +|void| **play_custom_scene**\ (\ scene_filepath\: :ref:`String`\ ) :ref:`🔗` Plays the scene specified by its filepath. @@ -651,7 +651,7 @@ Plays the scene specified by its filepath. .. rst-class:: classref-method -|void| **play_main_scene**\ (\ ) +|void| **play_main_scene**\ (\ ) :ref:`🔗` Plays the main scene. @@ -663,7 +663,7 @@ Plays the main scene. .. rst-class:: classref-method -|void| **popup_dialog**\ (\ dialog\: :ref:`Window`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) +|void| **popup_dialog**\ (\ dialog\: :ref:`Window`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) :ref:`🔗` Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive`. The dialog must have no current parent, otherwise the method fails. @@ -677,7 +677,7 @@ See also :ref:`Window.set_unparent_when_invisible`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) +|void| **popup_dialog_centered**\ (\ dialog\: :ref:`Window`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) :ref:`🔗` Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered`. The dialog must have no current parent, otherwise the method fails. @@ -691,7 +691,7 @@ See also :ref:`Window.set_unparent_when_invisible`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) +|void| **popup_dialog_centered_clamped**\ (\ dialog\: :ref:`Window`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) :ref:`🔗` Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_clamped`. The dialog must have no current parent, otherwise the method fails. @@ -705,7 +705,7 @@ See also :ref:`Window.set_unparent_when_invisible`, ratio\: :ref:`float` = 0.8\ ) +|void| **popup_dialog_centered_ratio**\ (\ dialog\: :ref:`Window`, ratio\: :ref:`float` = 0.8\ ) :ref:`🔗` Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_ratio`. The dialog must have no current parent, otherwise the method fails. @@ -719,7 +719,7 @@ See also :ref:`Window.set_unparent_when_invisible`, valid_types\: :ref:`Array`\[:ref:`StringName`\] = []\ ) +|void| **popup_node_selector**\ (\ callback\: :ref:`Callable`, valid_types\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` Pops up an editor dialog for selecting a :ref:`Node` from the edited scene. The ``callback`` must take a single argument of type :ref:`NodePath`. It is called on the selected :ref:`NodePath` or the empty path ``^""`` if the dialog is canceled. If ``valid_types`` is provided, the dialog will only show Nodes that match one of the listed Node types. @@ -745,7 +745,7 @@ Pops up an editor dialog for selecting a :ref:`Node` from the edited .. rst-class:: classref-method -|void| **popup_property_selector**\ (\ object\: :ref:`Object`, callback\: :ref:`Callable`, type_filter\: :ref:`PackedInt32Array` = PackedInt32Array()\ ) +|void| **popup_property_selector**\ (\ object\: :ref:`Object`, callback\: :ref:`Callable`, type_filter\: :ref:`PackedInt32Array` = PackedInt32Array()\ ) :ref:`🔗` Pops up an editor dialog for selecting properties from ``object``. The ``callback`` must take a single argument of type :ref:`NodePath`. It is called on the selected property path (see :ref:`NodePath.get_as_property_path`) or the empty path ``^""`` if the dialog is canceled. If ``type_filter`` is provided, the dialog will only show properties that match one of the listed :ref:`Variant.Type` values. @@ -771,7 +771,7 @@ Pops up an editor dialog for selecting properties from ``object``. The ``callbac .. rst-class:: classref-method -|void| **reload_scene_from_path**\ (\ scene_filepath\: :ref:`String`\ ) +|void| **reload_scene_from_path**\ (\ scene_filepath\: :ref:`String`\ ) :ref:`🔗` Reloads the scene at the given path. @@ -783,7 +783,7 @@ Reloads the scene at the given path. .. rst-class:: classref-method -|void| **restart_editor**\ (\ save\: :ref:`bool` = true\ ) +|void| **restart_editor**\ (\ save\: :ref:`bool` = true\ ) :ref:`🔗` Restarts the editor. This closes the editor and then opens the same project. If ``save`` is ``true``, the project will be saved before restarting. @@ -795,7 +795,7 @@ Restarts the editor. This closes the editor and then opens the same project. If .. rst-class:: classref-method -|void| **save_all_scenes**\ (\ ) +|void| **save_all_scenes**\ (\ ) :ref:`🔗` Saves all opened scenes in the editor. @@ -807,7 +807,7 @@ Saves all opened scenes in the editor. .. rst-class:: classref-method -:ref:`Error` **save_scene**\ (\ ) +:ref:`Error` **save_scene**\ (\ ) :ref:`🔗` Saves the currently active scene. Returns either :ref:`@GlobalScope.OK` or :ref:`@GlobalScope.ERR_CANT_CREATE`. @@ -819,7 +819,7 @@ Saves the currently active scene. Returns either :ref:`@GlobalScope.OK`, with_preview\: :ref:`bool` = true\ ) +|void| **save_scene_as**\ (\ path\: :ref:`String`, with_preview\: :ref:`bool` = true\ ) :ref:`🔗` Saves the currently active scene as a file at ``path``. @@ -831,7 +831,7 @@ Saves the currently active scene as a file at ``path``. .. rst-class:: classref-method -|void| **select_file**\ (\ file\: :ref:`String`\ ) +|void| **select_file**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Selects the file, with the path provided by ``file``, in the FileSystem dock. @@ -843,7 +843,7 @@ Selects the file, with the path provided by ``file``, in the FileSystem dock. .. rst-class:: classref-method -|void| **set_current_feature_profile**\ (\ profile_name\: :ref:`String`\ ) +|void| **set_current_feature_profile**\ (\ profile_name\: :ref:`String`\ ) :ref:`🔗` Selects and activates the specified feature profile with the given ``profile_name``. Set ``profile_name`` to an empty string to reset to the default feature profile. @@ -859,7 +859,7 @@ A feature profile can be created programmatically using the :ref:`EditorFeatureP .. rst-class:: classref-method -|void| **set_main_screen_editor**\ (\ name\: :ref:`String`\ ) +|void| **set_main_screen_editor**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Sets the editor's current main screen to the one specified in ``name``. ``name`` must match the title of the tab in question exactly (e.g. ``2D``, ``3D``, ``Script``, or ``AssetLib`` for default tabs). @@ -871,7 +871,7 @@ Sets the editor's current main screen to the one specified in ``name``. ``name`` .. rst-class:: classref-method -|void| **set_plugin_enabled**\ (\ plugin\: :ref:`String`, enabled\: :ref:`bool`\ ) +|void| **set_plugin_enabled**\ (\ plugin\: :ref:`String`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets the enabled status of a plugin. The plugin name is the same as its directory name. @@ -883,7 +883,7 @@ Sets the enabled status of a plugin. The plugin name is the same as its director .. rst-class:: classref-method -|void| **stop_playing_scene**\ (\ ) +|void| **stop_playing_scene**\ (\ ) :ref:`🔗` Stops the scene that is currently playing. diff --git a/classes/class_editornode3dgizmo.rst b/classes/class_editornode3dgizmo.rst index fcc1b8c41b0..ef8a09dc424 100644 --- a/classes/class_editornode3dgizmo.rst +++ b/classes/class_editornode3dgizmo.rst @@ -94,7 +94,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_begin_handle_action**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| +|void| **_begin_handle_action**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -108,7 +108,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_commit_handle**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| +|void| **_commit_handle**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to commit a handle being edited (handles must have been previously added by :ref:`add_handles`). This usually means creating an :ref:`UndoRedo` action for the change, using the current handle value as "do" and the ``restore`` argument as "undo". @@ -124,7 +124,7 @@ The ``secondary`` argument is ``true`` when the committed handle is secondary (s .. rst-class:: classref-method -|void| **_commit_subgizmos**\ (\ ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| +|void| **_commit_subgizmos**\ (\ ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to commit a group of subgizmos being edited (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). This usually means creating an :ref:`UndoRedo` action for the change, using the current transforms as "do" and the ``restores`` transforms as "undo". @@ -138,7 +138,7 @@ If the ``cancel`` argument is ``true``, the ``restores`` transforms should be di .. rst-class:: classref-method -:ref:`String` **_get_handle_name**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| +:ref:`String` **_get_handle_name**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Override this method to return the name of an edited handle (handles must have been previously added by :ref:`add_handles`). Handles can be named for reference to the user when editing. @@ -152,7 +152,7 @@ The ``secondary`` argument is ``true`` when the requested handle is secondary (s .. rst-class:: classref-method -:ref:`Variant` **_get_handle_value**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| +:ref:`Variant` **_get_handle_value**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the ``restore`` argument in :ref:`_commit_handle`. @@ -166,7 +166,7 @@ The ``secondary`` argument is ``true`` when the requested handle is secondary (s .. rst-class:: classref-method -:ref:`Transform3D` **_get_subgizmo_transform**\ (\ id\: :ref:`int`\ ) |virtual| |const| +:ref:`Transform3D` **_get_subgizmo_transform**\ (\ id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the ``restore`` argument in :ref:`_commit_subgizmos`. @@ -178,7 +178,7 @@ Override this method to return the current transform of a subgizmo. This transfo .. rst-class:: classref-method -:ref:`bool` **_is_handle_highlighted**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| +:ref:`bool` **_is_handle_highlighted**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Override this method to return ``true`` whenever the given handle should be highlighted in the editor. @@ -192,7 +192,7 @@ The ``secondary`` argument is ``true`` when the requested handle is secondary (s .. rst-class:: classref-method -|void| **_redraw**\ (\ ) |virtual| +|void| **_redraw**\ (\ ) |virtual| :ref:`🔗` Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call :ref:`clear` at the beginning of this method and then add visual elements depending on the node's properties. @@ -204,7 +204,7 @@ Override this method to add all the gizmo elements whenever a gizmo update is re .. rst-class:: classref-method -|void| **_set_handle**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| +|void| **_set_handle**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Override this method to update the node properties when the user drags a gizmo handle (previously added with :ref:`add_handles`). The provided ``point`` is the mouse position in screen coordinates and the ``camera`` can be used to convert it to raycasts. @@ -218,7 +218,7 @@ The ``secondary`` argument is ``true`` when the edited handle is secondary (see .. rst-class:: classref-method -|void| **_set_subgizmo_transform**\ (\ id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_set_subgizmo_transform**\ (\ id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` Override this method to update the node properties during subgizmo editing (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). The ``transform`` is given in the :ref:`Node3D`'s local coordinate system. @@ -230,7 +230,7 @@ Override this method to update the node properties during subgizmo editing (see .. rst-class:: classref-method -:ref:`PackedInt32Array` **_subgizmos_intersect_frustum**\ (\ camera\: :ref:`Camera3D`, frustum\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| +:ref:`PackedInt32Array` **_subgizmos_intersect_frustum**\ (\ camera\: :ref:`Camera3D`, frustum\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| :ref:`🔗` Override this method to allow selecting subgizmos using mouse drag box selection. Given a ``camera`` and a ``frustum``, this method should return which subgizmos are contained within the frustum. The ``frustum`` argument consists of an array with all the :ref:`Plane`\ s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. @@ -242,7 +242,7 @@ Override this method to allow selecting subgizmos using mouse drag box selection .. rst-class:: classref-method -:ref:`int` **_subgizmos_intersect_ray**\ (\ camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| |const| +:ref:`int` **_subgizmos_intersect_ray**\ (\ camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` Override this method to allow selecting subgizmos using mouse clicks. Given a ``camera`` and a ``point`` in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. @@ -254,7 +254,7 @@ Override this method to allow selecting subgizmos using mouse clicks. Given a `` .. rst-class:: classref-method -|void| **add_collision_segments**\ (\ segments\: :ref:`PackedVector3Array`\ ) +|void| **add_collision_segments**\ (\ segments\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Adds the specified ``segments`` to the gizmo's collision shape for picking. Call this method during :ref:`_redraw`. @@ -266,7 +266,7 @@ Adds the specified ``segments`` to the gizmo's collision shape for picking. Call .. rst-class:: classref-method -|void| **add_collision_triangles**\ (\ triangles\: :ref:`TriangleMesh`\ ) +|void| **add_collision_triangles**\ (\ triangles\: :ref:`TriangleMesh`\ ) :ref:`🔗` Adds collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this method during :ref:`_redraw`. @@ -278,7 +278,7 @@ Adds collision triangles to the gizmo for picking. A :ref:`TriangleMesh`, material\: :ref:`Material`, ids\: :ref:`PackedInt32Array`, billboard\: :ref:`bool` = false, secondary\: :ref:`bool` = false\ ) +|void| **add_handles**\ (\ handles\: :ref:`PackedVector3Array`, material\: :ref:`Material`, ids\: :ref:`PackedInt32Array`, billboard\: :ref:`bool` = false, secondary\: :ref:`bool` = false\ ) :ref:`🔗` Adds a list of handles (points) which can be used to edit the properties of the gizmo's :ref:`Node3D`. The ``ids`` argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the ``handles`` argument order. @@ -294,7 +294,7 @@ There are virtual methods which will be called upon editing of these handles. Ca .. rst-class:: classref-method -|void| **add_lines**\ (\ lines\: :ref:`PackedVector3Array`, material\: :ref:`Material`, billboard\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **add_lines**\ (\ lines\: :ref:`PackedVector3Array`, material\: :ref:`Material`, billboard\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during :ref:`_redraw`. @@ -306,7 +306,7 @@ Adds lines to the gizmo (as sets of 2 points), with a given material. The lines .. rst-class:: classref-method -|void| **add_mesh**\ (\ mesh\: :ref:`Mesh`, material\: :ref:`Material` = null, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), skeleton\: :ref:`SkinReference` = null\ ) +|void| **add_mesh**\ (\ mesh\: :ref:`Mesh`, material\: :ref:`Material` = null, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), skeleton\: :ref:`SkinReference` = null\ ) :ref:`🔗` Adds a mesh to the gizmo with the specified ``material``, local ``transform`` and ``skeleton``. Call this method during :ref:`_redraw`. @@ -318,7 +318,7 @@ Adds a mesh to the gizmo with the specified ``material``, local ``transform`` an .. rst-class:: classref-method -|void| **add_unscaled_billboard**\ (\ material\: :ref:`Material`, default_scale\: :ref:`float` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **add_unscaled_billboard**\ (\ material\: :ref:`Material`, default_scale\: :ref:`float` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Adds an unscaled billboard for visualization and selection. Call this method during :ref:`_redraw`. @@ -330,7 +330,7 @@ Adds an unscaled billboard for visualization and selection. Call this method dur .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Removes everything in the gizmo including meshes, collisions and handles. @@ -342,7 +342,7 @@ Removes everything in the gizmo including meshes, collisions and handles. .. rst-class:: classref-method -:ref:`Node3D` **get_node_3d**\ (\ ) |const| +:ref:`Node3D` **get_node_3d**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Node3D` node associated with this gizmo. @@ -354,7 +354,7 @@ Returns the :ref:`Node3D` node associated with this gizmo. .. rst-class:: classref-method -:ref:`EditorNode3DGizmoPlugin` **get_plugin**\ (\ ) |const| +:ref:`EditorNode3DGizmoPlugin` **get_plugin**\ (\ ) |const| :ref:`🔗` Returns the :ref:`EditorNode3DGizmoPlugin` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorNode3DGizmoPlugin.get_material`. @@ -366,7 +366,7 @@ Returns the :ref:`EditorNode3DGizmoPlugin` that o .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_subgizmo_selection**\ (\ ) |const| +:ref:`PackedInt32Array` **get_subgizmo_selection**\ (\ ) |const| :ref:`🔗` Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during :ref:`_redraw`. @@ -378,7 +378,7 @@ Returns a list of the currently selected subgizmos. Can be used to highlight sel .. rst-class:: classref-method -:ref:`bool` **is_subgizmo_selected**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **is_subgizmo_selected**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given subgizmo is currently selected. Can be used to highlight selected elements during :ref:`_redraw`. @@ -390,7 +390,7 @@ Returns ``true`` if the given subgizmo is currently selected. Can be used to hig .. rst-class:: classref-method -|void| **set_hidden**\ (\ hidden\: :ref:`bool`\ ) +|void| **set_hidden**\ (\ hidden\: :ref:`bool`\ ) :ref:`🔗` Sets the gizmo's hidden state. If ``true``, the gizmo will be hidden. If ``false``, it will be shown. @@ -402,7 +402,7 @@ Sets the gizmo's hidden state. If ``true``, the gizmo will be hidden. If ``false .. rst-class:: classref-method -|void| **set_node_3d**\ (\ node\: :ref:`Node`\ ) +|void| **set_node_3d**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Sets the reference :ref:`Node3D` node for the gizmo. ``node`` must inherit from :ref:`Node3D`. diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index 1dc15c01563..f8404550182 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_begin_handle_action**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| +|void| **_begin_handle_action**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -113,7 +113,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_be_hidden**\ (\ ) |virtual| |const| +:ref:`bool` **_can_be_hidden**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns ``true`` if not overridden. @@ -125,7 +125,7 @@ Override this method to define whether the gizmos handled by this plugin can be .. rst-class:: classref-method -|void| **_commit_handle**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| +|void| **_commit_handle**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to commit a handle being edited (handles must have been previously added by :ref:`EditorNode3DGizmo.add_handles` during :ref:`_redraw`). This usually means creating an :ref:`UndoRedo` action for the change, using the current handle value as "do" and the ``restore`` argument as "undo". @@ -143,7 +143,7 @@ Called for this plugin's active gizmos. .. rst-class:: classref-method -|void| **_commit_subgizmos**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| +|void| **_commit_subgizmos**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to commit a group of subgizmos being edited (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). This usually means creating an :ref:`UndoRedo` action for the change, using the current transforms as "do" and the ``restores`` transforms as "undo". @@ -157,7 +157,7 @@ If the ``cancel`` argument is ``true``, the ``restores`` transforms should be di .. rst-class:: classref-method -:ref:`EditorNode3DGizmo` **_create_gizmo**\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| +:ref:`EditorNode3DGizmo` **_create_gizmo**\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| :ref:`🔗` Override this method to return a custom :ref:`EditorNode3DGizmo` for the spatial nodes of your choice, return ``null`` for the rest of nodes. See also :ref:`_has_gizmo`. @@ -169,7 +169,7 @@ Override this method to return a custom :ref:`EditorNode3DGizmo` **_get_gizmo_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_gizmo_name**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to provide the name that will appear in the gizmo visibility menu. @@ -181,7 +181,7 @@ Override this method to provide the name that will appear in the gizmo visibilit .. rst-class:: classref-method -:ref:`String` **_get_handle_name**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| +:ref:`String` **_get_handle_name**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Override this method to provide gizmo's handle names. The ``secondary`` argument is ``true`` when the requested handle is secondary (see :ref:`EditorNode3DGizmo.add_handles` for more information). Called for this plugin's active gizmos. @@ -193,7 +193,7 @@ Override this method to provide gizmo's handle names. The ``secondary`` argument .. rst-class:: classref-method -:ref:`Variant` **_get_handle_value**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| +:ref:`Variant` **_get_handle_value**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the ``restore`` argument in :ref:`_commit_handle`. @@ -209,7 +209,7 @@ Called for this plugin's active gizmos. .. rst-class:: classref-method -:ref:`int` **_get_priority**\ (\ ) |virtual| |const| +:ref:`int` **_get_priority**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection. @@ -223,7 +223,7 @@ All built-in editor gizmos return a priority of ``-1``. If not overridden, this .. rst-class:: classref-method -:ref:`Transform3D` **_get_subgizmo_transform**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`\ ) |virtual| |const| +:ref:`Transform3D` **_get_subgizmo_transform**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the ``restore`` argument in :ref:`_commit_subgizmos`. Called for this plugin's active gizmos. @@ -235,7 +235,7 @@ Override this method to return the current transform of a subgizmo. As with all .. rst-class:: classref-method -:ref:`bool` **_has_gizmo**\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| +:ref:`bool` **_has_gizmo**\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| :ref:`🔗` Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a :ref:`Node3D` node is added to a scene this method is called, if it returns ``true`` the node gets a generic :ref:`EditorNode3DGizmo` assigned and is added to this plugin's list of active gizmos. @@ -247,7 +247,7 @@ Override this method to define which Node3D nodes have a gizmo from this plugin. .. rst-class:: classref-method -:ref:`bool` **_is_handle_highlighted**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| +:ref:`bool` **_is_handle_highlighted**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Override this method to return ``true`` whenever to given handle should be highlighted in the editor. The ``secondary`` argument is ``true`` when the requested handle is secondary (see :ref:`EditorNode3DGizmo.add_handles` for more information). Called for this plugin's active gizmos. @@ -259,7 +259,7 @@ Override this method to return ``true`` whenever to given handle should be highl .. rst-class:: classref-method -:ref:`bool` **_is_selectable_when_hidden**\ (\ ) |virtual| |const| +:ref:`bool` **_is_selectable_when_hidden**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden. @@ -271,7 +271,7 @@ Override this method to define whether Node3D with this gizmo should be selectab .. rst-class:: classref-method -|void| **_redraw**\ (\ gizmo\: :ref:`EditorNode3DGizmo`\ ) |virtual| +|void| **_redraw**\ (\ gizmo\: :ref:`EditorNode3DGizmo`\ ) |virtual| :ref:`🔗` Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call :ref:`EditorNode3DGizmo.clear` at the beginning of this method and then add visual elements depending on the node's properties. @@ -283,7 +283,7 @@ Override this method to add all the gizmo elements whenever a gizmo update is re .. rst-class:: classref-method -|void| **_set_handle**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| +|void| **_set_handle**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Override this method to update the node's properties when the user drags a gizmo handle (previously added with :ref:`EditorNode3DGizmo.add_handles`). The provided ``screen_pos`` is the mouse position in screen coordinates and the ``camera`` can be used to convert it to raycasts. @@ -299,7 +299,7 @@ Called for this plugin's active gizmos. .. rst-class:: classref-method -|void| **_set_subgizmo_transform**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_set_subgizmo_transform**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` Override this method to update the node properties during subgizmo editing (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). The ``transform`` is given in the Node3D's local coordinate system. Called for this plugin's active gizmos. @@ -311,7 +311,7 @@ Override this method to update the node properties during subgizmo editing (see .. rst-class:: classref-method -:ref:`PackedInt32Array` **_subgizmos_intersect_frustum**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, frustum_planes\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| +:ref:`PackedInt32Array` **_subgizmos_intersect_frustum**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, frustum_planes\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| :ref:`🔗` Override this method to allow selecting subgizmos using mouse drag box selection. Given a ``camera`` and ``frustum_planes``, this method should return which subgizmos are contained within the frustums. The ``frustum_planes`` argument consists of an array with all the :ref:`Plane`\ s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. Called for this plugin's active gizmos. @@ -323,7 +323,7 @@ Override this method to allow selecting subgizmos using mouse drag box selection .. rst-class:: classref-method -:ref:`int` **_subgizmos_intersect_ray**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| |const| +:ref:`int` **_subgizmos_intersect_ray**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` Override this method to allow selecting subgizmos using mouse clicks. Given a ``camera`` and a ``screen_pos`` in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. Called for this plugin's active gizmos. @@ -335,7 +335,7 @@ Override this method to allow selecting subgizmos using mouse clicks. Given a `` .. rst-class:: classref-method -|void| **add_material**\ (\ name\: :ref:`String`, material\: :ref:`StandardMaterial3D`\ ) +|void| **add_material**\ (\ name\: :ref:`String`, material\: :ref:`StandardMaterial3D`\ ) :ref:`🔗` Adds a new material to the internal material list for the plugin. It can then be accessed with :ref:`get_material`. Should not be overridden. @@ -347,7 +347,7 @@ Adds a new material to the internal material list for the plugin. It can then be .. rst-class:: classref-method -|void| **create_handle_material**\ (\ name\: :ref:`String`, billboard\: :ref:`bool` = false, texture\: :ref:`Texture2D` = null\ ) +|void| **create_handle_material**\ (\ name\: :ref:`String`, billboard\: :ref:`bool` = false, texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorNode3DGizmo.add_handles`. Should not be overridden. @@ -361,7 +361,7 @@ You can optionally provide a texture to use instead of the default icon. .. rst-class:: classref-method -|void| **create_icon_material**\ (\ name\: :ref:`String`, texture\: :ref:`Texture2D`, on_top\: :ref:`bool` = false, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **create_icon_material**\ (\ name\: :ref:`String`, texture\: :ref:`Texture2D`, on_top\: :ref:`bool` = false, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorNode3DGizmo.add_unscaled_billboard`. Should not be overridden. @@ -373,7 +373,7 @@ Creates an icon material with its variants (selected and/or editable) and adds t .. rst-class:: classref-method -|void| **create_material**\ (\ name\: :ref:`String`, color\: :ref:`Color`, billboard\: :ref:`bool` = false, on_top\: :ref:`bool` = false, use_vertex_color\: :ref:`bool` = false\ ) +|void| **create_material**\ (\ name\: :ref:`String`, color\: :ref:`Color`, billboard\: :ref:`bool` = false, on_top\: :ref:`bool` = false, use_vertex_color\: :ref:`bool` = false\ ) :ref:`🔗` Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorNode3DGizmo.add_mesh` and :ref:`EditorNode3DGizmo.add_lines`. Should not be overridden. @@ -385,7 +385,7 @@ Creates an unshaded material with its variants (selected and/or editable) and ad .. rst-class:: classref-method -:ref:`StandardMaterial3D` **get_material**\ (\ name\: :ref:`String`, gizmo\: :ref:`EditorNode3DGizmo` = null\ ) +:ref:`StandardMaterial3D` **get_material**\ (\ name\: :ref:`String`, gizmo\: :ref:`EditorNode3DGizmo` = null\ ) :ref:`🔗` Gets material from the internal list of materials. If an :ref:`EditorNode3DGizmo` is provided, it will try to get the corresponding variant (selected and/or editable). diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index 41d5e1b2854..571d9a16aac 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_cache_dir**\ (\ ) |const| +:ref:`String` **get_cache_dir**\ (\ ) |const| :ref:`🔗` Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails). @@ -87,7 +87,7 @@ Returns the absolute path to the user's cache folder. This folder should be used .. rst-class:: classref-method -:ref:`String` **get_config_dir**\ (\ ) |const| +:ref:`String` **get_config_dir**\ (\ ) |const| :ref:`🔗` Returns the absolute path to the user's configuration folder. This folder should be used for *persistent* user configuration files. @@ -107,7 +107,7 @@ Returns the absolute path to the user's configuration folder. This folder should .. rst-class:: classref-method -:ref:`String` **get_data_dir**\ (\ ) |const| +:ref:`String` **get_data_dir**\ (\ ) |const| :ref:`🔗` Returns the absolute path to the user's data folder. This folder should be used for *persistent* user data files such as installed export templates. @@ -127,7 +127,7 @@ Returns the absolute path to the user's data folder. This folder should be used .. rst-class:: classref-method -:ref:`String` **get_project_settings_dir**\ (\ ) |const| +:ref:`String` **get_project_settings_dir**\ (\ ) |const| :ref:`🔗` Returns the project-specific editor settings path. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved. @@ -139,7 +139,7 @@ Returns the project-specific editor settings path. Projects all have a unique su .. rst-class:: classref-method -:ref:`String` **get_self_contained_file**\ (\ ) |const| +:ref:`String` **get_self_contained_file**\ (\ ) |const| :ref:`🔗` Returns the absolute path to the self-contained file that makes the current Godot editor instance be considered as self-contained. Returns an empty string if the current Godot editor instance isn't self-contained. See also :ref:`is_self_contained`. @@ -151,7 +151,7 @@ Returns the absolute path to the self-contained file that makes the current Godo .. rst-class:: classref-method -:ref:`bool` **is_self_contained**\ (\ ) |const| +:ref:`bool` **is_self_contained**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the editor is marked as self-contained, ``false`` otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an ``editor_data/`` folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 16979d928c0..cd00a3e7b51 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -191,7 +191,7 @@ Signals .. rst-class:: classref-signal -**main_screen_changed**\ (\ screen_name\: :ref:`String`\ ) +**main_screen_changed**\ (\ screen_name\: :ref:`String`\ ) :ref:`🔗` Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib**). Also works with custom screens defined by plugins. @@ -203,7 +203,7 @@ Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib* .. rst-class:: classref-signal -**project_settings_changed**\ (\ ) +**project_settings_changed**\ (\ ) :ref:`🔗` **Deprecated:** Use :ref:`ProjectSettings.settings_changed` instead. @@ -217,7 +217,7 @@ Emitted when any project setting has changed. .. rst-class:: classref-signal -**resource_saved**\ (\ resource\: :ref:`Resource`\ ) +**resource_saved**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` Emitted when the given ``resource`` was saved on disc. See also :ref:`scene_saved`. @@ -229,7 +229,7 @@ Emitted when the given ``resource`` was saved on disc. See also :ref:`scene_save .. rst-class:: classref-signal -**scene_changed**\ (\ scene_root\: :ref:`Node`\ ) +**scene_changed**\ (\ scene_root\: :ref:`Node`\ ) :ref:`🔗` Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be ``null``. @@ -241,7 +241,7 @@ Emitted when the scene is changed in the editor. The argument will return the ro .. rst-class:: classref-signal -**scene_closed**\ (\ filepath\: :ref:`String`\ ) +**scene_closed**\ (\ filepath\: :ref:`String`\ ) :ref:`🔗` Emitted when user closes a scene. The argument is a file path to the closed scene. @@ -253,7 +253,7 @@ Emitted when user closes a scene. The argument is a file path to the closed scen .. rst-class:: classref-signal -**scene_saved**\ (\ filepath\: :ref:`String`\ ) +**scene_saved**\ (\ filepath\: :ref:`String`\ ) :ref:`🔗` Emitted when a scene was saved on disc. The argument is a file path to the saved scene. See also :ref:`resource_saved`. @@ -270,7 +270,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CustomControlContainer**: +enum **CustomControlContainer**: :ref:`🔗` .. _class_EditorPlugin_constant_CONTAINER_TOOLBAR: @@ -376,7 +376,7 @@ Tab of Project Settings dialog, to the right of other tabs. .. rst-class:: classref-enumeration -enum **DockSlot**: +enum **DockSlot**: :ref:`🔗` .. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UL: @@ -458,7 +458,7 @@ Represents the size of the :ref:`DockSlot` enum. .. rst-class:: classref-enumeration -enum **AfterGUIInput**: +enum **AfterGUIInput**: :ref:`🔗` .. _class_EditorPlugin_constant_AFTER_GUI_INPUT_PASS: @@ -497,7 +497,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_changes**\ (\ ) |virtual| +|void| **_apply_changes**\ (\ ) |virtual| :ref:`🔗` This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. @@ -511,7 +511,7 @@ This is used, for example, in shader editors to let the plugin know that it must .. rst-class:: classref-method -:ref:`bool` **_build**\ (\ ) |virtual| +:ref:`bool` **_build**\ (\ ) |virtual| :ref:`🔗` This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs. @@ -525,7 +525,7 @@ This method must return a boolean. If this method returns ``false``, the project .. rst-class:: classref-method -|void| **_clear**\ (\ ) |virtual| +|void| **_clear**\ (\ ) |virtual| :ref:`🔗` Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. @@ -537,7 +537,7 @@ Clear all the state and reset the object being edited to zero. This ensures your .. rst-class:: classref-method -|void| **_disable_plugin**\ (\ ) |virtual| +|void| **_disable_plugin**\ (\ ) |virtual| :ref:`🔗` Called by the engine when the user disables the **EditorPlugin** in the Plugin tab of the project settings window. @@ -549,7 +549,7 @@ Called by the engine when the user disables the **EditorPlugin** in the Plugin t .. rst-class:: classref-method -|void| **_edit**\ (\ object\: :ref:`Object`\ ) |virtual| +|void| **_edit**\ (\ object\: :ref:`Object`\ ) |virtual| :ref:`🔗` This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. @@ -563,7 +563,7 @@ This function is used for plugins that edit specific object types (nodes or reso .. rst-class:: classref-method -|void| **_enable_plugin**\ (\ ) |virtual| +|void| **_enable_plugin**\ (\ ) |virtual| :ref:`🔗` Called by the engine when the user enables the **EditorPlugin** in the Plugin tab of the project settings window. @@ -575,7 +575,7 @@ Called by the engine when the user enables the **EditorPlugin** in the Plugin ta .. rst-class:: classref-method -|void| **_forward_3d_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| +|void| **_forward_3d_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` Called by the engine when the 3D editor's viewport is updated. Use the ``overlay`` :ref:`Control` for drawing. You can update the viewport manually by calling :ref:`update_overlays`. @@ -624,7 +624,7 @@ Called by the engine when the 3D editor's viewport is updated. Use the ``overlay .. rst-class:: classref-method -|void| **_forward_3d_force_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| +|void| **_forward_3d_force_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` This method is the same as :ref:`_forward_3d_draw_over_viewport`, except it draws on top of everything. Useful when you need an extra layer that shows over anything else. @@ -638,7 +638,7 @@ You need to enable calling of this method by using :ref:`set_force_draw_over_for .. rst-class:: classref-method -:ref:`int` **_forward_3d_gui_input**\ (\ viewport_camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`\ ) |virtual| +:ref:`int` **_forward_3d_gui_input**\ (\ viewport_camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Called when there is a root node in the current edited scene, :ref:`_handles` is implemented, and an :ref:`InputEvent` happens in the 3D viewport. The return value decides whether the :ref:`InputEvent` is consumed or forwarded to other **EditorPlugin**\ s. See :ref:`AfterGUIInput` for options. @@ -694,7 +694,7 @@ Must ``return EditorPlugin.AFTER_GUI_INPUT_PASS`` in order to forward the :ref:` .. rst-class:: classref-method -|void| **_forward_canvas_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| +|void| **_forward_canvas_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` Called by the engine when the 2D editor's viewport is updated. Use the ``overlay`` :ref:`Control` for drawing. You can update the viewport manually by calling :ref:`update_overlays`. @@ -743,7 +743,7 @@ Called by the engine when the 2D editor's viewport is updated. Use the ``overlay .. rst-class:: classref-method -|void| **_forward_canvas_force_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| +|void| **_forward_canvas_force_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` This method is the same as :ref:`_forward_canvas_draw_over_viewport`, except it draws on top of everything. Useful when you need an extra layer that shows over anything else. @@ -757,7 +757,7 @@ You need to enable calling of this method by using :ref:`set_force_draw_over_for .. rst-class:: classref-method -:ref:`bool` **_forward_canvas_gui_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| +:ref:`bool` **_forward_canvas_gui_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Called when there is a root node in the current edited scene, :ref:`_handles` is implemented and an :ref:`InputEvent` happens in the 2D viewport. Intercepts the :ref:`InputEvent`, if ``return true`` **EditorPlugin** consumes the ``event``, otherwise forwards ``event`` to other Editor classes. @@ -819,7 +819,7 @@ Must ``return false`` in order to forward the :ref:`InputEvent .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_breakpoints**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_breakpoints**\ (\ ) |virtual| |const| :ref:`🔗` This is for editors that edit script-based objects. You can return a list of breakpoints in the format (``script:line``), for example: ``res://path_to_script.gd:25``. @@ -831,7 +831,7 @@ This is for editors that edit script-based objects. You can return a list of bre .. rst-class:: classref-method -:ref:`Texture2D` **_get_plugin_icon**\ (\ ) |virtual| |const| +:ref:`Texture2D` **_get_plugin_icon**\ (\ ) |virtual| |const| :ref:`🔗` Override this method in your plugin to return a :ref:`Texture2D` in order to give it an icon. @@ -870,7 +870,7 @@ Ideally, the plugin icon should be white with a transparent background and 16×1 .. rst-class:: classref-method -:ref:`String` **_get_plugin_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_plugin_name**\ (\ ) |virtual| |const| :ref:`🔗` Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. @@ -884,7 +884,7 @@ For main screen plugins, this appears at the top of the screen, to the right of .. rst-class:: classref-method -:ref:`Dictionary` **_get_state**\ (\ ) |virtual| |const| +:ref:`Dictionary` **_get_state**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to provide a state data you want to be saved, like view position, grid settings, folding, etc. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). This data is automatically saved for each scene in an ``editstate`` file in the editor metadata folder. If you want to store global (scene-independent) editor data for your plugin, you can use :ref:`_get_window_layout` instead. @@ -908,7 +908,7 @@ Use :ref:`_set_state` to restore y .. rst-class:: classref-method -:ref:`String` **_get_unsaved_status**\ (\ for_scene\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_get_unsaved_status**\ (\ for_scene\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Override this method to provide a custom message that lists unsaved changes. The editor will call this method when exiting or when closing a scene, and display the returned string in a confirmation dialog. Return empty string if the plugin has no unsaved changes. @@ -946,7 +946,7 @@ If the plugin has no scene-specific changes, you can ignore the calls when closi .. rst-class:: classref-method -|void| **_get_window_layout**\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| +|void| **_get_window_layout**\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| :ref:`🔗` Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when :ref:`queue_save_layout` is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the ``editor_layout.cfg`` file in the editor metadata directory. @@ -966,7 +966,7 @@ Use :ref:`_set_window_layout` **_handles**\ (\ object\: :ref:`Object`\ ) |virtual| |const| +:ref:`bool` **_handles**\ (\ object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` Implement this function if your plugin edits a specific type of object (Resource or Node). If you return ``true``, then you will get the functions :ref:`_edit` and :ref:`_make_visible` called when the editor requests them. If you have declared the methods :ref:`_forward_canvas_gui_input` and :ref:`_forward_3d_gui_input` these will be called too. @@ -980,7 +980,7 @@ Implement this function if your plugin edits a specific type of object (Resource .. rst-class:: classref-method -:ref:`bool` **_has_main_screen**\ (\ ) |virtual| |const| +:ref:`bool` **_has_main_screen**\ (\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script** and **AssetLib**). @@ -1017,7 +1017,7 @@ Use :ref:`_get_plugin_name` .. rst-class:: classref-method -|void| **_make_visible**\ (\ visible\: :ref:`bool`\ ) |virtual| +|void| **_make_visible**\ (\ visible\: :ref:`bool`\ ) |virtual| :ref:`🔗` This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. @@ -1031,7 +1031,7 @@ Remember that you have to manage the visibility of all your editor controls manu .. rst-class:: classref-method -|void| **_save_external_data**\ (\ ) |virtual| +|void| **_save_external_data**\ (\ ) |virtual| :ref:`🔗` This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. @@ -1043,7 +1043,7 @@ This method is called after the editor saves the project or when it's closed. It .. rst-class:: classref-method -|void| **_set_state**\ (\ state\: :ref:`Dictionary`\ ) |virtual| +|void| **_set_state**\ (\ state\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` Restore the state saved by :ref:`_get_state`. This method is called when the current scene tab is changed in the editor. @@ -1063,7 +1063,7 @@ Restore the state saved by :ref:`_get_state`\ ) |virtual| +|void| **_set_window_layout**\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| :ref:`🔗` Restore the plugin GUI layout and data saved by :ref:`_get_window_layout`. This method is called for every plugin on editor startup. Use the provided ``configuration`` file to read your saved data. @@ -1081,7 +1081,7 @@ Restore the plugin GUI layout and data saved by :ref:`_get_window_layout`, path\: :ref:`String`\ ) +|void| **add_autoload_singleton**\ (\ name\: :ref:`String`, path\: :ref:`String`\ ) :ref:`🔗` Adds a script at ``path`` to the Autoload list as ``name``. @@ -1093,7 +1093,7 @@ Adds a script at ``path`` to the Autoload list as ``name``. .. rst-class:: classref-method -:ref:`Button` **add_control_to_bottom_panel**\ (\ control\: :ref:`Control`, title\: :ref:`String`, shortcut\: :ref:`Shortcut` = null\ ) +:ref:`Button` **add_control_to_bottom_panel**\ (\ control\: :ref:`Control`, title\: :ref:`String`, shortcut\: :ref:`Shortcut` = null\ ) :ref:`🔗` Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel` and free it with :ref:`Node.queue_free`. @@ -1107,7 +1107,7 @@ Optionally, you can specify a shortcut parameter. When pressed, this shortcut wi .. rst-class:: classref-method -|void| **add_control_to_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) +|void| **add_control_to_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) :ref:`🔗` Adds a custom control to a container (see :ref:`CustomControlContainer`). There are many locations where custom controls can be added in the editor UI. @@ -1123,7 +1123,7 @@ When your plugin is deactivated, make sure to remove your custom control with :r .. rst-class:: classref-method -|void| **add_control_to_dock**\ (\ slot\: :ref:`DockSlot`, control\: :ref:`Control`, shortcut\: :ref:`Shortcut` = null\ ) +|void| **add_control_to_dock**\ (\ slot\: :ref:`DockSlot`, control\: :ref:`Control`, shortcut\: :ref:`Shortcut` = null\ ) :ref:`🔗` Adds the control to a specific dock slot (see :ref:`DockSlot` for options). @@ -1141,7 +1141,7 @@ Optionally, you can specify a shortcut parameter. When pressed, this shortcut wi .. rst-class:: classref-method -|void| **add_custom_type**\ (\ type\: :ref:`String`, base\: :ref:`String`, script\: :ref:`Script`, icon\: :ref:`Texture2D`\ ) +|void| **add_custom_type**\ (\ type\: :ref:`String`, base\: :ref:`String`, script\: :ref:`Script`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. @@ -1163,7 +1163,7 @@ During run-time, this will be a simple object with a script so this function doe .. rst-class:: classref-method -|void| **add_debugger_plugin**\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) +|void| **add_debugger_plugin**\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) :ref:`🔗` Adds a :ref:`Script` as debugger plugin to the Debugger. The script must extend :ref:`EditorDebuggerPlugin`. @@ -1175,7 +1175,7 @@ Adds a :ref:`Script` as debugger plugin to the Debugger. The scrip .. rst-class:: classref-method -|void| **add_export_plugin**\ (\ plugin\: :ref:`EditorExportPlugin`\ ) +|void| **add_export_plugin**\ (\ plugin\: :ref:`EditorExportPlugin`\ ) :ref:`🔗` Registers a new :ref:`EditorExportPlugin`. Export plugins are used to perform tasks when the project is being exported. @@ -1189,7 +1189,7 @@ See :ref:`add_inspector_plugin` .. rst-class:: classref-method -|void| **add_import_plugin**\ (\ importer\: :ref:`EditorImportPlugin`, first_priority\: :ref:`bool` = false\ ) +|void| **add_import_plugin**\ (\ importer\: :ref:`EditorImportPlugin`, first_priority\: :ref:`bool` = false\ ) :ref:`🔗` Registers a new :ref:`EditorImportPlugin`. Import plugins are used to import custom and unsupported assets as a custom :ref:`Resource` type. @@ -1207,7 +1207,7 @@ See :ref:`add_inspector_plugin` .. rst-class:: classref-method -|void| **add_inspector_plugin**\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) +|void| **add_inspector_plugin**\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) :ref:`🔗` Registers a new :ref:`EditorInspectorPlugin`. Inspector plugins are used to extend :ref:`EditorInspector` and provide custom configuration tools for your object's properties. @@ -1237,7 +1237,7 @@ Registers a new :ref:`EditorInspectorPlugin`. Inspe .. rst-class:: classref-method -|void| **add_node_3d_gizmo_plugin**\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) +|void| **add_node_3d_gizmo_plugin**\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) :ref:`🔗` Registers a new :ref:`EditorNode3DGizmoPlugin`. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a :ref:`Node3D`. @@ -1251,7 +1251,7 @@ See :ref:`add_inspector_plugin` .. rst-class:: classref-method -|void| **add_resource_conversion_plugin**\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) +|void| **add_resource_conversion_plugin**\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) :ref:`🔗` Registers a new :ref:`EditorResourceConversionPlugin`. Resource conversion plugins are used to add custom resource converters to the editor inspector. @@ -1265,7 +1265,7 @@ See :ref:`EditorResourceConversionPlugin` .. rst-class:: classref-method -|void| **add_scene_format_importer_plugin**\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`, first_priority\: :ref:`bool` = false\ ) +|void| **add_scene_format_importer_plugin**\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`, first_priority\: :ref:`bool` = false\ ) :ref:`🔗` Registers a new :ref:`EditorSceneFormatImporter`. Scene importers are used to import custom 3D asset formats as scenes. @@ -1279,7 +1279,7 @@ If ``first_priority`` is ``true``, the new import plugin is inserted first in th .. rst-class:: classref-method -|void| **add_scene_post_import_plugin**\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`, first_priority\: :ref:`bool` = false\ ) +|void| **add_scene_post_import_plugin**\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`, first_priority\: :ref:`bool` = false\ ) :ref:`🔗` Add a :ref:`EditorScenePostImportPlugin`. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. @@ -1293,7 +1293,7 @@ If ``first_priority`` is ``true``, the new import plugin is inserted first in th .. rst-class:: classref-method -|void| **add_tool_menu_item**\ (\ name\: :ref:`String`, callable\: :ref:`Callable`\ ) +|void| **add_tool_menu_item**\ (\ name\: :ref:`String`, callable\: :ref:`Callable`\ ) :ref:`🔗` Adds a custom menu item to **Project > Tools** named ``name``. When clicked, the provided ``callable`` will be called. @@ -1305,7 +1305,7 @@ Adds a custom menu item to **Project > Tools** named ``name``. When clicked, the .. rst-class:: classref-method -|void| **add_tool_submenu_item**\ (\ name\: :ref:`String`, submenu\: :ref:`PopupMenu`\ ) +|void| **add_tool_submenu_item**\ (\ name\: :ref:`String`, submenu\: :ref:`PopupMenu`\ ) :ref:`🔗` Adds a custom :ref:`PopupMenu` submenu under **Project > Tools >** ``name``. Use :ref:`remove_tool_menu_item` on plugin clean up to remove the menu. @@ -1317,7 +1317,7 @@ Adds a custom :ref:`PopupMenu` submenu under **Project > Tools .. rst-class:: classref-method -|void| **add_translation_parser_plugin**\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) +|void| **add_translation_parser_plugin**\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) :ref:`🔗` Registers a custom translation parser plugin for extracting translatable strings from custom files. @@ -1329,7 +1329,7 @@ Registers a custom translation parser plugin for extracting translatable strings .. rst-class:: classref-method -|void| **add_undo_redo_inspector_hook_callback**\ (\ callable\: :ref:`Callable`\ ) +|void| **add_undo_redo_inspector_hook_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. @@ -1343,7 +1343,7 @@ The callback should have 4 arguments: :ref:`Object` ``undo_redo``, .. rst-class:: classref-method -:ref:`EditorInterface` **get_editor_interface**\ (\ ) +:ref:`EditorInterface` **get_editor_interface**\ (\ ) :ref:`🔗` **Deprecated:** :ref:`EditorInterface` is a global singleton and can be accessed directly by its name. @@ -1357,7 +1357,7 @@ Returns the :ref:`EditorInterface` singleton instance. .. rst-class:: classref-method -:ref:`PopupMenu` **get_export_as_menu**\ (\ ) +:ref:`PopupMenu` **get_export_as_menu**\ (\ ) :ref:`🔗` Returns the :ref:`PopupMenu` under **Scene > Export As...**. @@ -1369,7 +1369,7 @@ Returns the :ref:`PopupMenu` under **Scene > Export As...**. .. rst-class:: classref-method -:ref:`String` **get_plugin_version**\ (\ ) |const| +:ref:`String` **get_plugin_version**\ (\ ) |const| :ref:`🔗` Provide the version of the plugin declared in the ``plugin.cfg`` config file. @@ -1381,7 +1381,7 @@ Provide the version of the plugin declared in the ``plugin.cfg`` config file. .. rst-class:: classref-method -:ref:`ScriptCreateDialog` **get_script_create_dialog**\ (\ ) +:ref:`ScriptCreateDialog` **get_script_create_dialog**\ (\ ) :ref:`🔗` Gets the Editor's dialog used for making scripts. @@ -1397,7 +1397,7 @@ Gets the Editor's dialog used for making scripts. .. rst-class:: classref-method -:ref:`EditorUndoRedoManager` **get_undo_redo**\ (\ ) +:ref:`EditorUndoRedoManager` **get_undo_redo**\ (\ ) :ref:`🔗` Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. @@ -1409,7 +1409,7 @@ Gets the undo/redo object. Most actions in the editor can be undoable, so use th .. rst-class:: classref-method -|void| **hide_bottom_panel**\ (\ ) +|void| **hide_bottom_panel**\ (\ ) :ref:`🔗` Minimizes the bottom panel. @@ -1421,7 +1421,7 @@ Minimizes the bottom panel. .. rst-class:: classref-method -|void| **make_bottom_panel_item_visible**\ (\ item\: :ref:`Control`\ ) +|void| **make_bottom_panel_item_visible**\ (\ item\: :ref:`Control`\ ) :ref:`🔗` Makes a specific item in the bottom panel visible. @@ -1433,7 +1433,7 @@ Makes a specific item in the bottom panel visible. .. rst-class:: classref-method -|void| **queue_save_layout**\ (\ ) +|void| **queue_save_layout**\ (\ ) :ref:`🔗` Queue save the project's editor layout. @@ -1445,7 +1445,7 @@ Queue save the project's editor layout. .. rst-class:: classref-method -|void| **remove_autoload_singleton**\ (\ name\: :ref:`String`\ ) +|void| **remove_autoload_singleton**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Removes an Autoload ``name`` from the list. @@ -1457,7 +1457,7 @@ Removes an Autoload ``name`` from the list. .. rst-class:: classref-method -|void| **remove_control_from_bottom_panel**\ (\ control\: :ref:`Control`\ ) +|void| **remove_control_from_bottom_panel**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Removes the control from the bottom panel. You have to manually :ref:`Node.queue_free` the control. @@ -1469,7 +1469,7 @@ Removes the control from the bottom panel. You have to manually :ref:`Node.queue .. rst-class:: classref-method -|void| **remove_control_from_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) +|void| **remove_control_from_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) :ref:`🔗` Removes the control from the specified container. You have to manually :ref:`Node.queue_free` the control. @@ -1481,7 +1481,7 @@ Removes the control from the specified container. You have to manually :ref:`Nod .. rst-class:: classref-method -|void| **remove_control_from_docks**\ (\ control\: :ref:`Control`\ ) +|void| **remove_control_from_docks**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Removes the control from the dock. You have to manually :ref:`Node.queue_free` the control. @@ -1493,7 +1493,7 @@ Removes the control from the dock. You have to manually :ref:`Node.queue_free`\ ) +|void| **remove_custom_type**\ (\ type\: :ref:`String`\ ) :ref:`🔗` Removes a custom type added by :ref:`add_custom_type`. @@ -1505,7 +1505,7 @@ Removes a custom type added by :ref:`add_custom_type`\ ) +|void| **remove_debugger_plugin**\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) :ref:`🔗` Removes the debugger plugin with given script from the Debugger. @@ -1517,7 +1517,7 @@ Removes the debugger plugin with given script from the Debugger. .. rst-class:: classref-method -|void| **remove_export_plugin**\ (\ plugin\: :ref:`EditorExportPlugin`\ ) +|void| **remove_export_plugin**\ (\ plugin\: :ref:`EditorExportPlugin`\ ) :ref:`🔗` Removes an export plugin registered by :ref:`add_export_plugin`. @@ -1529,7 +1529,7 @@ Removes an export plugin registered by :ref:`add_export_plugin`\ ) +|void| **remove_import_plugin**\ (\ importer\: :ref:`EditorImportPlugin`\ ) :ref:`🔗` Removes an import plugin registered by :ref:`add_import_plugin`. @@ -1541,7 +1541,7 @@ Removes an import plugin registered by :ref:`add_import_plugin`\ ) +|void| **remove_inspector_plugin**\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) :ref:`🔗` Removes an inspector plugin registered by :ref:`add_import_plugin` @@ -1553,7 +1553,7 @@ Removes an inspector plugin registered by :ref:`add_import_plugin`\ ) +|void| **remove_node_3d_gizmo_plugin**\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) :ref:`🔗` Removes a gizmo plugin registered by :ref:`add_node_3d_gizmo_plugin`. @@ -1565,7 +1565,7 @@ Removes a gizmo plugin registered by :ref:`add_node_3d_gizmo_plugin`\ ) +|void| **remove_resource_conversion_plugin**\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) :ref:`🔗` Removes a resource conversion plugin registered by :ref:`add_resource_conversion_plugin`. @@ -1577,7 +1577,7 @@ Removes a resource conversion plugin registered by :ref:`add_resource_conversion .. rst-class:: classref-method -|void| **remove_scene_format_importer_plugin**\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`\ ) +|void| **remove_scene_format_importer_plugin**\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`\ ) :ref:`🔗` Removes a scene format importer registered by :ref:`add_scene_format_importer_plugin`. @@ -1589,7 +1589,7 @@ Removes a scene format importer registered by :ref:`add_scene_format_importer_pl .. rst-class:: classref-method -|void| **remove_scene_post_import_plugin**\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`\ ) +|void| **remove_scene_post_import_plugin**\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`\ ) :ref:`🔗` Remove the :ref:`EditorScenePostImportPlugin`, added with :ref:`add_scene_post_import_plugin`. @@ -1601,7 +1601,7 @@ Remove the :ref:`EditorScenePostImportPlugin` .. rst-class:: classref-method -|void| **remove_tool_menu_item**\ (\ name\: :ref:`String`\ ) +|void| **remove_tool_menu_item**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Removes a menu ``name`` from **Project > Tools**. @@ -1613,7 +1613,7 @@ Removes a menu ``name`` from **Project > Tools**. .. rst-class:: classref-method -|void| **remove_translation_parser_plugin**\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) +|void| **remove_translation_parser_plugin**\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) :ref:`🔗` Removes a custom translation parser plugin registered by :ref:`add_translation_parser_plugin`. @@ -1625,7 +1625,7 @@ Removes a custom translation parser plugin registered by :ref:`add_translation_p .. rst-class:: classref-method -|void| **remove_undo_redo_inspector_hook_callback**\ (\ callable\: :ref:`Callable`\ ) +|void| **remove_undo_redo_inspector_hook_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Removes a callback previously added by :ref:`add_undo_redo_inspector_hook_callback`. @@ -1637,7 +1637,7 @@ Removes a callback previously added by :ref:`add_undo_redo_inspector_hook_callba .. rst-class:: classref-method -|void| **set_dock_tab_icon**\ (\ control\: :ref:`Control`, icon\: :ref:`Texture2D`\ ) +|void| **set_dock_tab_icon**\ (\ control\: :ref:`Control`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the tab icon for the given control in a dock slot. Setting to ``null`` removes the icon. @@ -1649,7 +1649,7 @@ Sets the tab icon for the given control in a dock slot. Setting to ``null`` remo .. rst-class:: classref-method -|void| **set_force_draw_over_forwarding_enabled**\ (\ ) +|void| **set_force_draw_over_forwarding_enabled**\ (\ ) :ref:`🔗` Enables calling of :ref:`_forward_canvas_force_draw_over_viewport` for the 2D editor and :ref:`_forward_3d_force_draw_over_viewport` for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. @@ -1661,7 +1661,7 @@ Enables calling of :ref:`_forward_canvas_force_draw_over_viewport` Use this method if you always want to receive inputs from 3D view screen inside :ref:`_forward_3d_gui_input`. It might be especially usable if your plugin will want to use raycast in the scene. @@ -1673,7 +1673,7 @@ Use this method if you always want to receive inputs from 3D view screen inside .. rst-class:: classref-method -:ref:`int` **update_overlays**\ (\ ) |const| +:ref:`int` **update_overlays**\ (\ ) |const| :ref:`🔗` Updates the overlays of the 2D and 3D editor viewport. Causes methods :ref:`_forward_canvas_draw_over_viewport`, :ref:`_forward_canvas_force_draw_over_viewport`, :ref:`_forward_3d_draw_over_viewport` and :ref:`_forward_3d_force_draw_over_viewport` to be called. diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index bd1e984007a..5db52360bf6 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -84,7 +84,7 @@ Signals .. rst-class:: classref-signal -**multiple_properties_changed**\ (\ properties\: :ref:`PackedStringArray`, value\: :ref:`Array`\ ) +**multiple_properties_changed**\ (\ properties\: :ref:`PackedStringArray`, value\: :ref:`Array`\ ) :ref:`🔗` Emit it if you want multiple properties modified at the same time. Do not use if added via :ref:`EditorInspectorPlugin._parse_property`. @@ -96,7 +96,7 @@ Emit it if you want multiple properties modified at the same time. Do not use if .. rst-class:: classref-signal -**object_id_selected**\ (\ property\: :ref:`StringName`, id\: :ref:`int`\ ) +**object_id_selected**\ (\ property\: :ref:`StringName`, id\: :ref:`int`\ ) :ref:`🔗` Used by sub-inspectors. Emit it if what was selected was an Object ID. @@ -108,7 +108,7 @@ Used by sub-inspectors. Emit it if what was selected was an Object ID. .. rst-class:: classref-signal -**property_can_revert_changed**\ (\ property\: :ref:`StringName`, can_revert\: :ref:`bool`\ ) +**property_can_revert_changed**\ (\ property\: :ref:`StringName`, can_revert\: :ref:`bool`\ ) :ref:`🔗` Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed. @@ -120,7 +120,7 @@ Emitted when the revertability (i.e., whether it has a non-default value and thu .. rst-class:: classref-signal -**property_changed**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName`, changing\: :ref:`bool`\ ) +**property_changed**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName`, changing\: :ref:`bool`\ ) :ref:`🔗` Do not emit this manually, use the :ref:`emit_changed` method instead. @@ -132,7 +132,7 @@ Do not emit this manually, use the :ref:`emit_changed`, checked\: :ref:`bool`\ ) +**property_checked**\ (\ property\: :ref:`StringName`, checked\: :ref:`bool`\ ) :ref:`🔗` Emitted when a property was checked. Used internally. @@ -144,7 +144,7 @@ Emitted when a property was checked. Used internally. .. rst-class:: classref-signal -**property_deleted**\ (\ property\: :ref:`StringName`\ ) +**property_deleted**\ (\ property\: :ref:`StringName`\ ) :ref:`🔗` Emitted when a property was deleted. Used internally. @@ -156,7 +156,7 @@ Emitted when a property was deleted. Used internally. .. rst-class:: classref-signal -**property_keyed**\ (\ property\: :ref:`StringName`\ ) +**property_keyed**\ (\ property\: :ref:`StringName`\ ) :ref:`🔗` Emit it if you want to add this value as an animation key (check for keying being enabled first). @@ -168,7 +168,7 @@ Emit it if you want to add this value as an animation key (check for keying bein .. rst-class:: classref-signal -**property_keyed_with_value**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +**property_keyed_with_value**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Emit it if you want to key a property with a single value. @@ -180,7 +180,7 @@ Emit it if you want to key a property with a single value. .. rst-class:: classref-signal -**property_pinned**\ (\ property\: :ref:`StringName`, pinned\: :ref:`bool`\ ) +**property_pinned**\ (\ property\: :ref:`StringName`, pinned\: :ref:`bool`\ ) :ref:`🔗` 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. @@ -194,7 +194,7 @@ The default value is the one the property will get when the node is just instant .. rst-class:: classref-signal -**resource_selected**\ (\ path\: :ref:`String`, resource\: :ref:`Resource`\ ) +**resource_selected**\ (\ path\: :ref:`String`, resource\: :ref:`Resource`\ ) :ref:`🔗` If you want a sub-resource to be edited, emit this signal with the resource. @@ -206,7 +206,7 @@ If you want a sub-resource to be edited, emit this signal with the resource. .. rst-class:: classref-signal -**selected**\ (\ path\: :ref:`String`, focusable_idx\: :ref:`int`\ ) +**selected**\ (\ path\: :ref:`String`, focusable_idx\: :ref:`int`\ ) :ref:`🔗` Emitted when selected. Used internally. @@ -223,7 +223,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **checkable** = ``false`` +:ref:`bool` **checkable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ Used by the inspector, set to ``true`` when the property is checkable. .. rst-class:: classref-property -:ref:`bool` **checked** = ``false`` +:ref:`bool` **checked** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ Used by the inspector, set to ``true`` when the property is checked. .. rst-class:: classref-property -:ref:`bool` **deletable** = ``false`` +:ref:`bool` **deletable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -274,7 +274,7 @@ Used by the inspector, set to ``true`` when the property can be deleted by the u .. rst-class:: classref-property -:ref:`bool` **draw_warning** = ``false`` +:ref:`bool` **draw_warning** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -291,7 +291,7 @@ Used by the inspector, set to ``true`` when the property is drawn with the edito .. rst-class:: classref-property -:ref:`bool` **keying** = ``false`` +:ref:`bool` **keying** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -308,7 +308,7 @@ Used by the inspector, set to ``true`` when the property can add keys for animat .. rst-class:: classref-property -:ref:`String` **label** = ``""`` +:ref:`String` **label** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -325,7 +325,7 @@ Set this property to change the label (if you want to show one). .. rst-class:: classref-property -:ref:`bool` **read_only** = ``false`` +:ref:`bool` **read_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +347,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_read_only**\ (\ read_only\: :ref:`bool`\ ) |virtual| +|void| **_set_read_only**\ (\ read_only\: :ref:`bool`\ ) |virtual| :ref:`🔗` Called when the read-only status of the property is changed. It may be used to change custom controls into a read-only or modifiable state. @@ -359,7 +359,7 @@ Called when the read-only status of the property is changed. It may be used to c .. rst-class:: classref-method -|void| **_update_property**\ (\ ) |virtual| +|void| **_update_property**\ (\ ) |virtual| :ref:`🔗` When this virtual function is called, you must update your editor. @@ -371,7 +371,7 @@ When this virtual function is called, you must update your editor. .. rst-class:: classref-method -|void| **add_focusable**\ (\ control\: :ref:`Control`\ ) +|void| **add_focusable**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. @@ -383,7 +383,7 @@ If any of the controls added can gain keyboard focus, add it here. This ensures .. rst-class:: classref-method -|void| **emit_changed**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName` = &"", changing\: :ref:`bool` = false\ ) +|void| **emit_changed**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName` = &"", changing\: :ref:`bool` = false\ ) :ref:`🔗` If one or several properties have changed, this must be called. ``field`` is used in case your editor can modify fields separately (as an example, Vector3.x). The ``changing`` argument avoids the editor requesting this property to be refreshed (leave as ``false`` if unsure). @@ -395,7 +395,7 @@ If one or several properties have changed, this must be called. ``field`` is use .. rst-class:: classref-method -:ref:`Object` **get_edited_object**\ (\ ) +:ref:`Object` **get_edited_object**\ (\ ) :ref:`🔗` Gets the edited object. @@ -407,7 +407,7 @@ Gets the edited object. .. rst-class:: classref-method -:ref:`StringName` **get_edited_property**\ (\ ) |const| +:ref:`StringName` **get_edited_property**\ (\ ) |const| :ref:`🔗` Gets the edited property. If your editor is for a single property (added via :ref:`EditorInspectorPlugin._parse_property`), then this will return the property. @@ -419,7 +419,7 @@ Gets the edited property. If your editor is for a single property (added via :re .. rst-class:: classref-method -|void| **set_bottom_editor**\ (\ editor\: :ref:`Control`\ ) +|void| **set_bottom_editor**\ (\ editor\: :ref:`Control`\ ) :ref:`🔗` Puts the ``editor`` control below the property label. The control must be previously added using :ref:`Node.add_child`. @@ -431,7 +431,7 @@ Puts the ``editor`` control below the property label. The control must be previo .. rst-class:: classref-method -|void| **update_property**\ (\ ) +|void| **update_property**\ (\ ) :ref:`🔗` Forces refresh of the property display. diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index fe0a2193859..eb8c0d43c64 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **_convert**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| +:ref:`Resource` **_convert**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| :ref:`🔗` Takes an input :ref:`Resource` and converts it to the type given in :ref:`_converts_to`. The returned :ref:`Resource` is the result of the conversion, and the input :ref:`Resource` remains unchanged. @@ -86,7 +86,7 @@ Takes an input :ref:`Resource` and converts it to the type given .. rst-class:: classref-method -:ref:`String` **_converts_to**\ (\ ) |virtual| |const| +:ref:`String` **_converts_to**\ (\ ) |virtual| |const| :ref:`🔗` Returns the class name of the target type of :ref:`Resource` that this plugin converts source resources to. @@ -98,7 +98,7 @@ Returns the class name of the target type of :ref:`Resource` tha .. rst-class:: classref-method -:ref:`bool` **_handles**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| +:ref:`bool` **_handles**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| :ref:`🔗` Called to determine whether a particular :ref:`Resource` can be converted to the target resource type by this plugin. diff --git a/classes/class_editorresourcepicker.rst b/classes/class_editorresourcepicker.rst index 07fc27240e2..01e8ff525ff 100644 --- a/classes/class_editorresourcepicker.rst +++ b/classes/class_editorresourcepicker.rst @@ -74,7 +74,7 @@ Signals .. rst-class:: classref-signal -**resource_changed**\ (\ resource\: :ref:`Resource`\ ) +**resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` Emitted when the value of the edited resource was changed. @@ -86,7 +86,7 @@ Emitted when the value of the edited resource was changed. .. rst-class:: classref-signal -**resource_selected**\ (\ resource\: :ref:`Resource`, inspect\: :ref:`bool`\ ) +**resource_selected**\ (\ resource\: :ref:`Resource`, inspect\: :ref:`bool`\ ) :ref:`🔗` Emitted when the resource value was set and user clicked to edit it. When ``inspect`` is ``true``, the signal was caused by the context menu "Edit" or "Inspect" option. @@ -103,7 +103,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **base_type** = ``""`` +:ref:`String` **base_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ The base type of allowed resource types. Can be a comma-separated list of severa .. rst-class:: classref-property -:ref:`bool` **editable** = ``true`` +:ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ If ``true``, the value can be selected and edited. .. rst-class:: classref-property -:ref:`Resource` **edited_resource** +:ref:`Resource` **edited_resource** :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ The edited resource value. .. rst-class:: classref-property -:ref:`bool` **toggle_mode** = ``false`` +:ref:`bool` **toggle_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_handle_menu_selected**\ (\ id\: :ref:`int`\ ) |virtual| +:ref:`bool` **_handle_menu_selected**\ (\ id\: :ref:`int`\ ) |virtual| :ref:`🔗` This virtual method can be implemented to handle context menu items not handled by default. See :ref:`_set_create_options`. @@ -188,7 +188,7 @@ This virtual method can be implemented to handle context menu items not handled .. rst-class:: classref-method -|void| **_set_create_options**\ (\ menu_node\: :ref:`Object`\ ) |virtual| +|void| **_set_create_options**\ (\ menu_node\: :ref:`Object`\ ) |virtual| :ref:`🔗` This virtual method is called when updating the context menu of **EditorResourcePicker**. Implement this method to override the "New ..." items with your own options. ``menu_node`` is a reference to the :ref:`PopupMenu` node. @@ -202,7 +202,7 @@ This virtual method is called when updating the context menu of **EditorResource .. rst-class:: classref-method -:ref:`PackedStringArray` **get_allowed_types**\ (\ ) |const| +:ref:`PackedStringArray` **get_allowed_types**\ (\ ) |const| :ref:`🔗` Returns a list of all allowed types and subtypes corresponding to the :ref:`base_type`. If the :ref:`base_type` is empty, an empty list is returned. @@ -214,7 +214,7 @@ Returns a list of all allowed types and subtypes corresponding to the :ref:`base .. rst-class:: classref-method -|void| **set_toggle_pressed**\ (\ pressed\: :ref:`bool`\ ) +|void| **set_toggle_pressed**\ (\ pressed\: :ref:`bool`\ ) :ref:`🔗` Sets the toggle mode state for the main button. Works only if :ref:`toggle_mode` is set to ``true``. diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 0fc53aca50b..0cf95c7fddf 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -56,7 +56,7 @@ Signals .. rst-class:: classref-signal -**preview_invalidated**\ (\ path\: :ref:`String`\ ) +**preview_invalidated**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Emitted if a preview was invalidated (changed). ``path`` corresponds to the path of the preview. @@ -73,7 +73,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) +|void| **add_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) :ref:`🔗` Create an own, custom preview generator. @@ -85,7 +85,7 @@ Create an own, custom preview generator. .. rst-class:: classref-method -|void| **check_for_invalidation**\ (\ path\: :ref:`String`\ ) +|void| **check_for_invalidation**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. @@ -97,7 +97,7 @@ Check if the resource changed, if so, it will be invalidated and the correspondi .. rst-class:: classref-method -|void| **queue_edited_resource_preview**\ (\ resource\: :ref:`Resource`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) +|void| **queue_edited_resource_preview**\ (\ resource\: :ref:`Resource`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) :ref:`🔗` Queue the ``resource`` being edited for preview. Once the preview is ready, the ``receiver``'s ``receiver_func`` will be called. The ``receiver_func`` must take the following four arguments: :ref:`String` path, :ref:`Texture2D` preview, :ref:`Texture2D` thumbnail_preview, :ref:`Variant` userdata. ``userdata`` can be anything, and will be returned when ``receiver_func`` is called. @@ -111,7 +111,7 @@ Queue the ``resource`` being edited for preview. Once the preview is ready, the .. rst-class:: classref-method -|void| **queue_resource_preview**\ (\ path\: :ref:`String`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) +|void| **queue_resource_preview**\ (\ path\: :ref:`String`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) :ref:`🔗` Queue a resource file located at ``path`` for preview. Once the preview is ready, the ``receiver``'s ``receiver_func`` will be called. The ``receiver_func`` must take the following four arguments: :ref:`String` path, :ref:`Texture2D` preview, :ref:`Texture2D` thumbnail_preview, :ref:`Variant` userdata. ``userdata`` can be anything, and will be returned when ``receiver_func`` is called. @@ -125,7 +125,7 @@ Queue a resource file located at ``path`` for preview. Once the preview is ready .. rst-class:: classref-method -|void| **remove_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) +|void| **remove_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) :ref:`🔗` Removes a custom preview generator. diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 42178b67ab0..6229916f434 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_generate_small_preview**\ (\ ) |virtual| |const| +:ref:`bool` **_can_generate_small_preview**\ (\ ) |virtual| |const| :ref:`🔗` If this function returns ``true``, the generator will call :ref:`_generate` or :ref:`_generate_from_path` for small previews as well. @@ -68,7 +68,7 @@ By default, it returns ``false``. .. rst-class:: classref-method -:ref:`Texture2D` **_generate**\ (\ resource\: :ref:`Resource`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| +:ref:`Texture2D` **_generate**\ (\ resource\: :ref:`Resource`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| :ref:`🔗` Generate a preview from a given resource with the specified size. This must always be implemented. @@ -86,7 +86,7 @@ Care must be taken because this function is always called from a thread (not the .. rst-class:: classref-method -:ref:`Texture2D` **_generate_from_path**\ (\ path\: :ref:`String`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| +:ref:`Texture2D` **_generate_from_path**\ (\ path\: :ref:`String`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| :ref:`🔗` Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`_generate`. @@ -104,7 +104,7 @@ Care must be taken because this function is always called from a thread (not the .. rst-class:: classref-method -:ref:`bool` **_generate_small_preview_automatically**\ (\ ) |virtual| |const| +:ref:`bool` **_generate_small_preview_automatically**\ (\ ) |virtual| |const| :ref:`🔗` If this function returns ``true``, the generator will automatically generate the small previews from the normal preview texture generated by the methods :ref:`_generate` or :ref:`_generate_from_path`. @@ -118,7 +118,7 @@ By default, it returns ``false``. .. rst-class:: classref-method -:ref:`bool` **_handles**\ (\ type\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_handles**\ (\ type\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if your generator supports the resource of type ``type``. diff --git a/classes/class_editorresourcetooltipplugin.rst b/classes/class_editorresourcetooltipplugin.rst index 898acf34667..47bf830134f 100644 --- a/classes/class_editorresourcetooltipplugin.rst +++ b/classes/class_editorresourcetooltipplugin.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_handles**\ (\ type\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_handles**\ (\ type\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Return ``true`` if the plugin is going to handle the given :ref:`Resource` ``type``. @@ -64,7 +64,7 @@ Return ``true`` if the plugin is going to handle the given :ref:`Resource` **_make_tooltip_for_path**\ (\ path\: :ref:`String`, metadata\: :ref:`Dictionary`, base\: :ref:`Control`\ ) |virtual| |const| +:ref:`Control` **_make_tooltip_for_path**\ (\ path\: :ref:`String`, metadata\: :ref:`Dictionary`, base\: :ref:`Control`\ ) |virtual| |const| :ref:`🔗` Create and return a tooltip that will be displayed when the user hovers a resource under the given ``path`` in filesystem dock. @@ -92,7 +92,7 @@ The ``metadata`` dictionary is provided by preview generator (see :ref:`EditorRe .. rst-class:: classref-method -|void| **request_thumbnail**\ (\ path\: :ref:`String`, control\: :ref:`TextureRect`\ ) |const| +|void| **request_thumbnail**\ (\ path\: :ref:`String`, control\: :ref:`TextureRect`\ ) |const| :ref:`🔗` Requests a thumbnail for the given :ref:`TextureRect`. The thumbnail is created asynchronously by :ref:`EditorResourcePreview` and automatically set when available. diff --git a/classes/class_editorsceneformatimporter.rst b/classes/class_editorsceneformatimporter.rst index 854f77145b7..552e8ea7db7 100644 --- a/classes/class_editorsceneformatimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -58,7 +58,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_SCENE** = ``1`` +**IMPORT_SCENE** = ``1`` :ref:`🔗` .. container:: contribute @@ -70,7 +70,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_ANIMATION** = ``2`` +**IMPORT_ANIMATION** = ``2`` :ref:`🔗` .. container:: contribute @@ -82,7 +82,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = ``4`` +**IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = ``4`` :ref:`🔗` .. container:: contribute @@ -94,7 +94,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_GENERATE_TANGENT_ARRAYS** = ``8`` +**IMPORT_GENERATE_TANGENT_ARRAYS** = ``8`` :ref:`🔗` .. container:: contribute @@ -106,7 +106,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_USE_NAMED_SKIN_BINDS** = ``16`` +**IMPORT_USE_NAMED_SKIN_BINDS** = ``16`` :ref:`🔗` .. container:: contribute @@ -118,7 +118,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_DISCARD_MESHES_AND_MATERIALS** = ``32`` +**IMPORT_DISCARD_MESHES_AND_MATERIALS** = ``32`` :ref:`🔗` .. container:: contribute @@ -130,7 +130,7 @@ Constants .. rst-class:: classref-constant -**IMPORT_FORCE_DISABLE_MESH_COMPRESSION** = ``64`` +**IMPORT_FORCE_DISABLE_MESH_COMPRESSION** = ``64`` :ref:`🔗` .. container:: contribute @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_extensions**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_import_flags**\ (\ ) |virtual| |const| +:ref:`int` **_get_import_flags**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| +|void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -193,7 +193,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| +:ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -207,7 +207,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **_import_scene**\ (\ path\: :ref:`String`, flags\: :ref:`int`, options\: :ref:`Dictionary`\ ) |virtual| +:ref:`Object` **_import_scene**\ (\ path\: :ref:`String`, flags\: :ref:`int`, options\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` .. container:: contribute diff --git a/classes/class_editorsceneformatimporterfbx2gltf.rst b/classes/class_editorsceneformatimporterfbx2gltf.rst index 73d94cf05f7..d01f97b1296 100644 --- a/classes/class_editorsceneformatimporterfbx2gltf.rst +++ b/classes/class_editorsceneformatimporterfbx2gltf.rst @@ -21,7 +21,7 @@ Description Imports Autodesk FBX 3D scenes by way of converting them to glTF 2.0 using the FBX2glTF command line tool. -The location of the FBX2glTF binary is set via the :ref:`EditorSettings.filesystem/import/fbx2gltf/fbx2gltf_path` editor setting. +The location of the FBX2glTF binary is set via the :ref:`EditorSettings.filesystem/import/fbx/fbx2gltf_path` editor setting. This importer is only used if :ref:`ProjectSettings.filesystem/import/fbx2gltf/enabled` is set to ``true``. diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index a046ed08396..04e622afb32 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -109,7 +109,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **_post_import**\ (\ scene\: :ref:`Node`\ ) |virtual| +:ref:`Object` **_post_import**\ (\ scene\: :ref:`Node`\ ) |virtual| :ref:`🔗` Called after the scene was imported. This method must return the modified version of the scene. @@ -121,7 +121,7 @@ Called after the scene was imported. This method must return the modified versio .. rst-class:: classref-method -:ref:`String` **get_source_file**\ (\ ) |const| +:ref:`String` **get_source_file**\ (\ ) |const| :ref:`🔗` Returns the source file path which got imported (e.g. ``res://scene.dae``). diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst index c14641d7695..c5ce96d5f03 100644 --- a/classes/class_editorscenepostimportplugin.rst +++ b/classes/class_editorscenepostimportplugin.rst @@ -66,7 +66,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **InternalImportCategory**: +enum **InternalImportCategory**: :ref:`🔗` .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_NODE: @@ -177,7 +177,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| +|void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| :ref:`🔗` Override to add general import options. These will appear in the main import dock on the editor. Add options via :ref:`add_import_option` and :ref:`add_import_option_advanced`. @@ -189,7 +189,7 @@ Override to add general import options. These will appear in the main import doc .. rst-class:: classref-method -|void| **_get_internal_import_options**\ (\ category\: :ref:`int`\ ) |virtual| +|void| **_get_internal_import_options**\ (\ category\: :ref:`int`\ ) |virtual| :ref:`🔗` Override to add internal import options. These will appear in the 3D scene import dialog. Add options via :ref:`add_import_option` and :ref:`add_import_option_advanced`. @@ -201,7 +201,7 @@ Override to add internal import options. These will appear in the 3D scene impor .. rst-class:: classref-method -:ref:`Variant` **_get_internal_option_update_view_required**\ (\ category\: :ref:`int`, option\: :ref:`String`\ ) |virtual| |const| +:ref:`Variant` **_get_internal_option_update_view_required**\ (\ category\: :ref:`int`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. @@ -213,7 +213,7 @@ Return true whether updating the 3D view of the import dialog needs to be update .. rst-class:: classref-method -:ref:`Variant` **_get_internal_option_visibility**\ (\ category\: :ref:`int`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| +:ref:`Variant` **_get_internal_option_visibility**\ (\ category\: :ref:`int`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Return true or false whether a given option should be visible. Return null to ignore. @@ -225,7 +225,7 @@ Return true or false whether a given option should be visible. Return null to ig .. rst-class:: classref-method -:ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| +:ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Return true or false whether a given option should be visible. Return null to ignore. @@ -237,7 +237,7 @@ Return true or false whether a given option should be visible. Return null to ig .. rst-class:: classref-method -|void| **_internal_process**\ (\ category\: :ref:`int`, base_node\: :ref:`Node`, node\: :ref:`Node`, resource\: :ref:`Resource`\ ) |virtual| +|void| **_internal_process**\ (\ category\: :ref:`int`, base_node\: :ref:`Node`, node\: :ref:`Node`, resource\: :ref:`Resource`\ ) |virtual| :ref:`🔗` Process a specific node or resource for a given category. @@ -249,7 +249,7 @@ Process a specific node or resource for a given category. .. rst-class:: classref-method -|void| **_post_process**\ (\ scene\: :ref:`Node`\ ) |virtual| +|void| **_post_process**\ (\ scene\: :ref:`Node`\ ) |virtual| :ref:`🔗` Post process the scene. This function is called after the final scene has been configured. @@ -261,7 +261,7 @@ Post process the scene. This function is called after the final scene has been c .. rst-class:: classref-method -|void| **_pre_process**\ (\ scene\: :ref:`Node`\ ) |virtual| +|void| **_pre_process**\ (\ scene\: :ref:`Node`\ ) |virtual| :ref:`🔗` Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. @@ -273,7 +273,7 @@ Pre Process the scene. This function is called right after the scene format load .. rst-class:: classref-method -|void| **add_import_option**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **add_import_option**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Add a specific import option (name and default value only). This function can only be called from :ref:`_get_import_options` and :ref:`_get_internal_import_options`. @@ -285,7 +285,7 @@ Add a specific import option (name and default value only). This function can on .. rst-class:: classref-method -|void| **add_import_option_advanced**\ (\ type\: :ref:`Variant.Type`, name\: :ref:`String`, default_value\: :ref:`Variant`, hint\: :ref:`PropertyHint` = 0, hint_string\: :ref:`String` = "", usage_flags\: :ref:`int` = 6\ ) +|void| **add_import_option_advanced**\ (\ type\: :ref:`Variant.Type`, name\: :ref:`String`, default_value\: :ref:`Variant`, hint\: :ref:`PropertyHint` = 0, hint_string\: :ref:`String` = "", usage_flags\: :ref:`int` = 6\ ) :ref:`🔗` Add a specific import option. This function can only be called from :ref:`_get_import_options` and :ref:`_get_internal_import_options`. @@ -297,7 +297,7 @@ Add a specific import option. This function can only be called from :ref:`_get_i .. rst-class:: classref-method -:ref:`Variant` **get_option_value**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_option_value**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Query the value of an option. This function can only be called from those querying visibility, or processing. diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 126ebab5a63..676d36590a1 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_run**\ (\ ) |virtual| +|void| **_run**\ (\ ) |virtual| :ref:`🔗` This method is executed by the Editor when **File > Run** is used. @@ -98,7 +98,7 @@ This method is executed by the Editor when **File > Run** is used. .. rst-class:: classref-method -|void| **add_root_node**\ (\ node\: :ref:`Node`\ ) +|void| **add_root_node**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Adds ``node`` as a child of the root node in the editor context. @@ -112,7 +112,7 @@ Adds ``node`` as a child of the root node in the editor context. .. rst-class:: classref-method -:ref:`EditorInterface` **get_editor_interface**\ (\ ) |const| +:ref:`EditorInterface` **get_editor_interface**\ (\ ) |const| :ref:`🔗` **Deprecated:** :ref:`EditorInterface` is a global singleton and can be accessed directly by its name. @@ -126,7 +126,7 @@ Returns the :ref:`EditorInterface` singleton instance. .. rst-class:: classref-method -:ref:`Node` **get_scene**\ (\ ) |const| +:ref:`Node` **get_scene**\ (\ ) |const| :ref:`🔗` Returns the Editor's currently active scene. diff --git a/classes/class_editorscriptpicker.rst b/classes/class_editorscriptpicker.rst index 4564a557a5f..6b1fa149158 100644 --- a/classes/class_editorscriptpicker.rst +++ b/classes/class_editorscriptpicker.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Node` **script_owner** +:ref:`Node` **script_owner** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 709c8b657af..2eb349ba819 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -56,7 +56,7 @@ Signals .. rst-class:: classref-signal -**selection_changed**\ (\ ) +**selection_changed**\ (\ ) :ref:`🔗` Emitted when the selection changes. @@ -73,7 +73,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_node**\ (\ node\: :ref:`Node`\ ) +|void| **add_node**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Adds a node to the selection. @@ -87,7 +87,7 @@ Adds a node to the selection. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clear the selection. @@ -99,7 +99,7 @@ Clear the selection. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node`\] **get_selected_nodes**\ (\ ) +:ref:`Array`\[:ref:`Node`\] **get_selected_nodes**\ (\ ) :ref:`🔗` Returns the list of selected nodes. @@ -111,7 +111,7 @@ Returns the list of selected nodes. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node`\] **get_transformable_selected_nodes**\ (\ ) +:ref:`Array`\[:ref:`Node`\] **get_transformable_selected_nodes**\ (\ ) :ref:`🔗` Returns the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc.). This list can be used to avoid situations where a node is selected and is also a child/grandchild. @@ -123,7 +123,7 @@ Returns the list of selected nodes, optimized for transform operations (i.e. mov .. rst-class:: classref-method -|void| **remove_node**\ (\ node\: :ref:`Node`\ ) +|void| **remove_node**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Removes a node from the selection. diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index b274b32e39c..620979d2e10 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -297,7 +297,7 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`filesystem/import/blender/rpc_server_uptime` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/import/fbx2gltf/fbx2gltf_path` | + | :ref:`String` | :ref:`filesystem/import/fbx/fbx2gltf_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/on_save/compress_binary_resources` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -489,11 +489,11 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`run/auto_save/save_before_running` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_clear_output_on_play` | + | :ref:`int` | :ref:`run/bottom_panel/action_on_play` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_close_output_on_stop` | + | :ref:`int` | :ref:`run/bottom_panel/action_on_stop` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_open_output_on_play` | + | :ref:`bool` | :ref:`run/output/always_clear_output_on_play` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`run/output/font_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -557,6 +557,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/trim_final_newlines_on_save` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/trim_trailing_whitespace_on_save` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/indent/auto_indent` | @@ -751,7 +753,7 @@ Signals .. rst-class:: classref-signal -**settings_changed**\ (\ ) +**settings_changed**\ (\ ) :ref:`🔗` Emitted after any editor setting has changed. @@ -768,7 +770,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_EDITOR_SETTINGS_CHANGED** = ``10000`` +**NOTIFICATION_EDITOR_SETTINGS_CHANGED** = ``10000`` :ref:`🔗` Emitted after any editor setting has changed. It's used by various editor plugins to update their visuals on theme changes or logic on configuration changes. @@ -785,7 +787,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **debugger/auto_switch_to_remote_scene_tree** +:ref:`bool` **debugger/auto_switch_to_remote_scene_tree** :ref:`🔗` If ``true``, automatically switches to the **Remote** scene tree when running the project from the editor. If ``false``, stays on the **Local** scene tree when running the project from the editor. @@ -797,7 +799,7 @@ If ``true``, automatically switches to the **Remote** scene tree when running th .. rst-class:: classref-property -:ref:`bool` **debugger/profile_native_calls** +:ref:`bool` **debugger/profile_native_calls** :ref:`🔗` If ``true``, enables collection of profiling data from non-GDScript Godot functions, such as engine class methods. Enabling this slows execution while profiling further. @@ -809,7 +811,7 @@ If ``true``, enables collection of profiling data from non-GDScript Godot functi .. rst-class:: classref-property -:ref:`int` **debugger/profiler_frame_history_size** +:ref:`int` **debugger/profiler_frame_history_size** :ref:`🔗` The size of the profiler's frame history. The default value (3600) allows seeing up to 60 seconds of profiling if the project renders at a constant 60 FPS. Higher values allow viewing longer periods of profiling in the graphs, especially when the project is running at high framerates. @@ -821,7 +823,7 @@ The size of the profiler's frame history. The default value (3600) allows seeing .. rst-class:: classref-property -:ref:`int` **debugger/profiler_frame_max_functions** +:ref:`int` **debugger/profiler_frame_max_functions** :ref:`🔗` The maximum number of script functions that can be displayed per frame in the profiler. If there are more script functions called in a given profiler frame, these functions will be discarded from the profiling results entirely. @@ -835,7 +837,7 @@ The maximum number of script functions that can be displayed per frame in the pr .. rst-class:: classref-property -:ref:`float` **debugger/remote_inspect_refresh_interval** +:ref:`float` **debugger/remote_inspect_refresh_interval** :ref:`🔗` The refresh interval for the remote inspector's properties (in seconds). Lower values are more reactive, but may cause stuttering while the project is running from the editor and the **Remote** scene tree is selected in the Scene tree dock. @@ -847,7 +849,7 @@ The refresh interval for the remote inspector's properties (in seconds). Lower v .. rst-class:: classref-property -:ref:`float` **debugger/remote_scene_tree_refresh_interval** +:ref:`float` **debugger/remote_scene_tree_refresh_interval** :ref:`🔗` The refresh interval for the remote scene tree (in seconds). Lower values are more reactive, but may cause stuttering while the project is running from the editor and the **Remote** scene tree is selected in the Scene tree dock. @@ -859,7 +861,7 @@ The refresh interval for the remote scene tree (in seconds). Lower values are mo .. rst-class:: classref-property -:ref:`bool` **docks/filesystem/always_show_folders** +:ref:`bool` **docks/filesystem/always_show_folders** :ref:`🔗` If ``true``, displays folders in the FileSystem dock's bottom pane when split mode is enabled. If ``false``, only files will be displayed in the bottom pane. Split mode can be toggled by pressing the icon next to the ``res://`` folder path. @@ -873,7 +875,7 @@ If ``true``, displays folders in the FileSystem dock's bottom pane when split mo .. rst-class:: classref-property -:ref:`String` **docks/filesystem/textfile_extensions** +:ref:`String` **docks/filesystem/textfile_extensions** :ref:`🔗` List of file extensions to consider as editable text files in the FileSystem dock (by double-clicking on the files). @@ -885,7 +887,7 @@ List of file extensions to consider as editable text files in the FileSystem doc .. rst-class:: classref-property -:ref:`int` **docks/filesystem/thumbnail_size** +:ref:`int` **docks/filesystem/thumbnail_size** :ref:`🔗` The thumbnail size to use in the FileSystem dock (in pixels). See also :ref:`filesystem/file_dialog/thumbnail_size`. @@ -897,7 +899,7 @@ The thumbnail size to use in the FileSystem dock (in pixels). See also :ref:`fil .. rst-class:: classref-property -:ref:`float` **docks/property_editor/auto_refresh_interval** +:ref:`float` **docks/property_editor/auto_refresh_interval** :ref:`🔗` The refresh interval to use for the Inspector dock's properties. The effect of this setting is mainly noticeable when adjusting gizmos in the 2D/3D editor and looking at the inspector at the same time. Lower values make the inspector refresh more often, but take up more CPU time. @@ -909,7 +911,7 @@ The refresh interval to use for the Inspector dock's properties. The effect of t .. rst-class:: classref-property -:ref:`float` **docks/property_editor/subresource_hue_tint** +:ref:`float` **docks/property_editor/subresource_hue_tint** :ref:`🔗` The tint intensity to use for the subresources background in the Inspector dock. The tint is used to distinguish between different subresources in the inspector. Higher values result in a more noticeable background color difference. @@ -921,7 +923,7 @@ The tint intensity to use for the subresources background in the Inspector dock. .. rst-class:: classref-property -:ref:`bool` **docks/scene_tree/auto_expand_to_selected** +:ref:`bool` **docks/scene_tree/auto_expand_to_selected** :ref:`🔗` If ``true``, the scene tree dock will automatically unfold nodes when a node that has folded parents is selected. @@ -933,7 +935,7 @@ If ``true``, the scene tree dock will automatically unfold nodes when a node tha .. rst-class:: classref-property -:ref:`bool` **docks/scene_tree/center_node_on_reparent** +:ref:`bool` **docks/scene_tree/center_node_on_reparent** :ref:`🔗` If ``true``, new node created when reparenting node(s) will be positioned at the average position of the selected node(s). @@ -945,7 +947,7 @@ If ``true``, new node created when reparenting node(s) will be positioned at the .. rst-class:: classref-property -:ref:`bool` **docks/scene_tree/start_create_dialog_fully_expanded** +:ref:`bool` **docks/scene_tree/start_create_dialog_fully_expanded** :ref:`🔗` If ``true``, the Create dialog (Create New Node/Create New Resource) will start with all its sections expanded. Otherwise, sections will be collapsed until the user starts searching (which will automatically expand sections as needed). @@ -957,7 +959,7 @@ If ``true``, the Create dialog (Create New Node/Create New Resource) will start .. rst-class:: classref-property -:ref:`Color` **editors/2d/bone_color1** +:ref:`Color` **editors/2d/bone_color1** :ref:`🔗` The "start" stop of the color gradient to use for bones in the 2D skeleton editor. @@ -969,7 +971,7 @@ The "start" stop of the color gradient to use for bones in the 2D skeleton edito .. rst-class:: classref-property -:ref:`Color` **editors/2d/bone_color2** +:ref:`Color` **editors/2d/bone_color2** :ref:`🔗` The "end" stop of the color gradient to use for bones in the 2D skeleton editor. @@ -981,7 +983,7 @@ The "end" stop of the color gradient to use for bones in the 2D skeleton editor. .. rst-class:: classref-property -:ref:`Color` **editors/2d/bone_ik_color** +:ref:`Color` **editors/2d/bone_ik_color** :ref:`🔗` The color to use for inverse kinematics-enabled bones in the 2D skeleton editor. @@ -993,7 +995,7 @@ The color to use for inverse kinematics-enabled bones in the 2D skeleton editor. .. rst-class:: classref-property -:ref:`Color` **editors/2d/bone_outline_color** +:ref:`Color` **editors/2d/bone_outline_color** :ref:`🔗` The outline color to use for non-selected bones in the 2D skeleton editor. See also :ref:`editors/2d/bone_selected_color`. @@ -1005,7 +1007,7 @@ The outline color to use for non-selected bones in the 2D skeleton editor. See a .. rst-class:: classref-property -:ref:`float` **editors/2d/bone_outline_size** +:ref:`float` **editors/2d/bone_outline_size** :ref:`🔗` The outline size in the 2D skeleton editor (in pixels). See also :ref:`editors/2d/bone_width`. @@ -1019,7 +1021,7 @@ The outline size in the 2D skeleton editor (in pixels). See also :ref:`editors/2 .. rst-class:: classref-property -:ref:`Color` **editors/2d/bone_selected_color** +:ref:`Color` **editors/2d/bone_selected_color** :ref:`🔗` The color to use for selected bones in the 2D skeleton editor. See also :ref:`editors/2d/bone_outline_color`. @@ -1031,7 +1033,7 @@ The color to use for selected bones in the 2D skeleton editor. See also :ref:`ed .. rst-class:: classref-property -:ref:`float` **editors/2d/bone_width** +:ref:`float` **editors/2d/bone_width** :ref:`🔗` The bone width in the 2D skeleton editor (in pixels). See also :ref:`editors/2d/bone_outline_size`. @@ -1045,7 +1047,7 @@ The bone width in the 2D skeleton editor (in pixels). See also :ref:`editors/2d/ .. rst-class:: classref-property -:ref:`Color` **editors/2d/grid_color** +:ref:`Color` **editors/2d/grid_color** :ref:`🔗` The grid color to use in the 2D editor. @@ -1057,7 +1059,7 @@ The grid color to use in the 2D editor. .. rst-class:: classref-property -:ref:`Color` **editors/2d/guides_color** +:ref:`Color` **editors/2d/guides_color** :ref:`🔗` The guides color to use in the 2D editor. Guides can be created by dragging the mouse cursor from the rulers. @@ -1069,7 +1071,7 @@ The guides color to use in the 2D editor. Guides can be created by dragging the .. rst-class:: classref-property -:ref:`Color` **editors/2d/smart_snapping_line_color** +:ref:`Color` **editors/2d/smart_snapping_line_color** :ref:`🔗` The color to use when drawing smart snapping lines in the 2D editor. The smart snapping lines will automatically display when moving 2D nodes if smart snapping is enabled in the Snapping Options menu at the top of the 2D editor viewport. @@ -1081,7 +1083,7 @@ The color to use when drawing smart snapping lines in the 2D editor. The smart s .. rst-class:: classref-property -:ref:`bool` **editors/2d/use_integer_zoom_by_default** +:ref:`bool` **editors/2d/use_integer_zoom_by_default** :ref:`🔗` If ``true``, the 2D editor will snap to integer zoom values while not holding the :kbd:`Alt` key and powers of two while holding it. If ``false``, this behavior is swapped. @@ -1093,7 +1095,7 @@ If ``true``, the 2D editor will snap to integer zoom values while not holding th .. rst-class:: classref-property -:ref:`Color` **editors/2d/viewport_border_color** +:ref:`Color` **editors/2d/viewport_border_color** :ref:`🔗` The color of the viewport border in the 2D editor. This border represents the viewport's size at the base resolution defined in the Project Settings. Objects placed outside this border will not be visible unless a :ref:`Camera2D` node is used, or unless the window is resized and the stretch mode is set to ``disabled``. @@ -1105,7 +1107,7 @@ The color of the viewport border in the 2D editor. This border represents the vi .. rst-class:: classref-property -:ref:`float` **editors/3d/default_fov** +:ref:`float` **editors/3d/default_fov** :ref:`🔗` The default camera vertical field of view to use in the 3D editor (in degrees). The camera field of view can be adjusted on a per-scene basis using the **View** menu at the top of the 3D editor. If a scene had its camera field of view adjusted using the **View** menu, this setting is ignored in the scene in question. This setting is also ignored while a :ref:`Camera3D` node is being previewed in the editor. @@ -1119,7 +1121,7 @@ The default camera vertical field of view to use in the 3D editor (in degrees). .. rst-class:: classref-property -:ref:`float` **editors/3d/default_z_far** +:ref:`float` **editors/3d/default_z_far** :ref:`🔗` The default camera far clip distance to use in the 3D editor (in degrees). Higher values make it possible to view objects placed further away from the camera, at the cost of lower precision in the depth buffer (which can result in visible Z-fighting in the distance). The camera far clip distance can be adjusted on a per-scene basis using the **View** menu at the top of the 3D editor. If a scene had its camera far clip distance adjusted using the **View** menu, this setting is ignored in the scene in question. This setting is also ignored while a :ref:`Camera3D` node is being previewed in the editor. @@ -1131,7 +1133,7 @@ The default camera far clip distance to use in the 3D editor (in degrees). Highe .. rst-class:: classref-property -:ref:`float` **editors/3d/default_z_near** +:ref:`float` **editors/3d/default_z_near** :ref:`🔗` The default camera near clip distance to use in the 3D editor (in degrees). Lower values make it possible to view objects placed closer to the camera, at the cost of lower precision in the depth buffer (which can result in visible Z-fighting in the distance). The camera near clip distance can be adjusted on a per-scene basis using the **View** menu at the top of the 3D editor. If a scene had its camera near clip distance adjusted using the **View** menu, this setting is ignored in the scene in question. This setting is also ignored while a :ref:`Camera3D` node is being previewed in the editor. @@ -1143,7 +1145,7 @@ The default camera near clip distance to use in the 3D editor (in degrees). Lowe .. rst-class:: classref-property -:ref:`int` **editors/3d/freelook/freelook_activation_modifier** +:ref:`int` **editors/3d/freelook/freelook_activation_modifier** :ref:`🔗` The modifier key to use to enable freelook in the 3D editor (on top of pressing the right mouse button). @@ -1159,7 +1161,7 @@ The modifier key to use to enable freelook in the 3D editor (on top of pressing .. rst-class:: classref-property -:ref:`float` **editors/3d/freelook/freelook_base_speed** +:ref:`float` **editors/3d/freelook/freelook_base_speed** :ref:`🔗` The base 3D freelook speed in units per second. This can be adjusted by using the mouse wheel while in freelook mode, or by holding down the "fast" or "slow" modifier keys (:kbd:`Shift` and :kbd:`Alt` by default, respectively). @@ -1171,7 +1173,7 @@ The base 3D freelook speed in units per second. This can be adjusted by using th .. rst-class:: classref-property -:ref:`float` **editors/3d/freelook/freelook_inertia** +:ref:`float` **editors/3d/freelook/freelook_inertia** :ref:`🔗` The inertia of the 3D freelook camera. Higher values make the camera start and stop slower, which looks smoother but adds latency. @@ -1183,7 +1185,7 @@ The inertia of the 3D freelook camera. Higher values make the camera start and s .. rst-class:: classref-property -:ref:`int` **editors/3d/freelook/freelook_navigation_scheme** +:ref:`int` **editors/3d/freelook/freelook_navigation_scheme** :ref:`🔗` The navigation scheme to use when freelook is enabled in the 3D editor. Some of the navigation schemes below may be more convenient when designing specific levels in the 3D editor. @@ -1203,7 +1205,7 @@ See also :ref:`editors/3d/navigation/navigation_scheme` **editors/3d/freelook/freelook_sensitivity** +:ref:`float` **editors/3d/freelook/freelook_sensitivity** :ref:`🔗` The mouse sensitivity to use while freelook mode is active in the 3D editor. See also :ref:`editors/3d/navigation_feel/orbit_sensitivity`. @@ -1215,7 +1217,7 @@ The mouse sensitivity to use while freelook mode is active in the 3D editor. See .. rst-class:: classref-property -:ref:`bool` **editors/3d/freelook/freelook_speed_zoom_link** +:ref:`bool` **editors/3d/freelook/freelook_speed_zoom_link** :ref:`🔗` If ``true``, freelook speed is linked to the zoom value used in the camera orbit mode in the 3D editor. @@ -1227,7 +1229,7 @@ If ``true``, freelook speed is linked to the zoom value used in the camera orbit .. rst-class:: classref-property -:ref:`float` **editors/3d/grid_division_level_bias** +:ref:`float` **editors/3d/grid_division_level_bias** :ref:`🔗` The grid division bias to use in the 3D editor. Negative values will cause small grid divisions to appear earlier, whereas positive values will cause small grid divisions to appear later. @@ -1239,7 +1241,7 @@ The grid division bias to use in the 3D editor. Negative values will cause small .. rst-class:: classref-property -:ref:`int` **editors/3d/grid_division_level_max** +:ref:`int` **editors/3d/grid_division_level_max** :ref:`🔗` The largest grid division to use in the 3D editor. Together with :ref:`editors/3d/primary_grid_steps`, this determines how large the grid divisions can be. The grid divisions will not be able to get larger than ``primary_grid_steps ^ grid_division_level_max`` units. By default, when :ref:`editors/3d/primary_grid_steps` is ``8``, this means grid divisions cannot get larger than ``64`` units each (so primary grid lines are ``512`` units apart), no matter how far away the camera is from the grid. @@ -1251,7 +1253,7 @@ The largest grid division to use in the 3D editor. Together with :ref:`editors/3 .. rst-class:: classref-property -:ref:`int` **editors/3d/grid_division_level_min** +:ref:`int` **editors/3d/grid_division_level_min** :ref:`🔗` The smallest grid division to use in the 3D editor. Together with :ref:`editors/3d/primary_grid_steps`, this determines how small the grid divisions can be. The grid divisions will not be able to get smaller than ``primary_grid_steps ^ grid_division_level_min`` units. By default, this means grid divisions cannot get smaller than 1 unit each, no matter how close the camera is from the grid. @@ -1263,7 +1265,7 @@ The smallest grid division to use in the 3D editor. Together with :ref:`editors/ .. rst-class:: classref-property -:ref:`int` **editors/3d/grid_size** +:ref:`int` **editors/3d/grid_size** :ref:`🔗` The grid size in units. Higher values prevent the grid from appearing "cut off" at certain angles, but make the grid more demanding to render. Depending on the camera's position, the grid may not be fully visible since a shader is used to fade it progressively. @@ -1275,7 +1277,7 @@ The grid size in units. Higher values prevent the grid from appearing "cut off" .. rst-class:: classref-property -:ref:`bool` **editors/3d/grid_xy_plane** +:ref:`bool` **editors/3d/grid_xy_plane** :ref:`🔗` If ``true``, render the grid on an XY plane. This can be useful for 3D side-scrolling games. @@ -1287,7 +1289,7 @@ If ``true``, render the grid on an XY plane. This can be useful for 3D side-scro .. rst-class:: classref-property -:ref:`bool` **editors/3d/grid_xz_plane** +:ref:`bool` **editors/3d/grid_xz_plane** :ref:`🔗` If ``true``, render the grid on an XZ plane. @@ -1299,7 +1301,7 @@ If ``true``, render the grid on an XZ plane. .. rst-class:: classref-property -:ref:`bool` **editors/3d/grid_yz_plane** +:ref:`bool` **editors/3d/grid_yz_plane** :ref:`🔗` If ``true``, render the grid on a YZ plane. This can be useful for 3D side-scrolling games. @@ -1311,7 +1313,7 @@ If ``true``, render the grid on a YZ plane. This can be useful for 3D side-scrol .. rst-class:: classref-property -:ref:`bool` **editors/3d/navigation/emulate_3_button_mouse** +:ref:`bool` **editors/3d/navigation/emulate_3_button_mouse** :ref:`🔗` If ``true``, enables 3-button mouse emulation mode. This is useful on laptops when using a trackpad. @@ -1327,7 +1329,7 @@ When 3-button mouse emulation mode is enabled, the pan, zoom and orbit modifiers .. rst-class:: classref-property -:ref:`bool` **editors/3d/navigation/emulate_numpad** +:ref:`bool` **editors/3d/navigation/emulate_numpad** :ref:`🔗` If ``true``, allows using the top row :kbd:`0`-:kbd:`9` keys to function as their equivalent numpad keys for 3D editor navigation. This should be enabled on keyboards that have no numeric keypad available. @@ -1339,7 +1341,7 @@ If ``true``, allows using the top row :kbd:`0`-:kbd:`9` keys to function as thei .. rst-class:: classref-property -:ref:`bool` **editors/3d/navigation/invert_x_axis** +:ref:`bool` **editors/3d/navigation/invert_x_axis** :ref:`🔗` If ``true``, invert the horizontal mouse axis when panning or orbiting in the 3D editor. This setting does *not* apply to freelook mode. @@ -1351,7 +1353,7 @@ If ``true``, invert the horizontal mouse axis when panning or orbiting in the 3D .. rst-class:: classref-property -:ref:`bool` **editors/3d/navigation/invert_y_axis** +:ref:`bool` **editors/3d/navigation/invert_y_axis** :ref:`🔗` If ``true``, invert the vertical mouse axis when panning, orbiting, or using freelook mode in the 3D editor. @@ -1363,7 +1365,7 @@ If ``true``, invert the vertical mouse axis when panning, orbiting, or using fre .. rst-class:: classref-property -:ref:`int` **editors/3d/navigation/navigation_scheme** +:ref:`int` **editors/3d/navigation/navigation_scheme** :ref:`🔗` The navigation scheme to use in the 3D editor. Changing this setting will affect the mouse buttons that must be held down to perform certain operations in the 3D editor viewport. @@ -1385,7 +1387,7 @@ See also :ref:`editors/3d/freelook/freelook_navigation_scheme` **editors/3d/navigation/orbit_modifier** +:ref:`int` **editors/3d/navigation/orbit_modifier** :ref:`🔗` The modifier key that must be held to orbit in the 3D editor. @@ -1401,7 +1403,7 @@ The modifier key that must be held to orbit in the 3D editor. .. rst-class:: classref-property -:ref:`int` **editors/3d/navigation/pan_modifier** +:ref:`int` **editors/3d/navigation/pan_modifier** :ref:`🔗` The modifier key that must be held to pan in the 3D editor. @@ -1415,7 +1417,7 @@ The modifier key that must be held to pan in the 3D editor. .. rst-class:: classref-property -:ref:`bool` **editors/3d/navigation/warped_mouse_panning** +:ref:`bool` **editors/3d/navigation/warped_mouse_panning** :ref:`🔗` If ``true``, warps the mouse around the 3D viewport while panning in the 3D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. @@ -1427,7 +1429,7 @@ If ``true``, warps the mouse around the 3D viewport while panning in the 3D edit .. rst-class:: classref-property -:ref:`int` **editors/3d/navigation/zoom_modifier** +:ref:`int` **editors/3d/navigation/zoom_modifier** :ref:`🔗` The modifier key that must be held to zoom in the 3D editor. @@ -1441,7 +1443,7 @@ The modifier key that must be held to zoom in the 3D editor. .. rst-class:: classref-property -:ref:`int` **editors/3d/navigation/zoom_style** +:ref:`int` **editors/3d/navigation/zoom_style** :ref:`🔗` The mouse cursor movement direction to use when zooming by moving the mouse. This does not affect zooming with the mouse wheel. @@ -1453,7 +1455,7 @@ The mouse cursor movement direction to use when zooming by moving the mouse. Thi .. rst-class:: classref-property -:ref:`float` **editors/3d/navigation_feel/orbit_inertia** +:ref:`float` **editors/3d/navigation_feel/orbit_inertia** :ref:`🔗` The inertia to use when orbiting in the 3D editor. Higher values make the camera start and stop slower, which looks smoother but adds latency. @@ -1465,7 +1467,7 @@ The inertia to use when orbiting in the 3D editor. Higher values make the camera .. rst-class:: classref-property -:ref:`float` **editors/3d/navigation_feel/orbit_sensitivity** +:ref:`float` **editors/3d/navigation_feel/orbit_sensitivity** :ref:`🔗` The mouse sensitivity to use when orbiting in the 3D editor. See also :ref:`editors/3d/freelook/freelook_sensitivity`. @@ -1477,7 +1479,7 @@ The mouse sensitivity to use when orbiting in the 3D editor. See also :ref:`edit .. rst-class:: classref-property -:ref:`float` **editors/3d/navigation_feel/translation_inertia** +:ref:`float` **editors/3d/navigation_feel/translation_inertia** :ref:`🔗` The inertia to use when panning in the 3D editor. Higher values make the camera start and stop slower, which looks smoother but adds latency. @@ -1489,7 +1491,7 @@ The inertia to use when panning in the 3D editor. Higher values make the camera .. rst-class:: classref-property -:ref:`float` **editors/3d/navigation_feel/zoom_inertia** +:ref:`float` **editors/3d/navigation_feel/zoom_inertia** :ref:`🔗` The inertia to use when zooming in the 3D editor. Higher values make the camera start and stop slower, which looks smoother but adds latency. @@ -1501,7 +1503,7 @@ The inertia to use when zooming in the 3D editor. Higher values make the camera .. rst-class:: classref-property -:ref:`Color` **editors/3d/primary_grid_color** +:ref:`Color` **editors/3d/primary_grid_color** :ref:`🔗` The color to use for the primary 3D grid. The color's alpha channel affects the grid's opacity. @@ -1513,7 +1515,7 @@ The color to use for the primary 3D grid. The color's alpha channel affects the .. rst-class:: classref-property -:ref:`int` **editors/3d/primary_grid_steps** +:ref:`int` **editors/3d/primary_grid_steps** :ref:`🔗` If set above 0, where a primary grid line should be drawn. By default, primary lines are configured to be more visible than secondary lines. This helps with measurements in the 3D editor. See also :ref:`editors/3d/primary_grid_color` and :ref:`editors/3d/secondary_grid_color`. @@ -1525,7 +1527,7 @@ If set above 0, where a primary grid line should be drawn. By default, primary l .. rst-class:: classref-property -:ref:`Color` **editors/3d/secondary_grid_color** +:ref:`Color` **editors/3d/secondary_grid_color** :ref:`🔗` The color to use for the secondary 3D grid. This is generally a less visible color than :ref:`editors/3d/primary_grid_color`. The color's alpha channel affects the grid's opacity. @@ -1537,7 +1539,7 @@ The color to use for the secondary 3D grid. This is generally a less visible col .. rst-class:: classref-property -:ref:`Color` **editors/3d/selection_box_color** +:ref:`Color` **editors/3d/selection_box_color** :ref:`🔗` The color to use for the selection box that surrounds selected nodes in the 3D editor viewport. The color's alpha channel influences the selection box's opacity. @@ -1549,7 +1551,7 @@ The color to use for the selection box that surrounds selected nodes in the 3D e .. rst-class:: classref-property -:ref:`Color` **editors/3d_gizmos/gizmo_colors/aabb** +:ref:`Color` **editors/3d_gizmos/gizmo_colors/aabb** :ref:`🔗` The color to use for the AABB gizmo that displays the :ref:`GeometryInstance3D`'s custom :ref:`AABB`. @@ -1561,7 +1563,7 @@ The color to use for the AABB gizmo that displays the :ref:`GeometryInstance3D` **editors/3d_gizmos/gizmo_colors/instantiated** +:ref:`Color` **editors/3d_gizmos/gizmo_colors/instantiated** :ref:`🔗` The color override to use for 3D editor gizmos if the :ref:`Node3D` in question is part of an instantiated scene file (from the perspective of the current scene). @@ -1573,7 +1575,7 @@ The color override to use for 3D editor gizmos if the :ref:`Node3D .. rst-class:: classref-property -:ref:`Color` **editors/3d_gizmos/gizmo_colors/joint** +:ref:`Color` **editors/3d_gizmos/gizmo_colors/joint** :ref:`🔗` The 3D editor gizmo color for :ref:`Joint3D`\ s and :ref:`PhysicalBone3D`\ s. @@ -1585,7 +1587,7 @@ The 3D editor gizmo color for :ref:`Joint3D`\ s and :ref:`Physica .. rst-class:: classref-property -:ref:`bool` **editors/animation/autorename_animation_tracks** +:ref:`bool` **editors/animation/autorename_animation_tracks** :ref:`🔗` If ``true``, automatically updates animation tracks' target paths when renaming or reparenting nodes in the Scene tree dock. @@ -1597,7 +1599,7 @@ If ``true``, automatically updates animation tracks' target paths when renaming .. rst-class:: classref-property -:ref:`bool` **editors/animation/default_create_bezier_tracks** +:ref:`bool` **editors/animation/default_create_bezier_tracks** :ref:`🔗` If ``true``, create a Bezier track instead of a standard track when pressing the "key" icon next to a property. Bezier tracks provide more control over animation curves, but are more difficult to adjust quickly. @@ -1609,7 +1611,7 @@ If ``true``, create a Bezier track instead of a standard track when pressing the .. rst-class:: classref-property -:ref:`bool` **editors/animation/default_create_reset_tracks** +:ref:`bool` **editors/animation/default_create_reset_tracks** :ref:`🔗` If ``true``, create a ``RESET`` track when creating a new animation track. This track can be used to restore the animation to a "default" state. @@ -1621,7 +1623,7 @@ If ``true``, create a ``RESET`` track when creating a new animation track. This .. rst-class:: classref-property -:ref:`Color` **editors/animation/onion_layers_future_color** +:ref:`Color` **editors/animation/onion_layers_future_color** :ref:`🔗` The modulate color to use for "future" frames displayed in the animation editor's onion skinning feature. @@ -1633,7 +1635,7 @@ The modulate color to use for "future" frames displayed in the animation editor' .. rst-class:: classref-property -:ref:`Color` **editors/animation/onion_layers_past_color** +:ref:`Color` **editors/animation/onion_layers_past_color** :ref:`🔗` The modulate color to use for "past" frames displayed in the animation editor's onion skinning feature. @@ -1645,7 +1647,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. rst-class:: classref-property -:ref:`float` **editors/grid_map/pick_distance** +:ref:`float` **editors/grid_map/pick_distance** :ref:`🔗` The maximum distance at which tiles can be placed on a GridMap, relative to the camera position (in 3D units). @@ -1657,7 +1659,7 @@ The maximum distance at which tiles can be placed on a GridMap, relative to the .. rst-class:: classref-property -:ref:`int` **editors/panning/2d_editor_pan_speed** +:ref:`int` **editors/panning/2d_editor_pan_speed** :ref:`🔗` The panning speed when using the mouse wheel or touchscreen events in the 2D editor. This setting does not apply to panning by holding down the middle or right mouse buttons. @@ -1669,7 +1671,7 @@ The panning speed when using the mouse wheel or touchscreen events in the 2D edi .. rst-class:: classref-property -:ref:`int` **editors/panning/2d_editor_panning_scheme** +:ref:`int` **editors/panning/2d_editor_panning_scheme** :ref:`🔗` Controls whether the mouse wheel scroll zooms or pans in the 2D editor. See also :ref:`editors/panning/sub_editors_panning_scheme` and :ref:`editors/panning/animation_editors_panning_scheme`. @@ -1681,7 +1683,7 @@ Controls whether the mouse wheel scroll zooms or pans in the 2D editor. See also .. rst-class:: classref-property -:ref:`int` **editors/panning/animation_editors_panning_scheme** +:ref:`int` **editors/panning/animation_editors_panning_scheme** :ref:`🔗` Controls whether the mouse wheel scroll zooms or pans in the animation track and Bezier editors. See also :ref:`editors/panning/2d_editor_panning_scheme` and :ref:`editors/panning/sub_editors_panning_scheme` (which controls the animation blend tree editor's pan behavior). @@ -1693,7 +1695,7 @@ Controls whether the mouse wheel scroll zooms or pans in the animation track and .. rst-class:: classref-property -:ref:`bool` **editors/panning/simple_panning** +:ref:`bool` **editors/panning/simple_panning** :ref:`🔗` If ``true``, allows panning by holding down :kbd:`Space` in the 2D editor viewport (in addition to panning with the middle or right mouse buttons). If ``false``, the left mouse button must be held down while holding down :kbd:`Space` to pan in the 2D editor viewport. @@ -1705,7 +1707,7 @@ If ``true``, allows panning by holding down :kbd:`Space` in the 2D editor viewpo .. rst-class:: classref-property -:ref:`int` **editors/panning/sub_editors_panning_scheme** +:ref:`int` **editors/panning/sub_editors_panning_scheme** :ref:`🔗` Controls whether the mouse wheel scroll zooms or pans in subeditors. The list of affected subeditors is: animation blend tree editor, :ref:`Polygon2D` editor, tileset editor, texture region editor and visual shader editor. See also :ref:`editors/panning/2d_editor_panning_scheme` and :ref:`editors/panning/animation_editors_panning_scheme`. @@ -1717,7 +1719,7 @@ Controls whether the mouse wheel scroll zooms or pans in subeditors. The list of .. rst-class:: classref-property -:ref:`bool` **editors/panning/warped_mouse_panning** +:ref:`bool` **editors/panning/warped_mouse_panning** :ref:`🔗` If ``true``, warps the mouse around the 2D viewport while panning in the 2D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. @@ -1729,7 +1731,7 @@ If ``true``, warps the mouse around the 2D viewport while panning in the 2D edit .. rst-class:: classref-property -:ref:`float` **editors/polygon_editor/auto_bake_delay** +:ref:`float` **editors/polygon_editor/auto_bake_delay** :ref:`🔗` The delay in seconds until more complex and performance costly polygon editors commit their outlines, e.g. the 2D navigation polygon editor rebakes the navigation mesh polygons. A negative value stops the auto bake. @@ -1741,7 +1743,7 @@ The delay in seconds until more complex and performance costly polygon editors c .. rst-class:: classref-property -:ref:`int` **editors/polygon_editor/point_grab_radius** +:ref:`int` **editors/polygon_editor/point_grab_radius** :ref:`🔗` The radius in which points can be selected in the :ref:`Polygon2D` and :ref:`CollisionPolygon2D` editors (in pixels). Higher values make it easier to select points quickly, but can make it more difficult to select the expected point when several points are located close to each other. @@ -1753,7 +1755,7 @@ The radius in which points can be selected in the :ref:`Polygon2D` **editors/polygon_editor/show_previous_outline** +:ref:`bool` **editors/polygon_editor/show_previous_outline** :ref:`🔗` If ``true``, displays the polygon's previous shape in the 2D polygon editors with an opaque gray outline. This outline is displayed while dragging a point until the left mouse button is released. @@ -1765,7 +1767,7 @@ If ``true``, displays the polygon's previous shape in the 2D polygon editors wit .. rst-class:: classref-property -:ref:`bool` **editors/shader_editor/behavior/files/restore_shaders_on_load** +:ref:`bool` **editors/shader_editor/behavior/files/restore_shaders_on_load** :ref:`🔗` If ``true``, reopens shader files that were open in the shader editor when the project was last closed. @@ -1777,7 +1779,7 @@ If ``true``, reopens shader files that were open in the shader editor when the p .. rst-class:: classref-property -:ref:`bool` **editors/tiles_editor/display_grid** +:ref:`bool` **editors/tiles_editor/display_grid** :ref:`🔗` If ``true``, displays a grid while the TileMap editor is active. See also :ref:`editors/tiles_editor/grid_color`. @@ -1789,7 +1791,7 @@ If ``true``, displays a grid while the TileMap editor is active. See also :ref:` .. rst-class:: classref-property -:ref:`Color` **editors/tiles_editor/grid_color** +:ref:`Color` **editors/tiles_editor/grid_color** :ref:`🔗` The color to use for the TileMap editor's grid. @@ -1803,7 +1805,7 @@ The color to use for the TileMap editor's grid. .. rst-class:: classref-property -:ref:`bool` **editors/tiles_editor/highlight_selected_layer** +:ref:`bool` **editors/tiles_editor/highlight_selected_layer** :ref:`🔗` Highlight the currently selected TileMapLayer by dimming the other ones in the scene. @@ -1815,7 +1817,7 @@ Highlight the currently selected TileMapLayer by dimming the other ones in the s .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/color_color** +:ref:`Color` **editors/visual_editors/category_colors/color_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Color" category. @@ -1827,7 +1829,7 @@ The color of a graph node's header when it belongs to the "Color" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/conditional_color** +:ref:`Color` **editors/visual_editors/category_colors/conditional_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Conditional" category. @@ -1839,7 +1841,7 @@ The color of a graph node's header when it belongs to the "Conditional" category .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/input_color** +:ref:`Color` **editors/visual_editors/category_colors/input_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Input" category. @@ -1851,7 +1853,7 @@ The color of a graph node's header when it belongs to the "Input" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/output_color** +:ref:`Color` **editors/visual_editors/category_colors/output_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Output" category. @@ -1863,7 +1865,7 @@ The color of a graph node's header when it belongs to the "Output" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/particle_color** +:ref:`Color` **editors/visual_editors/category_colors/particle_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Particle" category. @@ -1875,7 +1877,7 @@ The color of a graph node's header when it belongs to the "Particle" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/scalar_color** +:ref:`Color` **editors/visual_editors/category_colors/scalar_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Scalar" category. @@ -1887,7 +1889,7 @@ The color of a graph node's header when it belongs to the "Scalar" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/special_color** +:ref:`Color` **editors/visual_editors/category_colors/special_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Special" category. @@ -1899,7 +1901,7 @@ The color of a graph node's header when it belongs to the "Special" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/textures_color** +:ref:`Color` **editors/visual_editors/category_colors/textures_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Textures" category. @@ -1911,7 +1913,7 @@ The color of a graph node's header when it belongs to the "Textures" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/transform_color** +:ref:`Color` **editors/visual_editors/category_colors/transform_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Transform" category. @@ -1923,7 +1925,7 @@ The color of a graph node's header when it belongs to the "Transform" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/utility_color** +:ref:`Color` **editors/visual_editors/category_colors/utility_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Utility" category. @@ -1935,7 +1937,7 @@ The color of a graph node's header when it belongs to the "Utility" category. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/category_colors/vector_color** +:ref:`Color` **editors/visual_editors/category_colors/vector_color** :ref:`🔗` The color of a graph node's header when it belongs to the "Vector" category. @@ -1947,7 +1949,7 @@ The color of a graph node's header when it belongs to the "Vector" category. .. rst-class:: classref-property -:ref:`String` **editors/visual_editors/color_theme** +:ref:`String` **editors/visual_editors/color_theme** :ref:`🔗` The color theme to use in the visual shader editor. @@ -1959,7 +1961,7 @@ The color theme to use in the visual shader editor. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/boolean_color** +:ref:`Color` **editors/visual_editors/connection_colors/boolean_color** :ref:`🔗` The color of a port/connection of boolean type. @@ -1971,7 +1973,7 @@ The color of a port/connection of boolean type. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/sampler_color** +:ref:`Color` **editors/visual_editors/connection_colors/sampler_color** :ref:`🔗` The color of a port/connection of sampler type. @@ -1983,7 +1985,7 @@ The color of a port/connection of sampler type. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/scalar_color** +:ref:`Color` **editors/visual_editors/connection_colors/scalar_color** :ref:`🔗` The color of a port/connection of scalar type (float, int, unsigned int). @@ -1995,7 +1997,7 @@ The color of a port/connection of scalar type (float, int, unsigned int). .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/transform_color** +:ref:`Color` **editors/visual_editors/connection_colors/transform_color** :ref:`🔗` The color of a port/connection of transform type. @@ -2007,7 +2009,7 @@ The color of a port/connection of transform type. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/vector2_color** +:ref:`Color` **editors/visual_editors/connection_colors/vector2_color** :ref:`🔗` The color of a port/connection of Vector2 type. @@ -2019,7 +2021,7 @@ The color of a port/connection of Vector2 type. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/vector3_color** +:ref:`Color` **editors/visual_editors/connection_colors/vector3_color** :ref:`🔗` The color of a port/connection of Vector3 type. @@ -2031,7 +2033,7 @@ The color of a port/connection of Vector3 type. .. rst-class:: classref-property -:ref:`Color` **editors/visual_editors/connection_colors/vector4_color** +:ref:`Color` **editors/visual_editors/connection_colors/vector4_color** :ref:`🔗` The color of a port/connection of Vector4 type. @@ -2043,7 +2045,7 @@ The color of a port/connection of Vector4 type. .. rst-class:: classref-property -:ref:`int` **editors/visual_editors/grid_pattern** +:ref:`int` **editors/visual_editors/grid_pattern** :ref:`🔗` The pattern used for the background grid. @@ -2055,7 +2057,7 @@ The pattern used for the background grid. .. rst-class:: classref-property -:ref:`float` **editors/visual_editors/lines_curvature** +:ref:`float` **editors/visual_editors/lines_curvature** :ref:`🔗` The curvature to use for connection lines in the visual shader editor. Higher values will make connection lines appear more curved, with values above ``0.5`` resulting in more "angular" turns in the middle of connection lines. @@ -2067,7 +2069,7 @@ The curvature to use for connection lines in the visual shader editor. Higher va .. rst-class:: classref-property -:ref:`float` **editors/visual_editors/minimap_opacity** +:ref:`float` **editors/visual_editors/minimap_opacity** :ref:`🔗` The opacity of the minimap displayed in the bottom-right corner of the visual shader editor. @@ -2079,7 +2081,7 @@ The opacity of the minimap displayed in the bottom-right corner of the visual sh .. rst-class:: classref-property -:ref:`int` **editors/visual_editors/visual_shader/port_preview_size** +:ref:`int` **editors/visual_editors/visual_shader/port_preview_size** :ref:`🔗` The size to use for port previews in the visual shader uniforms (toggled by clicking the "eye" icon next to an output). The value is defined in pixels at 100% zoom, and will scale with zoom automatically. @@ -2091,7 +2093,7 @@ The size to use for port previews in the visual shader uniforms (toggled by clic .. rst-class:: classref-property -:ref:`String` **filesystem/directories/autoscan_project_path** +:ref:`String` **filesystem/directories/autoscan_project_path** :ref:`🔗` The folder where projects should be scanned for (recursively), in a way similar to the project manager's **Scan** button. This can be set to the same value as :ref:`filesystem/directories/default_project_path` for convenience. @@ -2105,7 +2107,7 @@ The folder where projects should be scanned for (recursively), in a way similar .. rst-class:: classref-property -:ref:`String` **filesystem/directories/default_project_path** +:ref:`String` **filesystem/directories/default_project_path** :ref:`🔗` The folder where new projects should be created by default when clicking the project manager's **New Project** button. This can be set to the same value as :ref:`filesystem/directories/autoscan_project_path` for convenience. @@ -2117,7 +2119,7 @@ The folder where new projects should be created by default when clicking the pro .. rst-class:: classref-property -:ref:`String` **filesystem/external_programs/3d_model_editor** +:ref:`String` **filesystem/external_programs/3d_model_editor** :ref:`🔗` The program that opens 3D model scene files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program. @@ -2129,7 +2131,7 @@ The program that opens 3D model scene files when clicking "Open in External Prog .. rst-class:: classref-property -:ref:`String` **filesystem/external_programs/audio_editor** +:ref:`String` **filesystem/external_programs/audio_editor** :ref:`🔗` The program that opens audio files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program. @@ -2141,7 +2143,7 @@ The program that opens audio files when clicking "Open in External Program" opti .. rst-class:: classref-property -:ref:`String` **filesystem/external_programs/raster_image_editor** +:ref:`String` **filesystem/external_programs/raster_image_editor** :ref:`🔗` The program that opens raster image files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program. @@ -2153,7 +2155,7 @@ The program that opens raster image files when clicking "Open in External Progra .. rst-class:: classref-property -:ref:`String` **filesystem/external_programs/terminal_emulator** +:ref:`String` **filesystem/external_programs/terminal_emulator** :ref:`🔗` The terminal emulator program to use when using **Open in Terminal** context menu action in the FileSystem dock. You can enter an absolute path to a program binary, or a path to a program that is present in the ``PATH`` environment variable. @@ -2179,7 +2181,7 @@ If specifying a custom terminal emulator, you may need to override :ref:`filesys .. rst-class:: classref-property -:ref:`String` **filesystem/external_programs/terminal_emulator_flags** +:ref:`String` **filesystem/external_programs/terminal_emulator_flags** :ref:`🔗` The command-line arguments to pass to the terminal emulator that is run when using **Open in Terminal** context menu action in the FileSystem dock. See also :ref:`filesystem/external_programs/terminal_emulator`. @@ -2195,7 +2197,7 @@ If left empty, the default flags are ``{directory}``, which is replaced by the a .. rst-class:: classref-property -:ref:`String` **filesystem/external_programs/vector_image_editor** +:ref:`String` **filesystem/external_programs/vector_image_editor** :ref:`🔗` The program that opens vector image files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program. @@ -2207,7 +2209,7 @@ The program that opens vector image files when clicking "Open in External Progra .. rst-class:: classref-property -:ref:`int` **filesystem/file_dialog/display_mode** +:ref:`int` **filesystem/file_dialog/display_mode** :ref:`🔗` The display mode to use in the editor's file dialogs. @@ -2223,7 +2225,7 @@ The display mode to use in the editor's file dialogs. .. rst-class:: classref-property -:ref:`bool` **filesystem/file_dialog/show_hidden_files** +:ref:`bool` **filesystem/file_dialog/show_hidden_files** :ref:`🔗` If ``true``, display hidden files in the editor's file dialogs. Files that have names starting with ``.`` are considered hidden (e.g. ``.hidden_file``). @@ -2235,7 +2237,7 @@ If ``true``, display hidden files in the editor's file dialogs. Files that have .. rst-class:: classref-property -:ref:`int` **filesystem/file_dialog/thumbnail_size** +:ref:`int` **filesystem/file_dialog/thumbnail_size** :ref:`🔗` The thumbnail size to use in the editor's file dialogs (in pixels). See also :ref:`docks/filesystem/thumbnail_size`. @@ -2247,7 +2249,7 @@ The thumbnail size to use in the editor's file dialogs (in pixels). See also :re .. rst-class:: classref-property -:ref:`String` **filesystem/import/blender/blender_path** +:ref:`String` **filesystem/import/blender/blender_path** :ref:`🔗` The path to the directory containing the Blender executable used for converting the Blender 3D scene files ``.blend`` to glTF 2.0 format during import. Blender 3.0 or later is required. @@ -2261,7 +2263,7 @@ To enable this feature for your specific project, use :ref:`ProjectSettings.file .. rst-class:: classref-property -:ref:`int` **filesystem/import/blender/rpc_port** +:ref:`int` **filesystem/import/blender/rpc_port** :ref:`🔗` The port number used for Remote Procedure Call (RPC) communication with Godot's created process of the blender executable. @@ -2275,7 +2277,7 @@ Setting this to 0 effectively disables communication with Godot and the blender .. rst-class:: classref-property -:ref:`float` **filesystem/import/blender/rpc_server_uptime** +:ref:`float` **filesystem/import/blender/rpc_server_uptime** :ref:`🔗` The maximum idle uptime (in seconds) of the Blender process. @@ -2285,11 +2287,11 @@ This prevents Godot from having to create a new process for each import within t ---- -.. _class_EditorSettings_property_filesystem/import/fbx2gltf/fbx2gltf_path: +.. _class_EditorSettings_property_filesystem/import/fbx/fbx2gltf_path: .. rst-class:: classref-property -:ref:`String` **filesystem/import/fbx2gltf/fbx2gltf_path** +:ref:`String` **filesystem/import/fbx/fbx2gltf_path** :ref:`🔗` The path to the FBX2glTF executable used for converting Autodesk FBX 3D scene files ``.fbx`` to glTF 2.0 format during import. @@ -2303,7 +2305,7 @@ To enable this feature for your specific project, use :ref:`ProjectSettings.file .. rst-class:: classref-property -:ref:`bool` **filesystem/on_save/compress_binary_resources** +:ref:`bool` **filesystem/on_save/compress_binary_resources** :ref:`🔗` If ``true``, uses lossless compression for binary resources. @@ -2315,7 +2317,7 @@ If ``true``, uses lossless compression for binary resources. .. rst-class:: classref-property -:ref:`bool` **filesystem/on_save/safe_save_on_backup_then_rename** +:ref:`bool` **filesystem/on_save/safe_save_on_backup_then_rename** :ref:`🔗` If ``true``, when saving a file, the editor will rename the old file to a different name, save a new file, then only remove the old file once the new file has been saved. This makes loss of data less likely to happen if the editor or operating system exits unexpectedly while saving (e.g. due to a crash or power outage). @@ -2329,7 +2331,7 @@ If ``true``, when saving a file, the editor will rename the old file to a differ .. rst-class:: classref-property -:ref:`String` **filesystem/tools/oidn/oidn_denoise_path** +:ref:`String` **filesystem/tools/oidn/oidn_denoise_path** :ref:`🔗` The path to the directory containing the Open Image Denoise (OIDN) executable, used optionally for denoising lightmaps. It can be downloaded from `openimagedenoise.org `__. @@ -2343,7 +2345,7 @@ To enable this feature for your specific project, use :ref:`ProjectSettings.rend .. rst-class:: classref-property -:ref:`int` **interface/editor/accept_dialog_cancel_ok_buttons** +:ref:`int` **interface/editor/accept_dialog_cancel_ok_buttons** :ref:`🔗` How to position the Cancel and OK buttons in the editor's :ref:`AcceptDialog`\ s. Different platforms have different standard behaviors for this, which can be overridden using this setting. This is useful if you use Godot both on Windows and macOS/Linux and your Godot muscle memory is stronger than your OS specific one. @@ -2361,7 +2363,7 @@ How to position the Cancel and OK buttons in the editor's :ref:`AcceptDialog` **interface/editor/automatically_open_screenshots** +:ref:`bool` **interface/editor/automatically_open_screenshots** :ref:`🔗` If ``true``, automatically opens screenshots with the default program associated to ``.png`` files after a screenshot is taken using the **Editor > Take Screenshot** action. @@ -2373,7 +2375,7 @@ If ``true``, automatically opens screenshots with the default program associated .. rst-class:: classref-property -:ref:`String` **interface/editor/code_font** +:ref:`String` **interface/editor/code_font** :ref:`🔗` The font to use for the script editor. Must be a resource of a :ref:`Font` type such as a ``.ttf`` or ``.otf`` font file. @@ -2385,7 +2387,7 @@ The font to use for the script editor. Must be a resource of a :ref:`Font` **interface/editor/code_font_contextual_ligatures** +:ref:`int` **interface/editor/code_font_contextual_ligatures** :ref:`🔗` The font ligatures to enable for the currently configured code font. Not all fonts include support for ligatures. @@ -2399,7 +2401,7 @@ The font ligatures to enable for the currently configured code font. Not all fon .. rst-class:: classref-property -:ref:`String` **interface/editor/code_font_custom_opentype_features** +:ref:`String` **interface/editor/code_font_custom_opentype_features** :ref:`🔗` List of custom OpenType features to use, if supported by the currently configured code font. Not all fonts include support for custom OpenType features. The string should follow the OpenType specification. @@ -2413,7 +2415,7 @@ List of custom OpenType features to use, if supported by the currently configure .. rst-class:: classref-property -:ref:`String` **interface/editor/code_font_custom_variations** +:ref:`String` **interface/editor/code_font_custom_variations** :ref:`🔗` List of alternative characters to use, if supported by the currently configured code font. Not all fonts include support for custom variations. The string should follow the OpenType specification. @@ -2427,7 +2429,7 @@ List of alternative characters to use, if supported by the currently configured .. rst-class:: classref-property -:ref:`int` **interface/editor/code_font_size** +:ref:`int` **interface/editor/code_font_size** :ref:`🔗` The size of the font in the script editor. This setting does not impact the font size of the Output panel (see :ref:`run/output/font_size`). @@ -2439,7 +2441,7 @@ The size of the font in the script editor. This setting does not impact the font .. rst-class:: classref-property -:ref:`float` **interface/editor/custom_display_scale** +:ref:`float` **interface/editor/custom_display_scale** :ref:`🔗` The custom editor scale factor to use. This can be used for displays with very high DPI where a scale factor of 200% is not sufficient. @@ -2453,7 +2455,7 @@ The custom editor scale factor to use. This can be used for displays with very h .. rst-class:: classref-property -:ref:`bool` **interface/editor/debug/enable_pseudolocalization** +:ref:`bool` **interface/editor/debug/enable_pseudolocalization** :ref:`🔗` If ``true``, lengthens the editor's localizable strings and replaces their characters with accented variants. This allows spotting non-localizable strings easily, while also ensuring the UI layout doesn't break when strings are made longer (as many languages require strings to be longer). @@ -2467,7 +2469,7 @@ This is a debugging feature and should only be enabled when working on the edito .. rst-class:: classref-property -:ref:`int` **interface/editor/display_scale** +:ref:`int` **interface/editor/display_scale** :ref:`🔗` The display scale factor to use for the editor interface. Higher values are more suited to hiDPI/Retina displays. @@ -2483,7 +2485,7 @@ If set to **Custom**, the scaling value in :ref:`interface/editor/custom_display .. rst-class:: classref-property -:ref:`int` **interface/editor/dock_tab_style** +:ref:`int` **interface/editor/dock_tab_style** :ref:`🔗` Tab style of editor docks. @@ -2495,7 +2497,7 @@ Tab style of editor docks. .. rst-class:: classref-property -:ref:`String` **interface/editor/editor_language** +:ref:`String` **interface/editor/editor_language** :ref:`🔗` The language to use for the editor interface. @@ -2509,7 +2511,7 @@ Translations are provided by the community. If you spot a mistake, :doc:`contrib .. rst-class:: classref-property -:ref:`int` **interface/editor/editor_screen** +:ref:`int` **interface/editor/editor_screen** :ref:`🔗` The preferred monitor to display the editor. @@ -2521,7 +2523,7 @@ The preferred monitor to display the editor. .. rst-class:: classref-property -:ref:`bool` **interface/editor/expand_to_title** +:ref:`bool` **interface/editor/expand_to_title** :ref:`🔗` Expanding main editor window content to the title, if supported by :ref:`DisplayServer`. See :ref:`DisplayServer.WINDOW_FLAG_EXTEND_TO_TITLE`. @@ -2535,7 +2537,7 @@ Specific to the macOS platform. .. rst-class:: classref-property -:ref:`int` **interface/editor/font_antialiasing** +:ref:`int` **interface/editor/font_antialiasing** :ref:`🔗` FreeType's font anti-aliasing mode used to render the editor fonts. Most fonts are not designed to look good with anti-aliasing disabled, so it's recommended to leave this enabled unless you're using a pixel art font. @@ -2547,7 +2549,7 @@ FreeType's font anti-aliasing mode used to render the editor fonts. Most fonts a .. rst-class:: classref-property -:ref:`bool` **interface/editor/font_disable_embedded_bitmaps** +:ref:`bool` **interface/editor/font_disable_embedded_bitmaps** :ref:`🔗` If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). @@ -2559,7 +2561,7 @@ If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and co .. rst-class:: classref-property -:ref:`int` **interface/editor/font_hinting** +:ref:`int` **interface/editor/font_hinting** :ref:`🔗` The font hinting mode to use for the editor fonts. FreeType supports the following font hinting modes: @@ -2579,7 +2581,7 @@ If set to **Auto**, the font hinting mode will be set to match the current opera .. rst-class:: classref-property -:ref:`int` **interface/editor/font_subpixel_positioning** +:ref:`int` **interface/editor/font_subpixel_positioning** :ref:`🔗` The subpixel positioning mode to use when rendering editor font glyphs. This affects both the main and code fonts. **Disabled** is the fastest to render and uses the least memory. **Auto** only uses subpixel positioning for small font sizes (where the benefit is the most noticeable). **One Half of a Pixel** and **One Quarter of a Pixel** force the same subpixel positioning mode for all editor fonts, regardless of their size (with **One Quarter of a Pixel** being the highest-quality option). @@ -2591,7 +2593,7 @@ The subpixel positioning mode to use when rendering editor font glyphs. This aff .. rst-class:: classref-property -:ref:`bool` **interface/editor/import_resources_when_unfocused** +:ref:`bool` **interface/editor/import_resources_when_unfocused** :ref:`🔗` If ``true``, (re)imports resources even if the editor window is unfocused or minimized. If ``false``, resources are only (re)imported when the editor window is focused. This can be set to ``true`` to speed up iteration by starting the import process earlier when saving files in the project folder. This also allows getting visual feedback on changes without having to click the editor window, which is useful with multi-monitor setups. The downside of setting this to ``true`` is that it increases idle CPU usage and may steal CPU time from other applications when importing resources. @@ -2603,7 +2605,7 @@ If ``true``, (re)imports resources even if the editor window is unfocused or min .. rst-class:: classref-property -:ref:`bool` **interface/editor/localize_settings** +:ref:`bool` **interface/editor/localize_settings** :ref:`🔗` If ``true``, setting names in the editor are localized when possible. @@ -2617,7 +2619,7 @@ If ``true``, setting names in the editor are localized when possible. .. rst-class:: classref-property -:ref:`int` **interface/editor/low_processor_mode_sleep_usec** +:ref:`int` **interface/editor/low_processor_mode_sleep_usec** :ref:`🔗` The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops. However, higher values will result in a less responsive editor. The default value is set to allow for maximum smoothness on monitors up to 144 Hz. See also :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec`. @@ -2631,7 +2633,7 @@ The amount of sleeping between frames when the low-processor usage mode is enabl .. rst-class:: classref-property -:ref:`String` **interface/editor/main_font** +:ref:`String` **interface/editor/main_font** :ref:`🔗` The font to use for the editor interface. Must be a resource of a :ref:`Font` type such as a ``.ttf`` or ``.otf`` font file. @@ -2643,7 +2645,7 @@ The font to use for the editor interface. Must be a resource of a :ref:`Font` **interface/editor/main_font_bold** +:ref:`String` **interface/editor/main_font_bold** :ref:`🔗` The font to use for bold text in the editor interface. Must be a resource of a :ref:`Font` type such as a ``.ttf`` or ``.otf`` font file. @@ -2655,7 +2657,7 @@ The font to use for bold text in the editor interface. Must be a resource of a : .. rst-class:: classref-property -:ref:`int` **interface/editor/main_font_size** +:ref:`int` **interface/editor/main_font_size** :ref:`🔗` The size of the font in the editor interface. @@ -2667,7 +2669,7 @@ The size of the font in the editor interface. .. rst-class:: classref-property -:ref:`bool` **interface/editor/mouse_extra_buttons_navigate_history** +:ref:`bool` **interface/editor/mouse_extra_buttons_navigate_history** :ref:`🔗` If ``true``, the mouse's additional side buttons will be usable to navigate in the script editor's file history. Set this to ``false`` if you're using the side buttons for other purposes (such as a push-to-talk button in a VoIP program). @@ -2679,7 +2681,7 @@ If ``true``, the mouse's additional side buttons will be usable to navigate in t .. rst-class:: classref-property -:ref:`int` **interface/editor/project_manager_screen** +:ref:`int` **interface/editor/project_manager_screen** :ref:`🔗` The preferred monitor to display the project manager. @@ -2691,7 +2693,7 @@ The preferred monitor to display the project manager. .. rst-class:: classref-property -:ref:`bool` **interface/editor/save_each_scene_on_quit** +:ref:`bool` **interface/editor/save_each_scene_on_quit** :ref:`🔗` If ``false``, the editor will save all scenes when confirming the **Save** action when quitting the editor or quitting to the project list. If ``true``, the editor will ask to save each scene individually. @@ -2703,7 +2705,7 @@ If ``false``, the editor will save all scenes when confirming the **Save** actio .. rst-class:: classref-property -:ref:`bool` **interface/editor/save_on_focus_loss** +:ref:`bool` **interface/editor/save_on_focus_loss** :ref:`🔗` If ``true``, scenes and scripts are saved when the editor loses focus. Depending on the work flow, this behavior can be less intrusive than :ref:`text_editor/behavior/files/autosave_interval_secs` or remembering to save manually. @@ -2715,7 +2717,7 @@ If ``true``, scenes and scripts are saved when the editor loses focus. Depending .. rst-class:: classref-property -:ref:`bool` **interface/editor/separate_distraction_mode** +:ref:`bool` **interface/editor/separate_distraction_mode** :ref:`🔗` If ``true``, the editor's Script tab will have a separate distraction mode setting from the 2D/3D/AssetLib tabs. If ``false``, the distraction-free mode toggle is shared between all tabs. @@ -2727,7 +2729,7 @@ If ``true``, the editor's Script tab will have a separate distraction mode setti .. rst-class:: classref-property -:ref:`int` **interface/editor/show_internal_errors_in_toast_notifications** +:ref:`int` **interface/editor/show_internal_errors_in_toast_notifications** :ref:`🔗` If enabled, displays internal engine errors in toast notifications (toggleable by clicking the "bell" icon at the bottom of the editor). No matter the value of this setting, non-internal engine errors will always be visible in toast notifications. @@ -2741,7 +2743,7 @@ The default **Auto** value will only enable this if the editor was compiled with .. rst-class:: classref-property -:ref:`int` **interface/editor/show_update_spinner** +:ref:`int` **interface/editor/show_update_spinner** :ref:`🔗` If enabled, displays an icon in the top-right corner of the editor that spins when the editor redraws a frame. This can be used to diagnose situations where the engine is constantly redrawing, which should be avoided as this increases CPU and GPU utilization for no good reason. To further troubleshoot these situations, start the editor with the ``--debug-canvas-item-redraw`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. @@ -2759,7 +2761,7 @@ The default **Auto** value will only enable this if the editor was compiled with .. rst-class:: classref-property -:ref:`bool` **interface/editor/single_window_mode** +:ref:`bool` **interface/editor/single_window_mode** :ref:`🔗` If ``true``, embed modal windows such as docks inside the main editor window. When single-window mode is enabled, tooltips will also be embedded inside the main editor window, which means they can't be displayed outside of the editor window. @@ -2773,7 +2775,7 @@ If ``true``, embed modal windows such as docks inside the main editor window. Wh .. rst-class:: classref-property -:ref:`int` **interface/editor/ui_layout_direction** +:ref:`int` **interface/editor/ui_layout_direction** :ref:`🔗` Editor UI default layout direction. @@ -2785,7 +2787,7 @@ Editor UI default layout direction. .. rst-class:: classref-property -:ref:`int` **interface/editor/unfocused_low_processor_mode_sleep_usec** +:ref:`int` **interface/editor/unfocused_low_processor_mode_sleep_usec** :ref:`🔗` When the editor window is unfocused, the amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops (in addition to improving the running project's performance if the editor has to redraw continuously). However, higher values will result in a less responsive editor. The default value is set to limit the editor to 20 FPS when the editor window is unfocused. See also :ref:`interface/editor/low_processor_mode_sleep_usec`. @@ -2799,7 +2801,7 @@ When the editor window is unfocused, the amount of sleeping between frames when .. rst-class:: classref-property -:ref:`bool` **interface/editor/update_continuously** +:ref:`bool` **interface/editor/update_continuously** :ref:`🔗` If ``true``, redraws the editor every frame even if nothing has changed on screen. When this setting is enabled, the update spinner displays in red (see :ref:`interface/editor/show_update_spinner`). @@ -2813,7 +2815,7 @@ If ``true``, redraws the editor every frame even if nothing has changed on scree .. rst-class:: classref-property -:ref:`bool` **interface/editor/use_embedded_menu** +:ref:`bool` **interface/editor/use_embedded_menu** :ref:`🔗` If ``true``, editor main menu is using embedded :ref:`MenuBar` instead of system global menu. @@ -2827,7 +2829,7 @@ Specific to the macOS platform. .. rst-class:: classref-property -:ref:`bool` **interface/editor/use_native_file_dialogs** +:ref:`bool` **interface/editor/use_native_file_dialogs** :ref:`🔗` If ``true``, editor UI uses OS native file/directory selection dialogs. @@ -2839,7 +2841,7 @@ If ``true``, editor UI uses OS native file/directory selection dialogs. .. rst-class:: classref-property -:ref:`int` **interface/editor/vsync_mode** +:ref:`int` **interface/editor/vsync_mode** :ref:`🔗` Sets the V-Sync mode for the editor. Does not affect the project when run from the editor (this is controlled by :ref:`ProjectSettings.display/window/vsync/vsync_mode`). @@ -2855,7 +2857,7 @@ Depending on the platform and used renderer, the engine will fall back to **Enab .. rst-class:: classref-property -:ref:`bool` **interface/inspector/auto_unfold_foreign_scenes** +:ref:`bool` **interface/inspector/auto_unfold_foreign_scenes** :ref:`🔗` If ``true``, automatically expands property groups in the Inspector dock when opening a scene that hasn't been opened previously. If ``false``, all groups remain collapsed by default. @@ -2867,7 +2869,7 @@ If ``true``, automatically expands property groups in the Inspector dock when op .. rst-class:: classref-property -:ref:`int` **interface/inspector/default_color_picker_mode** +:ref:`int` **interface/inspector/default_color_picker_mode** :ref:`🔗` The default color picker mode to use when opening :ref:`ColorPicker`\ s in the editor. This mode can be temporarily adjusted on the color picker itself. @@ -2879,7 +2881,7 @@ The default color picker mode to use when opening :ref:`ColorPicker` **interface/inspector/default_color_picker_shape** +:ref:`int` **interface/inspector/default_color_picker_shape** :ref:`🔗` The default color picker shape to use when opening :ref:`ColorPicker`\ s in the editor. This shape can be temporarily adjusted on the color picker itself. @@ -2891,7 +2893,7 @@ The default color picker shape to use when opening :ref:`ColorPicker` **interface/inspector/default_float_step** +:ref:`float` **interface/inspector/default_float_step** :ref:`🔗` The floating-point precision to use for properties that don't define an explicit precision step. Lower values allow entering more precise values. @@ -2903,7 +2905,7 @@ The floating-point precision to use for properties that don't define an explicit .. rst-class:: classref-property -:ref:`int` **interface/inspector/default_property_name_style** +:ref:`int` **interface/inspector/default_property_name_style** :ref:`🔗` The default property name style to display in the Inspector dock. This style can be temporarily adjusted in the Inspector dock's menu. @@ -2923,7 +2925,7 @@ The default property name style to display in the Inspector dock. This style can .. rst-class:: classref-property -:ref:`bool` **interface/inspector/delimitate_all_container_and_resources** +:ref:`bool` **interface/inspector/delimitate_all_container_and_resources** :ref:`🔗` If ``true``, add a margin around Array, Dictionary, and Resource Editors that are not already colored. @@ -2937,7 +2939,7 @@ If ``true``, add a margin around Array, Dictionary, and Resource Editors that ar .. rst-class:: classref-property -:ref:`bool` **interface/inspector/disable_folding** +:ref:`bool` **interface/inspector/disable_folding** :ref:`🔗` If ``true``, forces all property groups to be expanded in the Inspector dock and prevents collapsing them. @@ -2949,7 +2951,7 @@ If ``true``, forces all property groups to be expanded in the Inspector dock and .. rst-class:: classref-property -:ref:`float` **interface/inspector/float_drag_speed** +:ref:`float` **interface/inspector/float_drag_speed** :ref:`🔗` Base speed for increasing/decreasing float values by dragging them in the inspector. @@ -2961,7 +2963,7 @@ Base speed for increasing/decreasing float values by dragging them in the inspec .. rst-class:: classref-property -:ref:`bool` **interface/inspector/horizontal_vector2_editing** +:ref:`bool` **interface/inspector/horizontal_vector2_editing** :ref:`🔗` If ``true``, :ref:`Vector2` and :ref:`Vector2i` properties are shown on a single line in the inspector instead of two lines. This is overall more compact, but it can be harder to view and edit large values without expanding the inspector horizontally. @@ -2973,7 +2975,7 @@ If ``true``, :ref:`Vector2` and :ref:`Vector2i` p .. rst-class:: classref-property -:ref:`bool` **interface/inspector/horizontal_vector_types_editing** +:ref:`bool` **interface/inspector/horizontal_vector_types_editing** :ref:`🔗` If ``true``, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`, :ref:`Rect2`, :ref:`Rect2i`, :ref:`Plane`, and :ref:`Quaternion` properties are shown on a single line in the inspector instead of multiple lines. This is overall more compact, but it can be harder to view and edit large values without expanding the inspector horizontally. @@ -2985,7 +2987,7 @@ If ``true``, :ref:`Vector3`, :ref:`Vector3i`, :re .. rst-class:: classref-property -:ref:`int` **interface/inspector/max_array_dictionary_items_per_page** +:ref:`int` **interface/inspector/max_array_dictionary_items_per_page** :ref:`🔗` The number of :ref:`Array` or :ref:`Dictionary` items to display on each "page" in the inspector. Higher values allow viewing more values per page, but take more time to load. This increased load time is noticeable when selecting nodes that have array or dictionary properties in the editor. @@ -2997,7 +2999,7 @@ The number of :ref:`Array` or :ref:`Dictionary` i .. rst-class:: classref-property -:ref:`int` **interface/inspector/nested_color_mode** +:ref:`int` **interface/inspector/nested_color_mode** :ref:`🔗` Control which property editors are colored when they are opened. @@ -3015,7 +3017,7 @@ Control which property editors are colored when they are opened. .. rst-class:: classref-property -:ref:`bool` **interface/inspector/open_resources_in_current_inspector** +:ref:`bool` **interface/inspector/open_resources_in_current_inspector** :ref:`🔗` If ``true``, subresources can be edited in the current inspector view. If the resource type is defined in :ref:`interface/inspector/resources_to_open_in_new_inspector` or if this setting is ``false``, attempting to edit a subresource always opens a new inspector view. @@ -3027,7 +3029,7 @@ If ``true``, subresources can be edited in the current inspector view. If the re .. rst-class:: classref-property -:ref:`PackedStringArray` **interface/inspector/resources_to_open_in_new_inspector** +:ref:`PackedStringArray` **interface/inspector/resources_to_open_in_new_inspector** :ref:`🔗` List of resources that should always be opened in a new inspector view, even if :ref:`interface/inspector/open_resources_in_current_inspector` is ``true``. @@ -3041,7 +3043,7 @@ List of resources that should always be opened in a new inspector view, even if .. rst-class:: classref-property -:ref:`bool` **interface/inspector/show_low_level_opentype_features** +:ref:`bool` **interface/inspector/show_low_level_opentype_features** :ref:`🔗` If ``true``, display OpenType features marked as ``hidden`` by the font file in the :ref:`Font` editor. @@ -3053,7 +3055,7 @@ If ``true``, display OpenType features marked as ``hidden`` by the font file in .. rst-class:: classref-property -:ref:`bool` **interface/multi_window/enable** +:ref:`bool` **interface/multi_window/enable** :ref:`🔗` If ``true``, multiple window support in editor is enabled. The following panels can become dedicated windows (i.e. made floating): Docks, Script editor, and Shader editor. @@ -3069,7 +3071,7 @@ If ``true``, multiple window support in editor is enabled. The following panels .. rst-class:: classref-property -:ref:`bool` **interface/multi_window/maximize_window** +:ref:`bool` **interface/multi_window/maximize_window** :ref:`🔗` If ``true``, when panels are made floating they will be maximized. @@ -3083,7 +3085,7 @@ If ``false``, when panels are made floating their position and size will match t .. rst-class:: classref-property -:ref:`bool` **interface/multi_window/restore_windows_on_load** +:ref:`bool` **interface/multi_window/restore_windows_on_load** :ref:`🔗` If ``true``, the floating panel position, size, and screen will be saved on editor exit. On next launch the panels that were floating will be made floating in the saved positions, sizes and screens, if possible. @@ -3095,7 +3097,7 @@ If ``true``, the floating panel position, size, and screen will be saved on edit .. rst-class:: classref-property -:ref:`int` **interface/scene_tabs/display_close_button** +:ref:`int` **interface/scene_tabs/display_close_button** :ref:`🔗` Controls when the Close (X) button is displayed on scene tabs at the top of the editor. @@ -3107,7 +3109,7 @@ Controls when the Close (X) button is displayed on scene tabs at the top of the .. rst-class:: classref-property -:ref:`int` **interface/scene_tabs/maximum_width** +:ref:`int` **interface/scene_tabs/maximum_width** :ref:`🔗` The maximum width of each scene tab at the top editor (in pixels). @@ -3119,7 +3121,7 @@ The maximum width of each scene tab at the top editor (in pixels). .. rst-class:: classref-property -:ref:`bool` **interface/scene_tabs/restore_scenes_on_load** +:ref:`bool` **interface/scene_tabs/restore_scenes_on_load** :ref:`🔗` If ``true``, when a project is loaded, restores scenes that were opened on the last editor session. @@ -3133,7 +3135,7 @@ If ``true``, when a project is loaded, restores scenes that were opened on the l .. rst-class:: classref-property -:ref:`bool` **interface/scene_tabs/show_script_button** +:ref:`bool` **interface/scene_tabs/show_script_button** :ref:`🔗` If ``true``, show a button next to each scene tab that opens the scene's "dominant" script when clicked. The "dominant" script is the one that is at the highest level in the scene's hierarchy. @@ -3145,7 +3147,7 @@ If ``true``, show a button next to each scene tab that opens the scene's "domina .. rst-class:: classref-property -:ref:`bool` **interface/scene_tabs/show_thumbnail_on_hover** +:ref:`bool` **interface/scene_tabs/show_thumbnail_on_hover** :ref:`🔗` If ``true``, display an automatically-generated thumbnail when hovering scene tabs with the mouse. Scene thumbnails are generated when saving the scene. @@ -3157,7 +3159,7 @@ If ``true``, display an automatically-generated thumbnail when hovering scene ta .. rst-class:: classref-property -:ref:`Color` **interface/theme/accent_color** +:ref:`Color` **interface/theme/accent_color** :ref:`🔗` The color to use for "highlighted" user interface elements in the editor (pressed and hovered items). @@ -3169,7 +3171,7 @@ The color to use for "highlighted" user interface elements in the editor (presse .. rst-class:: classref-property -:ref:`int` **interface/theme/additional_spacing** +:ref:`int` **interface/theme/additional_spacing** :ref:`🔗` The extra spacing to add to various GUI elements in the editor (in pixels). Increasing this value is useful to improve usability on touch screens, at the cost of reducing the amount of usable screen real estate. @@ -3183,7 +3185,7 @@ See also :ref:`interface/theme/spacing_preset` **interface/theme/base_color** +:ref:`Color` **interface/theme/base_color** :ref:`🔗` The base color to use for user interface elements in the editor. Secondary colors (such as darker/lighter variants) are derived from this color. @@ -3195,7 +3197,7 @@ The base color to use for user interface elements in the editor. Secondary color .. rst-class:: classref-property -:ref:`int` **interface/theme/base_spacing** +:ref:`int` **interface/theme/base_spacing** :ref:`🔗` The base spacing used by various GUI elements in the editor (in pixels). See also :ref:`interface/theme/spacing_preset`. @@ -3207,7 +3209,7 @@ The base spacing used by various GUI elements in the editor (in pixels). See als .. rst-class:: classref-property -:ref:`int` **interface/theme/border_size** +:ref:`int` **interface/theme/border_size** :ref:`🔗` The border size to use for interface elements (in pixels). @@ -3219,7 +3221,7 @@ The border size to use for interface elements (in pixels). .. rst-class:: classref-property -:ref:`float` **interface/theme/contrast** +:ref:`float` **interface/theme/contrast** :ref:`🔗` The contrast factor to use when deriving the editor theme's base color (see :ref:`interface/theme/base_color`). When using a positive values, the derived colors will be *darker* than the base color. This contrast factor can be set to a negative value, which will make the derived colors *brighter* than the base color. Negative contrast rates often look better for light themes. @@ -3231,7 +3233,7 @@ The contrast factor to use when deriving the editor theme's base color (see :ref .. rst-class:: classref-property -:ref:`int` **interface/theme/corner_radius** +:ref:`int` **interface/theme/corner_radius** :ref:`🔗` The corner radius to use for interface elements (in pixels). ``0`` is square. @@ -3243,7 +3245,7 @@ The corner radius to use for interface elements (in pixels). ``0`` is square. .. rst-class:: classref-property -:ref:`String` **interface/theme/custom_theme** +:ref:`String` **interface/theme/custom_theme** :ref:`🔗` The custom theme resource to use for the editor. Must be a Godot theme resource in ``.tres`` or ``.res`` format. @@ -3255,7 +3257,7 @@ The custom theme resource to use for the editor. Must be a Godot theme resource .. rst-class:: classref-property -:ref:`bool` **interface/theme/draw_extra_borders** +:ref:`bool` **interface/theme/draw_extra_borders** :ref:`🔗` If ``true``, draws additional borders around interactive UI elements in the editor. This is automatically enabled when using the **Black (OLED)** theme preset, as this theme preset uses a fully black background. @@ -3267,7 +3269,7 @@ If ``true``, draws additional borders around interactive UI elements in the edit .. rst-class:: classref-property -:ref:`bool` **interface/theme/follow_system_theme** +:ref:`bool` **interface/theme/follow_system_theme** :ref:`🔗` If ``true``, the editor theme preset will attempt to automatically match the system theme. @@ -3279,7 +3281,7 @@ If ``true``, the editor theme preset will attempt to automatically match the sys .. rst-class:: classref-property -:ref:`int` **interface/theme/icon_and_font_color** +:ref:`int` **interface/theme/icon_and_font_color** :ref:`🔗` The icon and font color scheme to use in the editor. @@ -3297,7 +3299,7 @@ The icon and font color scheme to use in the editor. .. rst-class:: classref-property -:ref:`float` **interface/theme/icon_saturation** +:ref:`float` **interface/theme/icon_saturation** :ref:`🔗` The saturation to use for editor icons. Higher values result in more vibrant colors. @@ -3311,7 +3313,7 @@ The saturation to use for editor icons. Higher values result in more vibrant col .. rst-class:: classref-property -:ref:`String` **interface/theme/preset** +:ref:`String` **interface/theme/preset** :ref:`🔗` The editor theme preset to use. @@ -3323,7 +3325,7 @@ The editor theme preset to use. .. rst-class:: classref-property -:ref:`float` **interface/theme/relationship_line_opacity** +:ref:`float` **interface/theme/relationship_line_opacity** :ref:`🔗` The opacity to use when drawing relationship lines in the editor's :ref:`Tree`-based GUIs (such as the Scene tree dock). @@ -3335,7 +3337,7 @@ The opacity to use when drawing relationship lines in the editor's :ref:`Tree` **interface/theme/spacing_preset** +:ref:`String` **interface/theme/spacing_preset** :ref:`🔗` The editor theme spacing preset to use. See also :ref:`interface/theme/base_spacing` and :ref:`interface/theme/additional_spacing`. @@ -3347,7 +3349,7 @@ The editor theme spacing preset to use. See also :ref:`interface/theme/base_spac .. rst-class:: classref-property -:ref:`bool` **interface/theme/use_system_accent_color** +:ref:`bool` **interface/theme/use_system_accent_color** :ref:`🔗` If ``true``, set accent color based on system settings. @@ -3361,7 +3363,7 @@ If ``true``, set accent color based on system settings. .. rst-class:: classref-property -:ref:`bool` **interface/touchscreen/enable_long_press_as_right_click** +:ref:`bool` **interface/touchscreen/enable_long_press_as_right_click** :ref:`🔗` If ``true``, long press on touchscreen is treated as right click. @@ -3375,7 +3377,7 @@ If ``true``, long press on touchscreen is treated as right click. .. rst-class:: classref-property -:ref:`bool` **interface/touchscreen/enable_pan_and_scale_gestures** +:ref:`bool` **interface/touchscreen/enable_pan_and_scale_gestures** :ref:`🔗` If ``true``, enable two finger pan and scale gestures on touchscreen devices. @@ -3389,7 +3391,7 @@ If ``true``, enable two finger pan and scale gestures on touchscreen devices. .. rst-class:: classref-property -:ref:`bool` **interface/touchscreen/increase_scrollbar_touch_area** +:ref:`bool` **interface/touchscreen/increase_scrollbar_touch_area** :ref:`🔗` If ``true``, increases the scrollbar touch area to improve usability on touchscreen devices. @@ -3403,7 +3405,7 @@ If ``true``, increases the scrollbar touch area to improve usability on touchscr .. rst-class:: classref-property -:ref:`float` **interface/touchscreen/scale_gizmo_handles** +:ref:`float` **interface/touchscreen/scale_gizmo_handles** :ref:`🔗` Specify the multiplier to apply to the scale for the editor gizmo handles to improve usability on touchscreen devices. @@ -3417,7 +3419,7 @@ Specify the multiplier to apply to the scale for the editor gizmo handles to imp .. rst-class:: classref-property -:ref:`int` **network/connection/engine_version_update_mode** +:ref:`int` **network/connection/engine_version_update_mode** :ref:`🔗` Specifies how the engine should check for updates. @@ -3439,7 +3441,7 @@ All update modes will ignore builds with different major versions (e.g. Godot 4 .. rst-class:: classref-property -:ref:`int` **network/connection/network_mode** +:ref:`int` **network/connection/network_mode** :ref:`🔗` Determines whether online features are enabled in the editor, such as the Asset Library or update checks. Disabling these online features helps alleviate privacy concerns by preventing the editor from making HTTP requests to the Godot website or third-party platforms hosting assets from the Asset Library. @@ -3451,7 +3453,7 @@ Determines whether online features are enabled in the editor, such as the Asset .. rst-class:: classref-property -:ref:`String` **network/debug/remote_host** +:ref:`String` **network/debug/remote_host** :ref:`🔗` The address to listen to when starting the remote debugger. This can be set to ``0.0.0.0`` to allow external clients to connect to the remote debugger (instead of restricting the remote debugger to connections from ``localhost``). @@ -3463,7 +3465,7 @@ The address to listen to when starting the remote debugger. This can be set to ` .. rst-class:: classref-property -:ref:`int` **network/debug/remote_port** +:ref:`int` **network/debug/remote_port** :ref:`🔗` The port to listen to when starting the remote debugger. Godot will try to use port numbers above the configured number if the configured number is already taken by another application. @@ -3475,7 +3477,7 @@ The port to listen to when starting the remote debugger. Godot will try to use p .. rst-class:: classref-property -:ref:`String` **network/http_proxy/host** +:ref:`String` **network/http_proxy/host** :ref:`🔗` The host to use to contact the HTTP and HTTPS proxy in the editor (for the asset library and export template downloads). See also :ref:`network/http_proxy/port`. @@ -3489,7 +3491,7 @@ The host to use to contact the HTTP and HTTPS proxy in the editor (for the asset .. rst-class:: classref-property -:ref:`int` **network/http_proxy/port** +:ref:`int` **network/http_proxy/port** :ref:`🔗` The port number to use to contact the HTTP and HTTPS proxy in the editor (for the asset library and export template downloads). See also :ref:`network/http_proxy/host`. @@ -3503,7 +3505,7 @@ The port number to use to contact the HTTP and HTTPS proxy in the editor (for th .. rst-class:: classref-property -:ref:`String` **network/tls/editor_tls_certificates** +:ref:`String` **network/tls/editor_tls_certificates** :ref:`🔗` The TLS certificate bundle to use for HTTP requests made within the editor (e.g. from the AssetLib tab). If left empty, the `included Mozilla certificate bundle `__ will be used. @@ -3515,7 +3517,7 @@ The TLS certificate bundle to use for HTTP requests made within the editor (e.g. .. rst-class:: classref-property -:ref:`String` **project_manager/default_renderer** +:ref:`String` **project_manager/default_renderer** :ref:`🔗` The renderer type that will be checked off by default when creating a new project. Accepted strings are "forward_plus", "mobile" or "gl_compatibility". @@ -3527,7 +3529,7 @@ The renderer type that will be checked off by default when creating a new projec .. rst-class:: classref-property -:ref:`int` **project_manager/directory_naming_convention** +:ref:`int` **project_manager/directory_naming_convention** :ref:`🔗` Directory naming convention for the project manager. Options are "No convention" (project name is directory name), "kebab-case" (default), "snake_case", "camelCase", "PascalCase", or "Title Case". @@ -3539,7 +3541,7 @@ Directory naming convention for the project manager. Options are "No convention" .. rst-class:: classref-property -:ref:`int` **project_manager/sorting_order** +:ref:`int` **project_manager/sorting_order** :ref:`🔗` The sorting order to use in the project manager. When changing the sorting order in the project manager, this setting is set permanently in the editor settings. @@ -3551,7 +3553,7 @@ The sorting order to use in the project manager. When changing the sorting order .. rst-class:: classref-property -:ref:`bool` **run/auto_save/save_before_running** +:ref:`bool` **run/auto_save/save_before_running** :ref:`🔗` If ``true``, saves all scenes and scripts automatically before running the project. Setting this to ``false`` prevents the editor from saving if there are no changes which can speed up the project startup slightly, but it makes it possible to run a project that has unsaved changes. (Unsaved changes will not be visible in the running project.) @@ -3559,37 +3561,37 @@ If ``true``, saves all scenes and scripts automatically before running the proje ---- -.. _class_EditorSettings_property_run/output/always_clear_output_on_play: +.. _class_EditorSettings_property_run/bottom_panel/action_on_play: .. rst-class:: classref-property -:ref:`bool` **run/output/always_clear_output_on_play** +:ref:`int` **run/bottom_panel/action_on_play** :ref:`🔗` -If ``true``, the editor will clear the Output panel when running the project. +The action to execute on the bottom panel when running the project. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_run/output/always_close_output_on_stop: +.. _class_EditorSettings_property_run/bottom_panel/action_on_stop: .. rst-class:: classref-property -:ref:`bool` **run/output/always_close_output_on_stop** +:ref:`int` **run/bottom_panel/action_on_stop** :ref:`🔗` -If ``true``, the editor will collapse the Output panel when stopping the project. +The action to execute on the bottom panel when stopping the project. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_run/output/always_open_output_on_play: +.. _class_EditorSettings_property_run/output/always_clear_output_on_play: .. rst-class:: classref-property -:ref:`bool` **run/output/always_open_output_on_play** +:ref:`bool` **run/output/always_clear_output_on_play** :ref:`🔗` -If ``true``, the editor will expand the Output panel when running the project. +If ``true``, the editor will clear the Output panel when running the project. .. rst-class:: classref-item-separator @@ -3599,7 +3601,7 @@ If ``true``, the editor will expand the Output panel when running the project. .. rst-class:: classref-property -:ref:`int` **run/output/font_size** +:ref:`int` **run/output/font_size** :ref:`🔗` The size of the font in the **Output** panel at the bottom of the editor. This setting does not impact the font size of the script editor (see :ref:`interface/editor/code_font_size`). @@ -3611,7 +3613,7 @@ The size of the font in the **Output** panel at the bottom of the editor. This s .. rst-class:: classref-property -:ref:`int` **run/output/max_lines** +:ref:`int` **run/output/max_lines** :ref:`🔗` Maximum number of lines to show at any one time in the Output panel. @@ -3623,7 +3625,7 @@ Maximum number of lines to show at any one time in the Output panel. .. rst-class:: classref-property -:ref:`bool` **run/platforms/linuxbsd/prefer_wayland** +:ref:`bool` **run/platforms/linuxbsd/prefer_wayland** :ref:`🔗` If ``true``, on Linux/BSD, the editor will check for Wayland first instead of X11 (if available). @@ -3635,7 +3637,7 @@ If ``true``, on Linux/BSD, the editor will check for Wayland first instead of X1 .. rst-class:: classref-property -:ref:`int` **run/window_placement/android_window** +:ref:`int` **run/window_placement/android_window** :ref:`🔗` The Android window to display the project on when starting the project from the editor. @@ -3649,7 +3651,7 @@ The Android window to display the project on when starting the project from the .. rst-class:: classref-property -:ref:`int` **run/window_placement/rect** +:ref:`int` **run/window_placement/rect** :ref:`🔗` The window mode to use to display the project when starting the project from the editor. @@ -3661,7 +3663,7 @@ The window mode to use to display the project when starting the project from the .. rst-class:: classref-property -:ref:`Vector2` **run/window_placement/rect_custom_position** +:ref:`Vector2` **run/window_placement/rect_custom_position** :ref:`🔗` The custom position to use when starting the project from the editor (in pixels from the top-left corner). Only effective if :ref:`run/window_placement/rect` is set to **Custom Position**. @@ -3673,7 +3675,7 @@ The custom position to use when starting the project from the editor (in pixels .. rst-class:: classref-property -:ref:`int` **run/window_placement/screen** +:ref:`int` **run/window_placement/screen** :ref:`🔗` The monitor to display the project on when starting the project from the editor. @@ -3685,7 +3687,7 @@ The monitor to display the project on when starting the project from the editor. .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/caret/caret_blink** +:ref:`bool` **text_editor/appearance/caret/caret_blink** :ref:`🔗` If ``true``, makes the caret blink according to :ref:`text_editor/appearance/caret/caret_blink_interval`. Disabling this setting can improve battery life on laptops if you spend long amounts of time in the script editor, since it will reduce the frequency at which the editor needs to be redrawn. @@ -3697,7 +3699,7 @@ If ``true``, makes the caret blink according to :ref:`text_editor/appearance/car .. rst-class:: classref-property -:ref:`float` **text_editor/appearance/caret/caret_blink_interval** +:ref:`float` **text_editor/appearance/caret/caret_blink_interval** :ref:`🔗` The interval at which the caret will blink (in seconds). See also :ref:`text_editor/appearance/caret/caret_blink`. @@ -3709,7 +3711,7 @@ The interval at which the caret will blink (in seconds). See also :ref:`text_edi .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/caret/highlight_all_occurrences** +:ref:`bool` **text_editor/appearance/caret/highlight_all_occurrences** :ref:`🔗` If ``true``, highlights all occurrences of the currently selected text in the script editor. See also :ref:`text_editor/theme/highlighting/word_highlighted_color`. @@ -3721,7 +3723,7 @@ If ``true``, highlights all occurrences of the currently selected text in the sc .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/caret/highlight_current_line** +:ref:`bool` **text_editor/appearance/caret/highlight_current_line** :ref:`🔗` If ``true``, colors the background of the line the caret is currently on with :ref:`text_editor/theme/highlighting/current_line_color`. @@ -3733,7 +3735,7 @@ If ``true``, colors the background of the line the caret is currently on with :r .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/caret/type** +:ref:`int` **text_editor/appearance/caret/type** :ref:`🔗` The shape of the caret to use in the script editor. **Line** displays a vertical line to the left of the current character, whereas **Block** displays an outline over the current character. @@ -3745,7 +3747,7 @@ The shape of the caret to use in the script editor. **Line** displays a vertical .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/guidelines/line_length_guideline_hard_column** +:ref:`int` **text_editor/appearance/guidelines/line_length_guideline_hard_column** :ref:`🔗` The column at which to display a subtle line as a line length guideline for scripts. This should generally be greater than :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column`. @@ -3757,7 +3759,7 @@ The column at which to display a subtle line as a line length guideline for scri .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/guidelines/line_length_guideline_soft_column** +:ref:`int` **text_editor/appearance/guidelines/line_length_guideline_soft_column** :ref:`🔗` The column at which to display a *very* subtle line as a line length guideline for scripts. This should generally be lower than :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column`. @@ -3769,7 +3771,7 @@ The column at which to display a *very* subtle line as a line length guideline f .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/guidelines/show_line_length_guidelines** +:ref:`bool` **text_editor/appearance/guidelines/show_line_length_guidelines** :ref:`🔗` If ``true``, displays line length guidelines to help you keep line lengths in check. See also :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column` and :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column`. @@ -3781,7 +3783,7 @@ If ``true``, displays line length guidelines to help you keep line lengths in ch .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/gutters/highlight_type_safe_lines** +:ref:`bool` **text_editor/appearance/gutters/highlight_type_safe_lines** :ref:`🔗` If ``true``, highlights type-safe lines by displaying their line number color with :ref:`text_editor/theme/highlighting/safe_line_number_color` instead of :ref:`text_editor/theme/highlighting/line_number_color`. Type-safe lines are lines of code where the type of all variables is known at compile-time. These type-safe lines may run faster thanks to typed instructions. @@ -3793,7 +3795,7 @@ If ``true``, highlights type-safe lines by displaying their line number color wi .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/gutters/line_numbers_zero_padded** +:ref:`bool` **text_editor/appearance/gutters/line_numbers_zero_padded** :ref:`🔗` If ``true``, displays line numbers with zero padding (e.g. ``007`` instead of ``7``). @@ -3805,7 +3807,7 @@ If ``true``, displays line numbers with zero padding (e.g. ``007`` instead of `` .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/gutters/show_info_gutter** +:ref:`bool` **text_editor/appearance/gutters/show_info_gutter** :ref:`🔗` If ``true``, displays a gutter at the left containing icons for methods with signal connections and for overridden methods. @@ -3817,7 +3819,7 @@ If ``true``, displays a gutter at the left containing icons for methods with sig .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/gutters/show_line_numbers** +:ref:`bool` **text_editor/appearance/gutters/show_line_numbers** :ref:`🔗` If ``true``, displays line numbers in a gutter at the left. @@ -3829,7 +3831,7 @@ If ``true``, displays line numbers in a gutter at the left. .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/lines/autowrap_mode** +:ref:`int` **text_editor/appearance/lines/autowrap_mode** :ref:`🔗` If :ref:`text_editor/appearance/lines/word_wrap` is set to ``1``, sets text wrapping mode. To see how each mode behaves, see :ref:`AutowrapMode`. @@ -3841,7 +3843,7 @@ If :ref:`text_editor/appearance/lines/word_wrap` **text_editor/appearance/lines/code_folding** +:ref:`bool` **text_editor/appearance/lines/code_folding** :ref:`🔗` If ``true``, displays the folding arrows next to indented code sections and allows code folding. If ``false``, hides the folding arrows next to indented code sections and disallows code folding. @@ -3853,7 +3855,7 @@ If ``true``, displays the folding arrows next to indented code sections and allo .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/lines/word_wrap** +:ref:`int` **text_editor/appearance/lines/word_wrap** :ref:`🔗` If ``true``, wraps long lines over multiple lines to avoid horizontal scrolling. This is a display-only feature; it does not actually insert line breaks in your scripts. @@ -3865,7 +3867,7 @@ If ``true``, wraps long lines over multiple lines to avoid horizontal scrolling. .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/minimap/minimap_width** +:ref:`int` **text_editor/appearance/minimap/minimap_width** :ref:`🔗` The width of the minimap in the script editor (in pixels). @@ -3877,7 +3879,7 @@ The width of the minimap in the script editor (in pixels). .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/minimap/show_minimap** +:ref:`bool` **text_editor/appearance/minimap/show_minimap** :ref:`🔗` If ``true``, draws an overview of the script near the scroll bar. The minimap can be left-clicked to scroll directly to a location in an "absolute" manner. @@ -3889,7 +3891,7 @@ If ``true``, draws an overview of the script near the scroll bar. The minimap ca .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/whitespace/draw_spaces** +:ref:`bool` **text_editor/appearance/whitespace/draw_spaces** :ref:`🔗` If ``true``, draws space characters as centered points. @@ -3901,7 +3903,7 @@ If ``true``, draws space characters as centered points. .. rst-class:: classref-property -:ref:`bool` **text_editor/appearance/whitespace/draw_tabs** +:ref:`bool` **text_editor/appearance/whitespace/draw_tabs** :ref:`🔗` If ``true``, draws tab characters as chevrons. @@ -3913,7 +3915,7 @@ If ``true``, draws tab characters as chevrons. .. rst-class:: classref-property -:ref:`int` **text_editor/appearance/whitespace/line_spacing** +:ref:`int` **text_editor/appearance/whitespace/line_spacing** :ref:`🔗` The space to add between lines (in pixels). Greater line spacing can help improve readability at the cost of displaying fewer lines on screen. @@ -3925,7 +3927,7 @@ The space to add between lines (in pixels). Greater line spacing can help improv .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/files/auto_reload_scripts_on_external_change** +:ref:`bool` **text_editor/behavior/files/auto_reload_scripts_on_external_change** :ref:`🔗` If ``true``, automatically reloads scripts in the editor when they have been modified and saved by external editors. @@ -3937,7 +3939,7 @@ If ``true``, automatically reloads scripts in the editor when they have been mod .. rst-class:: classref-property -:ref:`int` **text_editor/behavior/files/autosave_interval_secs** +:ref:`int` **text_editor/behavior/files/autosave_interval_secs** :ref:`🔗` If set to a value greater than ``0``, automatically saves the current script following the specified interval (in seconds). This can be used to prevent data loss if the editor crashes. @@ -3949,7 +3951,7 @@ If set to a value greater than ``0``, automatically saves the current script fol .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/files/convert_indent_on_save** +:ref:`bool` **text_editor/behavior/files/convert_indent_on_save** :ref:`🔗` If ``true``, converts indentation to match the script editor's indentation settings when saving a script. See also :ref:`text_editor/behavior/indent/type`. @@ -3961,7 +3963,7 @@ If ``true``, converts indentation to match the script editor's indentation setti .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/files/restore_scripts_on_load** +:ref:`bool` **text_editor/behavior/files/restore_scripts_on_load** :ref:`🔗` If ``true``, reopens scripts that were opened in the last session when the editor is reopened on a given project. @@ -3969,11 +3971,23 @@ If ``true``, reopens scripts that were opened in the last session when the edito ---- +.. _class_EditorSettings_property_text_editor/behavior/files/trim_final_newlines_on_save: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/behavior/files/trim_final_newlines_on_save** :ref:`🔗` + +If ``true``, trims all empty newlines after the final newline when saving a script. Final newlines refer to the empty newlines found at the end of files. Since these serve no practical purpose, they can and should be removed to make version control diffs less noisy. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/behavior/files/trim_trailing_whitespace_on_save: .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/files/trim_trailing_whitespace_on_save** +:ref:`bool` **text_editor/behavior/files/trim_trailing_whitespace_on_save** :ref:`🔗` If ``true``, trims trailing whitespace when saving a script. Trailing whitespace refers to tab and space characters placed at the end of lines. Since these serve no practical purpose, they can and should be removed to make version control diffs less noisy. @@ -3985,7 +3999,7 @@ If ``true``, trims trailing whitespace when saving a script. Trailing whitespace .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/indent/auto_indent** +:ref:`bool` **text_editor/behavior/indent/auto_indent** :ref:`🔗` If ``true``, automatically indents code when pressing the :kbd:`Enter` key based on blocks above the new line. @@ -3997,7 +4011,7 @@ If ``true``, automatically indents code when pressing the :kbd:`Enter` key based .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/indent/indent_wrapped_lines** +:ref:`bool` **text_editor/behavior/indent/indent_wrapped_lines** :ref:`🔗` If ``true``, all wrapped lines are indented to the same amount as the unwrapped line. @@ -4009,7 +4023,7 @@ If ``true``, all wrapped lines are indented to the same amount as the unwrapped .. rst-class:: classref-property -:ref:`int` **text_editor/behavior/indent/size** +:ref:`int` **text_editor/behavior/indent/size** :ref:`🔗` When using tab indentation, determines the length of each tab. When using space indentation, determines how many spaces are inserted when pressing :kbd:`Tab` and when automatic indentation is performed. @@ -4021,7 +4035,7 @@ When using tab indentation, determines the length of each tab. When using space .. rst-class:: classref-property -:ref:`int` **text_editor/behavior/indent/type** +:ref:`int` **text_editor/behavior/indent/type** :ref:`🔗` The indentation style to use (tabs or spaces). @@ -4035,7 +4049,7 @@ The indentation style to use (tabs or spaces). .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/navigation/drag_and_drop_selection** +:ref:`bool` **text_editor/behavior/navigation/drag_and_drop_selection** :ref:`🔗` If ``true``, allows drag-and-dropping text in the script editor to move text. Disable this if you find yourself accidentally drag-and-dropping text in the script editor. @@ -4047,7 +4061,7 @@ If ``true``, allows drag-and-dropping text in the script editor to move text. Di .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/navigation/move_caret_on_right_click** +:ref:`bool` **text_editor/behavior/navigation/move_caret_on_right_click** :ref:`🔗` If ``true``, the caret will be moved when right-clicking somewhere in the script editor (like when left-clicking or middle-clicking). If ``false``, the caret will only be moved when left-clicking or middle-clicking somewhere. @@ -4059,7 +4073,7 @@ If ``true``, the caret will be moved when right-clicking somewhere in the script .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method** +:ref:`bool` **text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method** :ref:`🔗` If ``true``, opens the script editor when connecting a signal to an existing script method from the Node dock. @@ -4071,7 +4085,7 @@ If ``true``, opens the script editor when connecting a signal to an existing scr .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/navigation/scroll_past_end_of_file** +:ref:`bool` **text_editor/behavior/navigation/scroll_past_end_of_file** :ref:`🔗` If ``true``, allows scrolling past the end of the file. @@ -4083,7 +4097,7 @@ If ``true``, allows scrolling past the end of the file. .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/navigation/smooth_scrolling** +:ref:`bool` **text_editor/behavior/navigation/smooth_scrolling** :ref:`🔗` If ``true``, allows scrolling in sub-line intervals and enables a smooth scrolling animation when using the mouse wheel to scroll. @@ -4097,7 +4111,7 @@ If ``true``, allows scrolling in sub-line intervals and enables a smooth scrolli .. rst-class:: classref-property -:ref:`bool` **text_editor/behavior/navigation/stay_in_script_editor_on_node_selected** +:ref:`bool` **text_editor/behavior/navigation/stay_in_script_editor_on_node_selected** :ref:`🔗` If ``true``, prevents automatically switching between the Script and 2D/3D screens when selecting a node in the Scene tree dock. @@ -4109,7 +4123,7 @@ If ``true``, prevents automatically switching between the Script and 2D/3D scree .. rst-class:: classref-property -:ref:`int` **text_editor/behavior/navigation/v_scroll_speed** +:ref:`int` **text_editor/behavior/navigation/v_scroll_speed** :ref:`🔗` The number of pixels to scroll with every mouse wheel increment. Higher values make the script scroll by faster when using the mouse wheel. @@ -4123,7 +4137,7 @@ The number of pixels to scroll with every mouse wheel increment. Higher values m .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/add_node_path_literals** +:ref:`bool` **text_editor/completion/add_node_path_literals** :ref:`🔗` If ``true``, uses :ref:`NodePath` instead of :ref:`String` when appropriate for code autocompletion or for drag and dropping object properties into the script editor. @@ -4135,7 +4149,7 @@ If ``true``, uses :ref:`NodePath` instead of :ref:`String` **text_editor/completion/add_string_name_literals** +:ref:`bool` **text_editor/completion/add_string_name_literals** :ref:`🔗` If ``true``, uses :ref:`StringName` instead of :ref:`String` when appropriate for code autocompletion. @@ -4147,7 +4161,7 @@ If ``true``, uses :ref:`StringName` instead of :ref:`String` **text_editor/completion/add_type_hints** +:ref:`bool` **text_editor/completion/add_type_hints** :ref:`🔗` If ``true``, adds :doc:`GDScript static typing <../tutorials/scripting/gdscript/static_typing>` hints such as ``-> void`` and ``: int`` when using code autocompletion or when creating onready variables by drag and dropping nodes into the script editor while pressing the :kbd:`Ctrl` key. If ``true``, newly created scripts will also automatically have type hints added to their method parameters and return types. @@ -4159,7 +4173,7 @@ If ``true``, adds :doc:`GDScript static typing <../tutorials/scripting/gdscript/ .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/auto_brace_complete** +:ref:`bool` **text_editor/completion/auto_brace_complete** :ref:`🔗` If ``true``, automatically completes braces when making use of code completion. @@ -4171,7 +4185,7 @@ If ``true``, automatically completes braces when making use of code completion. .. rst-class:: classref-property -:ref:`float` **text_editor/completion/code_complete_delay** +:ref:`float` **text_editor/completion/code_complete_delay** :ref:`🔗` The delay in seconds after which autocompletion suggestions should be displayed when the user stops typing. @@ -4183,7 +4197,7 @@ The delay in seconds after which autocompletion suggestions should be displayed .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/code_complete_enabled** +:ref:`bool` **text_editor/completion/code_complete_enabled** :ref:`🔗` If ``true``, code completion will be triggered automatically after :ref:`text_editor/completion/code_complete_delay`. If ``false``, you can still trigger completion manually by pressing :kbd:`Ctrl + Space` (:kbd:`Cmd + Space` on macOS). @@ -4195,7 +4209,7 @@ If ``true``, code completion will be triggered automatically after :ref:`text_ed .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/colorize_suggestions** +:ref:`bool` **text_editor/completion/colorize_suggestions** :ref:`🔗` If ``true`` enables the coloring for some items in the autocompletion suggestions, like vector components. @@ -4207,7 +4221,7 @@ If ``true`` enables the coloring for some items in the autocompletion suggestion .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/complete_file_paths** +:ref:`bool` **text_editor/completion/complete_file_paths** :ref:`🔗` If ``true``, provides autocompletion suggestions for file paths in methods such as ``load()`` and ``preload()``. @@ -4219,7 +4233,7 @@ If ``true``, provides autocompletion suggestions for file paths in methods such .. rst-class:: classref-property -:ref:`float` **text_editor/completion/idle_parse_delay** +:ref:`float` **text_editor/completion/idle_parse_delay** :ref:`🔗` The delay in seconds after which the script editor should check for errors when the user stops typing. @@ -4231,7 +4245,7 @@ The delay in seconds after which the script editor should check for errors when .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/put_callhint_tooltip_below_current_line** +:ref:`bool` **text_editor/completion/put_callhint_tooltip_below_current_line** :ref:`🔗` If ``true``, the code completion tooltip will appear below the current line unless there is no space on screen below the current line. If ``false``, the code completion tooltip will appear above the current line. @@ -4243,7 +4257,7 @@ If ``true``, the code completion tooltip will appear below the current line unle .. rst-class:: classref-property -:ref:`bool` **text_editor/completion/use_single_quotes** +:ref:`bool` **text_editor/completion/use_single_quotes** :ref:`🔗` If ``true``, performs string autocompletion with single quotes. If ``false``, performs string autocompletion with double quotes (which matches the :doc:`GDScript style guide <../tutorials/scripting/gdscript/gdscript_styleguide>`). @@ -4255,7 +4269,7 @@ If ``true``, performs string autocompletion with single quotes. If ``false``, pe .. rst-class:: classref-property -:ref:`int` **text_editor/help/class_reference_examples** +:ref:`int` **text_editor/help/class_reference_examples** :ref:`🔗` Controls which multi-line code blocks should be displayed in the editor help. This setting does not affect single-line code literals in the editor help. @@ -4267,7 +4281,7 @@ Controls which multi-line code blocks should be displayed in the editor help. Th .. rst-class:: classref-property -:ref:`int` **text_editor/help/help_font_size** +:ref:`int` **text_editor/help/help_font_size** :ref:`🔗` The font size to use for the editor help (built-in class reference). @@ -4279,7 +4293,7 @@ The font size to use for the editor help (built-in class reference). .. rst-class:: classref-property -:ref:`int` **text_editor/help/help_source_font_size** +:ref:`int` **text_editor/help/help_source_font_size** :ref:`🔗` The font size to use for code samples in the editor help (built-in class reference). @@ -4291,7 +4305,7 @@ The font size to use for code samples in the editor help (built-in class referen .. rst-class:: classref-property -:ref:`int` **text_editor/help/help_title_font_size** +:ref:`int` **text_editor/help/help_title_font_size** :ref:`🔗` The font size to use for headings in the editor help (built-in class reference). @@ -4303,7 +4317,7 @@ The font size to use for headings in the editor help (built-in class reference). .. rst-class:: classref-property -:ref:`bool` **text_editor/help/show_help_index** +:ref:`bool` **text_editor/help/show_help_index** :ref:`🔗` If ``true``, displays a table of contents at the left of the editor help (at the location where the members overview would appear when editing a script). @@ -4315,7 +4329,7 @@ If ``true``, displays a table of contents at the left of the editor help (at the .. rst-class:: classref-property -:ref:`bool` **text_editor/script_list/show_members_overview** +:ref:`bool` **text_editor/script_list/show_members_overview** :ref:`🔗` If ``true``, displays an overview of the current script's member variables and functions at the left of the script editor. See also :ref:`text_editor/script_list/sort_members_outline_alphabetically`. @@ -4327,7 +4341,7 @@ If ``true``, displays an overview of the current script's member variables and f .. rst-class:: classref-property -:ref:`bool` **text_editor/script_list/sort_members_outline_alphabetically** +:ref:`bool` **text_editor/script_list/sort_members_outline_alphabetically** :ref:`🔗` If ``true``, sorts the members outline (located at the left of the script editor) using alphabetical order. If ``false``, sorts the members outline depending on the order in which members are found in the script. @@ -4341,7 +4355,7 @@ If ``true``, sorts the members outline (located at the left of the script editor .. rst-class:: classref-property -:ref:`String` **text_editor/theme/color_theme** +:ref:`String` **text_editor/theme/color_theme** :ref:`🔗` The syntax theme to use in the script editor. @@ -4357,7 +4371,7 @@ You can find additional syntax themes to install in the `godot-syntax-themes ` **text_editor/theme/highlighting/background_color** +:ref:`Color` **text_editor/theme/highlighting/background_color** :ref:`🔗` The script editor's background color. If set to a translucent color, the editor theme's base color will be visible behind. @@ -4369,7 +4383,7 @@ The script editor's background color. If set to a translucent color, the editor .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/base_type_color** +:ref:`Color` **text_editor/theme/highlighting/base_type_color** :ref:`🔗` The script editor's base type color (used for types like :ref:`Vector2`, :ref:`Vector3`, :ref:`Color`, ...). @@ -4381,7 +4395,7 @@ The script editor's base type color (used for types like :ref:`Vector2` **text_editor/theme/highlighting/bookmark_color** +:ref:`Color` **text_editor/theme/highlighting/bookmark_color** :ref:`🔗` The script editor's bookmark icon color (displayed in the gutter). @@ -4393,7 +4407,7 @@ The script editor's bookmark icon color (displayed in the gutter). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/brace_mismatch_color** +:ref:`Color` **text_editor/theme/highlighting/brace_mismatch_color** :ref:`🔗` The script editor's brace mismatch color. Used when the caret is currently on a mismatched brace, parenthesis or bracket character. @@ -4405,7 +4419,7 @@ The script editor's brace mismatch color. Used when the caret is currently on a .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/breakpoint_color** +:ref:`Color` **text_editor/theme/highlighting/breakpoint_color** :ref:`🔗` The script editor's breakpoint icon color (displayed in the gutter). @@ -4417,7 +4431,7 @@ The script editor's breakpoint icon color (displayed in the gutter). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/caret_background_color** +:ref:`Color` **text_editor/theme/highlighting/caret_background_color** :ref:`🔗` The script editor's caret background color. @@ -4431,7 +4445,7 @@ The script editor's caret background color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/caret_color** +:ref:`Color` **text_editor/theme/highlighting/caret_color** :ref:`🔗` The script editor's caret color. @@ -4443,7 +4457,7 @@ The script editor's caret color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/code_folding_color** +:ref:`Color` **text_editor/theme/highlighting/code_folding_color** :ref:`🔗` The script editor's color for the code folding icon (displayed in the gutter). @@ -4455,7 +4469,7 @@ The script editor's color for the code folding icon (displayed in the gutter). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/comment_color** +:ref:`Color` **text_editor/theme/highlighting/comment_color** :ref:`🔗` The script editor's comment color. @@ -4469,7 +4483,7 @@ The script editor's comment color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/completion_background_color** +:ref:`Color` **text_editor/theme/highlighting/completion_background_color** :ref:`🔗` The script editor's autocompletion box background color. @@ -4481,7 +4495,7 @@ The script editor's autocompletion box background color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/completion_existing_color** +:ref:`Color` **text_editor/theme/highlighting/completion_existing_color** :ref:`🔗` The script editor's autocompletion box background color to highlight existing characters in the completion results. This should be a translucent color so that :ref:`text_editor/theme/highlighting/completion_selected_color` can be seen behind. @@ -4493,7 +4507,7 @@ The script editor's autocompletion box background color to highlight existing ch .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/completion_font_color** +:ref:`Color` **text_editor/theme/highlighting/completion_font_color** :ref:`🔗` The script editor's autocompletion box text color. @@ -4505,7 +4519,7 @@ The script editor's autocompletion box text color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/completion_scroll_color** +:ref:`Color` **text_editor/theme/highlighting/completion_scroll_color** :ref:`🔗` The script editor's autocompletion box scroll bar color. @@ -4517,7 +4531,7 @@ The script editor's autocompletion box scroll bar color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/completion_scroll_hovered_color** +:ref:`Color` **text_editor/theme/highlighting/completion_scroll_hovered_color** :ref:`🔗` The script editor's autocompletion box scroll bar color when hovered or pressed with the mouse. @@ -4529,7 +4543,7 @@ The script editor's autocompletion box scroll bar color when hovered or pressed .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/completion_selected_color** +:ref:`Color` **text_editor/theme/highlighting/completion_selected_color** :ref:`🔗` The script editor's autocompletion box background color for the currently selected line. @@ -4541,7 +4555,7 @@ The script editor's autocompletion box background color for the currently select .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/control_flow_keyword_color** +:ref:`Color` **text_editor/theme/highlighting/control_flow_keyword_color** :ref:`🔗` The script editor's control flow keyword color (used for keywords like ``if``, ``for``, ``return``, ...). @@ -4553,7 +4567,7 @@ The script editor's control flow keyword color (used for keywords like ``if``, ` .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/current_line_color** +:ref:`Color` **text_editor/theme/highlighting/current_line_color** :ref:`🔗` The script editor's background color for the line the caret is currently on. This should be set to a translucent color so that it can display on top of other line color modifiers such as :ref:`text_editor/theme/highlighting/mark_color`. @@ -4565,7 +4579,7 @@ The script editor's background color for the line the caret is currently on. Thi .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/doc_comment_color** +:ref:`Color` **text_editor/theme/highlighting/doc_comment_color** :ref:`🔗` The script editor's documentation comment color. In GDScript, this is used for comments starting with ``##``. In C#, this is used for comments starting with ``///`` or ``/**``. @@ -4577,7 +4591,7 @@ The script editor's documentation comment color. In GDScript, this is used for c .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/engine_type_color** +:ref:`Color` **text_editor/theme/highlighting/engine_type_color** :ref:`🔗` The script editor's engine type color (:ref:`Vector2`, :ref:`Vector3`, :ref:`Color`, ...). @@ -4589,7 +4603,7 @@ The script editor's engine type color (:ref:`Vector2`, :ref:`Vect .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/executing_line_color** +:ref:`Color` **text_editor/theme/highlighting/executing_line_color** :ref:`🔗` The script editor's color for the debugger's executing line icon (displayed in the gutter). @@ -4601,7 +4615,7 @@ The script editor's color for the debugger's executing line icon (displayed in t .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/folded_code_region_color** +:ref:`Color` **text_editor/theme/highlighting/folded_code_region_color** :ref:`🔗` The script editor's background line highlighting color for folded code region. @@ -4613,7 +4627,7 @@ The script editor's background line highlighting color for folded code region. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/function_color** +:ref:`Color` **text_editor/theme/highlighting/function_color** :ref:`🔗` The script editor's function call color. @@ -4627,7 +4641,7 @@ The script editor's function call color. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/keyword_color** +:ref:`Color` **text_editor/theme/highlighting/keyword_color** :ref:`🔗` The script editor's non-control flow keyword color (used for keywords like ``var``, ``func``, ``extends``, ...). @@ -4639,7 +4653,7 @@ The script editor's non-control flow keyword color (used for keywords like ``var .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/line_length_guideline_color** +:ref:`Color` **text_editor/theme/highlighting/line_length_guideline_color** :ref:`🔗` The script editor's color for the line length guideline. The "hard" line length guideline will be drawn with this color, whereas the "soft" line length guideline will be drawn with half of its opacity. @@ -4651,7 +4665,7 @@ The script editor's color for the line length guideline. The "hard" line length .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/line_number_color** +:ref:`Color` **text_editor/theme/highlighting/line_number_color** :ref:`🔗` The script editor's color for line numbers. See also :ref:`text_editor/theme/highlighting/safe_line_number_color`. @@ -4663,7 +4677,7 @@ The script editor's color for line numbers. See also :ref:`text_editor/theme/hig .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/mark_color** +:ref:`Color` **text_editor/theme/highlighting/mark_color** :ref:`🔗` The script editor's background color for lines with errors. This should be set to a translucent color so that it can display on top of other line color modifiers such as :ref:`text_editor/theme/highlighting/current_line_color`. @@ -4675,7 +4689,7 @@ The script editor's background color for lines with errors. This should be set t .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/member_variable_color** +:ref:`Color` **text_editor/theme/highlighting/member_variable_color** :ref:`🔗` The script editor's color for member variables on objects (e.g. ``self.some_property``). @@ -4689,7 +4703,7 @@ The script editor's color for member variables on objects (e.g. ``self.some_prop .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/number_color** +:ref:`Color` **text_editor/theme/highlighting/number_color** :ref:`🔗` The script editor's color for numbers (integer and floating-point). @@ -4701,7 +4715,7 @@ The script editor's color for numbers (integer and floating-point). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/safe_line_number_color** +:ref:`Color` **text_editor/theme/highlighting/safe_line_number_color** :ref:`🔗` The script editor's color for type-safe line numbers. See also :ref:`text_editor/theme/highlighting/line_number_color`. @@ -4715,7 +4729,7 @@ The script editor's color for type-safe line numbers. See also :ref:`text_editor .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/search_result_border_color** +:ref:`Color` **text_editor/theme/highlighting/search_result_border_color** :ref:`🔗` The script editor's color for the border of search results. This border helps bring further attention to the search result. Set this color's opacity to 0 to disable the border. @@ -4727,7 +4741,7 @@ The script editor's color for the border of search results. This border helps br .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/search_result_color** +:ref:`Color` **text_editor/theme/highlighting/search_result_color** :ref:`🔗` The script editor's background color for search results. @@ -4739,7 +4753,7 @@ The script editor's background color for search results. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/selection_color** +:ref:`Color` **text_editor/theme/highlighting/selection_color** :ref:`🔗` The script editor's background color for the currently selected text. @@ -4751,7 +4765,7 @@ The script editor's background color for the currently selected text. .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/string_color** +:ref:`Color` **text_editor/theme/highlighting/string_color** :ref:`🔗` The script editor's color for strings (single-line and multi-line). @@ -4763,7 +4777,7 @@ The script editor's color for strings (single-line and multi-line). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/symbol_color** +:ref:`Color` **text_editor/theme/highlighting/symbol_color** :ref:`🔗` The script editor's color for operators (``( ) [ ] { } + - * /``, ...). @@ -4775,7 +4789,7 @@ The script editor's color for operators (``( ) [ ] { } + - * /``, ...). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/text_color** +:ref:`Color` **text_editor/theme/highlighting/text_color** :ref:`🔗` The script editor's color for text not highlighted by any syntax highlighting rule. @@ -4787,7 +4801,7 @@ The script editor's color for text not highlighted by any syntax highlighting ru .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/text_selected_color** +:ref:`Color` **text_editor/theme/highlighting/text_selected_color** :ref:`🔗` The script editor's background color for text. This should be set to a translucent color so that it can display on top of other line color modifiers such as :ref:`text_editor/theme/highlighting/current_line_color`. @@ -4799,7 +4813,7 @@ The script editor's background color for text. This should be set to a transluce .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/user_type_color** +:ref:`Color` **text_editor/theme/highlighting/user_type_color** :ref:`🔗` The script editor's color for user-defined types (using ``class_name``). @@ -4811,7 +4825,7 @@ The script editor's color for user-defined types (using ``class_name``). .. rst-class:: classref-property -:ref:`Color` **text_editor/theme/highlighting/word_highlighted_color** +:ref:`Color` **text_editor/theme/highlighting/word_highlighted_color** :ref:`🔗` The script editor's color for words highlighted by selecting them. Only visible if :ref:`text_editor/appearance/caret/highlight_all_occurrences` is ``true``. @@ -4828,7 +4842,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_property_info**\ (\ info\: :ref:`Dictionary`\ ) +|void| **add_property_info**\ (\ info\: :ref:`Dictionary`\ ) :ref:`🔗` Adds a custom property info to a property. The dictionary must contain: @@ -4882,7 +4896,7 @@ Adds a custom property info to a property. The dictionary must contain: .. rst-class:: classref-method -:ref:`bool` **check_changed_settings_in_group**\ (\ setting_prefix\: :ref:`String`\ ) |const| +:ref:`bool` **check_changed_settings_in_group**\ (\ setting_prefix\: :ref:`String`\ ) |const| :ref:`🔗` Checks if any settings with the prefix ``setting_prefix`` exist in the set of changed settings. See also :ref:`get_changed_settings`. @@ -4894,7 +4908,7 @@ Checks if any settings with the prefix ``setting_prefix`` exist in the set of ch .. rst-class:: classref-method -|void| **erase**\ (\ property\: :ref:`String`\ ) +|void| **erase**\ (\ property\: :ref:`String`\ ) :ref:`🔗` Erases the setting whose name is specified by ``property``. @@ -4906,7 +4920,7 @@ Erases the setting whose name is specified by ``property``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_changed_settings**\ (\ ) |const| +:ref:`PackedStringArray` **get_changed_settings**\ (\ ) |const| :ref:`🔗` Gets an array of the settings which have been changed since the last save. Note that internally ``changed_settings`` is cleared after a successful save, so generally the most appropriate place to use this method is when processing :ref:`NOTIFICATION_EDITOR_SETTINGS_CHANGED`. @@ -4918,7 +4932,7 @@ Gets an array of the settings which have been changed since the last save. Note .. rst-class:: classref-method -:ref:`PackedStringArray` **get_favorites**\ (\ ) |const| +:ref:`PackedStringArray` **get_favorites**\ (\ ) |const| :ref:`🔗` Returns the list of favorite files and directories for this project. @@ -4930,7 +4944,7 @@ Returns the list of favorite files and directories for this project. .. rst-class:: classref-method -:ref:`Variant` **get_project_metadata**\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| +:ref:`Variant` **get_project_metadata**\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Returns project-specific metadata for the ``section`` and ``key`` specified. If the metadata doesn't exist, ``default`` will be returned instead. See also :ref:`set_project_metadata`. @@ -4942,7 +4956,7 @@ Returns project-specific metadata for the ``section`` and ``key`` specified. If .. rst-class:: classref-method -:ref:`PackedStringArray` **get_recent_dirs**\ (\ ) |const| +:ref:`PackedStringArray` **get_recent_dirs**\ (\ ) |const| :ref:`🔗` Returns the list of recently visited folders in the file dialog for this project. @@ -4954,7 +4968,7 @@ Returns the list of recently visited folders in the file dialog for this project .. rst-class:: classref-method -:ref:`Variant` **get_setting**\ (\ name\: :ref:`String`\ ) |const| +:ref:`Variant` **get_setting**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the value of the setting specified by ``name``. This is equivalent to using :ref:`Object.get` on the EditorSettings instance. @@ -4966,7 +4980,7 @@ Returns the value of the setting specified by ``name``. This is equivalent to us .. rst-class:: classref-method -:ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| +:ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the setting specified by ``name`` exists, ``false`` otherwise. @@ -4978,7 +4992,7 @@ Returns ``true`` if the setting specified by ``name`` exists, ``false`` otherwis .. rst-class:: classref-method -|void| **mark_setting_changed**\ (\ setting\: :ref:`String`\ ) +|void| **mark_setting_changed**\ (\ setting\: :ref:`String`\ ) :ref:`🔗` Marks the passed editor setting as being changed, see :ref:`get_changed_settings`. Only settings which exist (see :ref:`has_setting`) will be accepted. @@ -4990,7 +5004,7 @@ Marks the passed editor setting as being changed, see :ref:`get_changed_settings .. rst-class:: classref-method -|void| **set_builtin_action_override**\ (\ name\: :ref:`String`, actions_list\: :ref:`Array`\[:ref:`InputEvent`\]\ ) +|void| **set_builtin_action_override**\ (\ name\: :ref:`String`, actions_list\: :ref:`Array`\[:ref:`InputEvent`\]\ ) :ref:`🔗` Overrides the built-in editor action ``name`` with the input actions defined in ``actions_list``. @@ -5002,7 +5016,7 @@ Overrides the built-in editor action ``name`` with the input actions defined in .. rst-class:: classref-method -|void| **set_favorites**\ (\ dirs\: :ref:`PackedStringArray`\ ) +|void| **set_favorites**\ (\ dirs\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the list of favorite files and directories for this project. @@ -5014,7 +5028,7 @@ Sets the list of favorite files and directories for this project. .. rst-class:: classref-method -|void| **set_initial_value**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`, update_current\: :ref:`bool`\ ) +|void| **set_initial_value**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`, update_current\: :ref:`bool`\ ) :ref:`🔗` Sets the initial value of the setting specified by ``name`` to ``value``. This is used to provide a value for the Revert button in the Editor Settings. If ``update_current`` is true, the current value of the setting will be set to ``value`` as well. @@ -5026,7 +5040,7 @@ Sets the initial value of the setting specified by ``name`` to ``value``. This i .. rst-class:: classref-method -|void| **set_project_metadata**\ (\ section\: :ref:`String`, key\: :ref:`String`, data\: :ref:`Variant`\ ) +|void| **set_project_metadata**\ (\ section\: :ref:`String`, key\: :ref:`String`, data\: :ref:`Variant`\ ) :ref:`🔗` Sets project-specific metadata with the ``section``, ``key`` and ``data`` specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also :ref:`get_project_metadata`. @@ -5038,7 +5052,7 @@ Sets project-specific metadata with the ``section``, ``key`` and ``data`` specif .. rst-class:: classref-method -|void| **set_recent_dirs**\ (\ dirs\: :ref:`PackedStringArray`\ ) +|void| **set_recent_dirs**\ (\ dirs\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the list of recently visited folders in the file dialog for this project. @@ -5050,7 +5064,7 @@ Sets the list of recently visited folders in the file dialog for this project. .. rst-class:: classref-method -|void| **set_setting**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_setting**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the ``value`` of the setting specified by ``name``. This is equivalent to using :ref:`Object.set` on the EditorSettings instance. diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index cf26e883cff..1906c45136a 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -62,7 +62,7 @@ Signals .. rst-class:: classref-signal -**grabbed**\ (\ ) +**grabbed**\ (\ ) :ref:`🔗` Emitted when the spinner/slider is grabbed. @@ -74,7 +74,7 @@ Emitted when the spinner/slider is grabbed. .. rst-class:: classref-signal -**ungrabbed**\ (\ ) +**ungrabbed**\ (\ ) :ref:`🔗` Emitted when the spinner/slider is ungrabbed. @@ -86,7 +86,7 @@ Emitted when the spinner/slider is ungrabbed. .. rst-class:: classref-signal -**value_focus_entered**\ (\ ) +**value_focus_entered**\ (\ ) :ref:`🔗` Emitted when the value form gains focus. @@ -98,7 +98,7 @@ Emitted when the value form gains focus. .. rst-class:: classref-signal -**value_focus_exited**\ (\ ) +**value_focus_exited**\ (\ ) :ref:`🔗` Emitted when the value form loses focus. @@ -115,7 +115,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **flat** = ``false`` +:ref:`bool` **flat** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ If ``true``, the slider will not draw background. .. rst-class:: classref-property -:ref:`bool` **hide_slider** = ``false`` +:ref:`bool` **hide_slider** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ If ``true``, the slider and up/down arrows are hidden. .. rst-class:: classref-property -:ref:`String` **label** = ``""`` +:ref:`String` **label** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ The text that displays to the left of the value. .. rst-class:: classref-property -:ref:`bool` **read_only** = ``false`` +:ref:`bool` **read_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ If ``true``, the slider can't be interacted with. .. rst-class:: classref-property -:ref:`String` **suffix** = ``""`` +:ref:`String` **suffix** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_editorsyntaxhighlighter.rst b/classes/class_editorsyntaxhighlighter.rst index eb22b01838e..27f6bc9de21 100644 --- a/classes/class_editorsyntaxhighlighter.rst +++ b/classes/class_editorsyntaxhighlighter.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method which can be overridden to return the syntax highlighter name. @@ -62,7 +62,7 @@ Virtual method which can be overridden to return the syntax highlighter name. .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_supported_languages**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_supported_languages**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method which can be overridden to return the supported language names. diff --git a/classes/class_editortranslationparserplugin.rst b/classes/class_editortranslationparserplugin.rst index 6c19cd8a0f2..fedd304399e 100644 --- a/classes/class_editortranslationparserplugin.rst +++ b/classes/class_editortranslationparserplugin.rst @@ -162,7 +162,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| :ref:`🔗` Gets the list of file extensions to associate with this parser, e.g. ``["csv"]``. @@ -174,7 +174,7 @@ Gets the list of file extensions to associate with this parser, e.g. ``["csv"]`` .. rst-class:: classref-method -|void| **_parse_file**\ (\ path\: :ref:`String`, msgids\: :ref:`Array`\[:ref:`String`\], msgids_context_plural\: :ref:`Array`\[:ref:`Array`\]\ ) |virtual| +|void| **_parse_file**\ (\ path\: :ref:`String`, msgids\: :ref:`Array`\[:ref:`String`\], msgids_context_plural\: :ref:`Array`\[:ref:`Array`\]\ ) |virtual| :ref:`🔗` Override this method to define a custom parsing logic to extract the translatable strings. diff --git a/classes/class_editorundoredomanager.rst b/classes/class_editorundoredomanager.rst index d4da5840926..a45eb3e1398 100644 --- a/classes/class_editorundoredomanager.rst +++ b/classes/class_editorundoredomanager.rst @@ -80,7 +80,7 @@ Signals .. rst-class:: classref-signal -**history_changed**\ (\ ) +**history_changed**\ (\ ) :ref:`🔗` Emitted when the list of actions in any history has changed, either when an action is committed or a history is cleared. @@ -92,7 +92,7 @@ Emitted when the list of actions in any history has changed, either when an acti .. rst-class:: classref-signal -**version_changed**\ (\ ) +**version_changed**\ (\ ) :ref:`🔗` Emitted when the version of any history has changed as a result of undo or redo call. @@ -109,7 +109,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SpecialHistory**: +enum **SpecialHistory**: :ref:`🔗` .. _class_EditorUndoRedoManager_constant_GLOBAL_HISTORY: @@ -148,7 +148,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_do_method**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| +|void| **add_do_method**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Register a method that will be called when the action is committed (i.e. the "do" action). @@ -162,7 +162,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -|void| **add_do_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **add_do_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Register a property value change for "do". @@ -176,7 +176,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -|void| **add_do_reference**\ (\ object\: :ref:`Object`\ ) +|void| **add_do_reference**\ (\ object\: :ref:`Object`\ ) :ref:`🔗` Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. @@ -188,7 +188,7 @@ Register a reference for "do" that will be erased if the "do" history is lost. T .. rst-class:: classref-method -|void| **add_undo_method**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| +|void| **add_undo_method**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Register a method that will be called when the action is undone (i.e. the "undo" action). @@ -202,7 +202,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -|void| **add_undo_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **add_undo_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Register a property value change for "undo". @@ -216,7 +216,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -|void| **add_undo_reference**\ (\ object\: :ref:`Object`\ ) +|void| **add_undo_reference**\ (\ object\: :ref:`Object`\ ) :ref:`🔗` Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). @@ -228,7 +228,7 @@ Register a reference for "undo" that will be erased if the "undo" history is los .. rst-class:: classref-method -|void| **commit_action**\ (\ execute\: :ref:`bool` = true\ ) +|void| **commit_action**\ (\ execute\: :ref:`bool` = true\ ) :ref:`🔗` Commit the action. If ``execute`` is true (default), all "do" methods/properties are called/set when this function is called. @@ -240,7 +240,7 @@ Commit the action. If ``execute`` is true (default), all "do" methods/properties .. rst-class:: classref-method -|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false\ ) +|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false\ ) :ref:`🔗` Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. @@ -258,7 +258,7 @@ The way undo operation are ordered in actions is dictated by ``backward_undo_ops .. rst-class:: classref-method -:ref:`UndoRedo` **get_history_undo_redo**\ (\ id\: :ref:`int`\ ) |const| +:ref:`UndoRedo` **get_history_undo_redo**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`UndoRedo` object associated with the given history ``id``. @@ -274,7 +274,7 @@ Best used with :ref:`get_object_history_id` **get_object_history_id**\ (\ object\: :ref:`Object`\ ) |const| +:ref:`int` **get_object_history_id**\ (\ object\: :ref:`Object`\ ) |const| :ref:`🔗` Returns the history ID deduced from the given ``object``. It can be used with :ref:`get_history_undo_redo`. @@ -286,7 +286,7 @@ Returns the history ID deduced from the given ``object``. It can be used with :r .. rst-class:: classref-method -:ref:`bool` **is_committing_action**\ (\ ) |const| +:ref:`bool` **is_committing_action**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the **EditorUndoRedoManager** is currently committing the action, i.e. running its "do" method or property change (see :ref:`commit_action`). diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index ab1eaaeb93f..d8899886f1d 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -113,7 +113,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ChangeType**: +enum **ChangeType**: :ref:`🔗` .. _class_EditorVCSInterface_constant_CHANGE_TYPE_NEW: @@ -171,7 +171,7 @@ A file is left unmerged. .. rst-class:: classref-enumeration -enum **TreeArea**: +enum **TreeArea**: :ref:`🔗` .. _class_EditorVCSInterface_constant_TREE_AREA_COMMIT: @@ -210,7 +210,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_checkout_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| +:ref:`bool` **_checkout_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| :ref:`🔗` Checks out a ``branch_name`` in the VCS. @@ -222,7 +222,7 @@ Checks out a ``branch_name`` in the VCS. .. rst-class:: classref-method -|void| **_commit**\ (\ msg\: :ref:`String`\ ) |virtual| +|void| **_commit**\ (\ msg\: :ref:`String`\ ) |virtual| :ref:`🔗` Commits the currently staged changes and applies the commit ``msg`` to the resulting commit. @@ -234,7 +234,7 @@ Commits the currently staged changes and applies the commit ``msg`` to the resul .. rst-class:: classref-method -|void| **_create_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| +|void| **_create_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| :ref:`🔗` Creates a new branch named ``branch_name`` in the VCS. @@ -246,7 +246,7 @@ Creates a new branch named ``branch_name`` in the VCS. .. rst-class:: classref-method -|void| **_create_remote**\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| +|void| **_create_remote**\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| :ref:`🔗` Creates a new remote destination with name ``remote_name`` and points it to ``remote_url``. This can be an HTTPS remote or an SSH remote. @@ -258,7 +258,7 @@ Creates a new remote destination with name ``remote_name`` and points it to ``re .. rst-class:: classref-method -|void| **_discard_file**\ (\ file_path\: :ref:`String`\ ) |virtual| +|void| **_discard_file**\ (\ file_path\: :ref:`String`\ ) |virtual| :ref:`🔗` Discards the changes made in a file present at ``file_path``. @@ -270,7 +270,7 @@ Discards the changes made in a file present at ``file_path``. .. rst-class:: classref-method -|void| **_fetch**\ (\ remote\: :ref:`String`\ ) |virtual| +|void| **_fetch**\ (\ remote\: :ref:`String`\ ) |virtual| :ref:`🔗` Fetches new changes from the ``remote``, but doesn't write changes to the current working directory. Equivalent to ``git fetch``. @@ -282,7 +282,7 @@ Fetches new changes from the ``remote``, but doesn't write changes to the curren .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **_get_branch_list**\ (\ ) |virtual| +:ref:`Array`\[:ref:`String`\] **_get_branch_list**\ (\ ) |virtual| :ref:`🔗` Gets an instance of an :ref:`Array` of :ref:`String`\ s containing available branch names in the VCS. @@ -294,7 +294,7 @@ Gets an instance of an :ref:`Array` of :ref:`String`\ .. rst-class:: classref-method -:ref:`String` **_get_current_branch_name**\ (\ ) |virtual| +:ref:`String` **_get_current_branch_name**\ (\ ) |virtual| :ref:`🔗` Gets the current branch name defined in the VCS. @@ -306,7 +306,7 @@ Gets the current branch name defined in the VCS. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_diff**\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_diff**\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| :ref:`🔗` Returns an array of :ref:`Dictionary` items (see :ref:`create_diff_file`, :ref:`create_diff_hunk`, :ref:`create_diff_line`, :ref:`add_line_diffs_into_diff_hunk` and :ref:`add_diff_hunks_into_diff_file`), each containing information about a diff. If ``identifier`` is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff. @@ -318,7 +318,7 @@ Returns an array of :ref:`Dictionary` items (see :ref:`create_ .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_line_diff**\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_line_diff**\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| :ref:`🔗` Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_diff_hunk`), each containing a line diff between a file at ``file_path`` and the ``text`` which is passed in. @@ -330,7 +330,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_modified_files_data**\ (\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_modified_files_data**\ (\ ) |virtual| :ref:`🔗` Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_status_file`), each containing the status data of every modified file in the project folder. @@ -342,7 +342,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_previous_commits**\ (\ max_commits\: :ref:`int`\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_previous_commits**\ (\ max_commits\: :ref:`int`\ ) |virtual| :ref:`🔗` Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_commit`), each containing the data for a past commit. @@ -354,7 +354,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **_get_remotes**\ (\ ) |virtual| +:ref:`Array`\[:ref:`String`\] **_get_remotes**\ (\ ) |virtual| :ref:`🔗` Returns an :ref:`Array` of :ref:`String`\ s, each containing the name of a remote configured in the VCS. @@ -366,7 +366,7 @@ Returns an :ref:`Array` of :ref:`String`\ s, each con .. rst-class:: classref-method -:ref:`String` **_get_vcs_name**\ (\ ) |virtual| +:ref:`String` **_get_vcs_name**\ (\ ) |virtual| :ref:`🔗` Returns the name of the underlying VCS provider. @@ -378,7 +378,7 @@ Returns the name of the underlying VCS provider. .. rst-class:: classref-method -:ref:`bool` **_initialize**\ (\ project_path\: :ref:`String`\ ) |virtual| +:ref:`bool` **_initialize**\ (\ project_path\: :ref:`String`\ ) |virtual| :ref:`🔗` Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at ``project_path``. @@ -390,7 +390,7 @@ Initializes the VCS plugin when called from the editor. Returns whether or not t .. rst-class:: classref-method -|void| **_pull**\ (\ remote\: :ref:`String`\ ) |virtual| +|void| **_pull**\ (\ remote\: :ref:`String`\ ) |virtual| :ref:`🔗` Pulls changes from the remote. This can give rise to merge conflicts. @@ -402,7 +402,7 @@ Pulls changes from the remote. This can give rise to merge conflicts. .. rst-class:: classref-method -|void| **_push**\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| +|void| **_push**\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| :ref:`🔗` Pushes changes to the ``remote``. If ``force`` is ``true``, a force push will override the change history already present on the remote. @@ -414,7 +414,7 @@ Pushes changes to the ``remote``. If ``force`` is ``true``, a force push will ov .. rst-class:: classref-method -|void| **_remove_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| +|void| **_remove_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| :ref:`🔗` Remove a branch from the local VCS. @@ -426,7 +426,7 @@ Remove a branch from the local VCS. .. rst-class:: classref-method -|void| **_remove_remote**\ (\ remote_name\: :ref:`String`\ ) |virtual| +|void| **_remove_remote**\ (\ remote_name\: :ref:`String`\ ) |virtual| :ref:`🔗` Remove a remote from the local VCS. @@ -438,7 +438,7 @@ Remove a remote from the local VCS. .. rst-class:: classref-method -|void| **_set_credentials**\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| +|void| **_set_credentials**\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| :ref:`🔗` Set user credentials in the underlying VCS. ``username`` and ``password`` are used only during HTTPS authentication unless not already mentioned in the remote URL. ``ssh_public_key_path``, ``ssh_private_key_path``, and ``ssh_passphrase`` are only used during SSH authentication. @@ -450,7 +450,7 @@ Set user credentials in the underlying VCS. ``username`` and ``password`` are us .. rst-class:: classref-method -:ref:`bool` **_shut_down**\ (\ ) |virtual| +:ref:`bool` **_shut_down**\ (\ ) |virtual| :ref:`🔗` Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI. @@ -462,7 +462,7 @@ Shuts down VCS plugin instance. Called when the user either closes the editor or .. rst-class:: classref-method -|void| **_stage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| +|void| **_stage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| :ref:`🔗` Stages the file present at ``file_path`` to the staged area. @@ -474,7 +474,7 @@ Stages the file present at ``file_path`` to the staged area. .. rst-class:: classref-method -|void| **_unstage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| +|void| **_unstage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| :ref:`🔗` Unstages the file present at ``file_path`` from the staged area to the unstaged area. @@ -486,7 +486,7 @@ Unstages the file present at ``file_path`` from the staged area to the unstaged .. rst-class:: classref-method -:ref:`Dictionary` **add_diff_hunks_into_diff_file**\ (\ diff_file\: :ref:`Dictionary`, diff_hunks\: :ref:`Array`\[:ref:`Dictionary`\]\ ) +:ref:`Dictionary` **add_diff_hunks_into_diff_file**\ (\ diff_file\: :ref:`Dictionary`, diff_hunks\: :ref:`Array`\[:ref:`Dictionary`\]\ ) :ref:`🔗` Helper function to add an array of ``diff_hunks`` into a ``diff_file``. @@ -498,7 +498,7 @@ Helper function to add an array of ``diff_hunks`` into a ``diff_file``. .. rst-class:: classref-method -:ref:`Dictionary` **add_line_diffs_into_diff_hunk**\ (\ diff_hunk\: :ref:`Dictionary`, line_diffs\: :ref:`Array`\[:ref:`Dictionary`\]\ ) +:ref:`Dictionary` **add_line_diffs_into_diff_hunk**\ (\ diff_hunk\: :ref:`Dictionary`, line_diffs\: :ref:`Array`\[:ref:`Dictionary`\]\ ) :ref:`🔗` Helper function to add an array of ``line_diffs`` into a ``diff_hunk``. @@ -510,7 +510,7 @@ Helper function to add an array of ``line_diffs`` into a ``diff_hunk``. .. rst-class:: classref-method -:ref:`Dictionary` **create_commit**\ (\ msg\: :ref:`String`, author\: :ref:`String`, id\: :ref:`String`, unix_timestamp\: :ref:`int`, offset_minutes\: :ref:`int`\ ) +:ref:`Dictionary` **create_commit**\ (\ msg\: :ref:`String`, author\: :ref:`String`, id\: :ref:`String`, unix_timestamp\: :ref:`int`, offset_minutes\: :ref:`int`\ ) :ref:`🔗` Helper function to create a commit :ref:`Dictionary` item. ``msg`` is the commit message of the commit. ``author`` is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. ``id`` is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. ``unix_timestamp`` is the UTC Unix timestamp of when the commit was created. ``offset_minutes`` is the timezone offset in minutes, recorded from the system timezone where the commit was created. @@ -522,7 +522,7 @@ Helper function to create a commit :ref:`Dictionary` item. ``m .. rst-class:: classref-method -:ref:`Dictionary` **create_diff_file**\ (\ new_file\: :ref:`String`, old_file\: :ref:`String`\ ) +:ref:`Dictionary` **create_diff_file**\ (\ new_file\: :ref:`String`, old_file\: :ref:`String`\ ) :ref:`🔗` Helper function to create a :ref:`Dictionary` for storing old and new diff file paths. @@ -534,7 +534,7 @@ Helper function to create a :ref:`Dictionary` for storing old .. rst-class:: classref-method -:ref:`Dictionary` **create_diff_hunk**\ (\ old_start\: :ref:`int`, new_start\: :ref:`int`, old_lines\: :ref:`int`, new_lines\: :ref:`int`\ ) +:ref:`Dictionary` **create_diff_hunk**\ (\ old_start\: :ref:`int`, new_start\: :ref:`int`, old_lines\: :ref:`int`, new_lines\: :ref:`int`\ ) :ref:`🔗` Helper function to create a :ref:`Dictionary` for storing diff hunk data. ``old_start`` is the starting line number in old file. ``new_start`` is the starting line number in new file. ``old_lines`` is the number of lines in the old file. ``new_lines`` is the number of lines in the new file. @@ -546,7 +546,7 @@ Helper function to create a :ref:`Dictionary` for storing diff .. rst-class:: classref-method -:ref:`Dictionary` **create_diff_line**\ (\ new_line_no\: :ref:`int`, old_line_no\: :ref:`int`, content\: :ref:`String`, status\: :ref:`String`\ ) +:ref:`Dictionary` **create_diff_line**\ (\ new_line_no\: :ref:`int`, old_line_no\: :ref:`int`, content\: :ref:`String`, status\: :ref:`String`\ ) :ref:`🔗` Helper function to create a :ref:`Dictionary` for storing a line diff. ``new_line_no`` is the line number in the new file (can be ``-1`` if the line is deleted). ``old_line_no`` is the line number in the old file (can be ``-1`` if the line is added). ``content`` is the diff text. ``status`` is a single character string which stores the line origin. @@ -558,7 +558,7 @@ Helper function to create a :ref:`Dictionary` for storing a li .. rst-class:: classref-method -:ref:`Dictionary` **create_status_file**\ (\ file_path\: :ref:`String`, change_type\: :ref:`ChangeType`, area\: :ref:`TreeArea`\ ) +:ref:`Dictionary` **create_status_file**\ (\ file_path\: :ref:`String`, change_type\: :ref:`ChangeType`, area\: :ref:`TreeArea`\ ) :ref:`🔗` Helper function to create a :ref:`Dictionary` used by editor to read the status of a file. @@ -570,7 +570,7 @@ Helper function to create a :ref:`Dictionary` used by editor t .. rst-class:: classref-method -|void| **popup_error**\ (\ msg\: :ref:`String`\ ) +|void| **popup_error**\ (\ msg\: :ref:`String`\ ) :ref:`🔗` Pops up an error message in the editor which is shown as coming from the underlying VCS. Use this to show VCS specific error messages. diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index bf4872b2506..86656540eeb 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **object_id** = ``0`` +:ref:`int` **object_id** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_enetconnection.rst b/classes/class_enetconnection.rst index 1e39c3fc6b3..2186fa03f24 100644 --- a/classes/class_enetconnection.rst +++ b/classes/class_enetconnection.rst @@ -87,7 +87,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CompressionMode**: +enum **CompressionMode**: :ref:`🔗` .. _class_ENetConnection_constant_COMPRESS_NONE: @@ -137,7 +137,7 @@ ENet's built-in range encoding. Works well on small packets, but is not the most .. rst-class:: classref-enumeration -enum **EventType**: +enum **EventType**: :ref:`🔗` .. _class_ENetConnection_constant_EVENT_ERROR: @@ -187,7 +187,7 @@ A packet has been received from a peer. The array will contain the peer which se .. rst-class:: classref-enumeration -enum **HostStatistic**: +enum **HostStatistic**: :ref:`🔗` .. _class_ENetConnection_constant_HOST_TOTAL_SENT_DATA: @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **bandwidth_limit**\ (\ in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) +|void| **bandwidth_limit**\ (\ in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) :ref:`🔗` Adjusts the bandwidth limits of a host. @@ -246,7 +246,7 @@ Adjusts the bandwidth limits of a host. .. rst-class:: classref-method -|void| **broadcast**\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) +|void| **broadcast**\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) :ref:`🔗` Queues a ``packet`` to be sent to all peers associated with the host over the specified ``channel``. See :ref:`ENetPacketPeer` ``FLAG_*`` constants for available packet flags. @@ -258,7 +258,7 @@ Queues a ``packet`` to be sent to all peers associated with the host over the sp .. rst-class:: classref-method -|void| **channel_limit**\ (\ limit\: :ref:`int`\ ) +|void| **channel_limit**\ (\ limit\: :ref:`int`\ ) :ref:`🔗` Limits the maximum allowed channels of future incoming connections. @@ -270,7 +270,7 @@ Limits the maximum allowed channels of future incoming connections. .. rst-class:: classref-method -|void| **compress**\ (\ mode\: :ref:`CompressionMode`\ ) +|void| **compress**\ (\ mode\: :ref:`CompressionMode`\ ) :ref:`🔗` Sets the compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. @@ -286,7 +286,7 @@ Sets the compression method used for network packets. These have different trade .. rst-class:: classref-method -:ref:`ENetPacketPeer` **connect_to_host**\ (\ address\: :ref:`String`, port\: :ref:`int`, channels\: :ref:`int` = 0, data\: :ref:`int` = 0\ ) +:ref:`ENetPacketPeer` **connect_to_host**\ (\ address\: :ref:`String`, port\: :ref:`int`, channels\: :ref:`int` = 0, data\: :ref:`int` = 0\ ) :ref:`🔗` Initiates a connection to a foreign ``address`` using the specified ``port`` and allocating the requested ``channels``. Optional ``data`` can be passed during connection in the form of a 32 bit integer. @@ -300,7 +300,7 @@ Initiates a connection to a foreign ``address`` using the specified ``port`` and .. rst-class:: classref-method -:ref:`Error` **create_host**\ (\ max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) +:ref:`Error` **create_host**\ (\ max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) :ref:`🔗` Create an ENetHost that will allow up to ``max_peers`` connected peers, each allocating up to ``max_channels`` channels, optionally limiting bandwidth to ``in_bandwidth`` and ``out_bandwidth``. @@ -312,7 +312,7 @@ Create an ENetHost that will allow up to ``max_peers`` connected peers, each all .. rst-class:: classref-method -:ref:`Error` **create_host_bound**\ (\ bind_address\: :ref:`String`, bind_port\: :ref:`int`, max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) +:ref:`Error` **create_host_bound**\ (\ bind_address\: :ref:`String`, bind_port\: :ref:`int`, max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) :ref:`🔗` Create an ENetHost like :ref:`create_host` which is also bound to the given ``bind_address`` and ``bind_port``. @@ -324,7 +324,7 @@ Create an ENetHost like :ref:`create_host` Destroys the host and all resources associated with it. @@ -336,7 +336,7 @@ Destroys the host and all resources associated with it. .. rst-class:: classref-method -:ref:`Error` **dtls_client_setup**\ (\ hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **dtls_client_setup**\ (\ hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet clients. Call this before :ref:`connect_to_host` to have ENet connect using DTLS validating the server certificate against ``hostname``. You can pass the optional ``client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -348,7 +348,7 @@ Configure this ENetHost to use the custom Godot extension allowing DTLS encrypti .. rst-class:: classref-method -:ref:`Error` **dtls_server_setup**\ (\ server_options\: :ref:`TLSOptions`\ ) +:ref:`Error` **dtls_server_setup**\ (\ server_options\: :ref:`TLSOptions`\ ) :ref:`🔗` Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet servers. Call this right after :ref:`create_host_bound` to have ENet expect peers to connect using DTLS. See :ref:`TLSOptions.server`. @@ -360,7 +360,7 @@ Configure this ENetHost to use the custom Godot extension allowing DTLS encrypti .. rst-class:: classref-method -|void| **flush**\ (\ ) +|void| **flush**\ (\ ) :ref:`🔗` Sends any queued packets on the host specified to its designated peers. @@ -372,7 +372,7 @@ Sends any queued packets on the host specified to its designated peers. .. rst-class:: classref-method -:ref:`int` **get_local_port**\ (\ ) |const| +:ref:`int` **get_local_port**\ (\ ) |const| :ref:`🔗` Returns the local port to which this peer is bound. @@ -384,7 +384,7 @@ Returns the local port to which this peer is bound. .. rst-class:: classref-method -:ref:`int` **get_max_channels**\ (\ ) |const| +:ref:`int` **get_max_channels**\ (\ ) |const| :ref:`🔗` Returns the maximum number of channels allowed for connected peers. @@ -396,7 +396,7 @@ Returns the maximum number of channels allowed for connected peers. .. rst-class:: classref-method -:ref:`Array`\[:ref:`ENetPacketPeer`\] **get_peers**\ (\ ) +:ref:`Array`\[:ref:`ENetPacketPeer`\] **get_peers**\ (\ ) :ref:`🔗` Returns the list of peers associated with this host. @@ -410,7 +410,7 @@ Returns the list of peers associated with this host. .. rst-class:: classref-method -:ref:`float` **pop_statistic**\ (\ statistic\: :ref:`HostStatistic`\ ) +:ref:`float` **pop_statistic**\ (\ statistic\: :ref:`HostStatistic`\ ) :ref:`🔗` Returns and resets host statistics. See :ref:`HostStatistic` for more info. @@ -422,7 +422,7 @@ Returns and resets host statistics. See :ref:`HostStatistic`\ ) +|void| **refuse_new_connections**\ (\ refuse\: :ref:`bool`\ ) :ref:`🔗` Configures the DTLS server to automatically drop new connections. @@ -436,7 +436,7 @@ Configures the DTLS server to automatically drop new connections. .. rst-class:: classref-method -:ref:`Array` **service**\ (\ timeout\: :ref:`int` = 0\ ) +:ref:`Array` **service**\ (\ timeout\: :ref:`int` = 0\ ) :ref:`🔗` Waits for events on the host specified and shuttles packets between the host and its peers. The returned :ref:`Array` will have 4 elements. An :ref:`EventType`, the :ref:`ENetPacketPeer` which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is :ref:`EVENT_RECEIVE`, the received packet will be queued to the associated :ref:`ENetPacketPeer`. @@ -450,7 +450,7 @@ Call this function regularly to handle connections, disconnections, and to recei .. rst-class:: classref-method -|void| **socket_send**\ (\ destination_address\: :ref:`String`, destination_port\: :ref:`int`, packet\: :ref:`PackedByteArray`\ ) +|void| **socket_send**\ (\ destination_address\: :ref:`String`, destination_port\: :ref:`int`, packet\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sends a ``packet`` toward a destination from the address and port currently bound by this ENetConnection instance. diff --git a/classes/class_enetmultiplayerpeer.rst b/classes/class_enetmultiplayerpeer.rst index 2c539c06a16..7123249a6c6 100644 --- a/classes/class_enetmultiplayerpeer.rst +++ b/classes/class_enetmultiplayerpeer.rst @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ENetConnection` **host** +:ref:`ENetConnection` **host** :ref:`🔗` .. rst-class:: classref-property-setget @@ -100,7 +100,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_mesh_peer**\ (\ peer_id\: :ref:`int`, host\: :ref:`ENetConnection`\ ) +:ref:`Error` **add_mesh_peer**\ (\ peer_id\: :ref:`int`, host\: :ref:`ENetConnection`\ ) :ref:`🔗` Add a new remote peer with the given ``peer_id`` connected to the given ``host``. @@ -114,7 +114,7 @@ Add a new remote peer with the given ``peer_id`` connected to the given ``host`` .. rst-class:: classref-method -:ref:`Error` **create_client**\ (\ address\: :ref:`String`, port\: :ref:`int`, channel_count\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0, local_port\: :ref:`int` = 0\ ) +:ref:`Error` **create_client**\ (\ address\: :ref:`String`, port\: :ref:`int`, channel_count\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0, local_port\: :ref:`int` = 0\ ) :ref:`🔗` Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain name (e.g. ``"www.example.com"``) or an IP address in IPv4 or IPv6 format (e.g. ``"192.168.1.1"``). The ``port`` is the port the server is listening on. The ``channel_count`` parameter can be used to specify the number of ENet channels allocated for the connection. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns :ref:`@GlobalScope.OK` if a client was created, :ref:`@GlobalScope.ERR_ALREADY_IN_USE` if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call :ref:`MultiplayerPeer.close` first) or :ref:`@GlobalScope.ERR_CANT_CREATE` if the client could not be created. If ``local_port`` is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques. @@ -126,7 +126,7 @@ Create client that connects to a server at ``address`` using specified ``port``. .. rst-class:: classref-method -:ref:`Error` **create_mesh**\ (\ unique_id\: :ref:`int`\ ) +:ref:`Error` **create_mesh**\ (\ unique_id\: :ref:`int`\ ) :ref:`🔗` Initialize this :ref:`MultiplayerPeer` in mesh mode. The provided ``unique_id`` will be used as the local peer network unique ID once assigned as the :ref:`MultiplayerAPI.multiplayer_peer`. In the mesh configuration you will need to set up each new peer manually using :ref:`ENetConnection` before calling :ref:`add_mesh_peer`. While this technique is more advanced, it allows for better control over the connection process (e.g. when dealing with NAT punch-through) and for better distribution of the network load (which would otherwise be more taxing on the server). @@ -138,7 +138,7 @@ Initialize this :ref:`MultiplayerPeer` in mesh mode. The .. rst-class:: classref-method -:ref:`Error` **create_server**\ (\ port\: :ref:`int`, max_clients\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) +:ref:`Error` **create_server**\ (\ port\: :ref:`int`, max_clients\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) :ref:`🔗` Create server that listens to connections via ``port``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip`. The default IP is the wildcard ``"*"``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client`. Returns :ref:`@GlobalScope.OK` if a server was created, :ref:`@GlobalScope.ERR_ALREADY_IN_USE` if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call :ref:`MultiplayerPeer.close` first) or :ref:`@GlobalScope.ERR_CANT_CREATE` if the server could not be created. @@ -150,7 +150,7 @@ Create server that listens to connections via ``port``. The port needs to be an .. rst-class:: classref-method -:ref:`ENetPacketPeer` **get_peer**\ (\ id\: :ref:`int`\ ) |const| +:ref:`ENetPacketPeer` **get_peer**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`ENetPacketPeer` associated to the given ``id``. @@ -162,7 +162,7 @@ Returns the :ref:`ENetPacketPeer` associated to the given .. rst-class:: classref-method -|void| **set_bind_ip**\ (\ ip\: :ref:`String`\ ) +|void| **set_bind_ip**\ (\ ip\: :ref:`String`\ ) :ref:`🔗` The IP used when creating a server. This is set to the wildcard ``"*"`` by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: ``"192.168.1.1"``. diff --git a/classes/class_enetpacketpeer.rst b/classes/class_enetpacketpeer.rst index d07b79c2f92..c0d0a0d3a63 100644 --- a/classes/class_enetpacketpeer.rst +++ b/classes/class_enetpacketpeer.rst @@ -85,7 +85,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PeerState**: +enum **PeerState**: :ref:`🔗` .. _class_ENetPacketPeer_constant_STATE_DISCONNECTED: @@ -175,7 +175,7 @@ The peer has lost connection, but is not considered truly disconnected (as the p .. rst-class:: classref-enumeration -enum **PeerStatistic**: +enum **PeerStatistic**: :ref:`🔗` .. _class_ENetPacketPeer_constant_PEER_PACKET_LOSS: @@ -302,7 +302,7 @@ Constants .. rst-class:: classref-constant -**PACKET_LOSS_SCALE** = ``65536`` +**PACKET_LOSS_SCALE** = ``65536`` :ref:`🔗` The reference scale for packet loss. See :ref:`get_statistic` and :ref:`PEER_PACKET_LOSS`. @@ -310,7 +310,7 @@ The reference scale for packet loss. See :ref:`get_statistic` The reference value for throttle configuration. The default value is ``32``. See :ref:`throttle_configure`. @@ -318,7 +318,7 @@ The reference value for throttle configuration. The default value is ``32``. See .. rst-class:: classref-constant -**FLAG_RELIABLE** = ``1`` +**FLAG_RELIABLE** = ``1`` :ref:`🔗` Mark the packet to be sent as reliable. @@ -326,7 +326,7 @@ Mark the packet to be sent as reliable. .. rst-class:: classref-constant -**FLAG_UNSEQUENCED** = ``2`` +**FLAG_UNSEQUENCED** = ``2`` :ref:`🔗` Mark the packet to be sent unsequenced (unreliable). @@ -334,7 +334,7 @@ Mark the packet to be sent unsequenced (unreliable). .. rst-class:: classref-constant -**FLAG_UNRELIABLE_FRAGMENT** = ``8`` +**FLAG_UNRELIABLE_FRAGMENT** = ``8`` :ref:`🔗` Mark the packet to be sent unreliable even if the packet is too big and needs fragmentation (increasing the chance of it being dropped). @@ -351,7 +351,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_channels**\ (\ ) |const| +:ref:`int` **get_channels**\ (\ ) |const| :ref:`🔗` Returns the number of channels allocated for communication with peer. @@ -363,7 +363,7 @@ Returns the number of channels allocated for communication with peer. .. rst-class:: classref-method -:ref:`String` **get_remote_address**\ (\ ) |const| +:ref:`String` **get_remote_address**\ (\ ) |const| :ref:`🔗` Returns the IP address of this peer. @@ -375,7 +375,7 @@ Returns the IP address of this peer. .. rst-class:: classref-method -:ref:`int` **get_remote_port**\ (\ ) |const| +:ref:`int` **get_remote_port**\ (\ ) |const| :ref:`🔗` Returns the remote port of this peer. @@ -387,7 +387,7 @@ Returns the remote port of this peer. .. rst-class:: classref-method -:ref:`PeerState` **get_state**\ (\ ) |const| +:ref:`PeerState` **get_state**\ (\ ) |const| :ref:`🔗` Returns the current peer state. See :ref:`PeerState`. @@ -399,7 +399,7 @@ Returns the current peer state. See :ref:`PeerState` **get_statistic**\ (\ statistic\: :ref:`PeerStatistic`\ ) +:ref:`float` **get_statistic**\ (\ statistic\: :ref:`PeerStatistic`\ ) :ref:`🔗` Returns the requested ``statistic`` for this peer. See :ref:`PeerStatistic`. @@ -411,7 +411,7 @@ Returns the requested ``statistic`` for this peer. See :ref:`PeerStatistic` **is_active**\ (\ ) |const| +:ref:`bool` **is_active**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the peer is currently active (i.e. the associated :ref:`ENetConnection` is still valid). @@ -423,7 +423,7 @@ Returns ``true`` if the peer is currently active (i.e. the associated :ref:`ENet .. rst-class:: classref-method -|void| **peer_disconnect**\ (\ data\: :ref:`int` = 0\ ) +|void| **peer_disconnect**\ (\ data\: :ref:`int` = 0\ ) :ref:`🔗` Request a disconnection from a peer. An :ref:`ENetConnection.EVENT_DISCONNECT` will be generated during :ref:`ENetConnection.service` once the disconnection is complete. @@ -435,7 +435,7 @@ Request a disconnection from a peer. An :ref:`ENetConnection.EVENT_DISCONNECT` = 0\ ) +|void| **peer_disconnect_later**\ (\ data\: :ref:`int` = 0\ ) :ref:`🔗` Request a disconnection from a peer, but only after all queued outgoing packets are sent. An :ref:`ENetConnection.EVENT_DISCONNECT` will be generated during :ref:`ENetConnection.service` once the disconnection is complete. @@ -447,7 +447,7 @@ Request a disconnection from a peer, but only after all queued outgoing packets .. rst-class:: classref-method -|void| **peer_disconnect_now**\ (\ data\: :ref:`int` = 0\ ) +|void| **peer_disconnect_now**\ (\ data\: :ref:`int` = 0\ ) :ref:`🔗` Force an immediate disconnection from a peer. No :ref:`ENetConnection.EVENT_DISCONNECT` will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function. @@ -459,7 +459,7 @@ Force an immediate disconnection from a peer. No :ref:`ENetConnection.EVENT_DISC .. rst-class:: classref-method -|void| **ping**\ (\ ) +|void| **ping**\ (\ ) :ref:`🔗` Sends a ping request to a peer. ENet automatically pings all connected peers at regular intervals, however, this function may be called to ensure more frequent ping requests. @@ -471,7 +471,7 @@ Sends a ping request to a peer. ENet automatically pings all connected peers at .. rst-class:: classref-method -|void| **ping_interval**\ (\ ping_interval\: :ref:`int`\ ) +|void| **ping_interval**\ (\ ping_interval\: :ref:`int`\ ) :ref:`🔗` Sets the ``ping_interval`` in milliseconds at which pings will be sent to a peer. Pings are used both to monitor the liveness of the connection and also to dynamically adjust the throttle during periods of low traffic so that the throttle has reasonable responsiveness during traffic spikes. The default ping interval is ``500`` milliseconds. @@ -483,7 +483,7 @@ Sets the ``ping_interval`` in milliseconds at which pings will be sent to a peer .. rst-class:: classref-method -|void| **reset**\ (\ ) +|void| **reset**\ (\ ) :ref:`🔗` Forcefully disconnects a peer. The foreign host represented by the peer is not notified of the disconnection and will timeout on its connection to the local host. @@ -495,7 +495,7 @@ Forcefully disconnects a peer. The foreign host represented by the peer is not n .. rst-class:: classref-method -:ref:`Error` **send**\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) +:ref:`Error` **send**\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) :ref:`🔗` Queues a ``packet`` to be sent over the specified ``channel``. See ``FLAG_*`` constants for available packet flags. @@ -507,7 +507,7 @@ Queues a ``packet`` to be sent over the specified ``channel``. See ``FLAG_*`` co .. rst-class:: classref-method -|void| **set_timeout**\ (\ timeout\: :ref:`int`, timeout_min\: :ref:`int`, timeout_max\: :ref:`int`\ ) +|void| **set_timeout**\ (\ timeout\: :ref:`int`, timeout_min\: :ref:`int`, timeout_max\: :ref:`int`\ ) :ref:`🔗` Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. @@ -521,7 +521,7 @@ The ``timeout`` is a factor that, multiplied by a value based on the average rou .. rst-class:: classref-method -|void| **throttle_configure**\ (\ interval\: :ref:`int`, acceleration\: :ref:`int`, deceleration\: :ref:`int`\ ) +|void| **throttle_configure**\ (\ interval\: :ref:`int`, acceleration\: :ref:`int`, deceleration\: :ref:`int`\ ) :ref:`🔗` Configures throttle parameter for a peer. diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 58908cd581f..30d29582c76 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -116,7 +116,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **max_fps** = ``0`` +:ref:`int` **max_fps** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ See also :ref:`physics_ticks_per_second` **max_physics_steps_per_frame** = ``8`` +:ref:`int` **max_physics_steps_per_frame** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The maximum number of physics steps that can be simulated each rendered frame. .. rst-class:: classref-property -:ref:`float` **physics_jitter_fix** = ``0.5`` +:ref:`float` **physics_jitter_fix** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ How much physics ticks are synchronized with real time. If ``0`` or less, the ti .. rst-class:: classref-property -:ref:`int` **physics_ticks_per_second** = ``60`` +:ref:`int` **physics_ticks_per_second** = ``60`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -204,7 +204,7 @@ The number of fixed iterations per second. This controls how often physics simul .. rst-class:: classref-property -:ref:`bool` **print_error_messages** = ``true`` +:ref:`bool` **print_error_messages** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ If ``false``, stops printing error and warning messages to the console and edito .. rst-class:: classref-property -:ref:`float` **time_scale** = ``1.0`` +:ref:`float` **time_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -255,7 +255,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_architecture_name**\ (\ ) |const| +:ref:`String` **get_architecture_name**\ (\ ) |const| :ref:`🔗` Returns the name of the CPU architecture the Godot binary was built for. Possible return values include ``"x86_64"``, ``"x86_32"``, ``"arm64"``, ``"arm32"``, ``"rv64"``, ``"riscv"``, ``"ppc64"``, ``"ppc"``, ``"wasm64"``, and ``"wasm32"``. @@ -290,7 +290,7 @@ To detect whether the current build is 64-bit, you can use the fact that all 64- .. rst-class:: classref-method -:ref:`Dictionary` **get_author_info**\ (\ ) |const| +:ref:`Dictionary` **get_author_info**\ (\ ) |const| :ref:`🔗` Returns the engine author information as a :ref:`Dictionary`, where each entry is an :ref:`Array` of strings with the names of notable contributors to the Godot Engine: ``lead_developers``, ``founders``, ``project_managers``, and ``developers``. @@ -302,7 +302,7 @@ Returns the engine author information as a :ref:`Dictionary`, .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_copyright_info**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_copyright_info**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` of dictionaries with copyright information for every component of Godot's source code. @@ -322,7 +322,7 @@ Every :ref:`Dictionary` contains a ``name`` identifier, and a .. rst-class:: classref-method -:ref:`Dictionary` **get_donor_info**\ (\ ) |const| +:ref:`Dictionary` **get_donor_info**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` of categorized donor names. Each entry is an :ref:`Array` of strings: @@ -336,7 +336,7 @@ Returns a :ref:`Dictionary` of categorized donor names. Each e .. rst-class:: classref-method -:ref:`int` **get_frames_drawn**\ (\ ) +:ref:`int` **get_frames_drawn**\ (\ ) :ref:`🔗` Returns the total number of frames drawn since the engine started. @@ -350,7 +350,7 @@ Returns the total number of frames drawn since the engine started. .. rst-class:: classref-method -:ref:`float` **get_frames_per_second**\ (\ ) |const| +:ref:`float` **get_frames_per_second**\ (\ ) |const| :ref:`🔗` Returns the average frames rendered every second (FPS), also known as the framerate. @@ -362,7 +362,7 @@ Returns the average frames rendered every second (FPS), also known as the framer .. rst-class:: classref-method -:ref:`Dictionary` **get_license_info**\ (\ ) |const| +:ref:`Dictionary` **get_license_info**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` of licenses used by Godot and included third party components. Each entry is a license name (such as "`Expat `__") and its associated text. @@ -374,7 +374,7 @@ Returns a :ref:`Dictionary` of licenses used by Godot and incl .. rst-class:: classref-method -:ref:`String` **get_license_text**\ (\ ) |const| +:ref:`String` **get_license_text**\ (\ ) |const| :ref:`🔗` Returns the full Godot license text. @@ -386,7 +386,7 @@ Returns the full Godot license text. .. rst-class:: classref-method -:ref:`MainLoop` **get_main_loop**\ (\ ) |const| +:ref:`MainLoop` **get_main_loop**\ (\ ) |const| :ref:`🔗` Returns the instance of the :ref:`MainLoop`. This is usually the main :ref:`SceneTree` and is the same as :ref:`Node.get_tree`. @@ -400,7 +400,7 @@ Returns the instance of the :ref:`MainLoop`. This is usually the .. rst-class:: classref-method -:ref:`int` **get_physics_frames**\ (\ ) |const| +:ref:`int` **get_physics_frames**\ (\ ) |const| :ref:`🔗` Returns the total number of frames passed since the engine started. This number is increased every **physics frame**. See also :ref:`get_process_frames`. @@ -437,7 +437,7 @@ This method can be used to run expensive logic less often without relying on a : .. rst-class:: classref-method -:ref:`float` **get_physics_interpolation_fraction**\ (\ ) |const| +:ref:`float` **get_physics_interpolation_fraction**\ (\ ) |const| :ref:`🔗` Returns the fraction through the current physics tick we are at the time of rendering the frame. This can be used to implement fixed timestep interpolation. @@ -449,7 +449,7 @@ Returns the fraction through the current physics tick we are at the time of rend .. rst-class:: classref-method -:ref:`int` **get_process_frames**\ (\ ) |const| +:ref:`int` **get_process_frames**\ (\ ) |const| :ref:`🔗` Returns the total number of frames passed since the engine started. This number is increased every **process frame**, regardless of whether the render loop is enabled. See also :ref:`get_frames_drawn` and :ref:`get_physics_frames`. @@ -486,7 +486,7 @@ This method can be used to run expensive logic less often without relying on a : .. rst-class:: classref-method -:ref:`ScriptLanguage` **get_script_language**\ (\ index\: :ref:`int`\ ) |const| +:ref:`ScriptLanguage` **get_script_language**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns an instance of a :ref:`ScriptLanguage` with the given ``index``. @@ -498,7 +498,7 @@ Returns an instance of a :ref:`ScriptLanguage` with the gi .. rst-class:: classref-method -:ref:`int` **get_script_language_count**\ (\ ) +:ref:`int` **get_script_language_count**\ (\ ) :ref:`🔗` Returns the number of available script languages. Use with :ref:`get_script_language`. @@ -510,7 +510,7 @@ Returns the number of available script languages. Use with :ref:`get_script_lang .. rst-class:: classref-method -:ref:`Object` **get_singleton**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Object` **get_singleton**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the global singleton with the given ``name``, or ``null`` if it does not exist. Often used for plugins. See also :ref:`has_singleton` and :ref:`get_singleton_list`. @@ -524,7 +524,7 @@ Returns the global singleton with the given ``name``, or ``null`` if it does not .. rst-class:: classref-method -:ref:`PackedStringArray` **get_singleton_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_singleton_list**\ (\ ) |const| :ref:`🔗` Returns a list of names of all available global singletons. See also :ref:`get_singleton`. @@ -536,7 +536,7 @@ Returns a list of names of all available global singletons. See also :ref:`get_s .. rst-class:: classref-method -:ref:`Dictionary` **get_version_info**\ (\ ) |const| +:ref:`Dictionary` **get_version_info**\ (\ ) |const| :ref:`🔗` Returns the current engine version information as a :ref:`Dictionary` containing the following entries: @@ -593,7 +593,7 @@ The ``hex`` value is encoded as follows, from left to right: one byte for the ma .. rst-class:: classref-method -:ref:`String` **get_write_movie_path**\ (\ ) |const| +:ref:`String` **get_write_movie_path**\ (\ ) |const| :ref:`🔗` Returns the path to the :ref:`MovieWriter`'s output file, or an empty string if the engine wasn't started in Movie Maker mode. The default path can be changed in :ref:`ProjectSettings.editor/movie_writer/movie_file`. @@ -605,7 +605,7 @@ Returns the path to the :ref:`MovieWriter`'s output file, or .. rst-class:: classref-method -:ref:`bool` **has_singleton**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_singleton**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a singleton with the given ``name`` exists in the global scope. See also :ref:`get_singleton`. @@ -638,7 +638,7 @@ Returns ``true`` if a singleton with the given ``name`` exists in the global sco .. rst-class:: classref-method -:ref:`bool` **is_editor_hint**\ (\ ) |const| +:ref:`bool` **is_editor_hint**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script is currently running inside the editor, otherwise returns ``false``. This is useful for ``@tool`` scripts to conditionally draw editor helpers, or prevent accidentally running "game" code that would affect the scene state while in the editor: @@ -673,7 +673,7 @@ See :doc:`Running code in the editor <../tutorials/plugins/running_code_in_the_e .. rst-class:: classref-method -:ref:`bool` **is_in_physics_frame**\ (\ ) |const| +:ref:`bool` **is_in_physics_frame**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the engine is inside the fixed physics process step of the main loop. @@ -698,7 +698,7 @@ Returns ``true`` if the engine is inside the fixed physics process step of the m .. rst-class:: classref-method -:ref:`Error` **register_script_language**\ (\ language\: :ref:`ScriptLanguage`\ ) +:ref:`Error` **register_script_language**\ (\ language\: :ref:`ScriptLanguage`\ ) :ref:`🔗` Registers a :ref:`ScriptLanguage` instance to be available with ``ScriptServer``. @@ -718,7 +718,7 @@ Returns: .. rst-class:: classref-method -|void| **register_singleton**\ (\ name\: :ref:`StringName`, instance\: :ref:`Object`\ ) +|void| **register_singleton**\ (\ name\: :ref:`StringName`, instance\: :ref:`Object`\ ) :ref:`🔗` Registers the given :ref:`Object` ``instance`` as a singleton, available globally under ``name``. Useful for plugins. @@ -730,7 +730,7 @@ Registers the given :ref:`Object` ``instance`` as a singleton, ava .. rst-class:: classref-method -:ref:`Error` **unregister_script_language**\ (\ language\: :ref:`ScriptLanguage`\ ) +:ref:`Error` **unregister_script_language**\ (\ language\: :ref:`ScriptLanguage`\ ) :ref:`🔗` Unregisters the :ref:`ScriptLanguage` instance from ``ScriptServer``. @@ -748,7 +748,7 @@ Returns: .. rst-class:: classref-method -|void| **unregister_singleton**\ (\ name\: :ref:`StringName`\ ) +|void| **unregister_singleton**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the singleton registered under ``name``. The singleton object is *not* freed. Only works with user-defined singletons registered with :ref:`register_singleton`. diff --git a/classes/class_enginedebugger.rst b/classes/class_enginedebugger.rst index b84ffd6afce..be314451dc2 100644 --- a/classes/class_enginedebugger.rst +++ b/classes/class_enginedebugger.rst @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **has_capture**\ (\ name\: :ref:`StringName`\ ) +:ref:`bool` **has_capture**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if a capture with the given name is present otherwise ``false``. @@ -78,7 +78,7 @@ Returns ``true`` if a capture with the given name is present otherwise ``false`` .. rst-class:: classref-method -:ref:`bool` **has_profiler**\ (\ name\: :ref:`StringName`\ ) +:ref:`bool` **has_profiler**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if a profiler with the given name is present otherwise ``false``. @@ -90,7 +90,7 @@ Returns ``true`` if a profiler with the given name is present otherwise ``false` .. rst-class:: classref-method -:ref:`bool` **is_active**\ (\ ) +:ref:`bool` **is_active**\ (\ ) :ref:`🔗` Returns ``true`` if the debugger is active otherwise ``false``. @@ -102,7 +102,7 @@ Returns ``true`` if the debugger is active otherwise ``false``. .. rst-class:: classref-method -:ref:`bool` **is_profiling**\ (\ name\: :ref:`StringName`\ ) +:ref:`bool` **is_profiling**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if a profiler with the given name is present and active otherwise ``false``. @@ -114,7 +114,7 @@ Returns ``true`` if a profiler with the given name is present and active otherwi .. rst-class:: classref-method -|void| **profiler_add_frame_data**\ (\ name\: :ref:`StringName`, data\: :ref:`Array`\ ) +|void| **profiler_add_frame_data**\ (\ name\: :ref:`StringName`, data\: :ref:`Array`\ ) :ref:`🔗` Calls the ``add`` callable of the profiler with given ``name`` and ``data``. @@ -126,7 +126,7 @@ Calls the ``add`` callable of the profiler with given ``name`` and ``data``. .. rst-class:: classref-method -|void| **profiler_enable**\ (\ name\: :ref:`StringName`, enable\: :ref:`bool`, arguments\: :ref:`Array` = []\ ) +|void| **profiler_enable**\ (\ name\: :ref:`StringName`, enable\: :ref:`bool`, arguments\: :ref:`Array` = []\ ) :ref:`🔗` Calls the ``toggle`` callable of the profiler with given ``name`` and ``arguments``. Enables/Disables the same profiler depending on ``enable`` argument. @@ -138,7 +138,7 @@ Calls the ``toggle`` callable of the profiler with given ``name`` and ``argument .. rst-class:: classref-method -|void| **register_message_capture**\ (\ name\: :ref:`StringName`, callable\: :ref:`Callable`\ ) +|void| **register_message_capture**\ (\ name\: :ref:`StringName`, callable\: :ref:`Callable`\ ) :ref:`🔗` Registers a message capture with given ``name``. If ``name`` is "my_message" then messages starting with "my_message:" will be called with the given callable. @@ -152,7 +152,7 @@ Callable must accept a message string and a data array as argument. If the messa .. rst-class:: classref-method -|void| **register_profiler**\ (\ name\: :ref:`StringName`, profiler\: :ref:`EngineProfiler`\ ) +|void| **register_profiler**\ (\ name\: :ref:`StringName`, profiler\: :ref:`EngineProfiler`\ ) :ref:`🔗` Registers a profiler with the given ``name``. See :ref:`EngineProfiler` for more information. @@ -164,7 +164,7 @@ Registers a profiler with the given ``name``. See :ref:`EngineProfiler`, data\: :ref:`Array`\ ) +|void| **send_message**\ (\ message\: :ref:`String`, data\: :ref:`Array`\ ) :ref:`🔗` Sends a message with given ``message`` and ``data`` array. @@ -176,7 +176,7 @@ Sends a message with given ``message`` and ``data`` array. .. rst-class:: classref-method -|void| **unregister_message_capture**\ (\ name\: :ref:`StringName`\ ) +|void| **unregister_message_capture**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Unregisters the message capture with given ``name``. @@ -188,7 +188,7 @@ Unregisters the message capture with given ``name``. .. rst-class:: classref-method -|void| **unregister_profiler**\ (\ name\: :ref:`StringName`\ ) +|void| **unregister_profiler**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Unregisters a profiler with given ``name``. diff --git a/classes/class_engineprofiler.rst b/classes/class_engineprofiler.rst index ad7f5802639..faab1d5fd76 100644 --- a/classes/class_engineprofiler.rst +++ b/classes/class_engineprofiler.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_frame**\ (\ data\: :ref:`Array`\ ) |virtual| +|void| **_add_frame**\ (\ data\: :ref:`Array`\ ) |virtual| :ref:`🔗` Called when data is added to profiler using :ref:`EngineDebugger.profiler_add_frame_data`. @@ -64,7 +64,7 @@ Called when data is added to profiler using :ref:`EngineDebugger.profiler_add_fr .. rst-class:: classref-method -|void| **_tick**\ (\ frame_time\: :ref:`float`, process_time\: :ref:`float`, physics_time\: :ref:`float`, physics_frame_time\: :ref:`float`\ ) |virtual| +|void| **_tick**\ (\ frame_time\: :ref:`float`, process_time\: :ref:`float`, physics_time\: :ref:`float`, physics_frame_time\: :ref:`float`\ ) |virtual| :ref:`🔗` Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better. @@ -76,7 +76,7 @@ Called once every engine iteration when the profiler is active with information .. rst-class:: classref-method -|void| **_toggle**\ (\ enable\: :ref:`bool`, options\: :ref:`Array`\ ) |virtual| +|void| **_toggle**\ (\ enable\: :ref:`bool`, options\: :ref:`Array`\ ) |virtual| :ref:`🔗` Called when the profiler is enabled/disabled, along with a set of ``options``. diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 51eb5689602..53c2e03f8c0 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -275,7 +275,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BGMode**: +enum **BGMode**: :ref:`🔗` .. _class_Environment_constant_BG_CLEAR_COLOR: @@ -341,7 +341,7 @@ Represents the size of the :ref:`BGMode` enum. .. rst-class:: classref-enumeration -enum **AmbientSource**: +enum **AmbientSource**: :ref:`🔗` .. _class_Environment_constant_AMBIENT_SOURCE_BG: @@ -383,7 +383,7 @@ Gather ambient light from the :ref:`Sky` regardless of what the backg .. rst-class:: classref-enumeration -enum **ReflectionSource**: +enum **ReflectionSource**: :ref:`🔗` .. _class_Environment_constant_REFLECTION_SOURCE_BG: @@ -417,7 +417,7 @@ Use the :ref:`Sky` for reflections regardless of what the background .. rst-class:: classref-enumeration -enum **ToneMapper**: +enum **ToneMapper**: :ref:`🔗` .. _class_Environment_constant_TONE_MAPPER_LINEAR: @@ -461,7 +461,7 @@ Use the Academy Color Encoding System tonemapper. ACES is slightly more expensiv .. rst-class:: classref-enumeration -enum **GlowBlendMode**: +enum **GlowBlendMode**: :ref:`🔗` .. _class_Environment_constant_GLOW_BLEND_MODE_ADDITIVE: @@ -511,7 +511,7 @@ Mixes the glow with the underlying color to avoid increasing brightness as much .. rst-class:: classref-enumeration -enum **FogMode**: +enum **FogMode**: :ref:`🔗` .. _class_Environment_constant_FOG_MODE_EXPONENTIAL: @@ -537,7 +537,7 @@ Use a simple fog model defined by start and end positions and a custom curve. Wh .. rst-class:: classref-enumeration -enum **SDFGIYScale**: +enum **SDFGIYScale**: :ref:`🔗` .. _class_Environment_constant_SDFGI_Y_SCALE_50_PERCENT: @@ -576,7 +576,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **adjustment_brightness** = ``1.0`` +:ref:`float` **adjustment_brightness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -593,7 +593,7 @@ The global brightness value of the rendered scene. Effective only if :ref:`adjus .. rst-class:: classref-property -:ref:`Texture` **adjustment_color_correction** +:ref:`Texture` **adjustment_color_correction** :ref:`🔗` .. rst-class:: classref-property-setget @@ -610,7 +610,7 @@ The :ref:`Texture2D` or :ref:`Texture3D` looku .. rst-class:: classref-property -:ref:`float` **adjustment_contrast** = ``1.0`` +:ref:`float` **adjustment_contrast** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -627,7 +627,7 @@ The global contrast value of the rendered scene (default value is 1). Effective .. rst-class:: classref-property -:ref:`bool` **adjustment_enabled** = ``false`` +:ref:`bool` **adjustment_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -646,7 +646,7 @@ If ``true``, enables the ``adjustment_*`` properties provided by this resource. .. rst-class:: classref-property -:ref:`float` **adjustment_saturation** = ``1.0`` +:ref:`float` **adjustment_saturation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -663,7 +663,7 @@ The global color saturation value of the rendered scene (default value is 1). Ef .. rst-class:: classref-property -:ref:`Color` **ambient_light_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **ambient_light_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -680,7 +680,7 @@ The ambient light's :ref:`Color`. Only effective if :ref:`ambient_l .. rst-class:: classref-property -:ref:`float` **ambient_light_energy** = ``1.0`` +:ref:`float` **ambient_light_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -697,7 +697,7 @@ The ambient light's energy. The higher the value, the stronger the light. Only e .. rst-class:: classref-property -:ref:`float` **ambient_light_sky_contribution** = ``1.0`` +:ref:`float` **ambient_light_sky_contribution** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -716,7 +716,7 @@ Defines the amount of light that the sky brings on the scene. A value of ``0.0`` .. rst-class:: classref-property -:ref:`AmbientSource` **ambient_light_source** = ``0`` +:ref:`AmbientSource` **ambient_light_source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -733,7 +733,7 @@ The ambient light source to use for rendering materials and global illumination. .. rst-class:: classref-property -:ref:`int` **background_camera_feed_id** = ``1`` +:ref:`int` **background_camera_feed_id** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -750,7 +750,7 @@ The ID of the camera feed to show in the background. .. rst-class:: classref-property -:ref:`int` **background_canvas_max_layer** = ``0`` +:ref:`int` **background_canvas_max_layer** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -767,7 +767,7 @@ The maximum layer ID to display. Only effective when using the :ref:`BG_CANVAS` **background_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **background_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -784,7 +784,7 @@ The :ref:`Color` displayed for clear areas of the scene. Only effec .. rst-class:: classref-property -:ref:`float` **background_energy_multiplier** = ``1.0`` +:ref:`float` **background_energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -801,7 +801,7 @@ Multiplier for background energy. Increase to make background brighter, decrease .. rst-class:: classref-property -:ref:`float` **background_intensity** = ``30000.0`` +:ref:`float` **background_intensity** = ``30000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -818,7 +818,7 @@ Luminance of background measured in nits (candela per square meter). Only used w .. rst-class:: classref-property -:ref:`BGMode` **background_mode** = ``0`` +:ref:`BGMode` **background_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -835,7 +835,7 @@ The background mode. See :ref:`BGMode` for possible val .. rst-class:: classref-property -:ref:`float` **fog_aerial_perspective** = ``0.0`` +:ref:`float` **fog_aerial_perspective** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -854,7 +854,7 @@ This is useful to simulate `aerial perspective ` **fog_density** = ``0.01`` +:ref:`float` **fog_density** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -875,7 +875,7 @@ The fog density to be used. This is demonstrated in different ways depending on .. rst-class:: classref-property -:ref:`float` **fog_depth_begin** = ``10.0`` +:ref:`float` **fog_depth_begin** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -892,7 +892,7 @@ The fog's depth starting distance from the camera. Only available when :ref:`fog .. rst-class:: classref-property -:ref:`float` **fog_depth_curve** = ``1.0`` +:ref:`float` **fog_depth_curve** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -909,7 +909,7 @@ The fog depth's intensity curve. A number of presets are available in the Inspec .. rst-class:: classref-property -:ref:`float` **fog_depth_end** = ``100.0`` +:ref:`float` **fog_depth_end** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -926,7 +926,7 @@ The fog's depth end distance from the camera. If this value is set to ``0``, it .. rst-class:: classref-property -:ref:`bool` **fog_enabled** = ``false`` +:ref:`bool` **fog_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -943,7 +943,7 @@ If ``true``, fog effects are enabled. .. rst-class:: classref-property -:ref:`float` **fog_height** = ``0.0`` +:ref:`float` **fog_height** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -960,7 +960,7 @@ The height at which the height fog effect begins. .. rst-class:: classref-property -:ref:`float` **fog_height_density** = ``0.0`` +:ref:`float` **fog_height_density** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -977,7 +977,7 @@ The density used to increase fog as height decreases. To make fog increase as he .. rst-class:: classref-property -:ref:`Color` **fog_light_color** = ``Color(0.518, 0.553, 0.608, 1)`` +:ref:`Color` **fog_light_color** = ``Color(0.518, 0.553, 0.608, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -994,7 +994,7 @@ The fog's color. .. rst-class:: classref-property -:ref:`float` **fog_light_energy** = ``1.0`` +:ref:`float` **fog_light_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1011,7 +1011,7 @@ The fog's brightness. Higher values result in brighter fog. .. rst-class:: classref-property -:ref:`FogMode` **fog_mode** = ``0`` +:ref:`FogMode` **fog_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1028,7 +1028,7 @@ The fog mode. See :ref:`FogMode` for possible values. .. rst-class:: classref-property -:ref:`float` **fog_sky_affect** = ``1.0`` +:ref:`float` **fog_sky_affect** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1047,7 +1047,7 @@ The factor to use when affecting the sky with non-volumetric fog. ``1.0`` means .. rst-class:: classref-property -:ref:`float` **fog_sun_scatter** = ``0.0`` +:ref:`float` **fog_sun_scatter** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1064,7 +1064,7 @@ If set above ``0.0``, renders the scene's directional light(s) in the fog color .. rst-class:: classref-property -:ref:`GlowBlendMode` **glow_blend_mode** = ``2`` +:ref:`GlowBlendMode` **glow_blend_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1083,7 +1083,7 @@ The glow blending mode. .. rst-class:: classref-property -:ref:`float` **glow_bloom** = ``0.0`` +:ref:`float` **glow_bloom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1100,7 +1100,7 @@ The bloom's intensity. If set to a value higher than ``0``, this will make glow .. rst-class:: classref-property -:ref:`bool` **glow_enabled** = ``false`` +:ref:`bool` **glow_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1121,7 +1121,7 @@ If ``true``, the glow effect is enabled. This simulates real world eye/camera be .. rst-class:: classref-property -:ref:`float` **glow_hdr_luminance_cap** = ``12.0`` +:ref:`float` **glow_hdr_luminance_cap** = ``12.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1138,7 +1138,7 @@ The higher threshold of the HDR glow. Areas brighter than this threshold will be .. rst-class:: classref-property -:ref:`float` **glow_hdr_scale** = ``2.0`` +:ref:`float` **glow_hdr_scale** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1155,7 +1155,7 @@ The bleed scale of the HDR glow. .. rst-class:: classref-property -:ref:`float` **glow_hdr_threshold** = ``1.0`` +:ref:`float` **glow_hdr_threshold** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1172,7 +1172,7 @@ The lower threshold of the HDR glow. When using the Mobile rendering method (whi .. rst-class:: classref-property -:ref:`float` **glow_intensity** = ``0.8`` +:ref:`float` **glow_intensity** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1189,7 +1189,7 @@ The overall brightness multiplier of the glow effect. When using the Mobile rend .. rst-class:: classref-property -:ref:`float` **glow_levels/1** = ``0.0`` +:ref:`float` **glow_levels/1** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1208,7 +1208,7 @@ The intensity of the 1st level of glow. This is the most "local" level (least bl .. rst-class:: classref-property -:ref:`float` **glow_levels/2** = ``0.0`` +:ref:`float` **glow_levels/2** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1227,7 +1227,7 @@ The intensity of the 2nd level of glow. .. rst-class:: classref-property -:ref:`float` **glow_levels/3** = ``1.0`` +:ref:`float` **glow_levels/3** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1246,7 +1246,7 @@ The intensity of the 3rd level of glow. .. rst-class:: classref-property -:ref:`float` **glow_levels/4** = ``0.0`` +:ref:`float` **glow_levels/4** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1265,7 +1265,7 @@ The intensity of the 4th level of glow. .. rst-class:: classref-property -:ref:`float` **glow_levels/5** = ``1.0`` +:ref:`float` **glow_levels/5** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1284,7 +1284,7 @@ The intensity of the 5th level of glow. .. rst-class:: classref-property -:ref:`float` **glow_levels/6** = ``0.0`` +:ref:`float` **glow_levels/6** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1303,7 +1303,7 @@ The intensity of the 6th level of glow. .. rst-class:: classref-property -:ref:`float` **glow_levels/7** = ``0.0`` +:ref:`float` **glow_levels/7** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1322,7 +1322,7 @@ The intensity of the 7th level of glow. This is the most "global" level (blurrie .. rst-class:: classref-property -:ref:`Texture` **glow_map** +:ref:`Texture` **glow_map** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1343,7 +1343,7 @@ The texture that should be used as a glow map to *multiply* the resulting glow c .. rst-class:: classref-property -:ref:`float` **glow_map_strength** = ``0.8`` +:ref:`float` **glow_map_strength** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1362,7 +1362,7 @@ How strong of an impact the :ref:`glow_map` .. rst-class:: classref-property -:ref:`float` **glow_mix** = ``0.05`` +:ref:`float` **glow_mix** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1381,7 +1381,7 @@ When using the :ref:`GLOW_BLEND_MODE_MIX` **glow_normalized** = ``false`` +:ref:`bool` **glow_normalized** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1400,7 +1400,7 @@ If ``true``, glow levels will be normalized so that summed together their intens .. rst-class:: classref-property -:ref:`float` **glow_strength** = ``1.0`` +:ref:`float` **glow_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1419,7 +1419,7 @@ The strength of the glow effect. This applies as the glow is blurred across the .. rst-class:: classref-property -:ref:`ReflectionSource` **reflected_light_source** = ``0`` +:ref:`ReflectionSource` **reflected_light_source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1436,7 +1436,7 @@ The reflected (specular) light source. .. rst-class:: classref-property -:ref:`float` **sdfgi_bounce_feedback** = ``0.5`` +:ref:`float` **sdfgi_bounce_feedback** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1457,7 +1457,7 @@ The energy multiplier applied to light every time it bounces from a surface when .. rst-class:: classref-property -:ref:`float` **sdfgi_cascade0_distance** = ``12.8`` +:ref:`float` **sdfgi_cascade0_distance** = ``12.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1474,7 +1474,7 @@ The energy multiplier applied to light every time it bounces from a surface when .. rst-class:: classref-property -:ref:`int` **sdfgi_cascades** = ``4`` +:ref:`int` **sdfgi_cascades** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1491,7 +1491,7 @@ The number of cascades to use for SDFGI (between 1 and 8). A higher number of ca .. rst-class:: classref-property -:ref:`bool` **sdfgi_enabled** = ``false`` +:ref:`bool` **sdfgi_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1514,7 +1514,7 @@ If ``true``, enables signed distance field global illumination for meshes that h .. rst-class:: classref-property -:ref:`float` **sdfgi_energy** = ``1.0`` +:ref:`float` **sdfgi_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1531,7 +1531,7 @@ The energy multiplier to use for SDFGI. Higher values will result in brighter in .. rst-class:: classref-property -:ref:`float` **sdfgi_max_distance** = ``204.8`` +:ref:`float` **sdfgi_max_distance** = ``204.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1550,7 +1550,7 @@ The maximum distance at which SDFGI is visible. Beyond this distance, environmen .. rst-class:: classref-property -:ref:`float` **sdfgi_min_cell_size** = ``0.2`` +:ref:`float` **sdfgi_min_cell_size** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1569,7 +1569,7 @@ The cell size to use for the closest SDFGI cascade (in 3D units). Lower values a .. rst-class:: classref-property -:ref:`float` **sdfgi_normal_bias** = ``1.1`` +:ref:`float` **sdfgi_normal_bias** = ``1.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1586,7 +1586,7 @@ The normal bias to use for SDFGI probes. Increasing this value can reduce visibl .. rst-class:: classref-property -:ref:`float` **sdfgi_probe_bias** = ``1.1`` +:ref:`float` **sdfgi_probe_bias** = ``1.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1603,7 +1603,7 @@ The constant bias to use for SDFGI probes. Increasing this value can reduce visi .. rst-class:: classref-property -:ref:`bool` **sdfgi_read_sky_light** = ``true`` +:ref:`bool` **sdfgi_read_sky_light** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1620,7 +1620,7 @@ If ``true``, SDFGI takes the environment lighting into account. This should be s .. rst-class:: classref-property -:ref:`bool` **sdfgi_use_occlusion** = ``false`` +:ref:`bool` **sdfgi_use_occlusion** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1637,7 +1637,7 @@ If ``true``, SDFGI uses an occlusion detection approach to reduce light leaking. .. rst-class:: classref-property -:ref:`SDFGIYScale` **sdfgi_y_scale** = ``1`` +:ref:`SDFGIYScale` **sdfgi_y_scale** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1654,7 +1654,7 @@ The Y scale to use for SDFGI cells. Lower values will result in SDFGI cells bein .. rst-class:: classref-property -:ref:`Sky` **sky** +:ref:`Sky` **sky** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1671,7 +1671,7 @@ The :ref:`Sky` resource used for this **Environment**. .. rst-class:: classref-property -:ref:`float` **sky_custom_fov** = ``0.0`` +:ref:`float` **sky_custom_fov** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1688,7 +1688,7 @@ If set to a value greater than ``0.0``, overrides the field of view to use for s .. rst-class:: classref-property -:ref:`Vector3` **sky_rotation** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **sky_rotation** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1705,7 +1705,7 @@ The rotation to use for sky rendering. .. rst-class:: classref-property -:ref:`float` **ssao_ao_channel_affect** = ``0.0`` +:ref:`float` **ssao_ao_channel_affect** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1722,7 +1722,7 @@ The screen-space ambient occlusion intensity on materials that have an AO textur .. rst-class:: classref-property -:ref:`float` **ssao_detail** = ``0.5`` +:ref:`float` **ssao_detail** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1739,7 +1739,7 @@ Sets the strength of the additional level of detail for the screen-space ambient .. rst-class:: classref-property -:ref:`bool` **ssao_enabled** = ``false`` +:ref:`bool` **ssao_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1758,7 +1758,7 @@ If ``true``, the screen-space ambient occlusion effect is enabled. This darkens .. rst-class:: classref-property -:ref:`float` **ssao_horizon** = ``0.06`` +:ref:`float` **ssao_horizon** = ``0.06`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1775,7 +1775,7 @@ The threshold for considering whether a given point on a surface is occluded or .. rst-class:: classref-property -:ref:`float` **ssao_intensity** = ``2.0`` +:ref:`float` **ssao_intensity** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1792,7 +1792,7 @@ The primary screen-space ambient occlusion intensity. Acts as a multiplier for t .. rst-class:: classref-property -:ref:`float` **ssao_light_affect** = ``0.0`` +:ref:`float` **ssao_light_affect** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1809,7 +1809,7 @@ The screen-space ambient occlusion intensity in direct light. In real life, ambi .. rst-class:: classref-property -:ref:`float` **ssao_power** = ``1.5`` +:ref:`float` **ssao_power** = ``1.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1826,7 +1826,7 @@ The distribution of occlusion. A higher value results in darker occlusion, simil .. rst-class:: classref-property -:ref:`float` **ssao_radius** = ``1.0`` +:ref:`float` **ssao_radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1843,7 +1843,7 @@ The distance at which objects can occlude each other when calculating screen-spa .. rst-class:: classref-property -:ref:`float` **ssao_sharpness** = ``0.98`` +:ref:`float` **ssao_sharpness** = ``0.98`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1860,7 +1860,7 @@ The amount that the screen-space ambient occlusion effect is allowed to blur ove .. rst-class:: classref-property -:ref:`bool` **ssil_enabled** = ``false`` +:ref:`bool` **ssil_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1879,7 +1879,7 @@ If ``true``, the screen-space indirect lighting effect is enabled. Screen space .. rst-class:: classref-property -:ref:`float` **ssil_intensity** = ``1.0`` +:ref:`float` **ssil_intensity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1896,7 +1896,7 @@ The brightness multiplier for the screen-space indirect lighting effect. A highe .. rst-class:: classref-property -:ref:`float` **ssil_normal_rejection** = ``1.0`` +:ref:`float` **ssil_normal_rejection** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1913,7 +1913,7 @@ Amount of normal rejection used when calculating screen-space indirect lighting. .. rst-class:: classref-property -:ref:`float` **ssil_radius** = ``5.0`` +:ref:`float` **ssil_radius** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1930,7 +1930,7 @@ The distance that bounced lighting can travel when using the screen space indire .. rst-class:: classref-property -:ref:`float` **ssil_sharpness** = ``0.98`` +:ref:`float` **ssil_sharpness** = ``0.98`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1947,7 +1947,7 @@ The amount that the screen-space indirect lighting effect is allowed to blur ove .. rst-class:: classref-property -:ref:`float` **ssr_depth_tolerance** = ``0.2`` +:ref:`float` **ssr_depth_tolerance** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1964,7 +1964,7 @@ The depth tolerance for screen-space reflections. .. rst-class:: classref-property -:ref:`bool` **ssr_enabled** = ``false`` +:ref:`bool` **ssr_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1983,7 +1983,7 @@ If ``true``, screen-space reflections are enabled. Screen-space reflections are .. rst-class:: classref-property -:ref:`float` **ssr_fade_in** = ``0.15`` +:ref:`float` **ssr_fade_in** = ``0.15`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2000,7 +2000,7 @@ The fade-in distance for screen-space reflections. Affects the area from the ref .. rst-class:: classref-property -:ref:`float` **ssr_fade_out** = ``2.0`` +:ref:`float` **ssr_fade_out** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2017,7 +2017,7 @@ The fade-out distance for screen-space reflections. Affects the area from the sc .. rst-class:: classref-property -:ref:`int` **ssr_max_steps** = ``64`` +:ref:`int` **ssr_max_steps** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2034,7 +2034,7 @@ The maximum number of steps for screen-space reflections. Higher values are slow .. rst-class:: classref-property -:ref:`float` **tonemap_exposure** = ``1.0`` +:ref:`float` **tonemap_exposure** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2051,7 +2051,7 @@ The default exposure used for tonemapping. Higher values result in a brighter im .. rst-class:: classref-property -:ref:`ToneMapper` **tonemap_mode** = ``0`` +:ref:`ToneMapper` **tonemap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2068,7 +2068,7 @@ The tonemapping mode to use. Tonemapping is the process that "converts" HDR valu .. rst-class:: classref-property -:ref:`float` **tonemap_white** = ``1.0`` +:ref:`float` **tonemap_white** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2085,7 +2085,7 @@ The white reference value for tonemapping (also called "whitepoint"). Higher val .. rst-class:: classref-property -:ref:`Color` **volumetric_fog_albedo** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **volumetric_fog_albedo** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2102,7 +2102,7 @@ The :ref:`Color` of the volumetric fog when interacting with lights .. rst-class:: classref-property -:ref:`float` **volumetric_fog_ambient_inject** = ``0.0`` +:ref:`float` **volumetric_fog_ambient_inject** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2121,7 +2121,7 @@ Scales the strength of ambient light used in the volumetric fog. A value of ``0. .. rst-class:: classref-property -:ref:`float` **volumetric_fog_anisotropy** = ``0.2`` +:ref:`float` **volumetric_fog_anisotropy** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2138,7 +2138,7 @@ The direction of scattered light as it goes through the volumetric fog. A value .. rst-class:: classref-property -:ref:`float` **volumetric_fog_density** = ``0.05`` +:ref:`float` **volumetric_fog_density** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2159,7 +2159,7 @@ To make volumetric fog work as a volumetric *lighting* solution, set :ref:`volum .. rst-class:: classref-property -:ref:`float` **volumetric_fog_detail_spread** = ``2.0`` +:ref:`float` **volumetric_fog_detail_spread** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2176,7 +2176,7 @@ The distribution of size down the length of the froxel buffer. A higher value co .. rst-class:: classref-property -:ref:`Color` **volumetric_fog_emission** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **volumetric_fog_emission** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2193,7 +2193,7 @@ The emitted light from the volumetric fog. Even with emission, volumetric fog wi .. rst-class:: classref-property -:ref:`float` **volumetric_fog_emission_energy** = ``1.0`` +:ref:`float` **volumetric_fog_emission_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2210,7 +2210,7 @@ The brightness of the emitted light from the volumetric fog. .. rst-class:: classref-property -:ref:`bool` **volumetric_fog_enabled** = ``false`` +:ref:`bool` **volumetric_fog_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2229,7 +2229,7 @@ Enables the volumetric fog effect. Volumetric fog uses a screen-aligned froxel b .. rst-class:: classref-property -:ref:`float` **volumetric_fog_gi_inject** = ``1.0`` +:ref:`float` **volumetric_fog_gi_inject** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2250,7 +2250,7 @@ Scales the strength of Global Illumination used in the volumetric fog's albedo c .. rst-class:: classref-property -:ref:`float` **volumetric_fog_length** = ``64.0`` +:ref:`float` **volumetric_fog_length** = ``64.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2267,7 +2267,7 @@ The distance over which the volumetric fog is computed. Increase to compute fog .. rst-class:: classref-property -:ref:`float` **volumetric_fog_sky_affect** = ``1.0`` +:ref:`float` **volumetric_fog_sky_affect** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2286,7 +2286,7 @@ The factor to use when affecting the sky with volumetric fog. ``1.0`` means that .. rst-class:: classref-property -:ref:`float` **volumetric_fog_temporal_reprojection_amount** = ``0.9`` +:ref:`float` **volumetric_fog_temporal_reprojection_amount** = ``0.9`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2303,7 +2303,7 @@ The amount by which to blend the last frame with the current frame. A higher num .. rst-class:: classref-property -:ref:`bool` **volumetric_fog_temporal_reprojection_enabled** = ``true`` +:ref:`bool` **volumetric_fog_temporal_reprojection_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2325,7 +2325,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the intensity of the glow level ``idx``. @@ -2337,7 +2337,7 @@ Returns the intensity of the glow level ``idx``. .. rst-class:: classref-method -|void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +|void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) :ref:`🔗` Sets the intensity of the glow level ``idx``. A value above ``0.0`` enables the level. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. diff --git a/classes/class_expression.rst b/classes/class_expression.rst index fc326170bbb..09f408cd58d 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -108,7 +108,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **execute**\ (\ inputs\: :ref:`Array` = [], base_instance\: :ref:`Object` = null, show_error\: :ref:`bool` = true, const_calls_only\: :ref:`bool` = false\ ) +:ref:`Variant` **execute**\ (\ inputs\: :ref:`Array` = [], base_instance\: :ref:`Object` = null, show_error\: :ref:`bool` = true, const_calls_only\: :ref:`bool` = false\ ) :ref:`🔗` Executes the expression that was previously parsed by :ref:`parse` and returns the result. Before you use the returned object, you should check if the method failed by calling :ref:`has_execute_failed`. @@ -122,7 +122,7 @@ If you defined input variables in :ref:`parse`, y .. rst-class:: classref-method -:ref:`String` **get_error_text**\ (\ ) |const| +:ref:`String` **get_error_text**\ (\ ) |const| :ref:`🔗` Returns the error text if :ref:`parse` or :ref:`execute` has failed. @@ -134,7 +134,7 @@ Returns the error text if :ref:`parse` or :ref:`e .. rst-class:: classref-method -:ref:`bool` **has_execute_failed**\ (\ ) |const| +:ref:`bool` **has_execute_failed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if :ref:`execute` has failed. @@ -146,7 +146,7 @@ Returns ``true`` if :ref:`execute` has failed. .. rst-class:: classref-method -:ref:`Error` **parse**\ (\ expression\: :ref:`String`, input_names\: :ref:`PackedStringArray` = PackedStringArray()\ ) +:ref:`Error` **parse**\ (\ expression\: :ref:`String`, input_names\: :ref:`PackedStringArray` = PackedStringArray()\ ) :ref:`🔗` Parses the expression and returns an :ref:`Error` code. diff --git a/classes/class_fastnoiselite.rst b/classes/class_fastnoiselite.rst index fc858d64a9e..130ca392e4e 100644 --- a/classes/class_fastnoiselite.rst +++ b/classes/class_fastnoiselite.rst @@ -88,7 +88,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **NoiseType**: +enum **NoiseType**: :ref:`🔗` .. _class_FastNoiseLite_constant_TYPE_VALUE: @@ -148,7 +148,7 @@ Modified, higher quality version of :ref:`TYPE_SIMPLEX` .. _class_FastNoiseLite_constant_FRACTAL_NONE: @@ -190,7 +190,7 @@ Method of combining octaves into a fractal with a ping pong effect. .. rst-class:: classref-enumeration -enum **CellularDistanceFunction**: +enum **CellularDistanceFunction**: :ref:`🔗` .. _class_FastNoiseLite_constant_DISTANCE_EUCLIDEAN: @@ -232,7 +232,7 @@ Blend of :ref:`DISTANCE_EUCLIDEAN` .. _class_FastNoiseLite_constant_RETURN_CELL_VALUE: @@ -298,7 +298,7 @@ The distance to the nearest point is divided by the distance to the second-neare .. rst-class:: classref-enumeration -enum **DomainWarpType**: +enum **DomainWarpType**: :ref:`🔗` .. _class_FastNoiseLite_constant_DOMAIN_WARP_SIMPLEX: @@ -332,7 +332,7 @@ The domain is warped using a simple noise grid (not as smooth as the other metho .. rst-class:: classref-enumeration -enum **DomainWarpFractalType**: +enum **DomainWarpFractalType**: :ref:`🔗` .. _class_FastNoiseLite_constant_DOMAIN_WARP_FRACTAL_NONE: @@ -371,7 +371,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CellularDistanceFunction` **cellular_distance_function** = ``0`` +:ref:`CellularDistanceFunction` **cellular_distance_function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -388,7 +388,7 @@ Determines how the distance to the nearest/second-nearest point is computed. See .. rst-class:: classref-property -:ref:`float` **cellular_jitter** = ``1.0`` +:ref:`float` **cellular_jitter** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -405,7 +405,7 @@ Maximum distance a point can move off of its grid position. Set to ``0`` for an .. rst-class:: classref-property -:ref:`CellularReturnType` **cellular_return_type** = ``1`` +:ref:`CellularReturnType` **cellular_return_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -422,7 +422,7 @@ Return type from cellular noise calculations. See :ref:`CellularReturnType` **domain_warp_amplitude** = ``30.0`` +:ref:`float` **domain_warp_amplitude** = ``30.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -439,7 +439,7 @@ Sets the maximum warp distance from the origin. .. rst-class:: classref-property -:ref:`bool` **domain_warp_enabled** = ``false`` +:ref:`bool` **domain_warp_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -456,7 +456,7 @@ If enabled, another FastNoiseLite instance is used to warp the space, resulting .. rst-class:: classref-property -:ref:`float` **domain_warp_fractal_gain** = ``0.5`` +:ref:`float` **domain_warp_fractal_gain** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -475,7 +475,7 @@ A low value places more emphasis on the lower frequency base layers, while a hig .. rst-class:: classref-property -:ref:`float` **domain_warp_fractal_lacunarity** = ``6.0`` +:ref:`float` **domain_warp_fractal_lacunarity** = ``6.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -492,7 +492,7 @@ Octave lacunarity of the fractal noise which warps the space. Increasing this va .. rst-class:: classref-property -:ref:`int` **domain_warp_fractal_octaves** = ``5`` +:ref:`int` **domain_warp_fractal_octaves** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -509,7 +509,7 @@ The number of noise layers that are sampled to get the final value for the fract .. rst-class:: classref-property -:ref:`DomainWarpFractalType` **domain_warp_fractal_type** = ``1`` +:ref:`DomainWarpFractalType` **domain_warp_fractal_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -526,7 +526,7 @@ The method for combining octaves into a fractal which is used to warp the space. .. rst-class:: classref-property -:ref:`float` **domain_warp_frequency** = ``0.05`` +:ref:`float` **domain_warp_frequency** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -543,7 +543,7 @@ Frequency of the noise which warps the space. Low frequency results in smooth no .. rst-class:: classref-property -:ref:`DomainWarpType` **domain_warp_type** = ``0`` +:ref:`DomainWarpType` **domain_warp_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -560,7 +560,7 @@ Sets the warp algorithm. See :ref:`DomainWarpType` **fractal_gain** = ``0.5`` +:ref:`float` **fractal_gain** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -579,7 +579,7 @@ A low value places more emphasis on the lower frequency base layers, while a hig .. rst-class:: classref-property -:ref:`float` **fractal_lacunarity** = ``2.0`` +:ref:`float` **fractal_lacunarity** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -596,7 +596,7 @@ Frequency multiplier between subsequent octaves. Increasing this value results i .. rst-class:: classref-property -:ref:`int` **fractal_octaves** = ``5`` +:ref:`int` **fractal_octaves** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -613,7 +613,7 @@ The number of noise layers that are sampled to get the final value for fractal n .. rst-class:: classref-property -:ref:`float` **fractal_ping_pong_strength** = ``2.0`` +:ref:`float` **fractal_ping_pong_strength** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -630,7 +630,7 @@ Sets the strength of the fractal ping pong type. .. rst-class:: classref-property -:ref:`FractalType` **fractal_type** = ``1`` +:ref:`FractalType` **fractal_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -647,7 +647,7 @@ The method for combining octaves into a fractal. See :ref:`FractalType` **fractal_weighted_strength** = ``0.0`` +:ref:`float` **fractal_weighted_strength** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -664,7 +664,7 @@ Higher weighting means higher octaves have less impact if lower octaves have a l .. rst-class:: classref-property -:ref:`float` **frequency** = ``0.01`` +:ref:`float` **frequency** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -681,7 +681,7 @@ The frequency for all noise types. Low frequency results in smooth noise while h .. rst-class:: classref-property -:ref:`NoiseType` **noise_type** = ``1`` +:ref:`NoiseType` **noise_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -698,7 +698,7 @@ The noise algorithm used. See :ref:`NoiseType`. .. rst-class:: classref-property -:ref:`Vector3` **offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -715,7 +715,7 @@ Translate the noise input coordinates by the given :ref:`Vector3` .. rst-class:: classref-property -:ref:`int` **seed** = ``0`` +:ref:`int` **seed** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_fbxstate.rst b/classes/class_fbxstate.rst index dd20b0778f2..819a60fcfa4 100644 --- a/classes/class_fbxstate.rst +++ b/classes/class_fbxstate.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_geometry_helper_nodes** = ``false`` +:ref:`bool` **allow_geometry_helper_nodes** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index 86af5bf086c..73a099ac549 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -218,7 +218,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ModeFlags**: +enum **ModeFlags**: :ref:`🔗` .. _class_FileAccess_constant_READ: @@ -236,7 +236,7 @@ Opens the file for read operations. The cursor is positioned at the beginning of Opens the file for write operations. The file is created if it does not exist, and truncated if it does. -\ **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see :ref:`DirAccess.make_dir_recursive`). +\ **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see :ref:`DirAccess.make_dir_recursive`. .. _class_FileAccess_constant_READ_WRITE: @@ -254,7 +254,7 @@ Opens the file for read and write operations. Does not truncate the file. The cu Opens the file for read and write operations. The file is created if it does not exist, and truncated if it does. The cursor is positioned at the beginning of the file. -\ **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see :ref:`DirAccess.make_dir_recursive`). +\ **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see :ref:`DirAccess.make_dir_recursive`. .. rst-class:: classref-item-separator @@ -264,7 +264,7 @@ Opens the file for read and write operations. The file is created if it does not .. rst-class:: classref-enumeration -enum **CompressionMode**: +enum **CompressionMode**: :ref:`🔗` .. _class_FileAccess_constant_COMPRESSION_FASTLZ: @@ -314,7 +314,7 @@ Uses the `brotli `__ compression method (only .. rst-class:: classref-enumeration -flags **UnixPermissionFlags**: +flags **UnixPermissionFlags**: :ref:`🔗` .. _class_FileAccess_constant_UNIX_READ_OWNER: @@ -425,7 +425,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **big_endian** +:ref:`bool` **big_endian** :ref:`🔗` .. rst-class:: classref-property-setget @@ -451,7 +451,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **close**\ (\ ) +|void| **close**\ (\ ) :ref:`🔗` Closes the currently opened file and prevents subsequent read/write operations. Use :ref:`flush` to persist the data to disk without closing the file. @@ -465,7 +465,7 @@ Closes the currently opened file and prevents subsequent read/write operations. .. rst-class:: classref-method -:ref:`bool` **eof_reached**\ (\ ) |const| +:ref:`bool` **eof_reached**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the file cursor has already read past the end of the file. @@ -496,7 +496,7 @@ Returns ``true`` if the file cursor has already read past the end of the file. .. rst-class:: classref-method -:ref:`bool` **file_exists**\ (\ path\: :ref:`String`\ ) |static| +:ref:`bool` **file_exists**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns ``true`` if the file exists in the given path. @@ -512,7 +512,7 @@ For a non-static, relative equivalent, use :ref:`DirAccess.file_exists` Writes the file's buffer to disk. Flushing is automatically performed when the file is closed. This means you don't need to call :ref:`flush` manually before closing a file. Still, calling :ref:`flush` can be used to ensure the data is safe even if the project crashes instead of being closed gracefully. @@ -526,7 +526,7 @@ Writes the file's buffer to disk. Flushing is automatically performed when the f .. rst-class:: classref-method -:ref:`int` **get_8**\ (\ ) |const| +:ref:`int` **get_8**\ (\ ) |const| :ref:`🔗` Returns the next 8 bits from the file as an integer. See :ref:`store_8` for details on what values can be stored and retrieved this way. @@ -538,7 +538,7 @@ Returns the next 8 bits from the file as an integer. See :ref:`store_8` **get_16**\ (\ ) |const| +:ref:`int` **get_16**\ (\ ) |const| :ref:`🔗` Returns the next 16 bits from the file as an integer. See :ref:`store_16` for details on what values can be stored and retrieved this way. @@ -550,7 +550,7 @@ Returns the next 16 bits from the file as an integer. See :ref:`store_16` **get_32**\ (\ ) |const| +:ref:`int` **get_32**\ (\ ) |const| :ref:`🔗` Returns the next 32 bits from the file as an integer. See :ref:`store_32` for details on what values can be stored and retrieved this way. @@ -562,7 +562,7 @@ Returns the next 32 bits from the file as an integer. See :ref:`store_32` **get_64**\ (\ ) |const| +:ref:`int` **get_64**\ (\ ) |const| :ref:`🔗` Returns the next 64 bits from the file as an integer. See :ref:`store_64` for details on what values can be stored and retrieved this way. @@ -574,7 +574,7 @@ Returns the next 64 bits from the file as an integer. See :ref:`store_64` **get_as_text**\ (\ skip_cr\: :ref:`bool` = false\ ) |const| +:ref:`String` **get_as_text**\ (\ skip_cr\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the whole file as a :ref:`String`. Text is interpreted as being UTF-8 encoded. @@ -588,7 +588,7 @@ If ``skip_cr`` is ``true``, carriage return characters (``\r``, CR) will be igno .. rst-class:: classref-method -:ref:`PackedByteArray` **get_buffer**\ (\ length\: :ref:`int`\ ) |const| +:ref:`PackedByteArray` **get_buffer**\ (\ length\: :ref:`int`\ ) |const| :ref:`🔗` Returns next ``length`` bytes of the file as a :ref:`PackedByteArray`. @@ -600,7 +600,7 @@ Returns next ``length`` bytes of the file as a :ref:`PackedByteArray` **get_csv_line**\ (\ delim\: :ref:`String` = ","\ ) |const| +:ref:`PackedStringArray` **get_csv_line**\ (\ delim\: :ref:`String` = ","\ ) |const| :ref:`🔗` Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long, and cannot be a double quotation mark. @@ -624,7 +624,7 @@ Note how the second line can omit the enclosing quotes as it does not include th .. rst-class:: classref-method -:ref:`float` **get_double**\ (\ ) |const| +:ref:`float` **get_double**\ (\ ) |const| :ref:`🔗` Returns the next 64 bits from the file as a floating-point number. @@ -636,7 +636,7 @@ Returns the next 64 bits from the file as a floating-point number. .. rst-class:: classref-method -:ref:`Error` **get_error**\ (\ ) |const| +:ref:`Error` **get_error**\ (\ ) |const| :ref:`🔗` Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`Error`. @@ -648,7 +648,7 @@ Returns the last error that happened when trying to perform operations. Compare .. rst-class:: classref-method -:ref:`PackedByteArray` **get_file_as_bytes**\ (\ path\: :ref:`String`\ ) |static| +:ref:`PackedByteArray` **get_file_as_bytes**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns the whole ``path`` file contents as a :ref:`PackedByteArray` without any decoding. @@ -662,7 +662,7 @@ Returns an empty :ref:`PackedByteArray` if an error occur .. rst-class:: classref-method -:ref:`String` **get_file_as_string**\ (\ path\: :ref:`String`\ ) |static| +:ref:`String` **get_file_as_string**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns the whole ``path`` file contents as a :ref:`String`. Text is interpreted as being UTF-8 encoded. @@ -676,7 +676,7 @@ Returns an empty :ref:`String` if an error occurred while opening .. rst-class:: classref-method -:ref:`float` **get_float**\ (\ ) |const| +:ref:`float` **get_float**\ (\ ) |const| :ref:`🔗` Returns the next 32 bits from the file as a floating-point number. @@ -688,7 +688,7 @@ Returns the next 32 bits from the file as a floating-point number. .. rst-class:: classref-method -:ref:`bool` **get_hidden_attribute**\ (\ file\: :ref:`String`\ ) |static| +:ref:`bool` **get_hidden_attribute**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` Returns ``true``, if file ``hidden`` attribute is set. @@ -702,7 +702,7 @@ Returns ``true``, if file ``hidden`` attribute is set. .. rst-class:: classref-method -:ref:`int` **get_length**\ (\ ) |const| +:ref:`int` **get_length**\ (\ ) |const| :ref:`🔗` Returns the size of the file in bytes. @@ -714,7 +714,7 @@ Returns the size of the file in bytes. .. rst-class:: classref-method -:ref:`String` **get_line**\ (\ ) |const| +:ref:`String` **get_line**\ (\ ) |const| :ref:`🔗` Returns the next line of the file as a :ref:`String`. The returned string doesn't include newline (``\n``) or carriage return (``\r``) characters, but does include any other leading or trailing whitespace. @@ -728,7 +728,7 @@ Text is interpreted as being UTF-8 encoded. .. rst-class:: classref-method -:ref:`String` **get_md5**\ (\ path\: :ref:`String`\ ) |static| +:ref:`String` **get_md5**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns an MD5 String representing the file at the given path or an empty :ref:`String` on failure. @@ -740,7 +740,7 @@ Returns an MD5 String representing the file at the given path or an empty :ref:` .. rst-class:: classref-method -:ref:`int` **get_modified_time**\ (\ file\: :ref:`String`\ ) |static| +:ref:`int` **get_modified_time**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` Returns the last time the ``file`` was modified in Unix timestamp format, or ``0`` on error. This Unix timestamp can be converted to another format using the :ref:`Time` singleton. @@ -752,7 +752,7 @@ Returns the last time the ``file`` was modified in Unix timestamp format, or ``0 .. rst-class:: classref-method -:ref:`Error` **get_open_error**\ (\ ) |static| +:ref:`Error` **get_open_error**\ (\ ) |static| :ref:`🔗` Returns the result of the last :ref:`open` call in the current thread. @@ -764,7 +764,7 @@ Returns the result of the last :ref:`open` call in .. rst-class:: classref-method -:ref:`String` **get_pascal_string**\ (\ ) +:ref:`String` **get_pascal_string**\ (\ ) :ref:`🔗` Returns a :ref:`String` saved in Pascal format from the file. @@ -778,7 +778,7 @@ Text is interpreted as being UTF-8 encoded. .. rst-class:: classref-method -:ref:`String` **get_path**\ (\ ) |const| +:ref:`String` **get_path**\ (\ ) |const| :ref:`🔗` Returns the path as a :ref:`String` for the current open file. @@ -790,7 +790,7 @@ Returns the path as a :ref:`String` for the current open file. .. rst-class:: classref-method -:ref:`String` **get_path_absolute**\ (\ ) |const| +:ref:`String` **get_path_absolute**\ (\ ) |const| :ref:`🔗` Returns the absolute path as a :ref:`String` for the current open file. @@ -802,7 +802,7 @@ Returns the absolute path as a :ref:`String` for the current open .. rst-class:: classref-method -:ref:`int` **get_position**\ (\ ) |const| +:ref:`int` **get_position**\ (\ ) |const| :ref:`🔗` Returns the file cursor's position. @@ -814,7 +814,7 @@ Returns the file cursor's position. .. rst-class:: classref-method -:ref:`bool` **get_read_only_attribute**\ (\ file\: :ref:`String`\ ) |static| +:ref:`bool` **get_read_only_attribute**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` Returns ``true``, if file ``read only`` attribute is set. @@ -828,7 +828,7 @@ Returns ``true``, if file ``read only`` attribute is set. .. rst-class:: classref-method -:ref:`float` **get_real**\ (\ ) |const| +:ref:`float` **get_real**\ (\ ) |const| :ref:`🔗` Returns the next bits from the file as a floating-point number. @@ -840,7 +840,7 @@ Returns the next bits from the file as a floating-point number. .. rst-class:: classref-method -:ref:`String` **get_sha256**\ (\ path\: :ref:`String`\ ) |static| +:ref:`String` **get_sha256**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Returns an SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. @@ -852,7 +852,7 @@ Returns an SHA-256 :ref:`String` representing the file at the give .. rst-class:: classref-method -|bitfield|\[:ref:`UnixPermissionFlags`\] **get_unix_permissions**\ (\ file\: :ref:`String`\ ) |static| +|bitfield|\[:ref:`UnixPermissionFlags`\] **get_unix_permissions**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` Returns file UNIX permissions. @@ -866,7 +866,7 @@ Returns file UNIX permissions. .. rst-class:: classref-method -:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) |const| +:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the next :ref:`Variant` value from the file. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -882,7 +882,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -:ref:`bool` **is_open**\ (\ ) |const| +:ref:`bool` **is_open**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the file is currently opened. @@ -894,7 +894,7 @@ Returns ``true`` if the file is currently opened. .. rst-class:: classref-method -:ref:`FileAccess` **open**\ (\ path\: :ref:`String`, flags\: :ref:`ModeFlags`\ ) |static| +:ref:`FileAccess` **open**\ (\ path\: :ref:`String`, flags\: :ref:`ModeFlags`\ ) |static| :ref:`🔗` Creates a new **FileAccess** object and opens the file for writing or reading, depending on the flags. @@ -908,7 +908,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **open_compressed**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, compression_mode\: :ref:`CompressionMode` = 0\ ) |static| +:ref:`FileAccess` **open_compressed**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, compression_mode\: :ref:`CompressionMode` = 0\ ) |static| :ref:`🔗` Creates a new **FileAccess** object and opens a compressed file for reading or writing. @@ -924,7 +924,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **open_encrypted**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, key\: :ref:`PackedByteArray`\ ) |static| +:ref:`FileAccess` **open_encrypted**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, key\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` Creates a new **FileAccess** object and opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -940,7 +940,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **open_encrypted_with_pass**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, pass\: :ref:`String`\ ) |static| +:ref:`FileAccess` **open_encrypted_with_pass**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, pass\: :ref:`String`\ ) |static| :ref:`🔗` Creates a new **FileAccess** object and opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. @@ -954,7 +954,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **resize**\ (\ length\: :ref:`int`\ ) +:ref:`Error` **resize**\ (\ length\: :ref:`int`\ ) :ref:`🔗` Resizes the file to a specified length. The file must be open in a mode that permits writing. If the file is extended, NUL characters are appended. If the file is truncated, all data from the end file to the original length of the file is lost. @@ -966,7 +966,7 @@ Resizes the file to a specified length. The file must be open in a mode that per .. rst-class:: classref-method -|void| **seek**\ (\ position\: :ref:`int`\ ) +|void| **seek**\ (\ position\: :ref:`int`\ ) :ref:`🔗` Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). @@ -978,7 +978,7 @@ Changes the file reading/writing cursor to the specified position (in bytes from .. rst-class:: classref-method -|void| **seek_end**\ (\ position\: :ref:`int` = 0\ ) +|void| **seek_end**\ (\ position\: :ref:`int` = 0\ ) :ref:`🔗` Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). @@ -992,7 +992,7 @@ Changes the file reading/writing cursor to the specified position (in bytes from .. rst-class:: classref-method -:ref:`Error` **set_hidden_attribute**\ (\ file\: :ref:`String`, hidden\: :ref:`bool`\ ) |static| +:ref:`Error` **set_hidden_attribute**\ (\ file\: :ref:`String`, hidden\: :ref:`bool`\ ) |static| :ref:`🔗` Sets file **hidden** attribute. @@ -1006,7 +1006,7 @@ Sets file **hidden** attribute. .. rst-class:: classref-method -:ref:`Error` **set_read_only_attribute**\ (\ file\: :ref:`String`, ro\: :ref:`bool`\ ) |static| +:ref:`Error` **set_read_only_attribute**\ (\ file\: :ref:`String`, ro\: :ref:`bool`\ ) |static| :ref:`🔗` Sets file **read only** attribute. @@ -1020,7 +1020,7 @@ Sets file **read only** attribute. .. rst-class:: classref-method -:ref:`Error` **set_unix_permissions**\ (\ file\: :ref:`String`, permissions\: |bitfield|\[:ref:`UnixPermissionFlags`\]\ ) |static| +:ref:`Error` **set_unix_permissions**\ (\ file\: :ref:`String`, permissions\: |bitfield|\[:ref:`UnixPermissionFlags`\]\ ) |static| :ref:`🔗` Sets file UNIX permissions. @@ -1034,7 +1034,7 @@ Sets file UNIX permissions. .. rst-class:: classref-method -|void| **store_8**\ (\ value\: :ref:`int`\ ) +|void| **store_8**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Stores an integer as 8 bits in the file. @@ -1050,7 +1050,7 @@ To store a signed integer, use :ref:`store_64` .. rst-class:: classref-method -|void| **store_16**\ (\ value\: :ref:`int`\ ) +|void| **store_16**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Stores an integer as 16 bits in the file. @@ -1103,7 +1103,7 @@ To store a signed integer, use :ref:`store_64` .. rst-class:: classref-method -|void| **store_32**\ (\ value\: :ref:`int`\ ) +|void| **store_32**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Stores an integer as 32 bits in the file. @@ -1119,7 +1119,7 @@ To store a signed integer, use :ref:`store_64` .. rst-class:: classref-method -|void| **store_64**\ (\ value\: :ref:`int`\ ) +|void| **store_64**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Stores an integer as 64 bits in the file. @@ -1133,7 +1133,7 @@ Stores an integer as 64 bits in the file. .. rst-class:: classref-method -|void| **store_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +|void| **store_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Stores the given array of bytes in the file. @@ -1145,7 +1145,7 @@ Stores the given array of bytes in the file. .. rst-class:: classref-method -|void| **store_csv_line**\ (\ values\: :ref:`PackedStringArray`, delim\: :ref:`String` = ","\ ) +|void| **store_csv_line**\ (\ values\: :ref:`PackedStringArray`, delim\: :ref:`String` = ","\ ) :ref:`🔗` Store the given :ref:`PackedStringArray` in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. @@ -1159,7 +1159,7 @@ Text will be encoded as UTF-8. .. rst-class:: classref-method -|void| **store_double**\ (\ value\: :ref:`float`\ ) +|void| **store_double**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Stores a floating-point number as 64 bits in the file. @@ -1171,7 +1171,7 @@ Stores a floating-point number as 64 bits in the file. .. rst-class:: classref-method -|void| **store_float**\ (\ value\: :ref:`float`\ ) +|void| **store_float**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Stores a floating-point number as 32 bits in the file. @@ -1183,7 +1183,7 @@ Stores a floating-point number as 32 bits in the file. .. rst-class:: classref-method -|void| **store_line**\ (\ line\: :ref:`String`\ ) +|void| **store_line**\ (\ line\: :ref:`String`\ ) :ref:`🔗` Appends ``line`` to the file followed by a line return character (``\n``), encoding the text as UTF-8. @@ -1195,7 +1195,7 @@ Appends ``line`` to the file followed by a line return character (``\n``), encod .. rst-class:: classref-method -|void| **store_pascal_string**\ (\ string\: :ref:`String`\ ) +|void| **store_pascal_string**\ (\ string\: :ref:`String`\ ) :ref:`🔗` Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). @@ -1209,7 +1209,7 @@ Text will be encoded as UTF-8. .. rst-class:: classref-method -|void| **store_real**\ (\ value\: :ref:`float`\ ) +|void| **store_real**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Stores a floating-point number in the file. @@ -1221,7 +1221,7 @@ Stores a floating-point number in the file. .. rst-class:: classref-method -|void| **store_string**\ (\ string\: :ref:`String`\ ) +|void| **store_string**\ (\ string\: :ref:`String`\ ) :ref:`🔗` Appends ``string`` to the file without a line return, encoding the text as UTF-8. @@ -1235,7 +1235,7 @@ Appends ``string`` to the file without a line return, encoding the text as UTF-8 .. rst-class:: classref-method -|void| **store_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) +|void| **store_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) :ref:`🔗` Stores any Variant value in the file. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 8bbd4a7b677..29bc9d9638e 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -140,7 +140,7 @@ Signals .. rst-class:: classref-signal -**dir_selected**\ (\ dir\: :ref:`String`\ ) +**dir_selected**\ (\ dir\: :ref:`String`\ ) :ref:`🔗` Emitted when the user selects a directory. @@ -152,7 +152,7 @@ Emitted when the user selects a directory. .. rst-class:: classref-signal -**file_selected**\ (\ path\: :ref:`String`\ ) +**file_selected**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Emitted when the user selects a file by double-clicking it or pressing the **OK** button. @@ -164,7 +164,7 @@ Emitted when the user selects a file by double-clicking it or pressing the **OK* .. rst-class:: classref-signal -**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) +**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted when the user selects multiple files. @@ -181,7 +181,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FileMode**: +enum **FileMode**: :ref:`🔗` .. _class_FileDialog_constant_FILE_MODE_OPEN_FILE: @@ -231,7 +231,7 @@ The dialog will warn when a file exists. .. rst-class:: classref-enumeration -enum **Access**: +enum **Access**: :ref:`🔗` .. _class_FileDialog_constant_ACCESS_RESOURCES: @@ -270,7 +270,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Access` **access** = ``0`` +:ref:`Access` **access** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -289,7 +289,7 @@ The file system access scope. See :ref:`Access` constant .. rst-class:: classref-property -:ref:`String` **current_dir** +:ref:`String` **current_dir** :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ The current working directory of the file dialog. .. rst-class:: classref-property -:ref:`String` **current_file** +:ref:`String` **current_file** :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ The currently selected file of the file dialog. .. rst-class:: classref-property -:ref:`String` **current_path** +:ref:`String` **current_path** :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ The currently selected file path of the file dialog. .. rst-class:: classref-property -:ref:`FileMode` **file_mode** = ``4`` +:ref:`FileMode` **file_mode** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -357,7 +357,7 @@ The dialog's open or save mode, which affects the selection behavior. See :ref:` .. rst-class:: classref-property -:ref:`PackedStringArray` **filters** = ``PackedStringArray()`` +:ref:`PackedStringArray` **filters** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -376,7 +376,7 @@ The available file type filters. Each filter string in the array should be forma .. rst-class:: classref-property -:ref:`bool` **mode_overrides_title** = ``true`` +:ref:`bool` **mode_overrides_title** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -393,7 +393,7 @@ If ``true``, changing the :ref:`file_mode` .. rst-class:: classref-property -:ref:`int` **option_count** = ``0`` +:ref:`int` **option_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -410,7 +410,7 @@ The number of additional :ref:`OptionButton`\ s and :ref:`Ch .. rst-class:: classref-property -:ref:`String` **root_subfolder** = ``""`` +:ref:`String` **root_subfolder** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -427,7 +427,7 @@ If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. u .. rst-class:: classref-property -:ref:`bool` **show_hidden_files** = ``false`` +:ref:`bool` **show_hidden_files** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -444,7 +444,7 @@ If ``true``, the dialog will show hidden files. .. rst-class:: classref-property -:ref:`bool` **use_native_dialog** = ``false`` +:ref:`bool` **use_native_dialog** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -468,7 +468,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) +|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) :ref:`🔗` Adds a comma-delimited file name ``filter`` option to the **FileDialog** with an optional ``description``, which restricts what files can be picked. @@ -484,7 +484,7 @@ For example, a ``filter`` of ``"*.png, *.jpg"`` and a ``description`` of ``"Imag .. rst-class:: classref-method -|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) +|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. @@ -498,7 +498,7 @@ Adds an additional :ref:`OptionButton` to the file dialog. I .. rst-class:: classref-method -|void| **clear_filters**\ (\ ) +|void| **clear_filters**\ (\ ) :ref:`🔗` Clear all the added filters in the dialog. @@ -510,7 +510,7 @@ Clear all the added filters in the dialog. .. rst-class:: classref-method -|void| **deselect_all**\ (\ ) +|void| **deselect_all**\ (\ ) :ref:`🔗` Clear all currently selected items in the dialog. @@ -522,7 +522,7 @@ Clear all currently selected items in the dialog. .. rst-class:: classref-method -:ref:`LineEdit` **get_line_edit**\ (\ ) +:ref:`LineEdit` **get_line_edit**\ (\ ) :ref:`🔗` Returns the LineEdit for the selected file. @@ -536,7 +536,7 @@ Returns the LineEdit for the selected file. .. rst-class:: classref-method -:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| +:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -548,7 +548,7 @@ Returns the default value index of the :ref:`OptionButton` o .. rst-class:: classref-method -:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| +:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -560,7 +560,7 @@ Returns the name of the :ref:`OptionButton` or :ref:`CheckBo .. rst-class:: classref-method -:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| +:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of values of the :ref:`OptionButton` with index ``option``. @@ -572,7 +572,7 @@ Returns an array of values of the :ref:`OptionButton` with i .. rst-class:: classref-method -:ref:`Dictionary` **get_selected_options**\ (\ ) |const| +:ref:`Dictionary` **get_selected_options**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`Dictionary` keys are names and values are selected value indices. @@ -584,7 +584,7 @@ Returns a :ref:`Dictionary` with the selected values of the ad .. rst-class:: classref-method -:ref:`VBoxContainer` **get_vbox**\ (\ ) +:ref:`VBoxContainer` **get_vbox**\ (\ ) :ref:`🔗` Returns the vertical box container of the dialog, custom controls can be added to it. @@ -598,7 +598,7 @@ Returns the vertical box container of the dialog, custom controls can be added t .. rst-class:: classref-method -|void| **invalidate**\ (\ ) +|void| **invalidate**\ (\ ) :ref:`🔗` Invalidate and update the current dialog content list. @@ -610,7 +610,7 @@ Invalidate and update the current dialog content list. .. rst-class:: classref-method -|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) +|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -622,7 +622,7 @@ Sets the default value index of the :ref:`OptionButton` or : .. rst-class:: classref-method -|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -634,7 +634,7 @@ Sets the name of the :ref:`OptionButton` or :ref:`CheckBox`, values\: :ref:`PackedStringArray`\ ) +|void| **set_option_values**\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the option values of the :ref:`OptionButton` with index ``option``. @@ -651,7 +651,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **file_disabled_color** = ``Color(1, 1, 1, 0.25)`` +:ref:`Color` **file_disabled_color** = ``Color(1, 1, 1, 0.25)`` :ref:`🔗` The color tint for disabled files (when the **FileDialog** is used in open folder mode). @@ -663,7 +663,7 @@ The color tint for disabled files (when the **FileDialog** is used in open folde .. rst-class:: classref-themeproperty -:ref:`Color` **file_icon_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **file_icon_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` The color modulation applied to the file icon. @@ -675,7 +675,7 @@ The color modulation applied to the file icon. .. rst-class:: classref-themeproperty -:ref:`Color` **folder_icon_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **folder_icon_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` The color modulation applied to the folder icon. @@ -687,7 +687,7 @@ The color modulation applied to the folder icon. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **back_folder** +:ref:`Texture2D` **back_folder** :ref:`🔗` Custom icon for the back arrow. @@ -699,7 +699,7 @@ Custom icon for the back arrow. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **create_folder** +:ref:`Texture2D` **create_folder** :ref:`🔗` Custom icon for the create folder button. @@ -711,7 +711,7 @@ Custom icon for the create folder button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **file** +:ref:`Texture2D` **file** :ref:`🔗` Custom icon for files. @@ -723,7 +723,7 @@ Custom icon for files. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **folder** +:ref:`Texture2D` **folder** :ref:`🔗` Custom icon for folders. @@ -735,7 +735,7 @@ Custom icon for folders. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **forward_folder** +:ref:`Texture2D` **forward_folder** :ref:`🔗` Custom icon for the forward arrow. @@ -747,7 +747,7 @@ Custom icon for the forward arrow. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **parent_folder** +:ref:`Texture2D` **parent_folder** :ref:`🔗` Custom icon for the parent folder arrow. @@ -759,7 +759,7 @@ Custom icon for the parent folder arrow. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **reload** +:ref:`Texture2D` **reload** :ref:`🔗` Custom icon for the reload button. @@ -771,7 +771,7 @@ Custom icon for the reload button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **toggle_hidden** +:ref:`Texture2D` **toggle_hidden** :ref:`🔗` Custom icon for the toggle hidden button. diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index b89846bf34e..7b5d6eb8fe3 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -52,7 +52,7 @@ Signals .. rst-class:: classref-signal -**display_mode_changed**\ (\ ) +**display_mode_changed**\ (\ ) :ref:`🔗` Emitted when the user switches file display mode or split mode. @@ -64,7 +64,7 @@ Emitted when the user switches file display mode or split mode. .. rst-class:: classref-signal -**file_removed**\ (\ file\: :ref:`String`\ ) +**file_removed**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Emitted when the given ``file`` was removed. @@ -76,7 +76,7 @@ Emitted when the given ``file`` was removed. .. rst-class:: classref-signal -**files_moved**\ (\ old_file\: :ref:`String`, new_file\: :ref:`String`\ ) +**files_moved**\ (\ old_file\: :ref:`String`, new_file\: :ref:`String`\ ) :ref:`🔗` Emitted when a file is moved from ``old_file`` path to ``new_file`` path. @@ -88,7 +88,7 @@ Emitted when a file is moved from ``old_file`` path to ``new_file`` path. .. rst-class:: classref-signal -**folder_color_changed**\ (\ ) +**folder_color_changed**\ (\ ) :ref:`🔗` Emitted when folders change color. @@ -100,7 +100,7 @@ Emitted when folders change color. .. rst-class:: classref-signal -**folder_moved**\ (\ old_folder\: :ref:`String`, new_folder\: :ref:`String`\ ) +**folder_moved**\ (\ old_folder\: :ref:`String`, new_folder\: :ref:`String`\ ) :ref:`🔗` Emitted when a folder is moved from ``old_folder`` path to ``new_folder`` path. @@ -112,7 +112,7 @@ Emitted when a folder is moved from ``old_folder`` path to ``new_folder`` path. .. rst-class:: classref-signal -**folder_removed**\ (\ folder\: :ref:`String`\ ) +**folder_removed**\ (\ folder\: :ref:`String`\ ) :ref:`🔗` Emitted when the given ``folder`` was removed. @@ -124,7 +124,7 @@ Emitted when the given ``folder`` was removed. .. rst-class:: classref-signal -**inherit**\ (\ file\: :ref:`String`\ ) +**inherit**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Emitted when a new scene is created that inherits the scene at ``file`` path. @@ -136,7 +136,7 @@ Emitted when a new scene is created that inherits the scene at ``file`` path. .. rst-class:: classref-signal -**instantiate**\ (\ files\: :ref:`PackedStringArray`\ ) +**instantiate**\ (\ files\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted when the given scenes are being instantiated in the editor. @@ -148,7 +148,7 @@ Emitted when the given scenes are being instantiated in the editor. .. rst-class:: classref-signal -**resource_removed**\ (\ resource\: :ref:`Resource`\ ) +**resource_removed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` Emitted when an external ``resource`` had its file removed. @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) +|void| **add_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) :ref:`🔗` Registers a new :ref:`EditorResourceTooltipPlugin`. @@ -177,7 +177,7 @@ Registers a new :ref:`EditorResourceTooltipPlugin`\ ) +|void| **navigate_to_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Sets the given ``path`` as currently selected, ensuring that the selected file/directory is visible. @@ -189,7 +189,7 @@ Sets the given ``path`` as currently selected, ensuring that the selected file/d .. rst-class:: classref-method -|void| **remove_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) +|void| **remove_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) :ref:`🔗` Removes an :ref:`EditorResourceTooltipPlugin`. Fails if the plugin wasn't previously added. diff --git a/classes/class_float.rst b/classes/class_float.rst index ba0ebb1e7b3..9e1f3088345 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -139,7 +139,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`float` **float**\ (\ ) +:ref:`float` **float**\ (\ ) :ref:`🔗` Constructs a default-initialized **float** set to ``0.0``. @@ -196,7 +196,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if two floats are different from each other. @@ -210,7 +210,7 @@ Returns ``true`` if two floats are different from each other. .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the integer has different value than the float. @@ -222,7 +222,7 @@ Returns ``true`` if the integer has different value than the float. .. rst-class:: classref-operator -:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) +:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Multiplies each component of the :ref:`Color`, including the alpha, by the given **float**. @@ -238,7 +238,7 @@ Multiplies each component of the :ref:`Color`, including the alpha, .. rst-class:: classref-operator -:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Multiplies each component of the :ref:`Quaternion` by the given **float**. This operation is not meaningful on its own, but it can be used as a part of a larger expression. @@ -250,7 +250,7 @@ Multiplies each component of the :ref:`Quaternion` by the give .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector2` by the given **float**. @@ -266,7 +266,7 @@ Multiplies each component of the :ref:`Vector2` by the given **fl .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector2i` by the given **float**. Returns a :ref:`Vector2`. @@ -282,7 +282,7 @@ Multiplies each component of the :ref:`Vector2i` by the given ** .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector3` by the given **float**. @@ -294,7 +294,7 @@ Multiplies each component of the :ref:`Vector3` by the given **fl .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector3i` by the given **float**. Returns a :ref:`Vector3`. @@ -310,7 +310,7 @@ Multiplies each component of the :ref:`Vector3i` by the given ** .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector4` by the given **float**. @@ -322,7 +322,7 @@ Multiplies each component of the :ref:`Vector4` by the given **fl .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector4i` by the given **float**. Returns a :ref:`Vector4`. @@ -338,7 +338,7 @@ Multiplies each component of the :ref:`Vector4i` by the given ** .. rst-class:: classref-operator -:ref:`float` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies two **float**\ s. @@ -350,7 +350,7 @@ Multiplies two **float**\ s. .. rst-class:: classref-operator -:ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies a **float** and an :ref:`int`. The result is a **float**. @@ -362,7 +362,7 @@ Multiplies a **float** and an :ref:`int`. The result is a **float**. .. rst-class:: classref-operator -:ref:`float` **operator ****\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator ****\ (\ right\: :ref:`float`\ ) :ref:`🔗` Raises a **float** to a power of a **float**. @@ -378,7 +378,7 @@ Raises a **float** to a power of a **float**. .. rst-class:: classref-operator -:ref:`float` **operator ****\ (\ right\: :ref:`int`\ ) +:ref:`float` **operator ****\ (\ right\: :ref:`int`\ ) :ref:`🔗` Raises a **float** to a power of an :ref:`int`. The result is a **float**. @@ -394,7 +394,7 @@ Raises a **float** to a power of an :ref:`int`. The result is a **flo .. rst-class:: classref-operator -:ref:`float` **operator +**\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator +**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Adds two floats. @@ -406,7 +406,7 @@ Adds two floats. .. rst-class:: classref-operator -:ref:`float` **operator +**\ (\ right\: :ref:`int`\ ) +:ref:`float` **operator +**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Adds a **float** and an :ref:`int`. The result is a **float**. @@ -418,7 +418,7 @@ Adds a **float** and an :ref:`int`. The result is a **float**. .. rst-class:: classref-operator -:ref:`float` **operator -**\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator -**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Subtracts a float from a float. @@ -430,7 +430,7 @@ Subtracts a float from a float. .. rst-class:: classref-operator -:ref:`float` **operator -**\ (\ right\: :ref:`int`\ ) +:ref:`float` **operator -**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Subtracts an :ref:`int` from a **float**. The result is a **float**. @@ -442,7 +442,7 @@ Subtracts an :ref:`int` from a **float**. The result is a **float**. .. rst-class:: classref-operator -:ref:`float` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides two floats. @@ -454,7 +454,7 @@ Divides two floats. .. rst-class:: classref-operator -:ref:`float` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`float` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides a **float** by an :ref:`int`. The result is a **float**. @@ -466,7 +466,7 @@ Divides a **float** by an :ref:`int`. The result is a **float**. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the left float is less than the right one. @@ -480,7 +480,7 @@ Returns ``true`` if the left float is less than the right one. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if this **float** is less than the given :ref:`int`. @@ -492,7 +492,7 @@ Returns ``true`` if this **float** is less than the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the left float is less than or equal to the right one. @@ -506,7 +506,7 @@ Returns ``true`` if the left float is less than or equal to the right one. .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if this **float** is less than or equal to the given :ref:`int`. @@ -518,7 +518,7 @@ Returns ``true`` if this **float** is less than or equal to the given :ref:`int< .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if both floats are exactly equal. @@ -534,7 +534,7 @@ Returns ``true`` if both floats are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the **float** and the given :ref:`int` are equal. @@ -546,7 +546,7 @@ Returns ``true`` if the **float** and the given :ref:`int` are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the left float is greater than the right one. @@ -560,7 +560,7 @@ Returns ``true`` if the left float is greater than the right one. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if this **float** is greater than the given :ref:`int`. @@ -572,7 +572,7 @@ Returns ``true`` if this **float** is greater than the given :ref:`int` **operator >=**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the left float is greater than or equal to the right one. @@ -586,7 +586,7 @@ Returns ``true`` if the left float is greater than or equal to the right one. .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if this **float** is greater than or equal to the given :ref:`int`. @@ -598,7 +598,7 @@ Returns ``true`` if this **float** is greater than or equal to the given :ref:`i .. rst-class:: classref-operator -:ref:`float` **operator unary+**\ (\ ) +:ref:`float` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -610,7 +610,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`float` **operator unary-**\ (\ ) +:ref:`float` **operator unary-**\ (\ ) :ref:`🔗` 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_flowcontainer.rst b/classes/class_flowcontainer.rst index 59e7dae4982..53c65e8c136 100644 --- a/classes/class_flowcontainer.rst +++ b/classes/class_flowcontainer.rst @@ -87,7 +87,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AlignmentMode**: +enum **AlignmentMode**: :ref:`🔗` .. _class_FlowContainer_constant_ALIGNMENT_BEGIN: @@ -121,7 +121,7 @@ The child controls will be arranged at the end of the container, i.e. bottom if .. rst-class:: classref-enumeration -enum **LastWrapAlignmentMode**: +enum **LastWrapAlignmentMode**: :ref:`🔗` .. _class_FlowContainer_constant_LAST_WRAP_ALIGNMENT_INHERIT: @@ -168,7 +168,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AlignmentMode` **alignment** = ``0`` +:ref:`AlignmentMode` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN< .. rst-class:: classref-property -:ref:`LastWrapAlignmentMode` **last_wrap_alignment** = ``0`` +:ref:`LastWrapAlignmentMode` **last_wrap_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ The wrap behavior of the last, partially filled row or column (must be one of :r .. rst-class:: classref-property -:ref:`bool` **reverse_fill** = ``false`` +:ref:`bool` **reverse_fill** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ When using a vertical **FlowContainer** with a right to left :ref:`Control.layou .. rst-class:: classref-property -:ref:`bool` **vertical** = ``false`` +:ref:`bool` **vertical** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -245,7 +245,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_line_count**\ (\ ) |const| +:ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` Returns the current line count. @@ -262,7 +262,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal separation of child nodes. @@ -274,7 +274,7 @@ The horizontal separation of child nodes. .. rst-class:: classref-themeproperty -:ref:`int` **v_separation** = ``4`` +:ref:`int` **v_separation** = ``4`` :ref:`🔗` The vertical separation of child nodes. diff --git a/classes/class_fogmaterial.rst b/classes/class_fogmaterial.rst index e06589036fc..4a2b18e6624 100644 --- a/classes/class_fogmaterial.rst +++ b/classes/class_fogmaterial.rst @@ -58,7 +58,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **albedo** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **albedo** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ The single-scattering :ref:`Color` of the :ref:`FogVolume` **density** = ``1.0`` +:ref:`float` **density** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ The density of the :ref:`FogVolume`. Denser objects are more op .. rst-class:: classref-property -:ref:`Texture3D` **density_texture** +:ref:`Texture3D` **density_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ The 3D texture that is used to scale the :ref:`density` **edge_fade** = ``0.1`` +:ref:`float` **edge_fade** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ The hardness of the edges of the :ref:`FogVolume`. A higher val .. rst-class:: classref-property -:ref:`Color` **emission** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **emission** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ The :ref:`Color` of the light emitted by the :ref:`FogVolume` **height_falloff** = ``0.0`` +:ref:`float` **height_falloff** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_fogvolume.rst b/classes/class_fogvolume.rst index 6ba884b39b2..8d9b06e010d 100644 --- a/classes/class_fogvolume.rst +++ b/classes/class_fogvolume.rst @@ -61,7 +61,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -78,7 +78,7 @@ The :ref:`Material` used by the **FogVolume**. Can be either a b .. rst-class:: classref-property -:ref:`FogVolumeShape` **shape** = ``3`` +:ref:`FogVolumeShape` **shape** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -95,7 +95,7 @@ The shape of the **FogVolume**. This can be set to either :ref:`RenderingServer. .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_font.rst b/classes/class_font.rst index 7a827228051..542dcb1a58d 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -122,7 +122,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array`\[:ref:`Font`\] **fallbacks** = ``[]`` +:ref:`Array`\[:ref:`Font`\] **fallbacks** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -146,7 +146,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **draw_char**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +:ref:`float` **draw_char**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw a single Unicode character ``char`` into a canvas item using the font, at a given position, with ``modulate`` color. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -160,7 +160,7 @@ Draw a single Unicode character ``char`` into a canvas item using the font, at a .. rst-class:: classref-method -:ref:`float` **draw_char_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +:ref:`float` **draw_char_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw a single Unicode character ``char`` outline into a canvas item using the font, at a given position, with ``modulate`` color and ``size`` outline size. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -174,7 +174,7 @@ Draw a single Unicode character ``char`` outline into a canvas item using the fo .. rst-class:: classref-method -|void| **draw_multiline_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_multiline_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Breaks ``text`` into lines using rules specified by ``brk_flags`` and draws it into a canvas item using the font, at a given position, with ``modulate`` color, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -188,7 +188,7 @@ See also :ref:`CanvasItem.draw_multiline_string`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_multiline_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Breaks ``text`` to the lines using rules specified by ``brk_flags`` and draws text outline into a canvas item using the font, at a given position, with ``modulate`` color and ``size`` outline size, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -202,7 +202,7 @@ See also :ref:`CanvasItem.draw_multiline_string_outline`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Draw ``text`` into a canvas item using the font, at a given position, with ``modulate`` color, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -216,7 +216,7 @@ See also :ref:`CanvasItem.draw_string`. .. rst-class:: classref-method -|void| **draw_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +|void| **draw_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Draw ``text`` outline into a canvas item using the font, at a given position, with ``modulate`` color and ``size`` outline size, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -230,7 +230,7 @@ See also :ref:`CanvasItem.draw_string_outline` **find_variation**\ (\ variation_coordinates\: :ref:`Dictionary`, face_index\: :ref:`int` = 0, strength\: :ref:`float` = 0.0, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), spacing_top\: :ref:`int` = 0, spacing_bottom\: :ref:`int` = 0, spacing_space\: :ref:`int` = 0, spacing_glyph\: :ref:`int` = 0, baseline_offset\: :ref:`float` = 0.0\ ) |const| +:ref:`RID` **find_variation**\ (\ variation_coordinates\: :ref:`Dictionary`, face_index\: :ref:`int` = 0, strength\: :ref:`float` = 0.0, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), spacing_top\: :ref:`int` = 0, spacing_bottom\: :ref:`int` = 0, spacing_space\: :ref:`int` = 0, spacing_glyph\: :ref:`int` = 0, baseline_offset\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` Returns :ref:`TextServer` RID of the font cache for specific variation. @@ -242,7 +242,7 @@ Returns :ref:`TextServer` RID of the font cache for specific v .. rst-class:: classref-method -:ref:`float` **get_ascent**\ (\ font_size\: :ref:`int` = 16\ ) |const| +:ref:`float` **get_ascent**\ (\ font_size\: :ref:`int` = 16\ ) |const| :ref:`🔗` Returns the average font ascent (number of pixels above the baseline). @@ -256,7 +256,7 @@ Returns the average font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`Vector2` **get_char_size**\ (\ char\: :ref:`int`, font_size\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_char_size**\ (\ char\: :ref:`int`, font_size\: :ref:`int`\ ) |const| :ref:`🔗` Returns the size of a character. Does not take kerning into account. @@ -270,7 +270,7 @@ Returns the size of a character. Does not take kerning into account. .. rst-class:: classref-method -:ref:`float` **get_descent**\ (\ font_size\: :ref:`int` = 16\ ) |const| +:ref:`float` **get_descent**\ (\ font_size\: :ref:`int` = 16\ ) |const| :ref:`🔗` Returns the average font descent (number of pixels below the baseline). @@ -284,7 +284,7 @@ Returns the average font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`int` **get_face_count**\ (\ ) |const| +:ref:`int` **get_face_count**\ (\ ) |const| :ref:`🔗` Returns number of faces in the TrueType / OpenType collection. @@ -296,7 +296,7 @@ Returns number of faces in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`String` **get_font_name**\ (\ ) |const| +:ref:`String` **get_font_name**\ (\ ) |const| :ref:`🔗` Returns font family name. @@ -308,7 +308,7 @@ Returns font family name. .. rst-class:: classref-method -:ref:`int` **get_font_stretch**\ (\ ) |const| +:ref:`int` **get_font_stretch**\ (\ ) |const| :ref:`🔗` Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -320,7 +320,7 @@ Returns font stretch amount, compared to a normal width. A percentage value betw .. rst-class:: classref-method -|bitfield|\[:ref:`FontStyle`\] **get_font_style**\ (\ ) |const| +|bitfield|\[:ref:`FontStyle`\] **get_font_style**\ (\ ) |const| :ref:`🔗` Returns font style flags, see :ref:`FontStyle`. @@ -332,7 +332,7 @@ Returns font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -:ref:`String` **get_font_style_name**\ (\ ) |const| +:ref:`String` **get_font_style_name**\ (\ ) |const| :ref:`🔗` Returns font style name. @@ -344,7 +344,7 @@ Returns font style name. .. rst-class:: classref-method -:ref:`int` **get_font_weight**\ (\ ) |const| +:ref:`int` **get_font_weight**\ (\ ) |const| :ref:`🔗` Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -356,7 +356,7 @@ Returns weight (boldness) of the font. A value in the ``100...999`` range, norma .. rst-class:: classref-method -:ref:`float` **get_height**\ (\ font_size\: :ref:`int` = 16\ ) |const| +:ref:`float` **get_height**\ (\ font_size\: :ref:`int` = 16\ ) |const| :ref:`🔗` Returns the total average font height (ascent plus descent) in pixels. @@ -370,7 +370,7 @@ Returns the total average font height (ascent plus descent) in pixels. .. rst-class:: classref-method -:ref:`Vector2` **get_multiline_string_size**\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +:ref:`Vector2` **get_multiline_string_size**\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. @@ -384,7 +384,7 @@ See also :ref:`draw_multiline_string`. .. rst-class:: classref-method -:ref:`Dictionary` **get_opentype_features**\ (\ ) |const| +:ref:`Dictionary` **get_opentype_features**\ (\ ) |const| :ref:`🔗` Returns a set of OpenType feature tags. More info: `OpenType feature tags `__. @@ -396,7 +396,7 @@ Returns a set of OpenType feature tags. More info: `OpenType feature tags ` **get_ot_name_strings**\ (\ ) |const| +:ref:`Dictionary` **get_ot_name_strings**\ (\ ) |const| :ref:`🔗` Returns :ref:`Dictionary` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). @@ -408,7 +408,7 @@ Returns :ref:`Dictionary` with OpenType font name strings (loc .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **get_rids**\ (\ ) |const| +:ref:`Array`\[:ref:`RID`\] **get_rids**\ (\ ) |const| :ref:`🔗` Returns :ref:`Array` of valid **Font** :ref:`RID`\ s, which can be passed to the :ref:`TextServer` methods. @@ -420,7 +420,7 @@ Returns :ref:`Array` of valid **Font** :ref:`RID`\ s, wh .. rst-class:: classref-method -:ref:`int` **get_spacing**\ (\ spacing\: :ref:`SpacingType`\ ) |const| +:ref:`int` **get_spacing**\ (\ spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` Returns the spacing for the given ``type`` (see :ref:`SpacingType`). @@ -432,7 +432,7 @@ Returns the spacing for the given ``type`` (see :ref:`SpacingType` **get_string_size**\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| +:ref:`Vector2` **get_string_size**\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| :ref:`🔗` Returns the size of a bounding box of a single-line string, taking kerning, advance and subpixel positioning into account. See also :ref:`get_multiline_string_size` and :ref:`draw_string`. @@ -464,7 +464,7 @@ For example, to get the string size as displayed by a single-line Label, use: .. rst-class:: classref-method -:ref:`String` **get_supported_chars**\ (\ ) |const| +:ref:`String` **get_supported_chars**\ (\ ) |const| :ref:`🔗` Returns a string containing all the characters available in the font. @@ -478,7 +478,7 @@ If a given character is included in more than one font data source, it appears o .. rst-class:: classref-method -:ref:`Dictionary` **get_supported_feature_list**\ (\ ) |const| +:ref:`Dictionary` **get_supported_feature_list**\ (\ ) |const| :ref:`🔗` Returns list of OpenType features supported by font. @@ -490,7 +490,7 @@ Returns list of OpenType features supported by font. .. rst-class:: classref-method -:ref:`Dictionary` **get_supported_variation_list**\ (\ ) |const| +:ref:`Dictionary` **get_supported_variation_list**\ (\ ) |const| :ref:`🔗` Returns list of supported `variation coordinates `__, each coordinate is returned as ``tag: Vector3i(min_value,max_value,default_value)``. @@ -518,7 +518,7 @@ To print available variation axes of a variable font: .. rst-class:: classref-method -:ref:`float` **get_underline_position**\ (\ font_size\: :ref:`int` = 16\ ) |const| +:ref:`float` **get_underline_position**\ (\ font_size\: :ref:`int` = 16\ ) |const| :ref:`🔗` Returns average pixel offset of the underline below the baseline. @@ -532,7 +532,7 @@ Returns average pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_underline_thickness**\ (\ font_size\: :ref:`int` = 16\ ) |const| +:ref:`float` **get_underline_thickness**\ (\ font_size\: :ref:`int` = 16\ ) |const| :ref:`🔗` Returns average thickness of the underline. @@ -546,7 +546,7 @@ Returns average thickness of the underline. .. rst-class:: classref-method -:ref:`bool` **has_char**\ (\ char\: :ref:`int`\ ) |const| +:ref:`bool` **has_char**\ (\ char\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if a Unicode ``char`` is available in the font. @@ -558,7 +558,7 @@ Returns ``true`` if a Unicode ``char`` is available in the font. .. rst-class:: classref-method -:ref:`bool` **is_language_supported**\ (\ language\: :ref:`String`\ ) |const| +:ref:`bool` **is_language_supported**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true``, if font supports given language (`ISO 639 `__ code). @@ -570,7 +570,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **is_script_supported**\ (\ script\: :ref:`String`\ ) |const| +:ref:`bool` **is_script_supported**\ (\ script\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true``, if font supports given script (`ISO 15924 `__ code). @@ -582,7 +582,7 @@ Returns ``true``, if font supports given script (`ISO 15924 `, multi_line\: :ref:`int`\ ) +|void| **set_cache_capacity**\ (\ single_line\: :ref:`int`, multi_line\: :ref:`int`\ ) :ref:`🔗` Sets LRU cache capacity for ``draw_*`` methods. diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index 32c1bac8ba0..740083a768b 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -270,7 +270,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_system_fallback** = ``true`` +:ref:`bool` **allow_system_fallback** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -287,7 +287,7 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-property -:ref:`FontAntialiasing` **antialiasing** = ``1`` +:ref:`FontAntialiasing` **antialiasing** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ Font anti-aliasing mode. .. rst-class:: classref-property -:ref:`PackedByteArray` **data** = ``PackedByteArray()`` +:ref:`PackedByteArray` **data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ Contents of the dynamic font source file. .. rst-class:: classref-property -:ref:`bool` **disable_embedded_bitmaps** = ``true`` +:ref:`bool` **disable_embedded_bitmaps** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and co .. rst-class:: classref-property -:ref:`int` **fixed_size** = ``0`` +:ref:`int` **fixed_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -357,7 +357,7 @@ Font size, used only for the bitmap fonts. .. rst-class:: classref-property -:ref:`FixedSizeScaleMode` **fixed_size_scale_mode** = ``0`` +:ref:`FixedSizeScaleMode` **fixed_size_scale_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -374,7 +374,7 @@ Scaling mode, used only for the bitmap fonts with :ref:`fixed_size` **font_name** = ``""`` +:ref:`String` **font_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -391,7 +391,7 @@ Font family name. .. rst-class:: classref-property -:ref:`int` **font_stretch** = ``100`` +:ref:`int` **font_stretch** = ``100`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -408,7 +408,7 @@ Font stretch amount, compared to a normal width. A percentage value between ``50 .. rst-class:: classref-property -|bitfield|\[:ref:`FontStyle`\] **font_style** = ``0`` +|bitfield|\[:ref:`FontStyle`\] **font_style** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -425,7 +425,7 @@ Font style flags, see :ref:`FontStyle`. .. rst-class:: classref-property -:ref:`int` **font_weight** = ``400`` +:ref:`int` **font_weight** = ``400`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -442,7 +442,7 @@ Weight (boldness) of the font. A value in the ``100...999`` range, normal font w .. rst-class:: classref-property -:ref:`bool` **force_autohinter** = ``false`` +:ref:`bool` **force_autohinter** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -459,7 +459,7 @@ If set to ``true``, auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-property -:ref:`bool` **generate_mipmaps** = ``false`` +:ref:`bool` **generate_mipmaps** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -476,7 +476,7 @@ If set to ``true``, generate mipmaps for the font textures. .. rst-class:: classref-property -:ref:`Hinting` **hinting** = ``1`` +:ref:`Hinting` **hinting** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -493,7 +493,7 @@ Font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-property -:ref:`int` **msdf_pixel_range** = ``16`` +:ref:`int` **msdf_pixel_range** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -510,7 +510,7 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property -:ref:`int` **msdf_size** = ``48`` +:ref:`int` **msdf_size** = ``48`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -527,7 +527,7 @@ Source font size used to generate MSDF textures. Higher values allow for more pr .. rst-class:: classref-property -:ref:`bool` **multichannel_signed_distance_field** = ``false`` +:ref:`bool` **multichannel_signed_distance_field** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -548,7 +548,7 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-property -:ref:`Dictionary` **opentype_feature_overrides** = ``{}`` +:ref:`Dictionary` **opentype_feature_overrides** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -565,7 +565,7 @@ Font OpenType feature set override. .. rst-class:: classref-property -:ref:`float` **oversampling** = ``0.0`` +:ref:`float` **oversampling** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -582,7 +582,7 @@ Font oversampling factor. If set to ``0.0``, the global oversampling factor is u .. rst-class:: classref-property -:ref:`String` **style_name** = ``""`` +:ref:`String` **style_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -599,7 +599,7 @@ Font style name. .. rst-class:: classref-property -:ref:`SubpixelPositioning` **subpixel_positioning** = ``1`` +:ref:`SubpixelPositioning` **subpixel_positioning** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -621,7 +621,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_cache**\ (\ ) +|void| **clear_cache**\ (\ ) :ref:`🔗` Removes all font cache entries. @@ -633,7 +633,7 @@ Removes all font cache entries. .. rst-class:: classref-method -|void| **clear_glyphs**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) +|void| **clear_glyphs**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Removes all rendered glyph information from the cache entry. @@ -647,7 +647,7 @@ Removes all rendered glyph information from the cache entry. .. rst-class:: classref-method -|void| **clear_kerning_map**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) +|void| **clear_kerning_map**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` Removes all kerning overrides. @@ -659,7 +659,7 @@ Removes all kerning overrides. .. rst-class:: classref-method -|void| **clear_size_cache**\ (\ cache_index\: :ref:`int`\ ) +|void| **clear_size_cache**\ (\ cache_index\: :ref:`int`\ ) :ref:`🔗` Removes all font sizes from the cache entry @@ -671,7 +671,7 @@ Removes all font sizes from the cache entry .. rst-class:: classref-method -|void| **clear_textures**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) +|void| **clear_textures**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Removes all textures from font cache entry. @@ -685,7 +685,7 @@ Removes all textures from font cache entry. .. rst-class:: classref-method -:ref:`float` **get_cache_ascent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| +:ref:`float` **get_cache_ascent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns the font ascent (number of pixels above the baseline). @@ -697,7 +697,7 @@ Returns the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`int` **get_cache_count**\ (\ ) |const| +:ref:`int` **get_cache_count**\ (\ ) |const| :ref:`🔗` Returns number of the font cache entries. @@ -709,7 +709,7 @@ Returns number of the font cache entries. .. rst-class:: classref-method -:ref:`float` **get_cache_descent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| +:ref:`float` **get_cache_descent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns the font descent (number of pixels below the baseline). @@ -721,7 +721,7 @@ Returns the font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`float` **get_cache_scale**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| +:ref:`float` **get_cache_scale**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns scaling factor of the color bitmap font. @@ -733,7 +733,7 @@ Returns scaling factor of the color bitmap font. .. rst-class:: classref-method -:ref:`float` **get_cache_underline_position**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| +:ref:`float` **get_cache_underline_position**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns pixel offset of the underline below the baseline. @@ -745,7 +745,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_cache_underline_thickness**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| +:ref:`float` **get_cache_underline_thickness**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns thickness of the underline in pixels. @@ -757,7 +757,7 @@ Returns thickness of the underline in pixels. .. rst-class:: classref-method -:ref:`int` **get_char_from_glyph_index**\ (\ size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| +:ref:`int` **get_char_from_glyph_index**\ (\ size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`get_glyph_index`. @@ -769,7 +769,7 @@ Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_inde .. rst-class:: classref-method -:ref:`float` **get_embolden**\ (\ cache_index\: :ref:`int`\ ) |const| +:ref:`float` **get_embolden**\ (\ cache_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -781,7 +781,7 @@ Returns embolden strength, if is not equal to zero, emboldens the font outlines. .. rst-class:: classref-method -:ref:`float` **get_extra_baseline_offset**\ (\ cache_index\: :ref:`int`\ ) |const| +:ref:`float` **get_extra_baseline_offset**\ (\ cache_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns extra baseline offset (as a fraction of font height). @@ -793,7 +793,7 @@ Returns extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -:ref:`int` **get_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`\ ) |const| +:ref:`int` **get_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` Returns spacing for ``spacing`` (see :ref:`SpacingType`) in pixels (not relative to the font size). @@ -805,7 +805,7 @@ Returns spacing for ``spacing`` (see :ref:`SpacingType` **get_face_index**\ (\ cache_index\: :ref:`int`\ ) |const| +:ref:`int` **get_face_index**\ (\ cache_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns an active face index in the TrueType / OpenType collection. @@ -817,7 +817,7 @@ Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`Vector2` **get_glyph_advance**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_glyph_advance**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns glyph advance (offset of the next glyph). @@ -831,7 +831,7 @@ Returns glyph advance (offset of the next glyph). .. rst-class:: classref-method -:ref:`int` **get_glyph_index**\ (\ size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| +:ref:`int` **get_glyph_index**\ (\ size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| :ref:`🔗` Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. @@ -843,7 +843,7 @@ Returns the glyph index of a ``char``, optionally modified by the ``variation_se .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_glyph_list**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| +:ref:`PackedInt32Array` **get_glyph_list**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns list of rendered glyphs in the cache entry. @@ -855,7 +855,7 @@ Returns list of rendered glyphs in the cache entry. .. rst-class:: classref-method -:ref:`Vector2` **get_glyph_offset**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_glyph_offset**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns glyph offset from the baseline. @@ -867,7 +867,7 @@ Returns glyph offset from the baseline. .. rst-class:: classref-method -:ref:`Vector2` **get_glyph_size**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_glyph_size**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns glyph size. @@ -879,7 +879,7 @@ Returns glyph size. .. rst-class:: classref-method -:ref:`int` **get_glyph_texture_idx**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`int` **get_glyph_texture_idx**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns index of the cache texture containing the glyph. @@ -891,7 +891,7 @@ Returns index of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Rect2` **get_glyph_uv_rect**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Rect2` **get_glyph_uv_rect**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns rectangle in the cache texture containing the glyph. @@ -903,7 +903,7 @@ Returns rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Vector2` **get_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2` **get_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns kerning for the pair of glyphs. @@ -915,7 +915,7 @@ Returns kerning for the pair of glyphs. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_kerning_list**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_kerning_list**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns list of the kerning overrides. @@ -927,7 +927,7 @@ Returns list of the kerning overrides. .. rst-class:: classref-method -:ref:`bool` **get_language_support_override**\ (\ language\: :ref:`String`\ ) |const| +:ref:`bool` **get_language_support_override**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if support override is enabled for the ``language``. @@ -939,7 +939,7 @@ Returns ``true`` if support override is enabled for the ``language``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_language_support_overrides**\ (\ ) |const| +:ref:`PackedStringArray` **get_language_support_overrides**\ (\ ) |const| :ref:`🔗` Returns list of language support overrides. @@ -951,7 +951,7 @@ Returns list of language support overrides. .. rst-class:: classref-method -:ref:`bool` **get_script_support_override**\ (\ script\: :ref:`String`\ ) |const| +:ref:`bool` **get_script_support_override**\ (\ script\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if support override is enabled for the ``script``. @@ -963,7 +963,7 @@ Returns ``true`` if support override is enabled for the ``script``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_script_support_overrides**\ (\ ) |const| +:ref:`PackedStringArray` **get_script_support_overrides**\ (\ ) |const| :ref:`🔗` Returns list of script support overrides. @@ -975,7 +975,7 @@ Returns list of script support overrides. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_size_cache_list**\ (\ cache_index\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_size_cache_list**\ (\ cache_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` with font size and outline size. @@ -987,7 +987,7 @@ Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` **get_texture_count**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_texture_count**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns number of textures used by font cache entry. @@ -999,7 +999,7 @@ Returns number of textures used by font cache entry. .. rst-class:: classref-method -:ref:`Image` **get_texture_image**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| +:ref:`Image` **get_texture_image**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns a copy of the font cache texture image. @@ -1011,7 +1011,7 @@ Returns a copy of the font cache texture image. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_texture_offsets**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_texture_offsets**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns a copy of the array containing glyph packing data. @@ -1023,7 +1023,7 @@ Returns a copy of the array containing glyph packing data. .. rst-class:: classref-method -:ref:`Transform2D` **get_transform**\ (\ cache_index\: :ref:`int`\ ) |const| +:ref:`Transform2D` **get_transform**\ (\ cache_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. @@ -1035,7 +1035,7 @@ Returns 2D transform, applied to the font outlines, can be used for slanting, fl .. rst-class:: classref-method -:ref:`Dictionary` **get_variation_coordinates**\ (\ cache_index\: :ref:`int`\ ) |const| +:ref:`Dictionary` **get_variation_coordinates**\ (\ cache_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns variation coordinates for the specified font cache entry. See :ref:`Font.get_supported_variation_list` for more info. @@ -1047,7 +1047,7 @@ Returns variation coordinates for the specified font cache entry. See :ref:`Font .. rst-class:: classref-method -:ref:`Error` **load_bitmap_font**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load_bitmap_font**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads an AngelCode BMFont (.fnt, .font) bitmap font from file ``path``. @@ -1061,7 +1061,7 @@ Loads an AngelCode BMFont (.fnt, .font) bitmap font from file ``path``. .. rst-class:: classref-method -:ref:`Error` **load_dynamic_font**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load_dynamic_font**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file ``path``. @@ -1075,7 +1075,7 @@ Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 .. rst-class:: classref-method -|void| **remove_cache**\ (\ cache_index\: :ref:`int`\ ) +|void| **remove_cache**\ (\ cache_index\: :ref:`int`\ ) :ref:`🔗` Removes specified font cache entry. @@ -1087,7 +1087,7 @@ Removes specified font cache entry. .. rst-class:: classref-method -|void| **remove_glyph**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) +|void| **remove_glyph**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) :ref:`🔗` Removes specified rendered glyph information from the cache entry. @@ -1101,7 +1101,7 @@ Removes specified rendered glyph information from the cache entry. .. rst-class:: classref-method -|void| **remove_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) +|void| **remove_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) :ref:`🔗` Removes kerning override for the pair of glyphs. @@ -1113,7 +1113,7 @@ Removes kerning override for the pair of glyphs. .. rst-class:: classref-method -|void| **remove_language_support_override**\ (\ language\: :ref:`String`\ ) +|void| **remove_language_support_override**\ (\ language\: :ref:`String`\ ) :ref:`🔗` Remove language support override. @@ -1125,7 +1125,7 @@ Remove language support override. .. rst-class:: classref-method -|void| **remove_script_support_override**\ (\ script\: :ref:`String`\ ) +|void| **remove_script_support_override**\ (\ script\: :ref:`String`\ ) :ref:`🔗` Removes script support override. @@ -1137,7 +1137,7 @@ Removes script support override. .. rst-class:: classref-method -|void| **remove_size_cache**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) +|void| **remove_size_cache**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Removes specified font size from the cache entry. @@ -1149,7 +1149,7 @@ Removes specified font size from the cache entry. .. rst-class:: classref-method -|void| **remove_texture**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) +|void| **remove_texture**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) :ref:`🔗` Removes specified texture from the cache entry. @@ -1163,7 +1163,7 @@ Removes specified texture from the cache entry. .. rst-class:: classref-method -|void| **render_glyph**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) +|void| **render_glyph**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) :ref:`🔗` Renders specified glyph to the font cache texture. @@ -1175,7 +1175,7 @@ Renders specified glyph to the font cache texture. .. rst-class:: classref-method -|void| **render_range**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) +|void| **render_range**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) :ref:`🔗` Renders the range of characters to the font cache texture. @@ -1187,7 +1187,7 @@ Renders the range of characters to the font cache texture. .. rst-class:: classref-method -|void| **set_cache_ascent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, ascent\: :ref:`float`\ ) +|void| **set_cache_ascent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, ascent\: :ref:`float`\ ) :ref:`🔗` Sets the font ascent (number of pixels above the baseline). @@ -1199,7 +1199,7 @@ Sets the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -|void| **set_cache_descent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, descent\: :ref:`float`\ ) +|void| **set_cache_descent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, descent\: :ref:`float`\ ) :ref:`🔗` Sets the font descent (number of pixels below the baseline). @@ -1211,7 +1211,7 @@ Sets the font descent (number of pixels below the baseline). .. rst-class:: classref-method -|void| **set_cache_scale**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, scale\: :ref:`float`\ ) +|void| **set_cache_scale**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, scale\: :ref:`float`\ ) :ref:`🔗` Sets scaling factor of the color bitmap font. @@ -1223,7 +1223,7 @@ Sets scaling factor of the color bitmap font. .. rst-class:: classref-method -|void| **set_cache_underline_position**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) +|void| **set_cache_underline_position**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) :ref:`🔗` Sets pixel offset of the underline below the baseline. @@ -1235,7 +1235,7 @@ Sets pixel offset of the underline below the baseline. .. rst-class:: classref-method -|void| **set_cache_underline_thickness**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) +|void| **set_cache_underline_thickness**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) :ref:`🔗` Sets thickness of the underline in pixels. @@ -1247,7 +1247,7 @@ Sets thickness of the underline in pixels. .. rst-class:: classref-method -|void| **set_embolden**\ (\ cache_index\: :ref:`int`, strength\: :ref:`float`\ ) +|void| **set_embolden**\ (\ cache_index\: :ref:`int`, strength\: :ref:`float`\ ) :ref:`🔗` Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -1259,7 +1259,7 @@ Sets embolden strength, if is not equal to zero, emboldens the font outlines. Ne .. rst-class:: classref-method -|void| **set_extra_baseline_offset**\ (\ cache_index\: :ref:`int`, baseline_offset\: :ref:`float`\ ) +|void| **set_extra_baseline_offset**\ (\ cache_index\: :ref:`int`, baseline_offset\: :ref:`float`\ ) :ref:`🔗` Sets extra baseline offset (as a fraction of font height). @@ -1271,7 +1271,7 @@ Sets extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -|void| **set_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +|void| **set_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). @@ -1283,7 +1283,7 @@ Sets the spacing for ``spacing`` (see :ref:`SpacingType`, face_index\: :ref:`int`\ ) +|void| **set_face_index**\ (\ cache_index\: :ref:`int`, face_index\: :ref:`int`\ ) :ref:`🔗` Sets an active face index in the TrueType / OpenType collection. @@ -1295,7 +1295,7 @@ Sets an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -|void| **set_glyph_advance**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) +|void| **set_glyph_advance**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) :ref:`🔗` Sets glyph advance (offset of the next glyph). @@ -1309,7 +1309,7 @@ Sets glyph advance (offset of the next glyph). .. rst-class:: classref-method -|void| **set_glyph_offset**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) +|void| **set_glyph_offset**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) :ref:`🔗` Sets glyph offset from the baseline. @@ -1321,7 +1321,7 @@ Sets glyph offset from the baseline. .. rst-class:: classref-method -|void| **set_glyph_size**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) +|void| **set_glyph_size**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) :ref:`🔗` Sets glyph size. @@ -1333,7 +1333,7 @@ Sets glyph size. .. rst-class:: classref-method -|void| **set_glyph_texture_idx**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) +|void| **set_glyph_texture_idx**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) :ref:`🔗` Sets index of the cache texture containing the glyph. @@ -1345,7 +1345,7 @@ Sets index of the cache texture containing the glyph. .. rst-class:: classref-method -|void| **set_glyph_uv_rect**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) +|void| **set_glyph_uv_rect**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) :ref:`🔗` Sets rectangle in the cache texture containing the glyph. @@ -1357,7 +1357,7 @@ Sets rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -|void| **set_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) +|void| **set_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) :ref:`🔗` Sets kerning for the pair of glyphs. @@ -1369,7 +1369,7 @@ Sets kerning for the pair of glyphs. .. rst-class:: classref-method -|void| **set_language_support_override**\ (\ language\: :ref:`String`, supported\: :ref:`bool`\ ) +|void| **set_language_support_override**\ (\ language\: :ref:`String`, supported\: :ref:`bool`\ ) :ref:`🔗` Adds override for :ref:`Font.is_language_supported`. @@ -1381,7 +1381,7 @@ Adds override for :ref:`Font.is_language_supported`, supported\: :ref:`bool`\ ) +|void| **set_script_support_override**\ (\ script\: :ref:`String`, supported\: :ref:`bool`\ ) :ref:`🔗` Adds override for :ref:`Font.is_script_supported`. @@ -1393,7 +1393,7 @@ Adds override for :ref:`Font.is_script_supported`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) +|void| **set_texture_image**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) :ref:`🔗` Sets font cache texture image. @@ -1405,7 +1405,7 @@ Sets font cache texture image. .. rst-class:: classref-method -|void| **set_texture_offsets**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) +|void| **set_texture_offsets**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Sets array containing glyph packing data. @@ -1417,7 +1417,7 @@ Sets array containing glyph packing data. .. rst-class:: classref-method -|void| **set_transform**\ (\ cache_index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **set_transform**\ (\ cache_index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. @@ -1429,7 +1429,7 @@ Sets 2D transform, applied to the font outlines, can be used for slanting, flipp .. rst-class:: classref-method -|void| **set_variation_coordinates**\ (\ cache_index\: :ref:`int`, variation_coordinates\: :ref:`Dictionary`\ ) +|void| **set_variation_coordinates**\ (\ cache_index\: :ref:`int`, variation_coordinates\: :ref:`Dictionary`\ ) :ref:`🔗` Sets variation coordinates for the specified font cache entry. See :ref:`Font.get_supported_variation_list` for more info. diff --git a/classes/class_fontvariation.rst b/classes/class_fontvariation.rst index 224e9d10417..ea7a927b185 100644 --- a/classes/class_fontvariation.rst +++ b/classes/class_fontvariation.rst @@ -110,7 +110,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Font` **base_font** +:ref:`Font` **base_font** :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ Base font used to create a variation. If not set, default :ref:`Theme` **baseline_offset** = ``0.0`` +:ref:`float` **baseline_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ Extra baseline offset (as a fraction of font height). .. rst-class:: classref-property -:ref:`Dictionary` **opentype_features** = ``{}`` +:ref:`Dictionary` **opentype_features** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ A set of OpenType feature tags. More info: `OpenType feature tags ` **spacing_bottom** = ``0`` +:ref:`int` **spacing_bottom** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ Extra spacing at the bottom of the line in pixels. .. rst-class:: classref-property -:ref:`int` **spacing_glyph** = ``0`` +:ref:`int` **spacing_glyph** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ Extra spacing between graphical glyphs. .. rst-class:: classref-property -:ref:`int` **spacing_space** = ``0`` +:ref:`int` **spacing_space** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ Extra width of the space glyphs. .. rst-class:: classref-property -:ref:`int` **spacing_top** = ``0`` +:ref:`int` **spacing_top** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -229,7 +229,7 @@ Extra spacing at the top of the line in pixels. .. rst-class:: classref-property -:ref:`float` **variation_embolden** = ``0.0`` +:ref:`float` **variation_embolden** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -248,7 +248,7 @@ If is not equal to zero, emboldens the font outlines. Negative values reduce the .. rst-class:: classref-property -:ref:`int` **variation_face_index** = ``0`` +:ref:`int` **variation_face_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -265,7 +265,7 @@ Active face index in the TrueType / OpenType collection file. .. rst-class:: classref-property -:ref:`Dictionary` **variation_opentype** = ``{}`` +:ref:`Dictionary` **variation_opentype** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -286,7 +286,7 @@ Font OpenType variation coordinates. More info: `OpenType variation tags ` **variation_transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` +:ref:`Transform2D` **variation_transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -310,7 +310,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +|void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). diff --git a/classes/class_framebuffercacherd.rst b/classes/class_framebuffercacherd.rst index 3aca1a4feb0..41ee705a756 100644 --- a/classes/class_framebuffercacherd.rst +++ b/classes/class_framebuffercacherd.rst @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_cache_multipass**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], views\: :ref:`int`\ ) |static| +:ref:`RID` **get_cache_multipass**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], views\: :ref:`int`\ ) |static| :ref:`🔗` Creates, or obtains a cached, framebuffer. ``textures`` lists textures accessed. ``passes`` defines the subpasses and texture allocation, if left empty a single pass is created and textures are allocated depending on their usage flags. ``views`` defines the number of views used when rendering. diff --git a/classes/class_gdextension.rst b/classes/class_gdextension.rst index f98cf4850a1..3015d96c576 100644 --- a/classes/class_gdextension.rst +++ b/classes/class_gdextension.rst @@ -59,7 +59,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **InitializationLevel**: +enum **InitializationLevel**: :ref:`🔗` .. _class_GDExtension_constant_INITIALIZATION_LEVEL_CORE: @@ -106,7 +106,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`InitializationLevel` **get_minimum_library_initialization_level**\ (\ ) |const| +:ref:`InitializationLevel` **get_minimum_library_initialization_level**\ (\ ) |const| :ref:`🔗` Returns the lowest level required for this extension to be properly initialized (see the :ref:`InitializationLevel` enum). @@ -118,7 +118,7 @@ Returns the lowest level required for this extension to be properly initialized .. rst-class:: classref-method -:ref:`bool` **is_library_open**\ (\ ) |const| +:ref:`bool` **is_library_open**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this extension's library has been opened. diff --git a/classes/class_gdextensionmanager.rst b/classes/class_gdextensionmanager.rst index 4f42fbcef72..406d574613b 100644 --- a/classes/class_gdextensionmanager.rst +++ b/classes/class_gdextensionmanager.rst @@ -67,7 +67,7 @@ Signals .. rst-class:: classref-signal -**extensions_reloaded**\ (\ ) +**extensions_reloaded**\ (\ ) :ref:`🔗` Emitted after the editor has finished reloading one or more extensions. @@ -84,7 +84,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **LoadStatus**: +enum **LoadStatus**: :ref:`🔗` .. _class_GDExtensionManager_constant_LOAD_STATUS_OK: @@ -139,7 +139,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GDExtension` **get_extension**\ (\ path\: :ref:`String`\ ) +:ref:`GDExtension` **get_extension**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns the :ref:`GDExtension` at the given file ``path``, or ``null`` if it has not been loaded or does not exist. @@ -151,7 +151,7 @@ Returns the :ref:`GDExtension` at the given file ``path``, or .. rst-class:: classref-method -:ref:`PackedStringArray` **get_loaded_extensions**\ (\ ) |const| +:ref:`PackedStringArray` **get_loaded_extensions**\ (\ ) |const| :ref:`🔗` Returns the file paths of all currently loaded extensions. @@ -163,7 +163,7 @@ Returns the file paths of all currently loaded extensions. .. rst-class:: classref-method -:ref:`bool` **is_extension_loaded**\ (\ path\: :ref:`String`\ ) |const| +:ref:`bool` **is_extension_loaded**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the extension at the given file ``path`` has already been loaded successfully. See also :ref:`get_loaded_extensions`. @@ -175,7 +175,7 @@ Returns ``true`` if the extension at the given file ``path`` has already been lo .. rst-class:: classref-method -:ref:`LoadStatus` **load_extension**\ (\ path\: :ref:`String`\ ) +:ref:`LoadStatus` **load_extension**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads an extension by absolute file path. The ``path`` needs to point to a valid :ref:`GDExtension`. Returns :ref:`LOAD_STATUS_OK` if successful. @@ -187,7 +187,7 @@ Loads an extension by absolute file path. The ``path`` needs to point to a valid .. rst-class:: classref-method -:ref:`LoadStatus` **reload_extension**\ (\ path\: :ref:`String`\ ) +:ref:`LoadStatus` **reload_extension**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Reloads the extension at the given file path. The ``path`` needs to point to a valid :ref:`GDExtension`, otherwise this method may return either :ref:`LOAD_STATUS_NOT_LOADED` or :ref:`LOAD_STATUS_FAILED`. @@ -201,7 +201,7 @@ Reloads the extension at the given file path. The ``path`` needs to point to a v .. rst-class:: classref-method -:ref:`LoadStatus` **unload_extension**\ (\ path\: :ref:`String`\ ) +:ref:`LoadStatus` **unload_extension**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Unloads an extension by file path. The ``path`` needs to point to an already loaded :ref:`GDExtension`, otherwise this method returns :ref:`LOAD_STATUS_NOT_LOADED`. diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 81947a285d9..60934044fcb 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **new**\ (\ ...\ ) |vararg| +:ref:`Variant` **new**\ (\ ...\ ) |vararg| :ref:`🔗` Returns a new instance of the script. diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index e8d7e1e1208..d87439736f3 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -248,7 +248,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Param**: +enum **Param**: :ref:`🔗` .. _class_Generic6DOFJoint3D_constant_PARAM_LINEAR_LOWER_LIMIT: @@ -466,7 +466,7 @@ Represents the size of the :ref:`Param` enum. .. rst-class:: classref-enumeration -enum **Flag**: +enum **Flag**: :ref:`🔗` .. _class_Generic6DOFJoint3D_constant_FLAG_ENABLE_LINEAR_LIMIT: @@ -545,7 +545,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_limit_x/damping** = ``1.0`` +:ref:`float` **angular_limit_x/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -564,7 +564,7 @@ The lower, the longer an impulse from one side takes to travel to the other side .. rst-class:: classref-property -:ref:`bool` **angular_limit_x/enabled** = ``true`` +:ref:`bool` **angular_limit_x/enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -581,7 +581,7 @@ If ``true``, rotation across the X axis is limited. .. rst-class:: classref-property -:ref:`float` **angular_limit_x/erp** = ``0.5`` +:ref:`float` **angular_limit_x/erp** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -598,7 +598,7 @@ When rotating across the X axis, this error tolerance factor defines how much th .. rst-class:: classref-property -:ref:`float` **angular_limit_x/force_limit** = ``0.0`` +:ref:`float` **angular_limit_x/force_limit** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -615,7 +615,7 @@ The maximum amount of force that can occur, when rotating around the X axis. .. rst-class:: classref-property -:ref:`float` **angular_limit_x/lower_angle** = ``0.0`` +:ref:`float` **angular_limit_x/lower_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -632,7 +632,7 @@ The minimum rotation in negative direction to break loose and rotate around the .. rst-class:: classref-property -:ref:`float` **angular_limit_x/restitution** = ``0.0`` +:ref:`float` **angular_limit_x/restitution** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -649,7 +649,7 @@ The amount of rotational restitution across the X axis. The lower, the more rest .. rst-class:: classref-property -:ref:`float` **angular_limit_x/softness** = ``0.5`` +:ref:`float` **angular_limit_x/softness** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -666,7 +666,7 @@ The speed of all rotations across the X axis. .. rst-class:: classref-property -:ref:`float` **angular_limit_x/upper_angle** = ``0.0`` +:ref:`float` **angular_limit_x/upper_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -683,7 +683,7 @@ The minimum rotation in positive direction to break loose and rotate around the .. rst-class:: classref-property -:ref:`float` **angular_limit_y/damping** = ``1.0`` +:ref:`float` **angular_limit_y/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -700,7 +700,7 @@ The amount of rotational damping across the Y axis. The lower, the more damping .. rst-class:: classref-property -:ref:`bool` **angular_limit_y/enabled** = ``true`` +:ref:`bool` **angular_limit_y/enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -717,7 +717,7 @@ If ``true``, rotation across the Y axis is limited. .. rst-class:: classref-property -:ref:`float` **angular_limit_y/erp** = ``0.5`` +:ref:`float` **angular_limit_y/erp** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -734,7 +734,7 @@ When rotating across the Y axis, this error tolerance factor defines how much th .. rst-class:: classref-property -:ref:`float` **angular_limit_y/force_limit** = ``0.0`` +:ref:`float` **angular_limit_y/force_limit** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -751,7 +751,7 @@ The maximum amount of force that can occur, when rotating around the Y axis. .. rst-class:: classref-property -:ref:`float` **angular_limit_y/lower_angle** = ``0.0`` +:ref:`float` **angular_limit_y/lower_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -768,7 +768,7 @@ The minimum rotation in negative direction to break loose and rotate around the .. rst-class:: classref-property -:ref:`float` **angular_limit_y/restitution** = ``0.0`` +:ref:`float` **angular_limit_y/restitution** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -785,7 +785,7 @@ The amount of rotational restitution across the Y axis. The lower, the more rest .. rst-class:: classref-property -:ref:`float` **angular_limit_y/softness** = ``0.5`` +:ref:`float` **angular_limit_y/softness** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -802,7 +802,7 @@ The speed of all rotations across the Y axis. .. rst-class:: classref-property -:ref:`float` **angular_limit_y/upper_angle** = ``0.0`` +:ref:`float` **angular_limit_y/upper_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -819,7 +819,7 @@ The minimum rotation in positive direction to break loose and rotate around the .. rst-class:: classref-property -:ref:`float` **angular_limit_z/damping** = ``1.0`` +:ref:`float` **angular_limit_z/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -836,7 +836,7 @@ The amount of rotational damping across the Z axis. The lower, the more damping .. rst-class:: classref-property -:ref:`bool` **angular_limit_z/enabled** = ``true`` +:ref:`bool` **angular_limit_z/enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -853,7 +853,7 @@ If ``true``, rotation across the Z axis is limited. .. rst-class:: classref-property -:ref:`float` **angular_limit_z/erp** = ``0.5`` +:ref:`float` **angular_limit_z/erp** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -870,7 +870,7 @@ When rotating across the Z axis, this error tolerance factor defines how much th .. rst-class:: classref-property -:ref:`float` **angular_limit_z/force_limit** = ``0.0`` +:ref:`float` **angular_limit_z/force_limit** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -887,7 +887,7 @@ The maximum amount of force that can occur, when rotating around the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_limit_z/lower_angle** = ``0.0`` +:ref:`float` **angular_limit_z/lower_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -904,7 +904,7 @@ The minimum rotation in negative direction to break loose and rotate around the .. rst-class:: classref-property -:ref:`float` **angular_limit_z/restitution** = ``0.0`` +:ref:`float` **angular_limit_z/restitution** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -921,7 +921,7 @@ The amount of rotational restitution across the Z axis. The lower, the more rest .. rst-class:: classref-property -:ref:`float` **angular_limit_z/softness** = ``0.5`` +:ref:`float` **angular_limit_z/softness** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -938,7 +938,7 @@ The speed of all rotations across the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_limit_z/upper_angle** = ``0.0`` +:ref:`float` **angular_limit_z/upper_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -955,7 +955,7 @@ The minimum rotation in positive direction to break loose and rotate around the .. rst-class:: classref-property -:ref:`bool` **angular_motor_x/enabled** = ``false`` +:ref:`bool` **angular_motor_x/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -972,7 +972,7 @@ If ``true``, a rotating motor at the X axis is enabled. .. rst-class:: classref-property -:ref:`float` **angular_motor_x/force_limit** = ``300.0`` +:ref:`float` **angular_motor_x/force_limit** = ``300.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -989,7 +989,7 @@ Maximum acceleration for the motor at the X axis. .. rst-class:: classref-property -:ref:`float` **angular_motor_x/target_velocity** = ``0.0`` +:ref:`float` **angular_motor_x/target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1006,7 +1006,7 @@ Target speed for the motor at the X axis. .. rst-class:: classref-property -:ref:`bool` **angular_motor_y/enabled** = ``false`` +:ref:`bool` **angular_motor_y/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1023,7 +1023,7 @@ If ``true``, a rotating motor at the Y axis is enabled. .. rst-class:: classref-property -:ref:`float` **angular_motor_y/force_limit** = ``300.0`` +:ref:`float` **angular_motor_y/force_limit** = ``300.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1040,7 +1040,7 @@ Maximum acceleration for the motor at the Y axis. .. rst-class:: classref-property -:ref:`float` **angular_motor_y/target_velocity** = ``0.0`` +:ref:`float` **angular_motor_y/target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1057,7 +1057,7 @@ Target speed for the motor at the Y axis. .. rst-class:: classref-property -:ref:`bool` **angular_motor_z/enabled** = ``false`` +:ref:`bool` **angular_motor_z/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1074,7 +1074,7 @@ If ``true``, a rotating motor at the Z axis is enabled. .. rst-class:: classref-property -:ref:`float` **angular_motor_z/force_limit** = ``300.0`` +:ref:`float` **angular_motor_z/force_limit** = ``300.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1091,7 +1091,7 @@ Maximum acceleration for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_motor_z/target_velocity** = ``0.0`` +:ref:`float` **angular_motor_z/target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1108,7 +1108,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_x/damping** = ``0.0`` +:ref:`float` **angular_spring_x/damping** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1127,7 +1127,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`bool` **angular_spring_x/enabled** = ``false`` +:ref:`bool` **angular_spring_x/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1146,7 +1146,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_x/equilibrium_point** = ``0.0`` +:ref:`float` **angular_spring_x/equilibrium_point** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1165,7 +1165,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_x/stiffness** = ``0.0`` +:ref:`float` **angular_spring_x/stiffness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1184,7 +1184,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_y/damping** = ``0.0`` +:ref:`float` **angular_spring_y/damping** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1203,7 +1203,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`bool` **angular_spring_y/enabled** = ``false`` +:ref:`bool` **angular_spring_y/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1222,7 +1222,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_y/equilibrium_point** = ``0.0`` +:ref:`float` **angular_spring_y/equilibrium_point** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1241,7 +1241,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_y/stiffness** = ``0.0`` +:ref:`float` **angular_spring_y/stiffness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1260,7 +1260,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_z/damping** = ``0.0`` +:ref:`float` **angular_spring_z/damping** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1279,7 +1279,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`bool` **angular_spring_z/enabled** = ``false`` +:ref:`bool` **angular_spring_z/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1298,7 +1298,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_z/equilibrium_point** = ``0.0`` +:ref:`float` **angular_spring_z/equilibrium_point** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1317,7 +1317,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **angular_spring_z/stiffness** = ``0.0`` +:ref:`float` **angular_spring_z/stiffness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1336,7 +1336,7 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_limit_x/damping** = ``1.0`` +:ref:`float` **linear_limit_x/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1353,7 +1353,7 @@ The amount of damping that happens at the X motion. .. rst-class:: classref-property -:ref:`bool` **linear_limit_x/enabled** = ``true`` +:ref:`bool` **linear_limit_x/enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1370,7 +1370,7 @@ If ``true``, the linear motion across the X axis is limited. .. rst-class:: classref-property -:ref:`float` **linear_limit_x/lower_distance** = ``0.0`` +:ref:`float` **linear_limit_x/lower_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1387,7 +1387,7 @@ The minimum difference between the pivot points' X axis. .. rst-class:: classref-property -:ref:`float` **linear_limit_x/restitution** = ``0.5`` +:ref:`float` **linear_limit_x/restitution** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1404,7 +1404,7 @@ The amount of restitution on the X axis movement. The lower, the more momentum g .. rst-class:: classref-property -:ref:`float` **linear_limit_x/softness** = ``0.7`` +:ref:`float` **linear_limit_x/softness** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1421,7 +1421,7 @@ A factor applied to the movement across the X axis. The lower, the slower the mo .. rst-class:: classref-property -:ref:`float` **linear_limit_x/upper_distance** = ``0.0`` +:ref:`float` **linear_limit_x/upper_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1438,7 +1438,7 @@ The maximum difference between the pivot points' X axis. .. rst-class:: classref-property -:ref:`float` **linear_limit_y/damping** = ``1.0`` +:ref:`float` **linear_limit_y/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1455,7 +1455,7 @@ The amount of damping that happens at the Y motion. .. rst-class:: classref-property -:ref:`bool` **linear_limit_y/enabled** = ``true`` +:ref:`bool` **linear_limit_y/enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1472,7 +1472,7 @@ If ``true``, the linear motion across the Y axis is limited. .. rst-class:: classref-property -:ref:`float` **linear_limit_y/lower_distance** = ``0.0`` +:ref:`float` **linear_limit_y/lower_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1489,7 +1489,7 @@ The minimum difference between the pivot points' Y axis. .. rst-class:: classref-property -:ref:`float` **linear_limit_y/restitution** = ``0.5`` +:ref:`float` **linear_limit_y/restitution** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1506,7 +1506,7 @@ The amount of restitution on the Y axis movement. The lower, the more momentum g .. rst-class:: classref-property -:ref:`float` **linear_limit_y/softness** = ``0.7`` +:ref:`float` **linear_limit_y/softness** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1523,7 +1523,7 @@ A factor applied to the movement across the Y axis. The lower, the slower the mo .. rst-class:: classref-property -:ref:`float` **linear_limit_y/upper_distance** = ``0.0`` +:ref:`float` **linear_limit_y/upper_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1540,7 +1540,7 @@ The maximum difference between the pivot points' Y axis. .. rst-class:: classref-property -:ref:`float` **linear_limit_z/damping** = ``1.0`` +:ref:`float` **linear_limit_z/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1557,7 +1557,7 @@ The amount of damping that happens at the Z motion. .. rst-class:: classref-property -:ref:`bool` **linear_limit_z/enabled** = ``true`` +:ref:`bool` **linear_limit_z/enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1574,7 +1574,7 @@ If ``true``, the linear motion across the Z axis is limited. .. rst-class:: classref-property -:ref:`float` **linear_limit_z/lower_distance** = ``0.0`` +:ref:`float` **linear_limit_z/lower_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1591,7 +1591,7 @@ The minimum difference between the pivot points' Z axis. .. rst-class:: classref-property -:ref:`float` **linear_limit_z/restitution** = ``0.5`` +:ref:`float` **linear_limit_z/restitution** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1608,7 +1608,7 @@ The amount of restitution on the Z axis movement. The lower, the more momentum g .. rst-class:: classref-property -:ref:`float` **linear_limit_z/softness** = ``0.7`` +:ref:`float` **linear_limit_z/softness** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1625,7 +1625,7 @@ A factor applied to the movement across the Z axis. The lower, the slower the mo .. rst-class:: classref-property -:ref:`float` **linear_limit_z/upper_distance** = ``0.0`` +:ref:`float` **linear_limit_z/upper_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1642,7 +1642,7 @@ The maximum difference between the pivot points' Z axis. .. rst-class:: classref-property -:ref:`bool` **linear_motor_x/enabled** = ``false`` +:ref:`bool` **linear_motor_x/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1659,7 +1659,7 @@ If ``true``, then there is a linear motor on the X axis. It will attempt to reac .. rst-class:: classref-property -:ref:`float` **linear_motor_x/force_limit** = ``0.0`` +:ref:`float` **linear_motor_x/force_limit** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1676,7 +1676,7 @@ The maximum force the linear motor can apply on the X axis while trying to reach .. rst-class:: classref-property -:ref:`float` **linear_motor_x/target_velocity** = ``0.0`` +:ref:`float` **linear_motor_x/target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1693,7 +1693,7 @@ The speed that the linear motor will attempt to reach on the X axis. .. rst-class:: classref-property -:ref:`bool` **linear_motor_y/enabled** = ``false`` +:ref:`bool` **linear_motor_y/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1710,7 +1710,7 @@ If ``true``, then there is a linear motor on the Y axis. It will attempt to reac .. rst-class:: classref-property -:ref:`float` **linear_motor_y/force_limit** = ``0.0`` +:ref:`float` **linear_motor_y/force_limit** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1727,7 +1727,7 @@ The maximum force the linear motor can apply on the Y axis while trying to reach .. rst-class:: classref-property -:ref:`float` **linear_motor_y/target_velocity** = ``0.0`` +:ref:`float` **linear_motor_y/target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1744,7 +1744,7 @@ The speed that the linear motor will attempt to reach on the Y axis. .. rst-class:: classref-property -:ref:`bool` **linear_motor_z/enabled** = ``false`` +:ref:`bool` **linear_motor_z/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1761,7 +1761,7 @@ If ``true``, then there is a linear motor on the Z axis. It will attempt to reac .. rst-class:: classref-property -:ref:`float` **linear_motor_z/force_limit** = ``0.0`` +:ref:`float` **linear_motor_z/force_limit** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1778,7 +1778,7 @@ The maximum force the linear motor can apply on the Z axis while trying to reach .. rst-class:: classref-property -:ref:`float` **linear_motor_z/target_velocity** = ``0.0`` +:ref:`float` **linear_motor_z/target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1795,7 +1795,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_x/damping** = ``0.01`` +:ref:`float` **linear_spring_x/damping** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1814,7 +1814,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`bool` **linear_spring_x/enabled** = ``false`` +:ref:`bool` **linear_spring_x/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1833,7 +1833,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_x/equilibrium_point** = ``0.0`` +:ref:`float` **linear_spring_x/equilibrium_point** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1852,7 +1852,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_x/stiffness** = ``0.01`` +:ref:`float` **linear_spring_x/stiffness** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1871,7 +1871,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_y/damping** = ``0.01`` +:ref:`float` **linear_spring_y/damping** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1890,7 +1890,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`bool` **linear_spring_y/enabled** = ``false`` +:ref:`bool` **linear_spring_y/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1909,7 +1909,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_y/equilibrium_point** = ``0.0`` +:ref:`float` **linear_spring_y/equilibrium_point** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1928,7 +1928,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_y/stiffness** = ``0.01`` +:ref:`float` **linear_spring_y/stiffness** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1947,7 +1947,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_z/damping** = ``0.01`` +:ref:`float` **linear_spring_z/damping** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1966,7 +1966,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`bool` **linear_spring_z/enabled** = ``false`` +:ref:`bool` **linear_spring_z/enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1985,7 +1985,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_z/equilibrium_point** = ``0.0`` +:ref:`float` **linear_spring_z/equilibrium_point** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2004,7 +2004,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property -:ref:`float` **linear_spring_z/stiffness** = ``0.01`` +:ref:`float` **linear_spring_z/stiffness** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2028,7 +2028,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| +:ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2042,7 +2042,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| +:ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2056,7 +2056,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| +:ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2070,7 +2070,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2084,7 +2084,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2098,7 +2098,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2112,7 +2112,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +|void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2126,7 +2126,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +|void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2140,7 +2140,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +|void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2154,7 +2154,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -2168,7 +2168,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -2182,7 +2182,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_geometry2d.rst b/classes/class_geometry2d.rst index 9be7b9ca6ad..dc692e09d7a 100644 --- a/classes/class_geometry2d.rst +++ b/classes/class_geometry2d.rst @@ -90,7 +90,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PolyBooleanOperation**: +enum **PolyBooleanOperation**: :ref:`🔗` .. _class_Geometry2D_constant_OPERATION_UNION: @@ -132,7 +132,7 @@ Create regions where either subject or clip polygons are filled but not where bo .. rst-class:: classref-enumeration -enum **PolyJoinType**: +enum **PolyJoinType**: :ref:`🔗` .. _class_Geometry2D_constant_JOIN_SQUARE: @@ -166,7 +166,7 @@ There's a necessary limit to mitered joins since offsetting edges that join at v .. rst-class:: classref-enumeration -enum **PolyEndType**: +enum **PolyEndType**: :ref:`🔗` .. _class_Geometry2D_constant_END_POLYGON: @@ -221,7 +221,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **clip_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **clip_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Clips ``polygon_a`` against ``polygon_b`` and returns an array of clipped polygons. This performs :ref:`OPERATION_DIFFERENCE` between polygons. Returns an empty array if ``polygon_b`` completely overlaps ``polygon_a``. @@ -235,7 +235,7 @@ If ``polygon_b`` is enclosed by ``polygon_a``, returns an outer polygon (boundar .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **clip_polyline_with_polygon**\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **clip_polyline_with_polygon**\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines. This performs :ref:`OPERATION_DIFFERENCE` between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. @@ -247,7 +247,7 @@ Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines .. rst-class:: classref-method -:ref:`PackedVector2Array` **convex_hull**\ (\ points\: :ref:`PackedVector2Array`\ ) +:ref:`PackedVector2Array` **convex_hull**\ (\ points\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one. @@ -259,7 +259,7 @@ Given an array of :ref:`Vector2`\ s, returns the convex hull as a .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **decompose_polygon_in_convex**\ (\ polygon\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **decompose_polygon_in_convex**\ (\ polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Decomposes the ``polygon`` into multiple convex hulls and returns an array of :ref:`PackedVector2Array`. @@ -271,7 +271,7 @@ Decomposes the ``polygon`` into multiple convex hulls and returns an array of :r .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **exclude_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **exclude_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Mutually excludes common area defined by intersection of ``polygon_a`` and ``polygon_b`` (see :ref:`intersect_polygons`) and returns an array of excluded polygons. This performs :ref:`OPERATION_XOR` between polygons. In other words, returns all but common area between polygons. @@ -285,7 +285,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point_to_segment**\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) +:ref:`Vector2` **get_closest_point_to_segment**\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) :ref:`🔗` Returns the 2D point on the 2D segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. @@ -297,7 +297,7 @@ Returns the 2D point on the 2D segment (``s1``, ``s2``) that is closest to ``poi .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point_to_segment_uncapped**\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) +:ref:`Vector2` **get_closest_point_to_segment_uncapped**\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) :ref:`🔗` Returns the 2D point on the 2D line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. @@ -309,7 +309,7 @@ Returns the 2D point on the 2D line defined by (``s1``, ``s2``) that is closest .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_closest_points_between_segments**\ (\ p1\: :ref:`Vector2`, q1\: :ref:`Vector2`, p2\: :ref:`Vector2`, q2\: :ref:`Vector2`\ ) +:ref:`PackedVector2Array` **get_closest_points_between_segments**\ (\ p1\: :ref:`Vector2`, q1\: :ref:`Vector2`, p2\: :ref:`Vector2`, q2\: :ref:`Vector2`\ ) :ref:`🔗` Given the two 2D segments (``p1``, ``q1``) and (``p2``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PackedVector2Array` that contains this point on (``p1``, ``q1``) as well the accompanying point on (``p2``, ``q2``). @@ -321,7 +321,7 @@ Given the two 2D segments (``p1``, ``q1``) and (``p2``, ``q2``), finds those two .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **intersect_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **intersect_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Intersects ``polygon_a`` with ``polygon_b`` and returns an array of intersected polygons. This performs :ref:`OPERATION_INTERSECTION` between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. @@ -335,7 +335,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **intersect_polyline_with_polygon**\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **intersect_polyline_with_polygon**\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Intersects ``polyline`` with ``polygon`` and returns an array of intersected polylines. This performs :ref:`OPERATION_INTERSECTION` between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. @@ -347,7 +347,7 @@ Intersects ``polyline`` with ``polygon`` and returns an array of intersected pol .. rst-class:: classref-method -:ref:`bool` **is_point_in_circle**\ (\ point\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) +:ref:`bool` **is_point_in_circle**\ (\ point\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if ``point`` is inside the circle or if it's located exactly *on* the circle's boundary, otherwise returns ``false``. @@ -359,7 +359,7 @@ Returns ``true`` if ``point`` is inside the circle or if it's located exactly *o .. rst-class:: classref-method -:ref:`bool` **is_point_in_polygon**\ (\ point\: :ref:`Vector2`, polygon\: :ref:`PackedVector2Array`\ ) +:ref:`bool` **is_point_in_polygon**\ (\ point\: :ref:`Vector2`, polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly *on* polygon's boundary, otherwise returns ``false``. @@ -371,10 +371,12 @@ Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly * .. rst-class:: classref-method -:ref:`bool` **is_polygon_clockwise**\ (\ polygon\: :ref:`PackedVector2Array`\ ) +:ref:`bool` **is_polygon_clockwise**\ (\ polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``. +\ **Note:** Assumes a Cartesian coordinate system where ``+x`` is right and ``+y`` is up. If using screen coordinates (``+y`` is down), the result will need to be flipped (i.e. a ``true`` result will indicate counter-clockwise). + .. rst-class:: classref-item-separator ---- @@ -383,7 +385,7 @@ Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, other .. rst-class:: classref-method -:ref:`Variant` **line_intersects_line**\ (\ from_a\: :ref:`Vector2`, dir_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, dir_b\: :ref:`Vector2`\ ) +:ref:`Variant` **line_intersects_line**\ (\ from_a\: :ref:`Vector2`, dir_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, dir_b\: :ref:`Vector2`\ ) :ref:`🔗` Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns ``null``. @@ -397,7 +399,7 @@ Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) inte .. rst-class:: classref-method -:ref:`Dictionary` **make_atlas**\ (\ sizes\: :ref:`PackedVector2Array`\ ) +:ref:`Dictionary` **make_atlas**\ (\ sizes\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a :ref:`PackedVector2Array` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2i`. @@ -409,7 +411,7 @@ Given an array of :ref:`Vector2`\ s representing tiles, builds an .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **merge_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **merge_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Merges (combines) ``polygon_a`` and ``polygon_b`` and returns an array of merged polygons. This performs :ref:`OPERATION_UNION` between polygons. @@ -423,7 +425,7 @@ The operation may result in an outer polygon (boundary) and multiple inner polyg .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **offset_polygon**\ (\ polygon\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **offset_polygon**\ (\ polygon\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0\ ) :ref:`🔗` Inflates or deflates ``polygon`` by ``delta`` units (pixels). If ``delta`` is positive, makes the polygon grow outward. If ``delta`` is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if ``delta`` is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. @@ -460,7 +462,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **offset_polyline**\ (\ polyline\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0, end_type\: :ref:`PolyEndType` = 3\ ) +:ref:`Array`\[:ref:`PackedVector2Array`\] **offset_polyline**\ (\ polyline\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0, end_type\: :ref:`PolyEndType` = 3\ ) :ref:`🔗` Inflates or deflates ``polyline`` by ``delta`` units (pixels), producing polygons. If ``delta`` is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If ``delta`` is negative, returns an empty array. @@ -478,7 +480,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`bool` **point_is_inside_triangle**\ (\ point\: :ref:`Vector2`, a\: :ref:`Vector2`, b\: :ref:`Vector2`, c\: :ref:`Vector2`\ ) |const| +:ref:`bool` **point_is_inside_triangle**\ (\ point\: :ref:`Vector2`, a\: :ref:`Vector2`, b\: :ref:`Vector2`, c\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. @@ -490,7 +492,7 @@ Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. .. rst-class:: classref-method -:ref:`float` **segment_intersects_circle**\ (\ segment_from\: :ref:`Vector2`, segment_to\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) +:ref:`float` **segment_intersects_circle**\ (\ segment_from\: :ref:`Vector2`, segment_to\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) :ref:`🔗` Given the 2D segment (``segment_from``, ``segment_to``), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position ``circle_position`` and has radius ``circle_radius``. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). @@ -502,7 +504,7 @@ Given the 2D segment (``segment_from``, ``segment_to``), returns the position on .. rst-class:: classref-method -:ref:`Variant` **segment_intersects_segment**\ (\ from_a\: :ref:`Vector2`, to_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, to_b\: :ref:`Vector2`\ ) +:ref:`Variant` **segment_intersects_segment**\ (\ from_a\: :ref:`Vector2`, to_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, to_b\: :ref:`Vector2`\ ) :ref:`🔗` Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns ``null``. @@ -514,7 +516,7 @@ Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) int .. rst-class:: classref-method -:ref:`PackedInt32Array` **triangulate_delaunay**\ (\ points\: :ref:`PackedVector2Array`\ ) +:ref:`PackedInt32Array` **triangulate_delaunay**\ (\ points\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Triangulates the area specified by discrete set of ``points`` such that no point is inside the circumcircle of any resulting triangle. Returns a :ref:`PackedInt32Array` where each triangle consists of three consecutive point indices into ``points`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PackedInt32Array` is returned. @@ -526,7 +528,7 @@ Triangulates the area specified by discrete set of ``points`` such that no point .. rst-class:: classref-method -:ref:`PackedInt32Array` **triangulate_polygon**\ (\ polygon\: :ref:`PackedVector2Array`\ ) +:ref:`PackedInt32Array` **triangulate_polygon**\ (\ polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PackedInt32Array` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). Output triangles will always be counter clockwise, and the contour will be flipped if it's clockwise. If the triangulation did not succeed, an empty :ref:`PackedInt32Array` is returned. diff --git a/classes/class_geometry3d.rst b/classes/class_geometry3d.rst index cd5ae95c1d1..193910e88d7 100644 --- a/classes/class_geometry3d.rst +++ b/classes/class_geometry3d.rst @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Plane`\] **build_box_planes**\ (\ extents\: :ref:`Vector3`\ ) +:ref:`Array`\[:ref:`Plane`\] **build_box_planes**\ (\ extents\: :ref:`Vector3`\ ) :ref:`🔗` Returns an array with 6 :ref:`Plane`\ s that describe the sides of a box centered at the origin. The box size is defined by ``extents``, which represents one (positive) corner of the box (i.e. half its actual size). @@ -86,7 +86,7 @@ Returns an array with 6 :ref:`Plane`\ s that describe the sides of .. rst-class:: classref-method -:ref:`Array`\[:ref:`Plane`\] **build_capsule_planes**\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, lats\: :ref:`int`, axis\: Vector3.Axis = 2\ ) +:ref:`Array`\[:ref:`Plane`\] **build_capsule_planes**\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, lats\: :ref:`int`, axis\: Vector3.Axis = 2\ ) :ref:`🔗` Returns an array of :ref:`Plane`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). @@ -98,7 +98,7 @@ Returns an array of :ref:`Plane`\ s closely bounding a faceted caps .. rst-class:: classref-method -:ref:`Array`\[:ref:`Plane`\] **build_cylinder_planes**\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, axis\: Vector3.Axis = 2\ ) +:ref:`Array`\[:ref:`Plane`\] **build_cylinder_planes**\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, axis\: Vector3.Axis = 2\ ) :ref:`🔗` Returns an array of :ref:`Plane`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). @@ -110,7 +110,7 @@ Returns an array of :ref:`Plane`\ s closely bounding a faceted cyli .. rst-class:: classref-method -:ref:`PackedVector3Array` **clip_polygon**\ (\ points\: :ref:`PackedVector3Array`, plane\: :ref:`Plane`\ ) +:ref:`PackedVector3Array` **clip_polygon**\ (\ points\: :ref:`PackedVector3Array`, plane\: :ref:`Plane`\ ) :ref:`🔗` Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. @@ -122,7 +122,7 @@ Clips the polygon defined by the points in ``points`` against the ``plane`` and .. rst-class:: classref-method -:ref:`PackedVector3Array` **compute_convex_mesh_points**\ (\ planes\: :ref:`Array`\[:ref:`Plane`\]\ ) +:ref:`PackedVector3Array` **compute_convex_mesh_points**\ (\ planes\: :ref:`Array`\[:ref:`Plane`\]\ ) :ref:`🔗` Calculates and returns all the vertex points of a convex shape defined by an array of ``planes``. @@ -134,7 +134,7 @@ Calculates and returns all the vertex points of a convex shape defined by an arr .. rst-class:: classref-method -:ref:`Vector3` **get_closest_point_to_segment**\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) +:ref:`Vector3` **get_closest_point_to_segment**\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) :ref:`🔗` Returns the 3D point on the 3D segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. @@ -146,7 +146,7 @@ Returns the 3D point on the 3D segment (``s1``, ``s2``) that is closest to ``poi .. rst-class:: classref-method -:ref:`Vector3` **get_closest_point_to_segment_uncapped**\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) +:ref:`Vector3` **get_closest_point_to_segment_uncapped**\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) :ref:`🔗` Returns the 3D point on the 3D line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. @@ -158,7 +158,7 @@ Returns the 3D point on the 3D line defined by (``s1``, ``s2``) that is closest .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_closest_points_between_segments**\ (\ p1\: :ref:`Vector3`, p2\: :ref:`Vector3`, q1\: :ref:`Vector3`, q2\: :ref:`Vector3`\ ) +:ref:`PackedVector3Array` **get_closest_points_between_segments**\ (\ p1\: :ref:`Vector3`, p2\: :ref:`Vector3`, q1\: :ref:`Vector3`, q2\: :ref:`Vector3`\ ) :ref:`🔗` Given the two 3D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PackedVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). @@ -170,7 +170,7 @@ Given the two 3D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two .. rst-class:: classref-method -:ref:`Vector3` **get_triangle_barycentric_coords**\ (\ point\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) +:ref:`Vector3` **get_triangle_barycentric_coords**\ (\ point\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) :ref:`🔗` Returns a :ref:`Vector3` containing weights based on how close a 3D position (``point``) is to a triangle's different vertices (``a``, ``b`` and ``c``). This is useful for interpolating between the data of different vertices in a triangle. One example use case is using this to smoothly rotate over a mesh instead of relying solely on face normals. @@ -184,7 +184,7 @@ Returns a :ref:`Vector3` containing weights based on how close a .. rst-class:: classref-method -:ref:`Variant` **ray_intersects_triangle**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) +:ref:`Variant` **ray_intersects_triangle**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) :ref:`🔗` Tests if the 3D ray starting at ``from`` with the direction of ``dir`` intersects the triangle specified by ``a``, ``b`` and ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, returns ``null``. @@ -196,7 +196,7 @@ Tests if the 3D ray starting at ``from`` with the direction of ``dir`` intersect .. rst-class:: classref-method -:ref:`PackedVector3Array` **segment_intersects_convex**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, planes\: :ref:`Array`\[:ref:`Plane`\]\ ) +:ref:`PackedVector3Array` **segment_intersects_convex**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, planes\: :ref:`Array`\[:ref:`Plane`\]\ ) :ref:`🔗` Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PackedVector3Array` containing the point the intersection and the hull's normal. Otherwise, returns an empty array. @@ -208,7 +208,7 @@ Given a convex hull defined though the :ref:`Plane`\ s in the array .. rst-class:: classref-method -:ref:`PackedVector3Array` **segment_intersects_cylinder**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, height\: :ref:`float`, radius\: :ref:`float`\ ) +:ref:`PackedVector3Array` **segment_intersects_cylinder**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, height\: :ref:`float`, radius\: :ref:`float`\ ) :ref:`🔗` Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PackedVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. @@ -220,7 +220,7 @@ Checks if the segment (``from``, ``to``) intersects the cylinder with height ``h .. rst-class:: classref-method -:ref:`PackedVector3Array` **segment_intersects_sphere**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, sphere_position\: :ref:`Vector3`, sphere_radius\: :ref:`float`\ ) +:ref:`PackedVector3Array` **segment_intersects_sphere**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, sphere_position\: :ref:`Vector3`, sphere_radius\: :ref:`float`\ ) :ref:`🔗` Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PackedVector3Array`. If yes, returns a :ref:`PackedVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. @@ -232,7 +232,7 @@ Checks if the segment (``from``, ``to``) intersects the sphere that is located a .. rst-class:: classref-method -:ref:`Variant` **segment_intersects_triangle**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) +:ref:`Variant` **segment_intersects_triangle**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) :ref:`🔗` Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, returns ``null``. @@ -244,7 +244,7 @@ Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, `` .. rst-class:: classref-method -:ref:`PackedInt32Array` **tetrahedralize_delaunay**\ (\ points\: :ref:`PackedVector3Array`\ ) +:ref:`PackedInt32Array` **tetrahedralize_delaunay**\ (\ points\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Tetrahedralizes the volume specified by a discrete set of ``points`` in 3D space, ensuring that no point lies within the circumsphere of any resulting tetrahedron. The method returns a :ref:`PackedInt32Array` where each tetrahedron consists of four consecutive point indices into the ``points`` array (resulting in an array with ``n * 4`` elements, where ``n`` is the number of tetrahedra found). If the tetrahedralization is unsuccessful, an empty :ref:`PackedInt32Array` is returned. diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index 41d9e645f58..6d532662a6d 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -97,7 +97,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ShadowCastingSetting**: +enum **ShadowCastingSetting**: :ref:`🔗` .. _class_GeometryInstance3D_constant_SHADOW_CASTING_SETTING_OFF: @@ -145,7 +145,7 @@ In other words, the actual mesh will not be visible, only the shadows casted fro .. rst-class:: classref-enumeration -enum **GIMode**: +enum **GIMode**: :ref:`🔗` .. _class_GeometryInstance3D_constant_GI_MODE_DISABLED: @@ -179,7 +179,7 @@ Dynamic global illumination mode. Use for dynamic objects that contribute to glo .. rst-class:: classref-enumeration -enum **LightmapScale**: +enum **LightmapScale**: :ref:`🔗` .. _class_GeometryInstance3D_constant_LIGHTMAP_SCALE_1X: @@ -229,7 +229,7 @@ Represents the size of the :ref:`LightmapScale` .. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_DISABLED: @@ -272,7 +272,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ShadowCastingSetting` **cast_shadow** = ``1`` +:ref:`ShadowCastingSetting` **cast_shadow** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -289,7 +289,7 @@ The selected shadow casting flag. See :ref:`ShadowCastingSetting` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ Overrides the bounding box of this node with a custom one. This can be used to a .. rst-class:: classref-property -:ref:`float` **extra_cull_margin** = ``0.0`` +:ref:`float` **extra_cull_margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ The extra distance added to the GeometryInstance3D's bounding box (:ref:`AABB` **gi_lightmap_scale** = ``0`` +:ref:`LightmapScale` **gi_lightmap_scale** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ The texel density to use for lightmapping in :ref:`LightmapGI` .. rst-class:: classref-property -:ref:`GIMode` **gi_mode** = ``1`` +:ref:`GIMode` **gi_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -359,7 +359,7 @@ The global illumination mode to use for the whole geometry. To avoid inconsisten .. rst-class:: classref-property -:ref:`bool` **ignore_occlusion_culling** = ``false`` +:ref:`bool` **ignore_occlusion_culling** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -378,7 +378,7 @@ If ``true``, disables occlusion culling for this instance. Useful for gizmos tha .. rst-class:: classref-property -:ref:`float` **lod_bias** = ``1.0`` +:ref:`float` **lod_bias** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -397,7 +397,7 @@ Useful for testing level of detail transitions in the editor. .. rst-class:: classref-property -:ref:`Material` **material_overlay** +:ref:`Material` **material_overlay** :ref:`🔗` .. rst-class:: classref-property-setget @@ -416,7 +416,7 @@ If a material is assigned to this property, it will be rendered on top of any ot .. rst-class:: classref-property -:ref:`Material` **material_override** +:ref:`Material` **material_override** :ref:`🔗` .. rst-class:: classref-property-setget @@ -435,7 +435,7 @@ If a material is assigned to this property, it will be used instead of any mater .. rst-class:: classref-property -:ref:`float` **transparency** = ``0.0`` +:ref:`float` **transparency** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -458,7 +458,7 @@ In spatial shaders, ``1.0 - transparency`` is set as the default value of the `` .. rst-class:: classref-property -:ref:`float` **visibility_range_begin** = ``0.0`` +:ref:`float` **visibility_range_begin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -475,7 +475,7 @@ Starting distance from which the GeometryInstance3D will be visible, taking :ref .. rst-class:: classref-property -:ref:`float` **visibility_range_begin_margin** = ``0.0`` +:ref:`float` **visibility_range_begin_margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -494,7 +494,7 @@ If :ref:`visibility_range_fade_mode` **visibility_range_end** = ``0.0`` +:ref:`float` **visibility_range_end** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -511,7 +511,7 @@ Distance from which the GeometryInstance3D will be hidden, taking :ref:`visibili .. rst-class:: classref-property -:ref:`float` **visibility_range_end_margin** = ``0.0`` +:ref:`float` **visibility_range_end_margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -530,7 +530,7 @@ If :ref:`visibility_range_fade_mode` **visibility_range_fade_mode** = ``0`` +:ref:`VisibilityRangeFadeMode` **visibility_range_fade_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -552,7 +552,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_instance_shader_parameter**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_instance_shader_parameter**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Get the value of a shader parameter as set on this instance. @@ -564,7 +564,7 @@ Get the value of a shader parameter as set on this instance. .. rst-class:: classref-method -|void| **set_instance_shader_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_instance_shader_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Set the value of a shader uniform for this instance only (`per-instance uniform <../tutorials/shaders/shader_reference/shading_language.html#per-instance-uniforms>`__). See also :ref:`ShaderMaterial.set_shader_parameter` to assign a uniform on all instances using the same :ref:`ShaderMaterial`. diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index fc6cc0952d9..c938fd962ea 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -40,6 +40,8 @@ Properties .. table:: :widths: auto + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`accessor_type` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ | :ref:`int` | :ref:`buffer_view` | ``-1`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+ @@ -79,11 +81,28 @@ Properties Property Descriptions --------------------- +.. _class_GLTFAccessor_property_accessor_type: + +.. rst-class:: classref-property + +:ref:`int` **accessor_type** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessor_type**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_accessor_type**\ (\ ) + +The GLTF accessor type as an enum. Possible values are 0 for "SCALAR", 1 for "VEC2", 2 for "VEC3", 3 for "VEC4", 4 for "MAT2", 5 for "MAT3", and 6 for "MAT4". + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFAccessor_property_buffer_view: .. rst-class:: classref-property -:ref:`int` **buffer_view** = ``-1`` +:ref:`int` **buffer_view** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -100,16 +119,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **byte_offset** = ``0`` +:ref:`int` **byte_offset** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_byte_offset**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_byte_offset**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The offset relative to the start of the buffer view in bytes. .. rst-class:: classref-item-separator @@ -119,16 +136,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **component_type** = ``0`` +:ref:`int` **component_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_component_type**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_component_type**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The GLTF component type as an enum. Possible values are 5120 for "BYTE", 5121 for "UNSIGNED_BYTE", 5122 for "SHORT", 5123 for "UNSIGNED_SHORT", 5125 for "UNSIGNED_INT", and 5126 for "FLOAT". A value of 5125 or "UNSIGNED_INT" must not be used for any accessor that is not referenced by mesh.primitive.indices. .. rst-class:: classref-item-separator @@ -138,16 +153,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **count** = ``0`` +:ref:`int` **count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_count**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The number of elements referenced by this accessor. .. rst-class:: classref-item-separator @@ -157,16 +170,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`PackedFloat64Array` **max** = ``PackedFloat64Array()`` +:ref:`PackedFloat64Array` **max** = ``PackedFloat64Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_max**\ (\ value\: :ref:`PackedFloat64Array`\ ) - :ref:`PackedFloat64Array` **get_max**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Maximum value of each component in this accessor. .. rst-class:: classref-item-separator @@ -176,16 +187,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`PackedFloat64Array` **min** = ``PackedFloat64Array()`` +:ref:`PackedFloat64Array` **min** = ``PackedFloat64Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_min**\ (\ value\: :ref:`PackedFloat64Array`\ ) - :ref:`PackedFloat64Array` **get_min**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Minimum value of each component in this accessor. .. rst-class:: classref-item-separator @@ -195,16 +204,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`bool` **normalized** = ``false`` +:ref:`bool` **normalized** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_normalized**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_normalized**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Specifies whether integer data values are normalized before usage. .. rst-class:: classref-item-separator @@ -214,16 +221,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **sparse_count** = ``0`` +:ref:`int` **sparse_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sparse_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_sparse_count**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Number of deviating accessor values stored in the sparse array. .. rst-class:: classref-item-separator @@ -233,16 +238,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **sparse_indices_buffer_view** = ``0`` +:ref:`int` **sparse_indices_buffer_view** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sparse_indices_buffer_view**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_sparse_indices_buffer_view**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The index of the buffer view with sparse indices. The referenced buffer view MUST NOT have its target or byteStride properties defined. The buffer view and the optional byteOffset MUST be aligned to the componentType byte length. .. rst-class:: classref-item-separator @@ -252,16 +255,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **sparse_indices_byte_offset** = ``0`` +:ref:`int` **sparse_indices_byte_offset** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sparse_indices_byte_offset**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_sparse_indices_byte_offset**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The offset relative to the start of the buffer view in bytes. .. rst-class:: classref-item-separator @@ -271,16 +272,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **sparse_indices_component_type** = ``0`` +:ref:`int` **sparse_indices_component_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sparse_indices_component_type**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_sparse_indices_component_type**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The indices component data type as an enum. Possible values are 5121 for "UNSIGNED_BYTE", 5123 for "UNSIGNED_SHORT", and 5125 for "UNSIGNED_INT". .. rst-class:: classref-item-separator @@ -290,16 +289,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **sparse_values_buffer_view** = ``0`` +:ref:`int` **sparse_values_buffer_view** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sparse_values_buffer_view**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_sparse_values_buffer_view**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The index of the bufferView with sparse values. The referenced buffer view MUST NOT have its target or byteStride properties defined. .. rst-class:: classref-item-separator @@ -309,16 +306,14 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **sparse_values_byte_offset** = ``0`` +:ref:`int` **sparse_values_byte_offset** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sparse_values_byte_offset**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_sparse_values_byte_offset**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The offset relative to the start of the bufferView in bytes. .. rst-class:: classref-item-separator @@ -328,16 +323,16 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property -:ref:`int` **type** = ``0`` +:ref:`int` **type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_type**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_type**\ (\ ) -.. container:: contribute +**Deprecated:** Use :ref:`accessor_type` instead. - There is currently no description for this property. Please help us by :ref:`contributing one `! +The GLTF accessor type as an enum. Use :ref:`accessor_type` instead. .. |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_gltfanimation.rst b/classes/class_gltfanimation.rst index 8a47f1aa5bd..fd6195bdee6 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **loop** = ``false`` +:ref:`bool` **loop** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -83,7 +83,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **original_name** = ``""`` +:ref:`String` **original_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` Gets additional arbitrary data in this **GLTFAnimation** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -119,7 +119,7 @@ The argument should be the :ref:`GLTFDocumentExtension`, additional_data\: :ref:`Variant`\ ) +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) :ref:`🔗` Sets additional arbitrary data in this **GLTFAnimation** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 1d8484eba5f..dc1f3c1cb81 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **buffer** = ``-1`` +:ref:`int` **buffer** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ The index of the buffer this buffer view is referencing. If ``-1``, this buffer .. rst-class:: classref-property -:ref:`int` **byte_length** = ``0`` +:ref:`int` **byte_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The length, in bytes, of this buffer view. If ``0``, this buffer view is empty. .. rst-class:: classref-property -:ref:`int` **byte_offset** = ``0`` +:ref:`int` **byte_offset** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ The offset, in bytes, from the start of the buffer to the start of this buffer v .. rst-class:: classref-property -:ref:`int` **byte_stride** = ``-1`` +:ref:`int` **byte_stride** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The stride, in bytes, between interleaved data. If ``-1``, this buffer view is n .. rst-class:: classref-property -:ref:`bool` **indices** = ``false`` +:ref:`bool` **indices** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ True if the GLTFBufferView's OpenGL GPU buffer type is an ``ELEMENT_ARRAY_BUFFER .. rst-class:: classref-property -:ref:`bool` **vertex_attributes** = ``false`` +:ref:`bool` **vertex_attributes** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -186,7 +186,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **load_buffer_view_data**\ (\ state\: :ref:`GLTFState`\ ) |const| +:ref:`PackedByteArray` **load_buffer_view_data**\ (\ state\: :ref:`GLTFState`\ ) |const| :ref:`🔗` Loads the buffer view data from the buffer referenced by this buffer view in the given :ref:`GLTFState`. Interleaved data with a byte stride is not yet supported by this method. The data is returned as a :ref:`PackedByteArray`. diff --git a/classes/class_gltfcamera.rst b/classes/class_gltfcamera.rst index 8251f6215bf..418bbfa1c25 100644 --- a/classes/class_gltfcamera.rst +++ b/classes/class_gltfcamera.rst @@ -83,7 +83,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **depth_far** = ``4000.0`` +:ref:`float` **depth_far** = ``4000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -100,7 +100,7 @@ The distance to the far culling boundary for this camera relative to its local Z .. rst-class:: classref-property -:ref:`float` **depth_near** = ``0.05`` +:ref:`float` **depth_near** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -117,7 +117,7 @@ The distance to the near culling boundary for this camera relative to its local .. rst-class:: classref-property -:ref:`float` **fov** = ``1.309`` +:ref:`float` **fov** = ``1.309`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,7 +134,7 @@ The FOV of the camera. This class and GLTF define the camera FOV in radians, whi .. rst-class:: classref-property -:ref:`bool` **perspective** = ``true`` +:ref:`bool` **perspective** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ Whether or not the camera is in perspective mode. If false, the camera is in ort .. rst-class:: classref-property -:ref:`float` **size_mag** = ``0.5`` +:ref:`float` **size_mag** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFCamera` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| +:ref:`GLTFCamera` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| :ref:`🔗` Creates a new GLTFCamera instance by parsing the given :ref:`Dictionary`. @@ -185,7 +185,7 @@ Creates a new GLTFCamera instance by parsing the given :ref:`Dictionary` **from_node**\ (\ camera_node\: :ref:`Camera3D`\ ) |static| +:ref:`GLTFCamera` **from_node**\ (\ camera_node\: :ref:`Camera3D`\ ) |static| :ref:`🔗` Create a new GLTFCamera instance from the given Godot :ref:`Camera3D` node. @@ -197,7 +197,7 @@ Create a new GLTFCamera instance from the given Godot :ref:`Camera3D` **to_dictionary**\ (\ ) |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| :ref:`🔗` Serializes this GLTFCamera instance into a :ref:`Dictionary`. @@ -209,7 +209,7 @@ Serializes this GLTFCamera instance into a :ref:`Dictionary`. .. rst-class:: classref-method -:ref:`Camera3D` **to_node**\ (\ ) |const| +:ref:`Camera3D` **to_node**\ (\ ) |const| :ref:`🔗` Converts this GLTFCamera instance into a Godot :ref:`Camera3D` node. diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index 42251b280c4..f5d8a657bc0 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -93,7 +93,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **RootNodeMode**: +enum **RootNodeMode**: :ref:`🔗` .. _class_GLTFDocument_constant_ROOT_NODE_MODE_SINGLE_ROOT: @@ -132,7 +132,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **image_format** = ``"PNG"`` +:ref:`String` **image_format** = ``"PNG"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ By default, Godot allows the following options: "None", "PNG", "JPEG", "Lossless .. rst-class:: classref-property -:ref:`float` **lossy_quality** = ``0.75`` +:ref:`float` **lossy_quality** = ``0.75`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ If :ref:`image_format` is a lossy imag .. rst-class:: classref-property -:ref:`RootNodeMode` **root_node_mode** = ``0`` +:ref:`RootNodeMode` **root_node_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **append_from_buffer**\ (\ bytes\: :ref:`PackedByteArray`, base_path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) +:ref:`Error` **append_from_buffer**\ (\ bytes\: :ref:`PackedByteArray`, base_path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) :ref:`🔗` Takes a :ref:`PackedByteArray` defining a GLTF and imports the data to the given :ref:`GLTFState` object through the ``state`` parameter. @@ -206,7 +206,7 @@ Takes a :ref:`PackedByteArray` defining a GLTF and import .. rst-class:: classref-method -:ref:`Error` **append_from_file**\ (\ path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0, base_path\: :ref:`String` = ""\ ) +:ref:`Error` **append_from_file**\ (\ path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0, base_path\: :ref:`String` = ""\ ) :ref:`🔗` Takes a path to a GLTF file and imports the data at that file path to the given :ref:`GLTFState` object through the ``state`` parameter. @@ -220,7 +220,7 @@ Takes a path to a GLTF file and imports the data at that file path to the given .. rst-class:: classref-method -:ref:`Error` **append_from_scene**\ (\ node\: :ref:`Node`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) +:ref:`Error` **append_from_scene**\ (\ node\: :ref:`Node`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) :ref:`🔗` Takes a Godot Engine scene node and exports it and its descendants to the given :ref:`GLTFState` object through the ``state`` parameter. @@ -232,7 +232,7 @@ Takes a Godot Engine scene node and exports it and its descendants to the given .. rst-class:: classref-method -:ref:`PackedByteArray` **generate_buffer**\ (\ state\: :ref:`GLTFState`\ ) +:ref:`PackedByteArray` **generate_buffer**\ (\ state\: :ref:`GLTFState`\ ) :ref:`🔗` Takes a :ref:`GLTFState` object through the ``state`` parameter and returns a GLTF :ref:`PackedByteArray`. @@ -244,10 +244,12 @@ Takes a :ref:`GLTFState` object through the ``state`` parameter .. rst-class:: classref-method -:ref:`Node` **generate_scene**\ (\ state\: :ref:`GLTFState`, bake_fps\: :ref:`float` = 30, trimming\: :ref:`bool` = false, remove_immutable_tracks\: :ref:`bool` = true\ ) +:ref:`Node` **generate_scene**\ (\ state\: :ref:`GLTFState`, bake_fps\: :ref:`float` = 30, trimming\: :ref:`bool` = false, remove_immutable_tracks\: :ref:`bool` = true\ ) :ref:`🔗` Takes a :ref:`GLTFState` object through the ``state`` parameter and returns a Godot Engine scene node. +The ``bake_fps`` parameter overrides the bake_fps in ``state``. + .. rst-class:: classref-item-separator ---- @@ -256,7 +258,7 @@ Takes a :ref:`GLTFState` object through the ``state`` parameter .. rst-class:: classref-method -|void| **register_gltf_document_extension**\ (\ extension\: :ref:`GLTFDocumentExtension`, first_priority\: :ref:`bool` = false\ ) |static| +|void| **register_gltf_document_extension**\ (\ extension\: :ref:`GLTFDocumentExtension`, first_priority\: :ref:`bool` = false\ ) |static| :ref:`🔗` Registers the given :ref:`GLTFDocumentExtension` instance with GLTFDocument. If ``first_priority`` is true, this extension will be run first. Otherwise, it will be run last. @@ -270,7 +272,7 @@ Registers the given :ref:`GLTFDocumentExtension` in .. rst-class:: classref-method -|void| **unregister_gltf_document_extension**\ (\ extension\: :ref:`GLTFDocumentExtension`\ ) |static| +|void| **unregister_gltf_document_extension**\ (\ extension\: :ref:`GLTFDocumentExtension`\ ) |static| :ref:`🔗` Unregisters the given :ref:`GLTFDocumentExtension` instance. @@ -282,7 +284,7 @@ Unregisters the given :ref:`GLTFDocumentExtension` .. rst-class:: classref-method -:ref:`Error` **write_to_filesystem**\ (\ state\: :ref:`GLTFState`, path\: :ref:`String`\ ) +:ref:`Error` **write_to_filesystem**\ (\ state\: :ref:`GLTFState`, path\: :ref:`String`\ ) :ref:`🔗` Takes a :ref:`GLTFState` object through the ``state`` parameter and writes a glTF file to the filesystem. diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index 3669a2f6b76..9daad61f3f2 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -95,7 +95,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_convert_scene_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_node\: :ref:`Node`\ ) |virtual| +|void| **_convert_scene_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_node\: :ref:`Node`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_export_preflight` and before :ref:`_export_preserialize`. @@ -109,7 +109,7 @@ Runs when converting the data from a Godot scene node. This method can be used t .. rst-class:: classref-method -:ref:`Error` **_export_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| +:ref:`Error` **_export_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_get_saveable_image_formats` and before :ref:`_export_post`. If this **GLTFDocumentExtension** is used for exporting images, this runs after :ref:`_serialize_texture_json`. @@ -123,7 +123,7 @@ This method can be used to modify the final JSON of each node. Data should be pr .. rst-class:: classref-method -:ref:`Error` **_export_post**\ (\ state\: :ref:`GLTFState`\ ) |virtual| +:ref:`Error` **_export_post**\ (\ state\: :ref:`GLTFState`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run last, after all other parts of the export process. @@ -137,7 +137,7 @@ This method can be used to modify the final JSON of the generated GLTF file. .. rst-class:: classref-method -:ref:`Error` **_export_preflight**\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| +:ref:`Error` **_export_preflight**\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run first, before all other parts of the export process. @@ -151,7 +151,7 @@ The return value is used to determine if this **GLTFDocumentExtension** instance .. rst-class:: classref-method -:ref:`Error` **_export_preserialize**\ (\ state\: :ref:`GLTFState`\ ) |virtual| +:ref:`Error` **_export_preserialize**\ (\ state\: :ref:`GLTFState`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_convert_scene_node` and before :ref:`_get_saveable_image_formats`. @@ -165,7 +165,7 @@ This method can be used to alter the state before performing serialization. It r .. rst-class:: classref-method -:ref:`Node3D` **_generate_scene_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_parent\: :ref:`Node`\ ) |virtual| +:ref:`Node3D` **_generate_scene_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_parent\: :ref:`Node`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_import_post_parse` and before :ref:`_import_node`. @@ -181,7 +181,7 @@ Runs when generating a Godot scene node from a GLTFNode. The returned node will .. rst-class:: classref-method -:ref:`String` **_get_image_file_extension**\ (\ ) |virtual| +:ref:`String` **_get_image_file_extension**\ (\ ) |virtual| :ref:`🔗` Returns the file extension to use for saving image data into, for example, ``".png"``. If defined, when this extension is used to handle images, and the images are saved to a separate file, the image bytes will be copied to a file with this extension. If this is set, there should be a :ref:`ResourceImporter` class able to import the file. If not defined or empty, Godot will save the image into a PNG file. @@ -193,7 +193,7 @@ Returns the file extension to use for saving image data into, for example, ``".p .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_saveable_image_formats**\ (\ ) |virtual| +:ref:`PackedStringArray` **_get_saveable_image_formats**\ (\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_convert_scene_node` and before :ref:`_export_node`. @@ -207,7 +207,7 @@ Returns an array of the image formats that can be saved/exported by this extensi .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_supported_extensions**\ (\ ) |virtual| +:ref:`PackedStringArray` **_get_supported_extensions**\ (\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_import_preflight` and before :ref:`_parse_node_extensions`. @@ -221,7 +221,7 @@ Returns an array of the GLTF extensions supported by this GLTFDocumentExtension .. rst-class:: classref-method -:ref:`Error` **_import_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| +:ref:`Error` **_import_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_generate_scene_node` and before :ref:`_import_post`. @@ -235,7 +235,7 @@ This method can be used to make modifications to each of the generated Godot sce .. rst-class:: classref-method -:ref:`Error` **_import_post**\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| +:ref:`Error` **_import_post**\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run last, after all other parts of the import process. @@ -249,7 +249,7 @@ This method can be used to modify the final Godot scene generated by the import .. rst-class:: classref-method -:ref:`Error` **_import_post_parse**\ (\ state\: :ref:`GLTFState`\ ) |virtual| +:ref:`Error` **_import_post_parse**\ (\ state\: :ref:`GLTFState`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_parse_node_extensions` and before :ref:`_generate_scene_node`. @@ -263,7 +263,7 @@ This method can be used to modify any of the data imported so far after parsing, .. rst-class:: classref-method -:ref:`Error` **_import_preflight**\ (\ state\: :ref:`GLTFState`, extensions\: :ref:`PackedStringArray`\ ) |virtual| +:ref:`Error` **_import_preflight**\ (\ state\: :ref:`GLTFState`, extensions\: :ref:`PackedStringArray`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run first, before all other parts of the import process. @@ -277,7 +277,7 @@ The return value is used to determine if this **GLTFDocumentExtension** instance .. rst-class:: classref-method -:ref:`Error` **_parse_image_data**\ (\ state\: :ref:`GLTFState`, image_data\: :ref:`PackedByteArray`, mime_type\: :ref:`String`, ret_image\: :ref:`Image`\ ) |virtual| +:ref:`Error` **_parse_image_data**\ (\ state\: :ref:`GLTFState`, image_data\: :ref:`PackedByteArray`, mime_type\: :ref:`String`, ret_image\: :ref:`Image`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_parse_node_extensions` and before :ref:`_parse_texture_json`. @@ -291,7 +291,7 @@ Runs when parsing image data from a GLTF file. The data could be sourced from a .. rst-class:: classref-method -:ref:`Error` **_parse_node_extensions**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, extensions\: :ref:`Dictionary`\ ) |virtual| +:ref:`Error` **_parse_node_extensions**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, extensions\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_get_supported_extensions` and before :ref:`_import_post_parse`. @@ -305,7 +305,7 @@ Runs when parsing the node extensions of a GLTFNode. This method can be used to .. rst-class:: classref-method -:ref:`Error` **_parse_texture_json**\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, ret_gltf_texture\: :ref:`GLTFTexture`\ ) |virtual| +:ref:`Error` **_parse_texture_json**\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, ret_gltf_texture\: :ref:`GLTFTexture`\ ) |virtual| :ref:`🔗` Part of the import process. This method is run after :ref:`_parse_image_data` and before :ref:`_generate_scene_node`. @@ -319,7 +319,7 @@ Runs when parsing the texture JSON from the GLTF textures array. This can be use .. rst-class:: classref-method -:ref:`Error` **_save_image_at_path**\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, file_path\: :ref:`String`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| +:ref:`Error` **_save_image_at_path**\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, file_path\: :ref:`String`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_get_saveable_image_formats` and before :ref:`_serialize_texture_json`. @@ -333,7 +333,7 @@ This method is run when saving images separately from the GLTF file. When images .. rst-class:: classref-method -:ref:`PackedByteArray` **_serialize_image_to_bytes**\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, image_dict\: :ref:`Dictionary`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| +:ref:`PackedByteArray` **_serialize_image_to_bytes**\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, image_dict\: :ref:`Dictionary`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_get_saveable_image_formats` and before :ref:`_serialize_texture_json`. @@ -349,7 +349,7 @@ This method must set the image MIME type in the ``image_dict`` with the ``"mimeT .. rst-class:: classref-method -:ref:`Error` **_serialize_texture_json**\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, gltf_texture\: :ref:`GLTFTexture`, image_format\: :ref:`String`\ ) |virtual| +:ref:`Error` **_serialize_texture_json**\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, gltf_texture\: :ref:`GLTFTexture`, image_format\: :ref:`String`\ ) |virtual| :ref:`🔗` Part of the export process. This method is run after :ref:`_save_image_at_path` or :ref:`_serialize_image_to_bytes`, and before :ref:`_export_node`. Note that this method only runs when this **GLTFDocumentExtension** is selected as the image exporter. diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index b9aa8c29542..d92a7c3a890 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ The :ref:`Color` of the light. Defaults to white. A black color cau .. rst-class:: classref-property -:ref:`float` **inner_cone_angle** = ``0.0`` +:ref:`float` **inner_cone_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Within this angle, the light is at full brightness. Between the inner and outer .. rst-class:: classref-property -:ref:`float` **intensity** = ``1.0`` +:ref:`float` **intensity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ The intensity of the light. This is expressed in candelas (lumens per steradian) .. rst-class:: classref-property -:ref:`String` **light_type** = ``""`` +:ref:`String` **light_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ The type of the light. The values accepted by Godot are "point", "spot", and "di .. rst-class:: classref-property -:ref:`float` **outer_cone_angle** = ``0.785398`` +:ref:`float` **outer_cone_angle** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ At this angle, the light drops off to zero brightness. Between the inner and out .. rst-class:: classref-property -:ref:`float` **range** = ``inf`` +:ref:`float` **range** = ``inf`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFLight` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| +:ref:`GLTFLight` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| :ref:`🔗` Creates a new GLTFLight instance by parsing the given :ref:`Dictionary`. @@ -210,7 +210,7 @@ Creates a new GLTFLight instance by parsing the given :ref:`Dictionary` **from_node**\ (\ light_node\: :ref:`Light3D`\ ) |static| +:ref:`GLTFLight` **from_node**\ (\ light_node\: :ref:`Light3D`\ ) |static| :ref:`🔗` Create a new GLTFLight instance from the given Godot :ref:`Light3D` node. @@ -222,7 +222,7 @@ Create a new GLTFLight instance from the given Godot :ref:`Light3D` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` .. container:: contribute @@ -236,7 +236,7 @@ Create a new GLTFLight instance from the given Godot :ref:`Light3D`, additional_data\: :ref:`Variant`\ ) +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) :ref:`🔗` .. container:: contribute @@ -250,7 +250,7 @@ Create a new GLTFLight instance from the given Godot :ref:`Light3D` **to_dictionary**\ (\ ) |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| :ref:`🔗` Serializes this GLTFLight instance into a :ref:`Dictionary`. @@ -262,7 +262,7 @@ Serializes this GLTFLight instance into a :ref:`Dictionary`. .. rst-class:: classref-method -:ref:`Light3D` **to_node**\ (\ ) |const| +:ref:`Light3D` **to_node**\ (\ ) |const| :ref:`🔗` Converts this GLTFLight instance into a Godot :ref:`Light3D` node. diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 18efec24f9b..1003478aa10 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -73,7 +73,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedFloat32Array` **blend_weights** = ``PackedFloat32Array()`` +:ref:`PackedFloat32Array` **blend_weights** = ``PackedFloat32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -92,7 +92,7 @@ An array of floats representing the blend weights of the mesh. .. rst-class:: classref-property -:ref:`Array`\[:ref:`Material`\] **instance_materials** = ``[]`` +:ref:`Array`\[:ref:`Material`\] **instance_materials** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -109,7 +109,7 @@ An array of Material objects representing the materials used in the mesh. .. rst-class:: classref-property -:ref:`ImporterMesh` **mesh** +:ref:`ImporterMesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -126,7 +126,7 @@ The :ref:`ImporterMesh` object representing the mesh itself. .. rst-class:: classref-property -:ref:`String` **original_name** = ``""`` +:ref:`String` **original_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` Gets additional arbitrary data in this **GLTFMesh** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -162,7 +162,7 @@ The argument should be the :ref:`GLTFDocumentExtension`, additional_data\: :ref:`Variant`\ ) +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) :ref:`🔗` Sets additional arbitrary data in this **GLTFMesh** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 0349117655a..dde695d27d3 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -95,7 +95,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **camera** = ``-1`` +:ref:`int` **camera** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -112,7 +112,7 @@ If this GLTF node is a camera, the index of the :ref:`GLTFCamera` **children** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **children** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ The indices of the child nodes in the :ref:`GLTFState`. If this .. rst-class:: classref-property -:ref:`int` **height** = ``-1`` +:ref:`int` **height** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ How deep into the node hierarchy this node is. A root node will have a height of .. rst-class:: classref-property -:ref:`int` **light** = ``-1`` +:ref:`int` **light** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -165,7 +165,7 @@ If this GLTF node is a light, the index of the :ref:`GLTFLight` .. rst-class:: classref-property -:ref:`int` **mesh** = ``-1`` +:ref:`int` **mesh** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -182,7 +182,7 @@ If this GLTF node is a mesh, the index of the :ref:`GLTFMesh` in .. rst-class:: classref-property -:ref:`String` **original_name** = ``""`` +:ref:`String` **original_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -199,7 +199,7 @@ The original name of the node. .. rst-class:: classref-property -:ref:`int` **parent** = ``-1`` +:ref:`int` **parent** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -216,7 +216,7 @@ The index of the parent node in the :ref:`GLTFState`. If -1, th .. rst-class:: classref-property -:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -233,7 +233,7 @@ The position of the GLTF node relative to its parent. .. rst-class:: classref-property -:ref:`Quaternion` **rotation** = ``Quaternion(0, 0, 0, 1)`` +:ref:`Quaternion` **rotation** = ``Quaternion(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -250,7 +250,7 @@ The rotation of the GLTF node relative to its parent. .. rst-class:: classref-property -:ref:`Vector3` **scale** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **scale** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -267,7 +267,7 @@ The scale of the GLTF node relative to its parent. .. rst-class:: classref-property -:ref:`int` **skeleton** = ``-1`` +:ref:`int` **skeleton** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -284,7 +284,7 @@ If this GLTF node has a skeleton, the index of the :ref:`GLTFSkeleton` **skin** = ``-1`` +:ref:`int` **skin** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -301,7 +301,7 @@ If this GLTF node has a skin, the index of the :ref:`GLTFSkin` i .. rst-class:: classref-property -:ref:`Transform3D` **xform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **xform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` Gets additional arbitrary data in this **GLTFNode** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -337,7 +337,7 @@ The argument should be the :ref:`GLTFDocumentExtension`, additional_data\: :ref:`Variant`\ ) +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) :ref:`🔗` Sets additional arbitrary data in this **GLTFNode** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst index 0efd9720834..4eb9962f904 100644 --- a/classes/class_gltfphysicsbody.rst +++ b/classes/class_gltfphysicsbody.rst @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ The angular velocity of the physics body, in radians per second. This is only us .. rst-class:: classref-property -:ref:`String` **body_type** = ``"rigid"`` +:ref:`String` **body_type** = ``"rigid"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ The type of the body. When importing, this controls what type of :ref:`Collision .. rst-class:: classref-property -:ref:`Vector3` **center_of_mass** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **center_of_mass** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ The center of mass of the body, in meters. This is in local space relative to th .. rst-class:: classref-property -:ref:`Vector3` **inertia_diagonal** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **inertia_diagonal** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ When converted to a Godot :ref:`RigidBody3D` node, if this va .. rst-class:: classref-property -:ref:`Quaternion` **inertia_orientation** = ``Quaternion(0, 0, 0, 1)`` +:ref:`Quaternion` **inertia_orientation** = ``Quaternion(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ The inertia orientation of the physics body. This defines the rotation of the in .. rst-class:: classref-property -:ref:`Basis` **inertia_tensor** = ``Basis(0, 0, 0, 0, 0, 0, 0, 0, 0)`` +:ref:`Basis` **inertia_tensor** = ``Basis(0, 0, 0, 0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ When converted to a Godot :ref:`RigidBody3D` node, if this va .. rst-class:: classref-property -:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ The linear velocity of the physics body, in meters per second. This is only used .. rst-class:: classref-property -:ref:`float` **mass** = ``1.0`` +:ref:`float` **mass** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFPhysicsBody` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| +:ref:`GLTFPhysicsBody` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| :ref:`🔗` Creates a new GLTFPhysicsBody instance by parsing the given :ref:`Dictionary` in the ``OMI_physics_body`` GLTF extension format. @@ -246,7 +246,7 @@ Creates a new GLTFPhysicsBody instance by parsing the given :ref:`Dictionary` **from_node**\ (\ body_node\: :ref:`CollisionObject3D`\ ) |static| +:ref:`GLTFPhysicsBody` **from_node**\ (\ body_node\: :ref:`CollisionObject3D`\ ) |static| :ref:`🔗` Creates a new GLTFPhysicsBody instance from the given Godot :ref:`CollisionObject3D` node. @@ -258,7 +258,7 @@ Creates a new GLTFPhysicsBody instance from the given Godot :ref:`CollisionObjec .. rst-class:: classref-method -:ref:`Dictionary` **to_dictionary**\ (\ ) |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| :ref:`🔗` Serializes this GLTFPhysicsBody instance into a :ref:`Dictionary`. It will be in the format expected by the ``OMI_physics_body`` GLTF extension. @@ -270,7 +270,7 @@ Serializes this GLTFPhysicsBody instance into a :ref:`Dictionary` **to_node**\ (\ ) |const| +:ref:`CollisionObject3D` **to_node**\ (\ ) |const| :ref:`🔗` Converts this GLTFPhysicsBody instance into a Godot :ref:`CollisionObject3D` node. diff --git a/classes/class_gltfphysicsshape.rst b/classes/class_gltfphysicsshape.rst index 229de617e81..b0b5cb10d41 100644 --- a/classes/class_gltfphysicsshape.rst +++ b/classes/class_gltfphysicsshape.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``2.0`` +:ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ The height of the shape, in meters. This is only used when the shape type is "ca .. rst-class:: classref-property -:ref:`ImporterMesh` **importer_mesh** +:ref:`ImporterMesh` **importer_mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ The :ref:`ImporterMesh` resource of the shape. This is only .. rst-class:: classref-property -:ref:`bool` **is_trigger** = ``false`` +:ref:`bool` **is_trigger** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ This is the only variable not used in the :ref:`to_node` **mesh_index** = ``-1`` +:ref:`int` **mesh_index** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ The index of the shape's mesh in the GLTF file. This is only used when the shape .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ The radius of the shape, in meters. This is only used when the shape type is "ca .. rst-class:: classref-property -:ref:`String` **shape_type** = ``""`` +:ref:`String` **shape_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ The type of shape this shape represents. Valid values are "box", "capsule", "cyl .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFPhysicsShape` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| +:ref:`GLTFPhysicsShape` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| :ref:`🔗` Creates a new GLTFPhysicsShape instance by parsing the given :ref:`Dictionary`. @@ -229,7 +229,7 @@ Creates a new GLTFPhysicsShape instance by parsing the given :ref:`Dictionary` **from_node**\ (\ shape_node\: :ref:`CollisionShape3D`\ ) |static| +:ref:`GLTFPhysicsShape` **from_node**\ (\ shape_node\: :ref:`CollisionShape3D`\ ) |static| :ref:`🔗` Creates a new GLTFPhysicsShape instance from the given Godot :ref:`CollisionShape3D` node. @@ -241,7 +241,7 @@ Creates a new GLTFPhysicsShape instance from the given Godot :ref:`CollisionShap .. rst-class:: classref-method -:ref:`GLTFPhysicsShape` **from_resource**\ (\ shape_resource\: :ref:`Shape3D`\ ) |static| +:ref:`GLTFPhysicsShape` **from_resource**\ (\ shape_resource\: :ref:`Shape3D`\ ) |static| :ref:`🔗` Creates a new GLTFPhysicsShape instance from the given Godot :ref:`Shape3D` resource. @@ -253,7 +253,7 @@ Creates a new GLTFPhysicsShape instance from the given Godot :ref:`Shape3D` **to_dictionary**\ (\ ) |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| :ref:`🔗` Serializes this GLTFPhysicsShape instance into a :ref:`Dictionary` in the format defined by ``OMI_physics_shape``. @@ -265,7 +265,7 @@ Serializes this GLTFPhysicsShape instance into a :ref:`Dictionary` **to_node**\ (\ cache_shapes\: :ref:`bool` = false\ ) +:ref:`CollisionShape3D` **to_node**\ (\ cache_shapes\: :ref:`bool` = false\ ) :ref:`🔗` Converts this GLTFPhysicsShape instance into a Godot :ref:`CollisionShape3D` node. @@ -277,7 +277,7 @@ Converts this GLTFPhysicsShape instance into a Godot :ref:`CollisionShape3D` **to_resource**\ (\ cache_shapes\: :ref:`bool` = false\ ) +:ref:`Shape3D` **to_resource**\ (\ cache_shapes\: :ref:`bool` = false\ ) :ref:`🔗` Converts this GLTFPhysicsShape instance into a Godot :ref:`Shape3D` resource. diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index 5b6b15ce1a5..9951dfc18aa 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -74,7 +74,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **joints** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **joints** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **roots** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **roots** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -117,7 +117,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`BoneAttachment3D` **get_bone_attachment**\ (\ idx\: :ref:`int`\ ) +:ref:`BoneAttachment3D` **get_bone_attachment**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute @@ -131,7 +131,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_bone_attachment_count**\ (\ ) +:ref:`int` **get_bone_attachment_count**\ (\ ) :ref:`🔗` .. container:: contribute @@ -145,7 +145,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_godot_bone_node**\ (\ ) +:ref:`Dictionary` **get_godot_bone_node**\ (\ ) :ref:`🔗` Returns a :ref:`Dictionary` that maps skeleton bone indices to the indices of GLTF nodes. This property is unused during import, and only set during export. In a GLTF file, a bone is a node, so Godot converts skeleton bones to GLTF nodes. @@ -157,7 +157,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. rst-class:: classref-method -:ref:`Skeleton3D` **get_godot_skeleton**\ (\ ) +:ref:`Skeleton3D` **get_godot_skeleton**\ (\ ) :ref:`🔗` .. container:: contribute @@ -171,7 +171,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) +:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) :ref:`🔗` .. container:: contribute @@ -185,7 +185,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. rst-class:: classref-method -|void| **set_godot_bone_node**\ (\ godot_bone_node\: :ref:`Dictionary`\ ) +|void| **set_godot_bone_node**\ (\ godot_bone_node\: :ref:`Dictionary`\ ) :ref:`🔗` Sets a :ref:`Dictionary` that maps skeleton bone indices to the indices of GLTF nodes. This property is unused during import, and only set during export. In a GLTF file, a bone is a node, so Godot converts skeleton bones to GLTF nodes. @@ -197,7 +197,7 @@ Sets a :ref:`Dictionary` that maps skeleton bone indices to th .. rst-class:: classref-method -|void| **set_unique_names**\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) +|void| **set_unique_names**\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index e9c04e14fa2..fabbff6adeb 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -82,7 +82,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Skin` **godot_skin** +:ref:`Skin` **godot_skin** :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **joints** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **joints** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **joints_original** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **joints_original** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **non_joints** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **non_joints** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -158,7 +158,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **roots** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **roots** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -177,7 +177,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **skeleton** = ``-1`` +:ref:`int` **skeleton** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **skin_root** = ``-1`` +:ref:`int` **skin_root** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Transform3D`\] **get_inverse_binds**\ (\ ) +:ref:`Array`\[:ref:`Transform3D`\] **get_inverse_binds**\ (\ ) :ref:`🔗` .. container:: contribute @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_joint_i_to_bone_i**\ (\ ) +:ref:`Dictionary` **get_joint_i_to_bone_i**\ (\ ) :ref:`🔗` .. container:: contribute @@ -248,7 +248,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_joint_i_to_name**\ (\ ) +:ref:`Dictionary` **get_joint_i_to_name**\ (\ ) :ref:`🔗` .. container:: contribute @@ -262,7 +262,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_inverse_binds**\ (\ inverse_binds\: :ref:`Array`\[:ref:`Transform3D`\]\ ) +|void| **set_inverse_binds**\ (\ inverse_binds\: :ref:`Array`\[:ref:`Transform3D`\]\ ) :ref:`🔗` .. container:: contribute @@ -276,7 +276,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_joint_i_to_bone_i**\ (\ joint_i_to_bone_i\: :ref:`Dictionary`\ ) +|void| **set_joint_i_to_bone_i**\ (\ joint_i_to_bone_i\: :ref:`Dictionary`\ ) :ref:`🔗` .. container:: contribute @@ -290,7 +290,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_joint_i_to_name**\ (\ joint_i_to_name\: :ref:`Dictionary`\ ) +|void| **set_joint_i_to_name**\ (\ joint_i_to_name\: :ref:`Dictionary`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_gltfspecgloss.rst b/classes/class_gltfspecgloss.rst index cd22b6517e8..a5cb4f2d997 100644 --- a/classes/class_gltfspecgloss.rst +++ b/classes/class_gltfspecgloss.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **diffuse_factor** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **diffuse_factor** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ The reflected diffuse factor of the material. .. rst-class:: classref-property -:ref:`Image` **diffuse_img** +:ref:`Image` **diffuse_img** :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ The diffuse texture. .. rst-class:: classref-property -:ref:`float` **gloss_factor** = ``1.0`` +:ref:`float` **gloss_factor** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ The glossiness or smoothness of the material. .. rst-class:: classref-property -:ref:`Image` **spec_gloss_img** +:ref:`Image` **spec_gloss_img** :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ The specular-glossiness texture. .. rst-class:: classref-property -:ref:`Color` **specular_factor** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **specular_factor** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 27093e6088b..9faaf6c653d 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -42,6 +42,8 @@ Properties .. table:: :widths: auto + +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`bake_fps` | ``30.0`` | +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+ | :ref:`String` | :ref:`base_path` | ``""`` | +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+ @@ -173,7 +175,7 @@ Constants .. rst-class:: classref-constant -**HANDLE_BINARY_DISCARD_TEXTURES** = ``0`` +**HANDLE_BINARY_DISCARD_TEXTURES** = ``0`` :ref:`🔗` Discards all embedded textures and uses untextured materials. @@ -181,7 +183,7 @@ Discards all embedded textures and uses untextured materials. .. rst-class:: classref-constant -**HANDLE_BINARY_EXTRACT_TEXTURES** = ``1`` +**HANDLE_BINARY_EXTRACT_TEXTURES** = ``1`` :ref:`🔗` Extracts embedded textures to be reimported and compressed. Editor only. Acts as uncompressed at runtime. @@ -189,7 +191,7 @@ Extracts embedded textures to be reimported and compressed. Editor only. Acts as .. rst-class:: classref-constant -**HANDLE_BINARY_EMBED_AS_BASISU** = ``2`` +**HANDLE_BINARY_EMBED_AS_BASISU** = ``2`` :ref:`🔗` Embeds textures VRAM compressed with Basis Universal into the generated scene. @@ -197,7 +199,7 @@ Embeds textures VRAM compressed with Basis Universal into the generated scene. .. rst-class:: classref-constant -**HANDLE_BINARY_EMBED_AS_UNCOMPRESSED** = ``3`` +**HANDLE_BINARY_EMBED_AS_UNCOMPRESSED** = ``3`` :ref:`🔗` Embeds textures compressed losslessly into the generated scene, matching old behavior. @@ -210,11 +212,28 @@ Embeds textures compressed losslessly into the generated scene, matching old beh Property Descriptions --------------------- +.. _class_GLTFState_property_bake_fps: + +.. rst-class:: classref-property + +:ref:`float` **bake_fps** = ``30.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_bake_fps**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bake_fps**\ (\ ) + +The baking fps of the animation for either import or export. + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFState_property_base_path: .. rst-class:: classref-property -:ref:`String` **base_path** = ``""`` +:ref:`String` **base_path** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +250,7 @@ The folder path associated with this GLTF data. This is used to find other files .. rst-class:: classref-property -:ref:`Array`\[:ref:`PackedByteArray`\] **buffers** = ``[]`` +:ref:`Array`\[:ref:`PackedByteArray`\] **buffers** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -250,7 +269,7 @@ The folder path associated with this GLTF data. This is used to find other files .. rst-class:: classref-property -:ref:`String` **copyright** = ``""`` +:ref:`String` **copyright** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -267,7 +286,7 @@ The copyright string in the asset header of the GLTF file. This is set during im .. rst-class:: classref-property -:ref:`bool` **create_animations** = ``true`` +:ref:`bool` **create_animations** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -286,7 +305,7 @@ The copyright string in the asset header of the GLTF file. This is set during im .. rst-class:: classref-property -:ref:`String` **filename** = ``""`` +:ref:`String` **filename** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -303,7 +322,7 @@ The file name associated with this GLTF data. If it ends with ``.gltf``, this is .. rst-class:: classref-property -:ref:`PackedByteArray` **glb_data** = ``PackedByteArray()`` +:ref:`PackedByteArray` **glb_data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -322,7 +341,7 @@ The binary buffer attached to a .glb file. .. rst-class:: classref-property -:ref:`bool` **import_as_skeleton_bones** = ``false`` +:ref:`bool` **import_as_skeleton_bones** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -339,7 +358,7 @@ True to force all GLTFNodes in the document to be bones of a single Skeleton3D g .. rst-class:: classref-property -:ref:`Dictionary` **json** = ``{}`` +:ref:`Dictionary` **json** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +375,7 @@ The original raw JSON document corresponding to this GLTFState. .. rst-class:: classref-property -:ref:`int` **major_version** = ``0`` +:ref:`int` **major_version** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +394,7 @@ The original raw JSON document corresponding to this GLTFState. .. rst-class:: classref-property -:ref:`int` **minor_version** = ``0`` +:ref:`int` **minor_version** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -394,7 +413,7 @@ The original raw JSON document corresponding to this GLTFState. .. rst-class:: classref-property -:ref:`PackedInt32Array` **root_nodes** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **root_nodes** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -413,7 +432,7 @@ The root nodes of the GLTF file. Typically, a GLTF file will only have one scene .. rst-class:: classref-property -:ref:`String` **scene_name** = ``""`` +:ref:`String` **scene_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -430,7 +449,7 @@ The name of the scene. When importing, if not specified, this will be the file n .. rst-class:: classref-property -:ref:`bool` **use_named_skin_binds** = ``false`` +:ref:`bool` **use_named_skin_binds** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -454,7 +473,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_used_extension**\ (\ extension_name\: :ref:`String`, required\: :ref:`bool`\ ) +|void| **add_used_extension**\ (\ extension_name\: :ref:`String`, required\: :ref:`bool`\ ) :ref:`🔗` Appends an extension to the list of extensions used by this GLTF file during serialization. If ``required`` is true, the extension will also be added to the list of required extensions. Do not run this in :ref:`GLTFDocumentExtension._export_post`, as that stage is too late to add extensions. The final list is sorted alphabetically. @@ -466,7 +485,7 @@ Appends an extension to the list of extensions used by this GLTF file during ser .. rst-class:: classref-method -:ref:`int` **append_data_to_buffers**\ (\ data\: :ref:`PackedByteArray`, deduplication\: :ref:`bool`\ ) +:ref:`int` **append_data_to_buffers**\ (\ data\: :ref:`PackedByteArray`, deduplication\: :ref:`bool`\ ) :ref:`🔗` Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferView` for it. The index of the destination :ref:`GLTFBufferView` is returned. If ``deduplication`` is true, the buffers will first be searched for duplicate data, otherwise new bytes will always be appended. @@ -478,7 +497,7 @@ Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferV .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFAccessor`\] **get_accessors**\ (\ ) +:ref:`Array`\[:ref:`GLTFAccessor`\] **get_accessors**\ (\ ) :ref:`🔗` .. container:: contribute @@ -492,7 +511,7 @@ Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferV .. rst-class:: classref-method -:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` Gets additional arbitrary data in this **GLTFState** instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -506,7 +525,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animation_player**\ (\ idx\: :ref:`int`\ ) +:ref:`AnimationPlayer` **get_animation_player**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`AnimationPlayer` node with the given index. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to GLTF animations. @@ -518,7 +537,7 @@ Returns the :ref:`AnimationPlayer` node with the given in .. rst-class:: classref-method -:ref:`int` **get_animation_players_count**\ (\ idx\: :ref:`int`\ ) +:ref:`int` **get_animation_players_count**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns the number of :ref:`AnimationPlayer` nodes in this **GLTFState**. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to GLTF animations. @@ -530,7 +549,7 @@ Returns the number of :ref:`AnimationPlayer` nodes in thi .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFAnimation`\] **get_animations**\ (\ ) +:ref:`Array`\[:ref:`GLTFAnimation`\] **get_animations**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF file. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. @@ -542,7 +561,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFBufferView`\] **get_buffer_views**\ (\ ) +:ref:`Array`\[:ref:`GLTFBufferView`\] **get_buffer_views**\ (\ ) :ref:`🔗` .. container:: contribute @@ -556,7 +575,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFCamera`\] **get_cameras**\ (\ ) +:ref:`Array`\[:ref:`GLTFCamera`\] **get_cameras**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. These are the cameras that the :ref:`GLTFNode.camera` index refers to. @@ -568,7 +587,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. .. rst-class:: classref-method -:ref:`int` **get_handle_binary_image**\ (\ ) +:ref:`int` **get_handle_binary_image**\ (\ ) :ref:`🔗` .. container:: contribute @@ -582,7 +601,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Texture2D`\] **get_images**\ (\ ) +:ref:`Array`\[:ref:`Texture2D`\] **get_images**\ (\ ) :ref:`🔗` Gets the images of the GLTF file as an array of :ref:`Texture2D`\ s. These are the images that the :ref:`GLTFTexture.src_image` index refers to. @@ -594,7 +613,7 @@ Gets the images of the GLTF file as an array of :ref:`Texture2D .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFLight`\] **get_lights**\ (\ ) +:ref:`Array`\[:ref:`GLTFLight`\] **get_lights**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. These are the lights that the :ref:`GLTFNode.light` index refers to. @@ -606,7 +625,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. T .. rst-class:: classref-method -:ref:`Array`\[:ref:`Material`\] **get_materials**\ (\ ) +:ref:`Array`\[:ref:`Material`\] **get_materials**\ (\ ) :ref:`🔗` .. container:: contribute @@ -620,7 +639,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. T .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFMesh`\] **get_meshes**\ (\ ) +:ref:`Array`\[:ref:`GLTFMesh`\] **get_meshes**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFMesh`\ es in the GLTF file. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. @@ -632,7 +651,7 @@ Returns an array of all :ref:`GLTFMesh`\ es in the GLTF file. Th .. rst-class:: classref-method -:ref:`int` **get_node_index**\ (\ scene_node\: :ref:`Node`\ ) +:ref:`int` **get_node_index**\ (\ scene_node\: :ref:`Node`\ ) :ref:`🔗` Returns the index of the :ref:`GLTFNode` corresponding to this Godot scene node. This is the inverse of :ref:`get_scene_node`. Useful during the export process. @@ -646,7 +665,7 @@ Returns the index of the :ref:`GLTFNode` corresponding to this G .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFNode`\] **get_nodes**\ (\ ) +:ref:`Array`\[:ref:`GLTFNode`\] **get_nodes**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFNode`\ s in the GLTF file. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. This includes nodes that may not be generated in the Godot scene, or nodes that may generate multiple Godot scene nodes. @@ -658,7 +677,7 @@ Returns an array of all :ref:`GLTFNode`\ s in the GLTF file. The .. rst-class:: classref-method -:ref:`Node` **get_scene_node**\ (\ idx\: :ref:`int`\ ) +:ref:`Node` **get_scene_node**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns the Godot scene node that corresponds to the same index as the :ref:`GLTFNode` it was generated from. This is the inverse of :ref:`get_node_index`. Useful during the import process. @@ -672,7 +691,7 @@ Returns the Godot scene node that corresponds to the same index as the :ref:`GLT .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFSkeleton`\] **get_skeletons**\ (\ ) +:ref:`Array`\[:ref:`GLTFSkeleton`\] **get_skeletons**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFSkeleton`\ s in the GLTF file. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. @@ -684,7 +703,7 @@ Returns an array of all :ref:`GLTFSkeleton`\ s in the GLTF f .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFSkin`\] **get_skins**\ (\ ) +:ref:`Array`\[:ref:`GLTFSkin`\] **get_skins**\ (\ ) :ref:`🔗` Returns an array of all :ref:`GLTFSkin`\ s in the GLTF file. These are the skins that the :ref:`GLTFNode.skin` index refers to. @@ -696,7 +715,7 @@ Returns an array of all :ref:`GLTFSkin`\ s in the GLTF file. The .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFTextureSampler`\] **get_texture_samplers**\ (\ ) +:ref:`Array`\[:ref:`GLTFTextureSampler`\] **get_texture_samplers**\ (\ ) :ref:`🔗` Retrieves the array of texture samplers that are used by the textures contained in the GLTF. @@ -708,7 +727,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFTexture`\] **get_textures**\ (\ ) +:ref:`Array`\[:ref:`GLTFTexture`\] **get_textures**\ (\ ) :ref:`🔗` .. container:: contribute @@ -722,7 +741,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **get_unique_animation_names**\ (\ ) +:ref:`Array`\[:ref:`String`\] **get_unique_animation_names**\ (\ ) :ref:`🔗` Returns an array of unique animation names. This is only used during the import process. @@ -734,7 +753,7 @@ Returns an array of unique animation names. This is only used during the import .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) +:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) :ref:`🔗` Returns an array of unique node names. This is used in both the import process and export process. @@ -746,7 +765,7 @@ Returns an array of unique node names. This is used in both the import process a .. rst-class:: classref-method -|void| **set_accessors**\ (\ accessors\: :ref:`Array`\[:ref:`GLTFAccessor`\]\ ) +|void| **set_accessors**\ (\ accessors\: :ref:`Array`\[:ref:`GLTFAccessor`\]\ ) :ref:`🔗` .. container:: contribute @@ -760,7 +779,7 @@ Returns an array of unique node names. This is used in both the import process a .. rst-class:: classref-method -|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) :ref:`🔗` Sets additional arbitrary data in this **GLTFState** instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -774,7 +793,7 @@ The first argument should be the :ref:`GLTFDocumentExtension`\[:ref:`GLTFAnimation`\]\ ) +|void| **set_animations**\ (\ animations\: :ref:`Array`\[:ref:`GLTFAnimation`\]\ ) :ref:`🔗` Sets the :ref:`GLTFAnimation`\ s in the state. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. @@ -786,7 +805,7 @@ Sets the :ref:`GLTFAnimation`\ s in the state. When importi .. rst-class:: classref-method -|void| **set_buffer_views**\ (\ buffer_views\: :ref:`Array`\[:ref:`GLTFBufferView`\]\ ) +|void| **set_buffer_views**\ (\ buffer_views\: :ref:`Array`\[:ref:`GLTFBufferView`\]\ ) :ref:`🔗` .. container:: contribute @@ -800,7 +819,7 @@ Sets the :ref:`GLTFAnimation`\ s in the state. When importi .. rst-class:: classref-method -|void| **set_cameras**\ (\ cameras\: :ref:`Array`\[:ref:`GLTFCamera`\]\ ) +|void| **set_cameras**\ (\ cameras\: :ref:`Array`\[:ref:`GLTFCamera`\]\ ) :ref:`🔗` Sets the :ref:`GLTFCamera`\ s in the state. These are the cameras that the :ref:`GLTFNode.camera` index refers to. @@ -812,7 +831,7 @@ Sets the :ref:`GLTFCamera`\ s in the state. These are the came .. rst-class:: classref-method -|void| **set_handle_binary_image**\ (\ method\: :ref:`int`\ ) +|void| **set_handle_binary_image**\ (\ method\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute @@ -826,7 +845,7 @@ Sets the :ref:`GLTFCamera`\ s in the state. These are the came .. rst-class:: classref-method -|void| **set_images**\ (\ images\: :ref:`Array`\[:ref:`Texture2D`\]\ ) +|void| **set_images**\ (\ images\: :ref:`Array`\[:ref:`Texture2D`\]\ ) :ref:`🔗` Sets the images in the state stored as an array of :ref:`Texture2D`\ s. This can be used during export. These are the images that the :ref:`GLTFTexture.src_image` index refers to. @@ -838,7 +857,7 @@ Sets the images in the state stored as an array of :ref:`Texture2D`\[:ref:`GLTFLight`\]\ ) +|void| **set_lights**\ (\ lights\: :ref:`Array`\[:ref:`GLTFLight`\]\ ) :ref:`🔗` Sets the :ref:`GLTFLight`\ s in the state. These are the lights that the :ref:`GLTFNode.light` index refers to. @@ -850,7 +869,7 @@ Sets the :ref:`GLTFLight`\ s in the state. These are the lights .. rst-class:: classref-method -|void| **set_materials**\ (\ materials\: :ref:`Array`\[:ref:`Material`\]\ ) +|void| **set_materials**\ (\ materials\: :ref:`Array`\[:ref:`Material`\]\ ) :ref:`🔗` .. container:: contribute @@ -864,7 +883,7 @@ Sets the :ref:`GLTFLight`\ s in the state. These are the lights .. rst-class:: classref-method -|void| **set_meshes**\ (\ meshes\: :ref:`Array`\[:ref:`GLTFMesh`\]\ ) +|void| **set_meshes**\ (\ meshes\: :ref:`Array`\[:ref:`GLTFMesh`\]\ ) :ref:`🔗` Sets the :ref:`GLTFMesh`\ es in the state. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. @@ -876,7 +895,7 @@ Sets the :ref:`GLTFMesh`\ es in the state. These are the meshes .. rst-class:: classref-method -|void| **set_nodes**\ (\ nodes\: :ref:`Array`\[:ref:`GLTFNode`\]\ ) +|void| **set_nodes**\ (\ nodes\: :ref:`Array`\[:ref:`GLTFNode`\]\ ) :ref:`🔗` Sets the :ref:`GLTFNode`\ s in the state. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. Some of the nodes set here may not be generated in the Godot scene, or may generate multiple Godot scene nodes. @@ -888,7 +907,7 @@ Sets the :ref:`GLTFNode`\ s in the state. These are the nodes th .. rst-class:: classref-method -|void| **set_skeletons**\ (\ skeletons\: :ref:`Array`\[:ref:`GLTFSkeleton`\]\ ) +|void| **set_skeletons**\ (\ skeletons\: :ref:`Array`\[:ref:`GLTFSkeleton`\]\ ) :ref:`🔗` Sets the :ref:`GLTFSkeleton`\ s in the state. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. @@ -900,7 +919,7 @@ Sets the :ref:`GLTFSkeleton`\ s in the state. These are the .. rst-class:: classref-method -|void| **set_skins**\ (\ skins\: :ref:`Array`\[:ref:`GLTFSkin`\]\ ) +|void| **set_skins**\ (\ skins\: :ref:`Array`\[:ref:`GLTFSkin`\]\ ) :ref:`🔗` Sets the :ref:`GLTFSkin`\ s in the state. These are the skins that the :ref:`GLTFNode.skin` index refers to. @@ -912,7 +931,7 @@ Sets the :ref:`GLTFSkin`\ s in the state. These are the skins th .. rst-class:: classref-method -|void| **set_texture_samplers**\ (\ texture_samplers\: :ref:`Array`\[:ref:`GLTFTextureSampler`\]\ ) +|void| **set_texture_samplers**\ (\ texture_samplers\: :ref:`Array`\[:ref:`GLTFTextureSampler`\]\ ) :ref:`🔗` Sets the array of texture samplers that are used by the textures contained in the GLTF. @@ -924,7 +943,7 @@ Sets the array of texture samplers that are used by the textures contained in th .. rst-class:: classref-method -|void| **set_textures**\ (\ textures\: :ref:`Array`\[:ref:`GLTFTexture`\]\ ) +|void| **set_textures**\ (\ textures\: :ref:`Array`\[:ref:`GLTFTexture`\]\ ) :ref:`🔗` .. container:: contribute @@ -938,7 +957,7 @@ Sets the array of texture samplers that are used by the textures contained in th .. rst-class:: classref-method -|void| **set_unique_animation_names**\ (\ unique_animation_names\: :ref:`Array`\[:ref:`String`\]\ ) +|void| **set_unique_animation_names**\ (\ unique_animation_names\: :ref:`Array`\[:ref:`String`\]\ ) :ref:`🔗` Sets the unique animation names in the state. This is only used during the import process. @@ -950,7 +969,7 @@ Sets the unique animation names in the state. This is only used during the impor .. rst-class:: classref-method -|void| **set_unique_names**\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) +|void| **set_unique_names**\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) :ref:`🔗` Sets the unique node names in the state. This is used in both the import process and export process. diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index 2c5882f7c6d..187d5364509 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **sampler** = ``-1`` +:ref:`int` **sampler** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ ID of the texture sampler to use when sampling the image. If -1, then the defaul .. rst-class:: classref-property -:ref:`int` **src_image** = ``-1`` +:ref:`int` **src_image** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gltftexturesampler.rst b/classes/class_gltftexturesampler.rst index f8f5081d7fa..dad254a2c83 100644 --- a/classes/class_gltftexturesampler.rst +++ b/classes/class_gltftexturesampler.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **mag_filter** = ``9729`` +:ref:`int` **mag_filter** = ``9729`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -76,7 +76,7 @@ Texture's magnification filter, used when texture appears larger on screen than .. rst-class:: classref-property -:ref:`int` **min_filter** = ``9987`` +:ref:`int` **min_filter** = ``9987`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Texture's minification filter, used when the texture appears smaller on screen t .. rst-class:: classref-property -:ref:`int` **wrap_s** = ``10497`` +:ref:`int` **wrap_s** = ``10497`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ Wrapping mode to use for S-axis (horizontal) texture coordinates. .. rst-class:: classref-property -:ref:`int` **wrap_t** = ``10497`` +:ref:`int` **wrap_t** = ``10497`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst deleted file mode 100644 index 35b23938761..00000000000 --- a/classes/class_godotsharp.rst +++ /dev/null @@ -1,62 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/mono/doc_classes/GodotSharp.xml. - -.. _class_GodotSharp: - -GodotSharp -========== - -**Inherits:** :ref:`Object` - -Bridge between Godot and the Mono runtime (Mono-enabled builds only). - -.. rst-class:: classref-introduction-group - -Description ------------ - -This class is a bridge between Godot and the Mono runtime. It exposes several low-level operations and is only available in Mono-enabled Godot builds. - -See also :ref:`CSharpScript`. - -.. rst-class:: classref-reftable-group - -Methods -------- - -.. table:: - :widths: auto - - +-------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_runtime_initialized`\ (\ ) | - +-------------------------+-------------------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Method Descriptions -------------------- - -.. _class_GodotSharp_method_is_runtime_initialized: - -.. rst-class:: classref-method - -:ref:`bool` **is_runtime_initialized**\ (\ ) - -Returns ``true`` if the .NET runtime is initialized, ``false`` otherwise. - -.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` -.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` -.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` -.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` -.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` -.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index dff2c7568d2..46f6cfa8562 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -125,7 +125,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when all active particles have finished processing. To immediately restart the emission cycle, call :ref:`restart`. @@ -146,7 +146,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawOrder**: +enum **DrawOrder**: :ref:`🔗` .. _class_GPUParticles2D_constant_DRAW_ORDER_INDEX: @@ -180,7 +180,7 @@ Particles are drawn in reverse order of remaining lifetime. In other words, the .. rst-class:: classref-enumeration -enum **EmitFlags**: +enum **EmitFlags**: :ref:`🔗` .. _class_GPUParticles2D_constant_EMIT_FLAG_POSITION: @@ -235,7 +235,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **amount** = ``8`` +:ref:`int` **amount** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ The number of particles to emit in one emission cycle. The effective emission ra .. rst-class:: classref-property -:ref:`float` **amount_ratio** = ``1.0`` +:ref:`float` **amount_ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -273,7 +273,7 @@ The ratio of particles that should actually be emitted. If set to a value lower .. rst-class:: classref-property -:ref:`float` **collision_base_size** = ``1.0`` +:ref:`float` **collision_base_size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ Multiplier for particle's collision radius. ``1.0`` corresponds to the size of t .. rst-class:: classref-property -:ref:`DrawOrder` **draw_order** = ``1`` +:ref:`DrawOrder` **draw_order** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -309,7 +309,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`bool` **emitting** = ``true`` +:ref:`bool` **emitting** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -330,7 +330,7 @@ If ``true``, particles are being emitted. :ref:`emitting` **explosiveness** = ``0.0`` +:ref:`float` **explosiveness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +347,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t .. rst-class:: classref-property -:ref:`int` **fixed_fps** = ``30`` +:ref:`int` **fixed_fps** = ``30`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -364,7 +364,7 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property -:ref:`bool` **fract_delta** = ``true`` +:ref:`bool` **fract_delta** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -381,7 +381,7 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property -:ref:`float` **interp_to_end** = ``0.0`` +:ref:`float` **interp_to_end** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -400,7 +400,7 @@ Causes all the particles in this node to interpolate towards the end of their li .. rst-class:: classref-property -:ref:`bool` **interpolate** = ``true`` +:ref:`bool` **interpolate** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -417,7 +417,7 @@ Enables particle interpolation, which makes the particle movement smoother when .. rst-class:: classref-property -:ref:`float` **lifetime** = ``1.0`` +:ref:`float` **lifetime** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -434,7 +434,7 @@ The amount of time each particle will exist (in seconds). The effective emission .. rst-class:: classref-property -:ref:`bool` **local_coords** = ``false`` +:ref:`bool` **local_coords** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -451,7 +451,7 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property -:ref:`bool` **one_shot** = ``false`` +:ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -468,7 +468,7 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi .. rst-class:: classref-property -:ref:`float` **preprocess** = ``0.0`` +:ref:`float` **preprocess** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -485,7 +485,7 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property -:ref:`Material` **process_material** +:ref:`Material` **process_material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -502,7 +502,7 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property -:ref:`float` **randomness** = ``0.0`` +:ref:`float` **randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -519,7 +519,7 @@ Emission lifetime randomness ratio. .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -536,7 +536,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. rst-class:: classref-property -:ref:`NodePath` **sub_emitter** = ``NodePath("")`` +:ref:`NodePath` **sub_emitter** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -555,7 +555,7 @@ Path to another **GPUParticles2D** node that will be used as a subemitter (see : .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -574,7 +574,7 @@ Particle texture. If ``null``, particles will be squares with a size of 1×1 pix .. rst-class:: classref-property -:ref:`bool` **trail_enabled** = ``false`` +:ref:`bool` **trail_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -593,7 +593,7 @@ If ``true``, enables particle trails using a mesh skinning system. .. rst-class:: classref-property -:ref:`float` **trail_lifetime** = ``0.3`` +:ref:`float` **trail_lifetime** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -610,7 +610,7 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. rst-class:: classref-property -:ref:`int` **trail_section_subdivisions** = ``4`` +:ref:`int` **trail_section_subdivisions** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -627,7 +627,7 @@ The number of subdivisions to use for the particle trail rendering. Higher value .. rst-class:: classref-property -:ref:`int` **trail_sections** = ``8`` +:ref:`int` **trail_sections** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -644,7 +644,7 @@ The number of sections to use for the particle trail rendering. Higher values ca .. rst-class:: classref-property -:ref:`Rect2` **visibility_rect** = ``Rect2(-100, -100, 200, 200)`` +:ref:`Rect2` **visibility_rect** = ``Rect2(-100, -100, 200, 200)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -668,7 +668,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **capture_rect**\ (\ ) |const| +:ref:`Rect2` **capture_rect**\ (\ ) |const| :ref:`🔗` Returns a rectangle containing the positions of all existing particles. @@ -682,7 +682,7 @@ Returns a rectangle containing the positions of all existing particles. .. rst-class:: classref-method -|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) :ref:`🔗` Sets this node's properties to match a given :ref:`CPUParticles2D` node. @@ -694,7 +694,7 @@ Sets this node's properties to match a given :ref:`CPUParticles2D`, velocity\: :ref:`Vector2`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) +|void| **emit_particle**\ (\ xform\: :ref:`Transform2D`, velocity\: :ref:`Vector2`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) :ref:`🔗` Emits a single particle. Whether ``xform``, ``velocity``, ``color`` and ``custom`` are applied depends on the value of ``flags``. See :ref:`EmitFlags`. @@ -708,7 +708,7 @@ The default ParticleProcessMaterial will overwrite ``color`` and use the content .. rst-class:: classref-method -|void| **restart**\ (\ ) +|void| **restart**\ (\ ) :ref:`🔗` Restarts the particle emission cycle, clearing existing particles. To avoid particles vanishing from the viewport, wait for the :ref:`finished` signal before calling. diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 208b1d9bc5b..524f13b68c8 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -135,7 +135,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when all active particles have finished processing. To immediately emit new particles, call :ref:`restart`. @@ -156,7 +156,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawOrder**: +enum **DrawOrder**: :ref:`🔗` .. _class_GPUParticles3D_constant_DRAW_ORDER_INDEX: @@ -198,7 +198,7 @@ Particles are drawn in order of depth. .. rst-class:: classref-enumeration -enum **EmitFlags**: +enum **EmitFlags**: :ref:`🔗` .. _class_GPUParticles3D_constant_EMIT_FLAG_POSITION: @@ -248,7 +248,7 @@ Particle starts with specified ``CUSTOM`` data. .. rst-class:: classref-enumeration -enum **TransformAlign**: +enum **TransformAlign**: :ref:`🔗` .. _class_GPUParticles3D_constant_TRANSFORM_ALIGN_DISABLED: @@ -311,7 +311,7 @@ Constants .. rst-class:: classref-constant -**MAX_DRAW_PASSES** = ``4`` +**MAX_DRAW_PASSES** = ``4`` :ref:`🔗` Maximum number of draw passes supported. @@ -328,7 +328,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **amount** = ``8`` +:ref:`int` **amount** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +347,7 @@ The number of particles to emit in one emission cycle. The effective emission ra .. rst-class:: classref-property -:ref:`float` **amount_ratio** = ``1.0`` +:ref:`float` **amount_ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -366,7 +366,7 @@ The ratio of particles that should actually be emitted. If set to a value lower .. rst-class:: classref-property -:ref:`float` **collision_base_size** = ``0.01`` +:ref:`float` **collision_base_size** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -385,7 +385,7 @@ The base diameter for particle collision in meters. If particles appear to sink .. rst-class:: classref-property -:ref:`DrawOrder` **draw_order** = ``0`` +:ref:`DrawOrder` **draw_order** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -404,7 +404,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`Mesh` **draw_pass_1** +:ref:`Mesh` **draw_pass_1** :ref:`🔗` .. rst-class:: classref-property-setget @@ -421,7 +421,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`Mesh` **draw_pass_2** +:ref:`Mesh` **draw_pass_2** :ref:`🔗` .. rst-class:: classref-property-setget @@ -438,7 +438,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`Mesh` **draw_pass_3** +:ref:`Mesh` **draw_pass_3** :ref:`🔗` .. rst-class:: classref-property-setget @@ -455,7 +455,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`Mesh` **draw_pass_4** +:ref:`Mesh` **draw_pass_4** :ref:`🔗` .. rst-class:: classref-property-setget @@ -472,7 +472,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property -:ref:`int` **draw_passes** = ``1`` +:ref:`int` **draw_passes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -489,7 +489,7 @@ The number of draw passes when rendering particles. .. rst-class:: classref-property -:ref:`Skin` **draw_skin** +:ref:`Skin` **draw_skin** :ref:`🔗` .. rst-class:: classref-property-setget @@ -508,7 +508,7 @@ The number of draw passes when rendering particles. .. rst-class:: classref-property -:ref:`bool` **emitting** = ``true`` +:ref:`bool` **emitting** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -529,7 +529,7 @@ If ``true``, particles are being emitted. :ref:`emitting` **explosiveness** = ``0.0`` +:ref:`float` **explosiveness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -546,7 +546,7 @@ Time ratio between each emission. If ``0``, particles are emitted continuously. .. rst-class:: classref-property -:ref:`int` **fixed_fps** = ``30`` +:ref:`int` **fixed_fps** = ``30`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -563,7 +563,7 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property -:ref:`bool` **fract_delta** = ``true`` +:ref:`bool` **fract_delta** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -580,7 +580,7 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property -:ref:`float` **interp_to_end** = ``0.0`` +:ref:`float` **interp_to_end** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -599,7 +599,7 @@ Causes all the particles in this node to interpolate towards the end of their li .. rst-class:: classref-property -:ref:`bool` **interpolate** = ``true`` +:ref:`bool` **interpolate** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -616,7 +616,7 @@ Enables particle interpolation, which makes the particle movement smoother when .. rst-class:: classref-property -:ref:`float` **lifetime** = ``1.0`` +:ref:`float` **lifetime** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -633,7 +633,7 @@ The amount of time each particle will exist (in seconds). The effective emission .. rst-class:: classref-property -:ref:`bool` **local_coords** = ``false`` +:ref:`bool` **local_coords** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -650,7 +650,7 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property -:ref:`bool` **one_shot** = ``false`` +:ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -667,7 +667,7 @@ If ``true``, only the number of particles equal to :ref:`amount` **preprocess** = ``0.0`` +:ref:`float` **preprocess** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -684,7 +684,7 @@ Amount of time to preprocess the particles before animation starts. Lets you sta .. rst-class:: classref-property -:ref:`Material` **process_material** +:ref:`Material` **process_material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -701,7 +701,7 @@ Amount of time to preprocess the particles before animation starts. Lets you sta .. rst-class:: classref-property -:ref:`float` **randomness** = ``0.0`` +:ref:`float` **randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -718,7 +718,7 @@ Emission randomness ratio. .. rst-class:: classref-property -:ref:`float` **speed_scale** = ``1.0`` +:ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -735,7 +735,7 @@ Speed scaling ratio. A value of ``0`` can be used to pause the particles. .. rst-class:: classref-property -:ref:`NodePath` **sub_emitter** = ``NodePath("")`` +:ref:`NodePath` **sub_emitter** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -754,7 +754,7 @@ Path to another **GPUParticles3D** node that will be used as a subemitter (see : .. rst-class:: classref-property -:ref:`bool` **trail_enabled** = ``false`` +:ref:`bool` **trail_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -775,7 +775,7 @@ If ``true``, enables particle trails using a mesh skinning system. Designed to w .. rst-class:: classref-property -:ref:`float` **trail_lifetime** = ``0.3`` +:ref:`float` **trail_lifetime** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -792,7 +792,7 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. rst-class:: classref-property -:ref:`TransformAlign` **transform_align** = ``0`` +:ref:`TransformAlign` **transform_align** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -811,7 +811,7 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. rst-class:: classref-property -:ref:`AABB` **visibility_aabb** = ``AABB(-4, -4, -4, 8, 8, 8)`` +:ref:`AABB` **visibility_aabb** = ``AABB(-4, -4, -4, 8, 8, 8)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -837,7 +837,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **capture_aabb**\ (\ ) |const| +:ref:`AABB` **capture_aabb**\ (\ ) |const| :ref:`🔗` Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. @@ -849,7 +849,7 @@ Returns the axis-aligned bounding box that contains all the particles that are a .. rst-class:: classref-method -|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) :ref:`🔗` Sets this node's properties to match a given :ref:`CPUParticles3D` node. @@ -861,7 +861,7 @@ Sets this node's properties to match a given :ref:`CPUParticles3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) +|void| **emit_particle**\ (\ xform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) :ref:`🔗` Emits a single particle. Whether ``xform``, ``velocity``, ``color`` and ``custom`` are applied depends on the value of ``flags``. See :ref:`EmitFlags`. @@ -875,7 +875,7 @@ The default ParticleProcessMaterial will overwrite ``color`` and use the content .. rst-class:: classref-method -:ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| +:ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Mesh` that is drawn at index ``pass``. @@ -887,7 +887,7 @@ Returns the :ref:`Mesh` that is drawn at index ``pass``. .. rst-class:: classref-method -|void| **restart**\ (\ ) +|void| **restart**\ (\ ) :ref:`🔗` Restarts the particle emission cycle, clearing existing particles. To avoid particles vanishing from the viewport, wait for the :ref:`finished` signal before calling. @@ -901,7 +901,7 @@ Restarts the particle emission cycle, clearing existing particles. To avoid part .. rst-class:: classref-method -|void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) +|void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) :ref:`🔗` Sets the :ref:`Mesh` that is drawn at index ``pass``. diff --git a/classes/class_gpuparticlesattractor3d.rst b/classes/class_gpuparticlesattractor3d.rst index df1af7032b9..1cb55fe99a0 100644 --- a/classes/class_gpuparticlesattractor3d.rst +++ b/classes/class_gpuparticlesattractor3d.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **attenuation** = ``1.0`` +:ref:`float` **attenuation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -77,7 +77,7 @@ The particle attractor's attenuation. Higher values result in more gradual pushi .. rst-class:: classref-property -:ref:`int` **cull_mask** = ``4294967295`` +:ref:`int` **cull_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -98,7 +98,7 @@ Particle attraction can also be disabled on a per-process material basis by sett .. rst-class:: classref-property -:ref:`float` **directionality** = ``0.0`` +:ref:`float` **directionality** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -117,7 +117,7 @@ Adjusts how directional the attractor is. At ``0.0``, the attractor is not direc .. rst-class:: classref-property -:ref:`float` **strength** = ``1.0`` +:ref:`float` **strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlesattractorbox3d.rst b/classes/class_gpuparticlesattractorbox3d.rst index a5f0015e830..64b42371c45 100644 --- a/classes/class_gpuparticlesattractorbox3d.rst +++ b/classes/class_gpuparticlesattractorbox3d.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlesattractorsphere3d.rst b/classes/class_gpuparticlesattractorsphere3d.rst index a3fc9c17f86..a0199f2be49 100644 --- a/classes/class_gpuparticlesattractorsphere3d.rst +++ b/classes/class_gpuparticlesattractorsphere3d.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **radius** = ``1.0`` +:ref:`float` **radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlesattractorvectorfield3d.rst b/classes/class_gpuparticlesattractorvectorfield3d.rst index a222426e411..25a122ef05a 100644 --- a/classes/class_gpuparticlesattractorvectorfield3d.rst +++ b/classes/class_gpuparticlesattractorvectorfield3d.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ The size of the vector field box in 3D units. .. rst-class:: classref-property -:ref:`Texture3D` **texture** +:ref:`Texture3D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlescollision3d.rst b/classes/class_gpuparticlescollision3d.rst index 766aaf81dcb..30095ef457a 100644 --- a/classes/class_gpuparticlescollision3d.rst +++ b/classes/class_gpuparticlescollision3d.rst @@ -58,7 +58,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **cull_mask** = ``4294967295`` +:ref:`int` **cull_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlescollisionbox3d.rst b/classes/class_gpuparticlescollisionbox3d.rst index 6c8effd7019..a335fba4955 100644 --- a/classes/class_gpuparticlescollisionbox3d.rst +++ b/classes/class_gpuparticlescollisionbox3d.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlescollisionheightfield3d.rst b/classes/class_gpuparticlescollisionheightfield3d.rst index 218f66bb792..da61e5ce4d6 100644 --- a/classes/class_gpuparticlescollisionheightfield3d.rst +++ b/classes/class_gpuparticlescollisionheightfield3d.rst @@ -60,7 +60,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Resolution**: +enum **Resolution**: :ref:`🔗` .. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_256: @@ -126,7 +126,7 @@ Represents the size of the :ref:`Resolution` .. _class_GPUParticlesCollisionHeightField3D_constant_UPDATE_MODE_WHEN_MOVED: @@ -157,7 +157,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **follow_camera_enabled** = ``false`` +:ref:`bool` **follow_camera_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Following the camera has a performance cost, as it will force the heightmap to u .. rst-class:: classref-property -:ref:`Resolution` **resolution** = ``2`` +:ref:`Resolution` **resolution** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ Higher resolutions can represent small details more accurately in large scenes, .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ The collision heightmap's size in 3D units. To improve heightmap quality, :ref:` .. rst-class:: classref-property -:ref:`UpdateMode` **update_mode** = ``0`` +:ref:`UpdateMode` **update_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gpuparticlescollisionsdf3d.rst b/classes/class_gpuparticlescollisionsdf3d.rst index 323e3377017..4f31607bee1 100644 --- a/classes/class_gpuparticlescollisionsdf3d.rst +++ b/classes/class_gpuparticlescollisionsdf3d.rst @@ -78,7 +78,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Resolution**: +enum **Resolution**: :ref:`🔗` .. _class_GPUParticlesCollisionSDF3D_constant_RESOLUTION_16: @@ -149,7 +149,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bake_mask** = ``4294967295`` +:ref:`int` **bake_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ The visual layers to account for when baking the particle collision SDF. Only :r .. rst-class:: classref-property -:ref:`Resolution` **resolution** = ``2`` +:ref:`Resolution` **resolution** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ The bake resolution to use for the signed distance field :ref:`texture` **size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ The collision SDF's size in 3D units. To improve SDF quality, the :ref:`size` **texture** +:ref:`Texture3D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ The 3D texture representing the signed distance field. .. rst-class:: classref-property -:ref:`float` **thickness** = ``1.0`` +:ref:`float` **thickness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_bake_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_bake_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`bake_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -251,7 +251,7 @@ Returns whether or not the specified layer of the :ref:`bake_mask`, value\: :ref:`bool`\ ) +|void| **set_bake_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`bake_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_gpuparticlescollisionsphere3d.rst b/classes/class_gpuparticlescollisionsphere3d.rst index ca6ceaf7eef..f4a2a3fbf98 100644 --- a/classes/class_gpuparticlescollisionsphere3d.rst +++ b/classes/class_gpuparticlescollisionsphere3d.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **radius** = ``1.0`` +:ref:`float` **radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 1e9d2c99946..b1e63e6dd29 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -82,7 +82,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **InterpolationMode**: +enum **InterpolationMode**: :ref:`🔗` .. _class_Gradient_constant_GRADIENT_INTERPOLATE_LINEAR: @@ -116,7 +116,7 @@ Cubic interpolation. .. rst-class:: classref-enumeration -enum **ColorSpace**: +enum **ColorSpace**: :ref:`🔗` .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_SRGB: @@ -155,7 +155,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedColorArray` **colors** = ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` +:ref:`PackedColorArray` **colors** = ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Gradient's colors as a :ref:`PackedColorArray`. .. rst-class:: classref-property -:ref:`ColorSpace` **interpolation_color_space** = ``0`` +:ref:`ColorSpace` **interpolation_color_space** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ The color space used to interpolate between points of the gradient. It does not .. rst-class:: classref-property -:ref:`InterpolationMode` **interpolation_mode** = ``0`` +:ref:`InterpolationMode` **interpolation_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ The algorithm used to interpolate between points of the gradient. See :ref:`Inte .. rst-class:: classref-property -:ref:`PackedFloat32Array` **offsets** = ``PackedFloat32Array(0, 1)`` +:ref:`PackedFloat32Array` **offsets** = ``PackedFloat32Array(0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_point**\ (\ offset\: :ref:`float`, color\: :ref:`Color`\ ) +|void| **add_point**\ (\ offset\: :ref:`float`, color\: :ref:`Color`\ ) :ref:`🔗` Adds the specified color to the gradient, with the specified offset. @@ -250,7 +250,7 @@ Adds the specified color to the gradient, with the specified offset. .. rst-class:: classref-method -:ref:`Color` **get_color**\ (\ point\: :ref:`int`\ ) +:ref:`Color` **get_color**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Returns the color of the gradient color at index ``point``. @@ -262,7 +262,7 @@ Returns the color of the gradient color at index ``point``. .. rst-class:: classref-method -:ref:`float` **get_offset**\ (\ point\: :ref:`int`\ ) +:ref:`float` **get_offset**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Returns the offset of the gradient color at index ``point``. @@ -274,7 +274,7 @@ Returns the offset of the gradient color at index ``point``. .. rst-class:: classref-method -:ref:`int` **get_point_count**\ (\ ) |const| +:ref:`int` **get_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of colors in the gradient. @@ -286,7 +286,7 @@ Returns the number of colors in the gradient. .. rst-class:: classref-method -|void| **remove_point**\ (\ point\: :ref:`int`\ ) +|void| **remove_point**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Removes the color at index ``point``. @@ -298,7 +298,7 @@ Removes the color at index ``point``. .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses/mirrors the gradient. @@ -312,7 +312,7 @@ Reverses/mirrors the gradient. .. rst-class:: classref-method -:ref:`Color` **sample**\ (\ offset\: :ref:`float`\ ) +:ref:`Color` **sample**\ (\ offset\: :ref:`float`\ ) :ref:`🔗` Returns the interpolated color specified by ``offset``. @@ -324,7 +324,7 @@ Returns the interpolated color specified by ``offset``. .. rst-class:: classref-method -|void| **set_color**\ (\ point\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_color**\ (\ point\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color of the gradient color at index ``point``. @@ -336,7 +336,7 @@ Sets the color of the gradient color at index ``point``. .. rst-class:: classref-method -|void| **set_offset**\ (\ point\: :ref:`int`, offset\: :ref:`float`\ ) +|void| **set_offset**\ (\ point\: :ref:`int`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the offset for the gradient color at index ``point``. diff --git a/classes/class_gradienttexture1d.rst b/classes/class_gradienttexture1d.rst index 7359da44360..2e939f756ad 100644 --- a/classes/class_gradienttexture1d.rst +++ b/classes/class_gradienttexture1d.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Gradient` **gradient** +:ref:`Gradient` **gradient** :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ The :ref:`Gradient` used to fill the texture. .. rst-class:: classref-property -:ref:`bool` **use_hdr** = ``false`` +:ref:`bool` **use_hdr** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ If ``true``, the generated texture will support high dynamic range (:ref:`Image. .. rst-class:: classref-property -:ref:`int` **width** = ``256`` +:ref:`int` **width** = ``256`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst index e5716b9ded3..ad66f711879 100644 --- a/classes/class_gradienttexture2d.rst +++ b/classes/class_gradienttexture2d.rst @@ -62,7 +62,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Fill**: +enum **Fill**: :ref:`🔗` .. _class_GradientTexture2D_constant_FILL_LINEAR: @@ -96,7 +96,7 @@ The colors are linearly interpolated in a square pattern. .. rst-class:: classref-enumeration -enum **Repeat**: +enum **Repeat**: :ref:`🔗` .. _class_GradientTexture2D_constant_REPEAT_NONE: @@ -135,7 +135,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Fill` **fill** = ``0`` +:ref:`Fill` **fill** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ The gradient fill type, one of the :ref:`Fill` valu .. rst-class:: classref-property -:ref:`Vector2` **fill_from** = ``Vector2(0, 0)`` +:ref:`Vector2` **fill_from** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ The initial offset used to fill the texture specified in UV coordinates. .. rst-class:: classref-property -:ref:`Vector2` **fill_to** = ``Vector2(1, 0)`` +:ref:`Vector2` **fill_to** = ``Vector2(1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -186,7 +186,7 @@ The final offset used to fill the texture specified in UV coordinates. .. rst-class:: classref-property -:ref:`Gradient` **gradient** +:ref:`Gradient` **gradient** :ref:`🔗` .. rst-class:: classref-property-setget @@ -203,7 +203,7 @@ The :ref:`Gradient` used to fill the texture. .. rst-class:: classref-property -:ref:`int` **height** = ``64`` +:ref:`int` **height** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ The number of vertical color samples that will be obtained from the :ref:`Gradie .. rst-class:: classref-property -:ref:`Repeat` **repeat** = ``0`` +:ref:`Repeat` **repeat** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ The gradient repeat type, one of the :ref:`Repeat .. rst-class:: classref-property -:ref:`bool` **use_hdr** = ``false`` +:ref:`bool` **use_hdr** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ If ``true``, the generated texture will support high dynamic range (:ref:`Image. .. rst-class:: classref-property -:ref:`int` **width** = ``64`` +:ref:`int` **width** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index b246d64efc4..21dbf9a8fc1 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -214,7 +214,7 @@ Signals .. rst-class:: classref-signal -**begin_node_move**\ (\ ) +**begin_node_move**\ (\ ) :ref:`🔗` Emitted at the beginning of a :ref:`GraphElement`'s movement. @@ -226,7 +226,7 @@ Emitted at the beginning of a :ref:`GraphElement`'s movement .. rst-class:: classref-signal -**connection_drag_ended**\ (\ ) +**connection_drag_ended**\ (\ ) :ref:`🔗` Emitted at the end of a connection drag. @@ -238,7 +238,7 @@ Emitted at the end of a connection drag. .. rst-class:: classref-signal -**connection_drag_started**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, is_output\: :ref:`bool`\ ) +**connection_drag_started**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, is_output\: :ref:`bool`\ ) :ref:`🔗` Emitted at the beginning of a connection drag. @@ -250,7 +250,7 @@ Emitted at the beginning of a connection drag. .. rst-class:: classref-signal -**connection_from_empty**\ (\ to_node\: :ref:`StringName`, to_port\: :ref:`int`, release_position\: :ref:`Vector2`\ ) +**connection_from_empty**\ (\ to_node\: :ref:`StringName`, to_port\: :ref:`int`, release_position\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when user drags a connection from an input port into the empty space of the graph. @@ -262,7 +262,7 @@ Emitted when user drags a connection from an input port into the empty space of .. rst-class:: classref-signal -**connection_request**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) +**connection_request**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) :ref:`🔗` Emitted to the GraphEdit when the connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode` and the ``to_port`` of the ``to_node`` :ref:`GraphNode` is attempted to be created. @@ -274,7 +274,7 @@ Emitted to the GraphEdit when the connection between the ``from_port`` of the `` .. rst-class:: classref-signal -**connection_to_empty**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, release_position\: :ref:`Vector2`\ ) +**connection_to_empty**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, release_position\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when user drags a connection from an output port into the empty space of the graph. @@ -286,7 +286,7 @@ Emitted when user drags a connection from an output port into the empty space of .. rst-class:: classref-signal -**copy_nodes_request**\ (\ ) +**copy_nodes_request**\ (\ ) :ref:`🔗` Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` by default). In general, this signal indicates that the selected :ref:`GraphElement`\ s should be copied. @@ -298,7 +298,7 @@ Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` b .. rst-class:: classref-signal -**delete_nodes_request**\ (\ nodes\: :ref:`Array`\[:ref:`StringName`\]\ ) +**delete_nodes_request**\ (\ nodes\: :ref:`Array`\[:ref:`StringName`\]\ ) :ref:`🔗` Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Delete` by default). @@ -312,7 +312,7 @@ Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Del .. rst-class:: classref-signal -**disconnection_request**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) +**disconnection_request**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) :ref:`🔗` Emitted to the GraphEdit when the connection between ``from_port`` of ``from_node`` :ref:`GraphNode` and ``to_port`` of ``to_node`` :ref:`GraphNode` is attempted to be removed. @@ -324,7 +324,7 @@ Emitted to the GraphEdit when the connection between ``from_port`` of ``from_nod .. rst-class:: classref-signal -**duplicate_nodes_request**\ (\ ) +**duplicate_nodes_request**\ (\ ) :ref:`🔗` Emitted when this **GraphEdit** captures a ``ui_graph_duplicate`` action (:kbd:`Ctrl + D` by default). In general, this signal indicates that the selected :ref:`GraphElement`\ s should be duplicated. @@ -336,7 +336,7 @@ Emitted when this **GraphEdit** captures a ``ui_graph_duplicate`` action (:kbd:` .. rst-class:: classref-signal -**end_node_move**\ (\ ) +**end_node_move**\ (\ ) :ref:`🔗` Emitted at the end of a :ref:`GraphElement`'s movement. @@ -348,7 +348,7 @@ Emitted at the end of a :ref:`GraphElement`'s movement. .. rst-class:: classref-signal -**frame_rect_changed**\ (\ frame\: :ref:`GraphFrame`, new_rect\: :ref:`Vector2`\ ) +**frame_rect_changed**\ (\ frame\: :ref:`GraphFrame`, new_rect\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when the :ref:`GraphFrame` ``frame`` is resized to ``new_rect``. @@ -360,7 +360,7 @@ Emitted when the :ref:`GraphFrame` ``frame`` is resized to ``n .. rst-class:: classref-signal -**graph_elements_linked_to_frame_request**\ (\ elements\: :ref:`Array`, frame\: :ref:`StringName`\ ) +**graph_elements_linked_to_frame_request**\ (\ elements\: :ref:`Array`, frame\: :ref:`StringName`\ ) :ref:`🔗` Emitted when one or more :ref:`GraphElement`\ s are dropped onto the :ref:`GraphFrame` named ``frame``, when they were not previously attached to any other one. @@ -374,7 +374,7 @@ Emitted when one or more :ref:`GraphElement`\ s are dropped .. rst-class:: classref-signal -**node_deselected**\ (\ node\: :ref:`Node`\ ) +**node_deselected**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the given :ref:`GraphElement` node is deselected. @@ -386,7 +386,7 @@ Emitted when the given :ref:`GraphElement` node is deselecte .. rst-class:: classref-signal -**node_selected**\ (\ node\: :ref:`Node`\ ) +**node_selected**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the given :ref:`GraphElement` node is selected. @@ -398,7 +398,7 @@ Emitted when the given :ref:`GraphElement` node is selected. .. rst-class:: classref-signal -**paste_nodes_request**\ (\ ) +**paste_nodes_request**\ (\ ) :ref:`🔗` Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` by default). In general, this signal indicates that previously copied :ref:`GraphElement`\ s should be pasted. @@ -410,7 +410,7 @@ Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` .. rst-class:: classref-signal -**popup_request**\ (\ at_position\: :ref:`Vector2`\ ) +**popup_request**\ (\ at_position\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ``at_position`` is the position of the mouse pointer when the signal is sent. @@ -422,7 +422,7 @@ Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ` .. rst-class:: classref-signal -**scroll_offset_changed**\ (\ offset\: :ref:`Vector2`\ ) +**scroll_offset_changed**\ (\ offset\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. @@ -439,7 +439,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PanningScheme**: +enum **PanningScheme**: :ref:`🔗` .. _class_GraphEdit_constant_SCROLL_ZOOMS: @@ -465,7 +465,7 @@ enum **PanningScheme**: .. rst-class:: classref-enumeration -enum **GridPattern**: +enum **GridPattern**: :ref:`🔗` .. _class_GraphEdit_constant_GRID_PATTERN_LINES: @@ -496,7 +496,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **connection_lines_antialiased** = ``true`` +:ref:`bool` **connection_lines_antialiased** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -513,7 +513,7 @@ If ``true``, the lines between nodes will use antialiasing. .. rst-class:: classref-property -:ref:`float` **connection_lines_curvature** = ``0.5`` +:ref:`float` **connection_lines_curvature** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -530,7 +530,7 @@ The curvature of the lines between the nodes. 0 results in straight lines. .. rst-class:: classref-property -:ref:`float` **connection_lines_thickness** = ``4.0`` +:ref:`float` **connection_lines_thickness** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -547,7 +547,7 @@ The thickness of the lines between the nodes. .. rst-class:: classref-property -:ref:`GridPattern` **grid_pattern** = ``0`` +:ref:`GridPattern` **grid_pattern** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -564,7 +564,7 @@ The pattern used for drawing the grid. .. rst-class:: classref-property -:ref:`bool` **minimap_enabled** = ``true`` +:ref:`bool` **minimap_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -581,7 +581,7 @@ If ``true``, the minimap is visible. .. rst-class:: classref-property -:ref:`float` **minimap_opacity** = ``0.65`` +:ref:`float` **minimap_opacity** = ``0.65`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -598,7 +598,7 @@ The opacity of the minimap rectangle. .. rst-class:: classref-property -:ref:`Vector2` **minimap_size** = ``Vector2(240, 160)`` +:ref:`Vector2` **minimap_size** = ``Vector2(240, 160)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -615,7 +615,7 @@ The size of the minimap rectangle. The map itself is based on the size of the gr .. rst-class:: classref-property -:ref:`PanningScheme` **panning_scheme** = ``0`` +:ref:`PanningScheme` **panning_scheme** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -632,7 +632,7 @@ Defines the control scheme for panning with mouse wheel. .. rst-class:: classref-property -:ref:`bool` **right_disconnects** = ``false`` +:ref:`bool` **right_disconnects** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -649,7 +649,7 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d .. rst-class:: classref-property -:ref:`Vector2` **scroll_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **scroll_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -666,7 +666,7 @@ The scroll offset. .. rst-class:: classref-property -:ref:`bool` **show_arrange_button** = ``true`` +:ref:`bool` **show_arrange_button** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -683,7 +683,7 @@ If ``true``, the button to automatically arrange graph nodes is visible. .. rst-class:: classref-property -:ref:`bool` **show_grid** = ``true`` +:ref:`bool` **show_grid** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -700,7 +700,7 @@ If ``true``, the grid is visible. .. rst-class:: classref-property -:ref:`bool` **show_grid_buttons** = ``true`` +:ref:`bool` **show_grid_buttons** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -717,7 +717,7 @@ If ``true``, buttons that allow to configure grid and snapping options are visib .. rst-class:: classref-property -:ref:`bool` **show_menu** = ``true`` +:ref:`bool` **show_menu** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -734,7 +734,7 @@ If ``true``, the menu toolbar is visible. .. rst-class:: classref-property -:ref:`bool` **show_minimap_button** = ``true`` +:ref:`bool` **show_minimap_button** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -751,7 +751,7 @@ If ``true``, the button to toggle the minimap is visible. .. rst-class:: classref-property -:ref:`bool` **show_zoom_buttons** = ``true`` +:ref:`bool` **show_zoom_buttons** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -768,7 +768,7 @@ If ``true``, buttons that allow to change and reset the zoom level are visible. .. rst-class:: classref-property -:ref:`bool` **show_zoom_label** = ``false`` +:ref:`bool` **show_zoom_label** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -785,7 +785,7 @@ If ``true``, the label with the current zoom level is visible. The zoom level is .. rst-class:: classref-property -:ref:`int` **snapping_distance** = ``20`` +:ref:`int` **snapping_distance** = ``20`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -802,7 +802,7 @@ The snapping distance in pixels, also determines the grid line distance. .. rst-class:: classref-property -:ref:`bool` **snapping_enabled** = ``true`` +:ref:`bool` **snapping_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -819,7 +819,7 @@ If ``true``, enables snapping. .. rst-class:: classref-property -:ref:`float` **zoom** = ``1.0`` +:ref:`float` **zoom** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -836,7 +836,7 @@ The current zoom value. .. rst-class:: classref-property -:ref:`float` **zoom_max** = ``2.0736`` +:ref:`float` **zoom_max** = ``2.0736`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -853,7 +853,7 @@ The upper zoom limit. .. rst-class:: classref-property -:ref:`float` **zoom_min** = ``0.232568`` +:ref:`float` **zoom_min** = ``0.232568`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -870,7 +870,7 @@ The lower zoom limit. .. rst-class:: classref-property -:ref:`float` **zoom_step** = ``1.2`` +:ref:`float` **zoom_step** = ``1.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -892,7 +892,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array` **_get_connection_line**\ (\ from_position\: :ref:`Vector2`, to_position\: :ref:`Vector2`\ ) |virtual| |const| +:ref:`PackedVector2Array` **_get_connection_line**\ (\ from_position\: :ref:`Vector2`, to_position\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` Virtual method which can be overridden to customize how connections are drawn. @@ -904,7 +904,7 @@ Virtual method which can be overridden to customize how connections are drawn. .. rst-class:: classref-method -:ref:`bool` **_is_in_input_hotzone**\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| +:ref:`bool` **_is_in_input_hotzone**\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Returns whether the ``mouse_position`` is in the input hot zone. @@ -929,7 +929,7 @@ Below is a sample code to help get started: .. rst-class:: classref-method -:ref:`bool` **_is_in_output_hotzone**\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| +:ref:`bool` **_is_in_output_hotzone**\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Returns whether the ``mouse_position`` is in the output hot zone. For more information on hot zones, see :ref:`_is_in_input_hotzone`. @@ -952,7 +952,7 @@ Below is a sample code to help get started: .. rst-class:: classref-method -:ref:`bool` **_is_node_hover_valid**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) |virtual| +:ref:`bool` **_is_node_hover_valid**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) |virtual| :ref:`🔗` This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port. @@ -985,7 +985,7 @@ In this example a connection to same node is suppressed: .. rst-class:: classref-method -|void| **add_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) +|void| **add_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) :ref:`🔗` Allows the connection between two different port types. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot` method. @@ -999,7 +999,7 @@ See also :ref:`is_valid_connection_type`\ ) +|void| **add_valid_left_disconnect_type**\ (\ type\: :ref:`int`\ ) :ref:`🔗` Allows to disconnect nodes when dragging from the left port of the :ref:`GraphNode`'s slot if it has the specified type. See also :ref:`remove_valid_left_disconnect_type`. @@ -1011,7 +1011,7 @@ Allows to disconnect nodes when dragging from the left port of the :ref:`GraphNo .. rst-class:: classref-method -|void| **add_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) +|void| **add_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) :ref:`🔗` Allows to disconnect nodes when dragging from the right port of the :ref:`GraphNode`'s slot if it has the specified type. See also :ref:`remove_valid_right_disconnect_type`. @@ -1023,7 +1023,7 @@ Allows to disconnect nodes when dragging from the right port of the :ref:`GraphN .. rst-class:: classref-method -|void| **arrange_nodes**\ (\ ) +|void| **arrange_nodes**\ (\ ) :ref:`🔗` Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes. @@ -1035,7 +1035,7 @@ Rearranges selected nodes in a layout with minimum crossings between connections .. rst-class:: classref-method -|void| **attach_graph_element_to_frame**\ (\ element\: :ref:`StringName`, frame\: :ref:`StringName`\ ) +|void| **attach_graph_element_to_frame**\ (\ element\: :ref:`StringName`, frame\: :ref:`StringName`\ ) :ref:`🔗` Attaches the ``element`` :ref:`GraphElement` to the ``frame`` :ref:`GraphFrame`. @@ -1047,7 +1047,7 @@ Attaches the ``element`` :ref:`GraphElement` to the ``frame` .. rst-class:: classref-method -|void| **clear_connections**\ (\ ) +|void| **clear_connections**\ (\ ) :ref:`🔗` Removes all connections between nodes. @@ -1059,7 +1059,7 @@ Removes all connections between nodes. .. rst-class:: classref-method -:ref:`Error` **connect_node**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) +:ref:`Error` **connect_node**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) :ref:`🔗` Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode` and the ``to_port`` of the ``to_node`` :ref:`GraphNode`. If the connection already exists, no connection is created. @@ -1071,7 +1071,7 @@ Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNo .. rst-class:: classref-method -|void| **detach_graph_element_from_frame**\ (\ element\: :ref:`StringName`\ ) +|void| **detach_graph_element_from_frame**\ (\ element\: :ref:`StringName`\ ) :ref:`🔗` Detaches the ``element`` :ref:`GraphElement` from the :ref:`GraphFrame` it is currently attached to. @@ -1083,7 +1083,7 @@ Detaches the ``element`` :ref:`GraphElement` from the :ref:` .. rst-class:: classref-method -|void| **disconnect_node**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) +|void| **disconnect_node**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) :ref:`🔗` Removes the connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode` and the ``to_port`` of the ``to_node`` :ref:`GraphNode`. If the connection does not exist, no connection is removed. @@ -1095,7 +1095,7 @@ Removes the connection between the ``from_port`` of the ``from_node`` :ref:`Grap .. rst-class:: classref-method -|void| **force_connection_drag_end**\ (\ ) +|void| **force_connection_drag_end**\ (\ ) :ref:`🔗` Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor. @@ -1111,7 +1111,7 @@ This is best used together with :ref:`connection_drag_started`\[:ref:`StringName`\] **get_attached_nodes_of_frame**\ (\ frame\: :ref:`StringName`\ ) +:ref:`Array`\[:ref:`StringName`\] **get_attached_nodes_of_frame**\ (\ frame\: :ref:`StringName`\ ) :ref:`🔗` Returns an array of node names that are attached to the :ref:`GraphFrame` with the given name. @@ -1123,7 +1123,7 @@ Returns an array of node names that are attached to the :ref:`GraphFrame` **get_closest_connection_at_point**\ (\ point\: :ref:`Vector2`, max_distance\: :ref:`float` = 4.0\ ) |const| +:ref:`Dictionary` **get_closest_connection_at_point**\ (\ point\: :ref:`Vector2`, max_distance\: :ref:`float` = 4.0\ ) |const| :ref:`🔗` Returns the closest connection to the given point in screen space. If no connection is found within ``max_distance`` pixels, an empty :ref:`Dictionary` is returned. @@ -1148,7 +1148,7 @@ For example, getting a connection at a given mouse position can be achieved like .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_connection_line**\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| +:ref:`PackedVector2Array` **get_connection_line**\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the points which would make up a connection between ``from_node`` and ``to_node``. @@ -1160,7 +1160,7 @@ Returns the points which would make up a connection between ``from_node`` and `` .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_connection_list**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_connection_list**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` containing the list of connections. A connection consists in a structure of the form ``{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }``. @@ -1172,7 +1172,7 @@ Returns an :ref:`Array` containing the list of connections. A conne .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_connections_intersecting_with_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_connections_intersecting_with_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns an :ref:`Array` containing the list of connections that intersect with the given :ref:`Rect2`. A connection consists in a structure of the form ``{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }``. @@ -1184,7 +1184,7 @@ Returns an :ref:`Array` containing the list of connections that int .. rst-class:: classref-method -:ref:`GraphFrame` **get_element_frame**\ (\ element\: :ref:`StringName`\ ) +:ref:`GraphFrame` **get_element_frame**\ (\ element\: :ref:`StringName`\ ) :ref:`🔗` Returns the :ref:`GraphFrame` that contains the :ref:`GraphElement` with the given name. @@ -1196,7 +1196,7 @@ Returns the :ref:`GraphFrame` that contains the :ref:`GraphEle .. rst-class:: classref-method -:ref:`HBoxContainer` **get_menu_hbox**\ (\ ) +:ref:`HBoxContainer` **get_menu_hbox**\ (\ ) :ref:`🔗` 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. @@ -1210,7 +1210,7 @@ Gets the :ref:`HBoxContainer` that contains the zooming and .. rst-class:: classref-method -:ref:`bool` **is_node_connected**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) +:ref:`bool` **is_node_connected**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the ``from_port`` of the ``from_node`` :ref:`GraphNode` is connected to the ``to_port`` of the ``to_node`` :ref:`GraphNode`. @@ -1222,7 +1222,7 @@ Returns ``true`` if the ``from_port`` of the ``from_node`` :ref:`GraphNode` **is_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) |const| +:ref:`bool` **is_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether it's possible to make a connection between two different port types. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot` method. @@ -1236,7 +1236,7 @@ See also :ref:`add_valid_connection_type`, to_type\: :ref:`int`\ ) +|void| **remove_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) :ref:`🔗` Disallows the connection between two different port types previously allowed by :ref:`add_valid_connection_type`. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot` method. @@ -1250,7 +1250,7 @@ See also :ref:`is_valid_connection_type`\ ) +|void| **remove_valid_left_disconnect_type**\ (\ type\: :ref:`int`\ ) :ref:`🔗` Disallows to disconnect nodes when dragging from the left port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_left_disconnect_type`. @@ -1262,7 +1262,7 @@ Disallows to disconnect nodes when dragging from the left port of the :ref:`Grap .. rst-class:: classref-method -|void| **remove_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) +|void| **remove_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) :ref:`🔗` Disallows to disconnect nodes when dragging from the right port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_right_disconnect_type`. @@ -1274,7 +1274,7 @@ Disallows to disconnect nodes when dragging from the right port of the :ref:`Gra .. rst-class:: classref-method -|void| **set_connection_activity**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`, amount\: :ref:`float`\ ) +|void| **set_connection_activity**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`, amount\: :ref:`float`\ ) :ref:`🔗` Sets the coloration of the connection between ``from_node``'s ``from_port`` and ``to_node``'s ``to_port`` with the color provided in the :ref:`activity` theme property. The color is linearly interpolated between the connection color and the activity color using ``amount`` as weight. @@ -1286,7 +1286,7 @@ Sets the coloration of the connection between ``from_node``'s ``from_port`` and .. rst-class:: classref-method -|void| **set_selected**\ (\ node\: :ref:`Node`\ ) +|void| **set_selected**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Sets the specified ``node`` as the one selected. @@ -1303,7 +1303,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **activity** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **activity** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Color the connection line is interpolated to based on the activity value of a connection (see :ref:`set_connection_activity`). @@ -1315,7 +1315,7 @@ Color the connection line is interpolated to based on the activity value of a co .. rst-class:: classref-themeproperty -:ref:`Color` **connection_hover_tint_color** = ``Color(0, 0, 0, 0.3)`` +:ref:`Color` **connection_hover_tint_color** = ``Color(0, 0, 0, 0.3)`` :ref:`🔗` Color which is blended with the connection line when the mouse is hovering over it. @@ -1327,7 +1327,7 @@ Color which is blended with the connection line when the mouse is hovering over .. rst-class:: classref-themeproperty -:ref:`Color` **connection_rim_color** = ``Color(0.1, 0.1, 0.1, 0.6)`` +:ref:`Color` **connection_rim_color** = ``Color(0.1, 0.1, 0.1, 0.6)`` :ref:`🔗` Color of the rim around each connection line used for making intersecting lines more distinguishable. @@ -1339,7 +1339,7 @@ Color of the rim around each connection line used for making intersecting lines .. rst-class:: classref-themeproperty -:ref:`Color` **connection_valid_target_tint_color** = ``Color(1, 1, 1, 0.4)`` +:ref:`Color` **connection_valid_target_tint_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗` Color which is blended with the connection line when the currently dragged connection is hovering over a valid target port. @@ -1351,7 +1351,7 @@ Color which is blended with the connection line when the currently dragged conne .. rst-class:: classref-themeproperty -:ref:`Color` **grid_major** = ``Color(1, 1, 1, 0.2)`` +:ref:`Color` **grid_major** = ``Color(1, 1, 1, 0.2)`` :ref:`🔗` Color of major grid lines/dots. @@ -1363,7 +1363,7 @@ Color of major grid lines/dots. .. rst-class:: classref-themeproperty -:ref:`Color` **grid_minor** = ``Color(1, 1, 1, 0.05)`` +:ref:`Color` **grid_minor** = ``Color(1, 1, 1, 0.05)`` :ref:`🔗` Color of minor grid lines/dots. @@ -1375,7 +1375,7 @@ Color of minor grid lines/dots. .. rst-class:: classref-themeproperty -:ref:`Color` **selection_fill** = ``Color(1, 1, 1, 0.3)`` +:ref:`Color` **selection_fill** = ``Color(1, 1, 1, 0.3)`` :ref:`🔗` The fill color of the selection rectangle. @@ -1387,7 +1387,7 @@ The fill color of the selection rectangle. .. rst-class:: classref-themeproperty -:ref:`Color` **selection_stroke** = ``Color(1, 1, 1, 0.8)`` +:ref:`Color` **selection_stroke** = ``Color(1, 1, 1, 0.8)`` :ref:`🔗` The outline color of the selection rectangle. @@ -1399,7 +1399,7 @@ The outline color of the selection rectangle. .. rst-class:: classref-themeproperty -:ref:`int` **port_hotzone_inner_extent** = ``22`` +:ref:`int` **port_hotzone_inner_extent** = ``22`` :ref:`🔗` The horizontal range within which a port can be grabbed (inner side). @@ -1411,7 +1411,7 @@ The horizontal range within which a port can be grabbed (inner side). .. rst-class:: classref-themeproperty -:ref:`int` **port_hotzone_outer_extent** = ``26`` +:ref:`int` **port_hotzone_outer_extent** = ``26`` :ref:`🔗` The horizontal range within which a port can be grabbed (outer side). @@ -1423,7 +1423,7 @@ The horizontal range within which a port can be grabbed (outer side). .. rst-class:: classref-themeproperty -:ref:`Texture2D` **grid_toggle** +:ref:`Texture2D` **grid_toggle** :ref:`🔗` The icon for the grid toggle button. @@ -1435,7 +1435,7 @@ The icon for the grid toggle button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **layout** +:ref:`Texture2D` **layout** :ref:`🔗` The icon for the layout button for auto-arranging the graph. @@ -1447,7 +1447,7 @@ The icon for the layout button for auto-arranging the graph. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **minimap_toggle** +:ref:`Texture2D` **minimap_toggle** :ref:`🔗` The icon for the minimap toggle button. @@ -1459,7 +1459,7 @@ The icon for the minimap toggle button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **snapping_toggle** +:ref:`Texture2D` **snapping_toggle** :ref:`🔗` The icon for the snapping toggle button. @@ -1471,7 +1471,7 @@ The icon for the snapping toggle button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **zoom_in** +:ref:`Texture2D` **zoom_in** :ref:`🔗` The icon for the zoom in button. @@ -1483,7 +1483,7 @@ The icon for the zoom in button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **zoom_out** +:ref:`Texture2D` **zoom_out** :ref:`🔗` The icon for the zoom out button. @@ -1495,7 +1495,7 @@ The icon for the zoom out button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **zoom_reset** +:ref:`Texture2D` **zoom_reset** :ref:`🔗` The icon for the zoom reset button. @@ -1507,7 +1507,7 @@ The icon for the zoom reset button. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **menu_panel** +:ref:`StyleBox` **menu_panel** :ref:`🔗` .. container:: contribute @@ -1521,7 +1521,7 @@ The icon for the zoom reset button. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The background drawn under the grid. diff --git a/classes/class_graphelement.rst b/classes/class_graphelement.rst index 3e8f2690993..c8e1fc3821d 100644 --- a/classes/class_graphelement.rst +++ b/classes/class_graphelement.rst @@ -70,7 +70,7 @@ Signals .. rst-class:: classref-signal -**delete_request**\ (\ ) +**delete_request**\ (\ ) :ref:`🔗` Emitted when removing the GraphElement is requested. @@ -82,7 +82,7 @@ Emitted when removing the GraphElement is requested. .. rst-class:: classref-signal -**dragged**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) +**dragged**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when the GraphElement is dragged. @@ -94,7 +94,7 @@ Emitted when the GraphElement is dragged. .. rst-class:: classref-signal -**node_deselected**\ (\ ) +**node_deselected**\ (\ ) :ref:`🔗` Emitted when the GraphElement is deselected. @@ -106,7 +106,7 @@ Emitted when the GraphElement is deselected. .. rst-class:: classref-signal -**node_selected**\ (\ ) +**node_selected**\ (\ ) :ref:`🔗` Emitted when the GraphElement is selected. @@ -118,7 +118,7 @@ Emitted when the GraphElement is selected. .. rst-class:: classref-signal -**position_offset_changed**\ (\ ) +**position_offset_changed**\ (\ ) :ref:`🔗` Emitted when the GraphElement is moved. @@ -130,7 +130,7 @@ Emitted when the GraphElement is moved. .. rst-class:: classref-signal -**raise_request**\ (\ ) +**raise_request**\ (\ ) :ref:`🔗` Emitted when displaying the GraphElement over other ones is requested. Happens on focusing (clicking into) the GraphElement. @@ -142,7 +142,7 @@ Emitted when displaying the GraphElement over other ones is requested. Happens o .. rst-class:: classref-signal -**resize_end**\ (\ new_size\: :ref:`Vector2`\ ) +**resize_end**\ (\ new_size\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when releasing the mouse button after dragging the resizer handle (see :ref:`resizable`). @@ -154,7 +154,7 @@ Emitted when releasing the mouse button after dragging the resizer handle (see : .. rst-class:: classref-signal -**resize_request**\ (\ new_size\: :ref:`Vector2`\ ) +**resize_request**\ (\ new_size\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when resizing the GraphElement is requested. Happens on dragging the resizer handle (see :ref:`resizable`). @@ -171,7 +171,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **draggable** = ``true`` +:ref:`bool` **draggable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ If ``true``, the user can drag the GraphElement. .. rst-class:: classref-property -:ref:`Vector2` **position_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **position_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ The offset of the GraphElement, relative to the scroll offset of the :ref:`Graph .. rst-class:: classref-property -:ref:`bool` **resizable** = ``false`` +:ref:`bool` **resizable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -224,7 +224,7 @@ If ``true``, the user can resize the GraphElement. .. rst-class:: classref-property -:ref:`bool` **selectable** = ``true`` +:ref:`bool` **selectable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ If ``true``, the user can select the GraphElement. .. rst-class:: classref-property -:ref:`bool` **selected** = ``false`` +:ref:`bool` **selected** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -263,7 +263,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Texture2D` **resizer** +:ref:`Texture2D` **resizer** :ref:`🔗` The icon used for the resizer, visible when :ref:`resizable` is enabled. diff --git a/classes/class_graphframe.rst b/classes/class_graphframe.rst index 97e28160b48..0c4a4a8c25e 100644 --- a/classes/class_graphframe.rst +++ b/classes/class_graphframe.rst @@ -94,7 +94,7 @@ Signals .. rst-class:: classref-signal -**autoshrink_changed**\ (\ ) +**autoshrink_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`autoshrink_enabled` or :ref:`autoshrink_margin` changes. @@ -111,7 +111,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **autoshrink_enabled** = ``true`` +:ref:`bool` **autoshrink_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ If ``true``, the frame's rect will be adjusted automatically to enclose all atta .. rst-class:: classref-property -:ref:`int` **autoshrink_margin** = ``40`` +:ref:`int` **autoshrink_margin** = ``40`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ The margin around the attached nodes that is used to calculate the size of the f .. rst-class:: classref-property -:ref:`int` **drag_margin** = ``16`` +:ref:`int` **drag_margin** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ The margin inside the frame that can be used to drag the frame. .. rst-class:: classref-property -:ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` +:ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ The color of the frame when :ref:`tint_color_enabled` **tint_color_enabled** = ``false`` +:ref:`bool` **tint_color_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ If ``true``, the tint color will be used to tint the frame. .. rst-class:: classref-property -:ref:`String` **title** = ``""`` +:ref:`String` **title** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) +:ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) :ref:`🔗` Returns the :ref:`HBoxContainer` used for the title bar, only containing a :ref:`Label` for displaying the title by default. @@ -237,7 +237,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` The color modulation applied to the resizer icon. @@ -249,7 +249,7 @@ The color modulation applied to the resizer icon. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The default :ref:`StyleBox` used for the background of the **GraphFrame**. @@ -261,7 +261,7 @@ The default :ref:`StyleBox` used for the background of the **Gra .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel_selected** +:ref:`StyleBox` **panel_selected** :ref:`🔗` The :ref:`StyleBox` used for the background of the **GraphFrame** when it is selected. @@ -273,7 +273,7 @@ The :ref:`StyleBox` used for the background of the **GraphFrame* .. rst-class:: classref-themeproperty -:ref:`StyleBox` **titlebar** +:ref:`StyleBox` **titlebar** :ref:`🔗` The :ref:`StyleBox` used for the title bar of the **GraphFrame**. @@ -285,7 +285,7 @@ The :ref:`StyleBox` used for the title bar of the **GraphFrame** .. rst-class:: classref-themeproperty -:ref:`StyleBox` **titlebar_selected** +:ref:`StyleBox` **titlebar_selected** :ref:`🔗` The :ref:`StyleBox` used for the title bar of the **GraphFrame** when it is selected. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 550eeb521de..7f131cb9151 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -162,7 +162,7 @@ Signals .. rst-class:: classref-signal -**slot_updated**\ (\ slot_index\: :ref:`int`\ ) +**slot_updated**\ (\ slot_index\: :ref:`int`\ ) :ref:`🔗` Emitted when any GraphNode's slot is updated. @@ -179,7 +179,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **ignore_invalid_connection_type** = ``false`` +:ref:`bool` **ignore_invalid_connection_type** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ If ``true``, you can connect ports with different types, even if the connection .. rst-class:: classref-property -:ref:`String` **title** = ``""`` +:ref:`String` **title** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_draw_port**\ (\ slot_index\: :ref:`int`, position\: :ref:`Vector2i`, left\: :ref:`bool`, color\: :ref:`Color`\ ) |virtual| +|void| **_draw_port**\ (\ slot_index\: :ref:`int`, position\: :ref:`Vector2i`, left\: :ref:`bool`, color\: :ref:`Color`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -232,7 +232,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_all_slots**\ (\ ) +|void| **clear_all_slots**\ (\ ) :ref:`🔗` Disables all slots of the GraphNode. This will remove all input/output ports from the GraphNode. @@ -244,7 +244,7 @@ Disables all slots of the GraphNode. This will remove all input/output ports fro .. rst-class:: classref-method -|void| **clear_slot**\ (\ slot_index\: :ref:`int`\ ) +|void| **clear_slot**\ (\ slot_index\: :ref:`int`\ ) :ref:`🔗` Disables the slot with the given ``slot_index``. This will remove the corresponding input and output port from the GraphNode. @@ -256,7 +256,7 @@ Disables the slot with the given ``slot_index``. This will remove the correspond .. rst-class:: classref-method -:ref:`Color` **get_input_port_color**\ (\ port_idx\: :ref:`int`\ ) +:ref:`Color` **get_input_port_color**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Color` of the input port with the given ``port_idx``. @@ -268,7 +268,7 @@ Returns the :ref:`Color` of the input port with the given ``port_id .. rst-class:: classref-method -:ref:`int` **get_input_port_count**\ (\ ) +:ref:`int` **get_input_port_count**\ (\ ) :ref:`🔗` Returns the number of slots with an enabled input port. @@ -280,7 +280,7 @@ Returns the number of slots with an enabled input port. .. rst-class:: classref-method -:ref:`Vector2` **get_input_port_position**\ (\ port_idx\: :ref:`int`\ ) +:ref:`Vector2` **get_input_port_position**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the position of the input port with the given ``port_idx``. @@ -292,7 +292,7 @@ Returns the position of the input port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`int` **get_input_port_slot**\ (\ port_idx\: :ref:`int`\ ) +:ref:`int` **get_input_port_slot**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the corresponding slot index of the input port with the given ``port_idx``. @@ -304,7 +304,7 @@ Returns the corresponding slot index of the input port with the given ``port_idx .. rst-class:: classref-method -:ref:`int` **get_input_port_type**\ (\ port_idx\: :ref:`int`\ ) +:ref:`int` **get_input_port_type**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the type of the input port with the given ``port_idx``. @@ -316,7 +316,7 @@ Returns the type of the input port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`Color` **get_output_port_color**\ (\ port_idx\: :ref:`int`\ ) +:ref:`Color` **get_output_port_color**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Color` of the output port with the given ``port_idx``. @@ -328,7 +328,7 @@ Returns the :ref:`Color` of the output port with the given ``port_i .. rst-class:: classref-method -:ref:`int` **get_output_port_count**\ (\ ) +:ref:`int` **get_output_port_count**\ (\ ) :ref:`🔗` Returns the number of slots with an enabled output port. @@ -340,7 +340,7 @@ Returns the number of slots with an enabled output port. .. rst-class:: classref-method -:ref:`Vector2` **get_output_port_position**\ (\ port_idx\: :ref:`int`\ ) +:ref:`Vector2` **get_output_port_position**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the position of the output port with the given ``port_idx``. @@ -352,7 +352,7 @@ Returns the position of the output port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`int` **get_output_port_slot**\ (\ port_idx\: :ref:`int`\ ) +:ref:`int` **get_output_port_slot**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the corresponding slot index of the output port with the given ``port_idx``. @@ -364,7 +364,7 @@ Returns the corresponding slot index of the output port with the given ``port_id .. rst-class:: classref-method -:ref:`int` **get_output_port_type**\ (\ port_idx\: :ref:`int`\ ) +:ref:`int` **get_output_port_type**\ (\ port_idx\: :ref:`int`\ ) :ref:`🔗` Returns the type of the output port with the given ``port_idx``. @@ -376,7 +376,7 @@ Returns the type of the output port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`Color` **get_slot_color_left**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`Color` **get_slot_color_left**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the left (input) :ref:`Color` of the slot with the given ``slot_index``. @@ -388,7 +388,7 @@ Returns the left (input) :ref:`Color` of the slot with the given `` .. rst-class:: classref-method -:ref:`Color` **get_slot_color_right**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`Color` **get_slot_color_right**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the right (output) :ref:`Color` of the slot with the given ``slot_index``. @@ -400,7 +400,7 @@ Returns the right (output) :ref:`Color` of the slot with the given .. rst-class:: classref-method -:ref:`Texture2D` **get_slot_custom_icon_left**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_slot_custom_icon_left**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the left (input) custom :ref:`Texture2D` of the slot with the given ``slot_index``. @@ -412,7 +412,7 @@ Returns the left (input) custom :ref:`Texture2D` of the slot wi .. rst-class:: classref-method -:ref:`Texture2D` **get_slot_custom_icon_right**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_slot_custom_icon_right**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the right (output) custom :ref:`Texture2D` of the slot with the given ``slot_index``. @@ -424,7 +424,7 @@ Returns the right (output) custom :ref:`Texture2D` of the slot .. rst-class:: classref-method -:ref:`int` **get_slot_type_left**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`int` **get_slot_type_left**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the left (input) type of the slot with the given ``slot_index``. @@ -436,7 +436,7 @@ Returns the left (input) type of the slot with the given ``slot_index``. .. rst-class:: classref-method -:ref:`int` **get_slot_type_right**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`int` **get_slot_type_right**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the right (output) type of the slot with the given ``slot_index``. @@ -448,7 +448,7 @@ Returns the right (output) type of the slot with the given ``slot_index``. .. rst-class:: classref-method -:ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) +:ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) :ref:`🔗` Returns the :ref:`HBoxContainer` used for the title bar, only containing a :ref:`Label` for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons. @@ -460,7 +460,7 @@ Returns the :ref:`HBoxContainer` used for the title bar, on .. rst-class:: classref-method -:ref:`bool` **is_slot_draw_stylebox**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`bool` **is_slot_draw_stylebox**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns true if the background :ref:`StyleBox` of the slot with the given ``slot_index`` is drawn. @@ -472,7 +472,7 @@ Returns true if the background :ref:`StyleBox` of the slot with .. rst-class:: classref-method -:ref:`bool` **is_slot_enabled_left**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`bool` **is_slot_enabled_left**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if left (input) side of the slot with the given ``slot_index`` is enabled. @@ -484,7 +484,7 @@ Returns ``true`` if left (input) side of the slot with the given ``slot_index`` .. rst-class:: classref-method -:ref:`bool` **is_slot_enabled_right**\ (\ slot_index\: :ref:`int`\ ) |const| +:ref:`bool` **is_slot_enabled_right**\ (\ slot_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if right (output) side of the slot with the given ``slot_index`` is enabled. @@ -496,7 +496,7 @@ Returns ``true`` if right (output) side of the slot with the given ``slot_index` .. rst-class:: classref-method -|void| **set_slot**\ (\ slot_index\: :ref:`int`, enable_left_port\: :ref:`bool`, type_left\: :ref:`int`, color_left\: :ref:`Color`, enable_right_port\: :ref:`bool`, type_right\: :ref:`int`, color_right\: :ref:`Color`, custom_icon_left\: :ref:`Texture2D` = null, custom_icon_right\: :ref:`Texture2D` = null, draw_stylebox\: :ref:`bool` = true\ ) +|void| **set_slot**\ (\ slot_index\: :ref:`int`, enable_left_port\: :ref:`bool`, type_left\: :ref:`int`, color_left\: :ref:`Color`, enable_right_port\: :ref:`bool`, type_right\: :ref:`int`, color_right\: :ref:`Color`, custom_icon_left\: :ref:`Texture2D` = null, custom_icon_right\: :ref:`Texture2D` = null, draw_stylebox\: :ref:`bool` = true\ ) :ref:`🔗` Sets properties of the slot with the given ``slot_index``. @@ -520,7 +520,7 @@ Individual properties can also be set using one of the ``set_slot_*`` methods. .. rst-class:: classref-method -|void| **set_slot_color_left**\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_slot_color_left**\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the :ref:`Color` of the left (input) side of the slot with the given ``slot_index`` to ``color``. @@ -532,7 +532,7 @@ Sets the :ref:`Color` of the left (input) side of the slot with the .. rst-class:: classref-method -|void| **set_slot_color_right**\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_slot_color_right**\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the :ref:`Color` of the right (output) side of the slot with the given ``slot_index`` to ``color``. @@ -544,7 +544,7 @@ Sets the :ref:`Color` of the right (output) side of the slot with t .. rst-class:: classref-method -|void| **set_slot_custom_icon_left**\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) +|void| **set_slot_custom_icon_left**\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the custom :ref:`Texture2D` of the left (input) side of the slot with the given ``slot_index`` to ``custom_icon``. @@ -556,7 +556,7 @@ Sets the custom :ref:`Texture2D` of the left (input) side of th .. rst-class:: classref-method -|void| **set_slot_custom_icon_right**\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) +|void| **set_slot_custom_icon_right**\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the custom :ref:`Texture2D` of the right (output) side of the slot with the given ``slot_index`` to ``custom_icon``. @@ -568,7 +568,7 @@ Sets the custom :ref:`Texture2D` of the right (output) side of .. rst-class:: classref-method -|void| **set_slot_draw_stylebox**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_slot_draw_stylebox**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Toggles the background :ref:`StyleBox` of the slot with the given ``slot_index``. @@ -580,7 +580,7 @@ Toggles the background :ref:`StyleBox` of the slot with the give .. rst-class:: classref-method -|void| **set_slot_enabled_left**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_slot_enabled_left**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Toggles the left (input) side of the slot with the given ``slot_index``. If ``enable`` is ``true``, a port will appear on the left side and the slot will be able to be connected from this side. @@ -592,7 +592,7 @@ Toggles the left (input) side of the slot with the given ``slot_index``. If ``en .. rst-class:: classref-method -|void| **set_slot_enabled_right**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_slot_enabled_right**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Toggles the right (output) side of the slot with the given ``slot_index``. If ``enable`` is ``true``, a port will appear on the right side and the slot will be able to be connected from this side. @@ -604,7 +604,7 @@ Toggles the right (output) side of the slot with the given ``slot_index``. If `` .. rst-class:: classref-method -|void| **set_slot_type_left**\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) +|void| **set_slot_type_left**\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) :ref:`🔗` Sets the left (input) type of the slot with the given ``slot_index`` to ``type``. If the value is negative, all connections will be disallowed to be created via user inputs. @@ -616,7 +616,7 @@ Sets the left (input) type of the slot with the given ``slot_index`` to ``type`` .. rst-class:: classref-method -|void| **set_slot_type_right**\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) +|void| **set_slot_type_right**\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) :ref:`🔗` Sets the right (output) type of the slot with the given ``slot_index`` to ``type``. If the value is negative, all connections will be disallowed to be created via user inputs. @@ -633,7 +633,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` The color modulation applied to the resizer icon. @@ -645,7 +645,7 @@ The color modulation applied to the resizer icon. .. rst-class:: classref-themeproperty -:ref:`int` **port_h_offset** = ``0`` +:ref:`int` **port_h_offset** = ``0`` :ref:`🔗` Horizontal offset for the ports. @@ -657,7 +657,7 @@ Horizontal offset for the ports. .. rst-class:: classref-themeproperty -:ref:`int` **separation** = ``2`` +:ref:`int` **separation** = ``2`` :ref:`🔗` The vertical distance between ports. @@ -669,7 +669,7 @@ The vertical distance between ports. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **port** +:ref:`Texture2D` **port** :ref:`🔗` The icon used for representing ports. @@ -681,7 +681,7 @@ The icon used for representing ports. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The default background for the slot area of the **GraphNode**. @@ -693,7 +693,7 @@ The default background for the slot area of the **GraphNode**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel_selected** +:ref:`StyleBox` **panel_selected** :ref:`🔗` The :ref:`StyleBox` used for the slot area when selected. @@ -705,7 +705,7 @@ The :ref:`StyleBox` used for the slot area when selected. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **slot** +:ref:`StyleBox` **slot** :ref:`🔗` The :ref:`StyleBox` used for each slot of the **GraphNode**. @@ -717,7 +717,7 @@ The :ref:`StyleBox` used for each slot of the **GraphNode**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **titlebar** +:ref:`StyleBox` **titlebar** :ref:`🔗` The :ref:`StyleBox` used for the title bar of the **GraphNode**. @@ -729,7 +729,7 @@ The :ref:`StyleBox` used for the title bar of the **GraphNode**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **titlebar_selected** +:ref:`StyleBox` **titlebar_selected** :ref:`🔗` The :ref:`StyleBox` used for the title bar of the **GraphNode** when it is selected. diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 7cec6808eab..4c88542043f 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **columns** = ``1`` +:ref:`int` **columns** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal separation of child nodes. @@ -105,7 +105,7 @@ The horizontal separation of child nodes. .. rst-class:: classref-themeproperty -:ref:`int` **v_separation** = ``4`` +:ref:`int` **v_separation** = ``4`` :ref:`🔗` The vertical separation of child nodes. diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index f4604f46354..a5da9915477 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -146,7 +146,7 @@ Signals .. rst-class:: classref-signal -**cell_size_changed**\ (\ cell_size\: :ref:`Vector3`\ ) +**cell_size_changed**\ (\ cell_size\: :ref:`Vector3`\ ) :ref:`🔗` Emitted when :ref:`cell_size` changes. @@ -158,7 +158,7 @@ Emitted when :ref:`cell_size` changes. .. rst-class:: classref-signal -**changed**\ (\ ) +**changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`MeshLibrary` of this GridMap changes. @@ -175,7 +175,7 @@ Constants .. rst-class:: classref-constant -**INVALID_CELL_ITEM** = ``-1`` +**INVALID_CELL_ITEM** = ``-1`` :ref:`🔗` Invalid cell item that can be used in :ref:`set_cell_item` to clear cells (or represent an empty cell in :ref:`get_cell_item`). @@ -192,7 +192,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **bake_navigation** = ``false`` +:ref:`bool` **bake_navigation** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -209,7 +209,7 @@ If ``true``, this GridMap creates a navigation region for each cell that uses a .. rst-class:: classref-property -:ref:`bool` **cell_center_x** = ``true`` +:ref:`bool` **cell_center_x** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ If ``true``, grid items are centered on the X axis. .. rst-class:: classref-property -:ref:`bool` **cell_center_y** = ``true`` +:ref:`bool` **cell_center_y** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -243,7 +243,7 @@ If ``true``, grid items are centered on the Y axis. .. rst-class:: classref-property -:ref:`bool` **cell_center_z** = ``true`` +:ref:`bool` **cell_center_z** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ If ``true``, grid items are centered on the Z axis. .. rst-class:: classref-property -:ref:`int` **cell_octant_size** = ``8`` +:ref:`int` **cell_octant_size** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ The size of each octant measured in number of cells. This applies to all three a .. rst-class:: classref-property -:ref:`float` **cell_scale** = ``1.0`` +:ref:`float` **cell_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -296,7 +296,7 @@ This does not affect the size of the grid cells themselves, only the items in th .. rst-class:: classref-property -:ref:`Vector3` **cell_size** = ``Vector3(2, 2, 2)`` +:ref:`Vector3` **cell_size** = ``Vector3(2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -315,7 +315,7 @@ This does not affect the size of the meshes. See :ref:`cell_scale` **collision_layer** = ``1`` +:ref:`int` **collision_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -334,7 +334,7 @@ GridMaps act as static bodies, meaning they aren't affected by gravity or other .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -351,7 +351,7 @@ The physics layers this GridMap detects collisions in. See `Collision layers and .. rst-class:: classref-property -:ref:`float` **collision_priority** = ``1.0`` +:ref:`float` **collision_priority** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -368,7 +368,7 @@ The priority used to solve colliding when occurring penetration. The higher the .. rst-class:: classref-property -:ref:`MeshLibrary` **mesh_library** +:ref:`MeshLibrary` **mesh_library** :ref:`🔗` .. rst-class:: classref-property-setget @@ -385,7 +385,7 @@ The assigned :ref:`MeshLibrary`. .. rst-class:: classref-property -:ref:`PhysicsMaterial` **physics_material** +:ref:`PhysicsMaterial` **physics_material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -407,7 +407,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clear all cells. @@ -419,7 +419,7 @@ Clear all cells. .. rst-class:: classref-method -|void| **clear_baked_meshes**\ (\ ) +|void| **clear_baked_meshes**\ (\ ) :ref:`🔗` Clears all baked meshes. See :ref:`make_baked_meshes`. @@ -431,7 +431,7 @@ Clears all baked meshes. See :ref:`make_baked_meshes` **get_bake_mesh_instance**\ (\ idx\: :ref:`int`\ ) +:ref:`RID` **get_bake_mesh_instance**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns :ref:`RID` of a baked mesh with the given ``idx``. @@ -443,7 +443,7 @@ Returns :ref:`RID` of a baked mesh with the given ``idx``. .. rst-class:: classref-method -:ref:`Array` **get_bake_meshes**\ (\ ) +:ref:`Array` **get_bake_meshes**\ (\ ) :ref:`🔗` Returns an array of :ref:`ArrayMesh`\ es and :ref:`Transform3D` references of all bake meshes that exist within the current GridMap. @@ -455,7 +455,7 @@ Returns an array of :ref:`ArrayMesh`\ es and :ref:`Transform3D< .. rst-class:: classref-method -:ref:`Basis` **get_basis_with_orthogonal_index**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Basis` **get_basis_with_orthogonal_index**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code. @@ -467,7 +467,7 @@ Returns one of 24 possible rotations that lie along the vectors (x,y,z) with eac .. rst-class:: classref-method -:ref:`int` **get_cell_item**\ (\ position\: :ref:`Vector3i`\ ) |const| +:ref:`int` **get_cell_item**\ (\ position\: :ref:`Vector3i`\ ) |const| :ref:`🔗` The :ref:`MeshLibrary` item index located at the given grid coordinates. If the cell is empty, :ref:`INVALID_CELL_ITEM` will be returned. @@ -479,7 +479,7 @@ The :ref:`MeshLibrary` item index located at the given grid c .. rst-class:: classref-method -:ref:`Basis` **get_cell_item_basis**\ (\ position\: :ref:`Vector3i`\ ) |const| +:ref:`Basis` **get_cell_item_basis**\ (\ position\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns the basis that gives the specified cell its orientation. @@ -491,7 +491,7 @@ Returns the basis that gives the specified cell its orientation. .. rst-class:: classref-method -:ref:`int` **get_cell_item_orientation**\ (\ position\: :ref:`Vector3i`\ ) |const| +:ref:`int` **get_cell_item_orientation**\ (\ position\: :ref:`Vector3i`\ ) |const| :ref:`🔗` The orientation of the cell at the given grid coordinates. ``-1`` is returned if the cell is empty. @@ -503,7 +503,7 @@ The orientation of the cell at the given grid coordinates. ``-1`` is returned if .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -515,7 +515,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -527,7 +527,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_meshes**\ (\ ) |const| +:ref:`Array` **get_meshes**\ (\ ) |const| :ref:`🔗` Returns an array of :ref:`Transform3D` and :ref:`Mesh` references corresponding to the non-empty cells in the grid. The transforms are specified in local space. @@ -539,7 +539,7 @@ Returns an array of :ref:`Transform3D` and :ref:`Mesh` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the navigation map this GridMap node uses for its cell baked navigation meshes. @@ -553,7 +553,7 @@ This function returns always the map set on the GridMap node and not the map on .. rst-class:: classref-method -:ref:`int` **get_orthogonal_index_from_basis**\ (\ basis\: :ref:`Basis`\ ) |const| +:ref:`int` **get_orthogonal_index_from_basis**\ (\ basis\: :ref:`Basis`\ ) |const| :ref:`🔗` This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code. @@ -565,7 +565,7 @@ This function considers a discretization of rotations into 24 points on unit sph .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector3i`\] **get_used_cells**\ (\ ) |const| +:ref:`Array`\[:ref:`Vector3i`\] **get_used_cells**\ (\ ) |const| :ref:`🔗` Returns an array of :ref:`Vector3` with the non-empty cell coordinates in the grid map. @@ -577,7 +577,7 @@ Returns an array of :ref:`Vector3` with the non-empty cell coordi .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector3i`\] **get_used_cells_by_item**\ (\ item\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Vector3i`\] **get_used_cells_by_item**\ (\ item\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of all cells with the given item index specified in ``item``. @@ -589,7 +589,7 @@ Returns an array of all cells with the given item index specified in ``item``. .. rst-class:: classref-method -:ref:`Vector3i` **local_to_map**\ (\ local_position\: :ref:`Vector3`\ ) |const| +:ref:`Vector3i` **local_to_map**\ (\ local_position\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node3D.to_local` before passing it to this method. See also :ref:`map_to_local`. @@ -601,7 +601,7 @@ Returns the map coordinates of the cell containing the given ``local_position``. .. rst-class:: classref-method -|void| **make_baked_meshes**\ (\ gen_lightmap_uv\: :ref:`bool` = false, lightmap_uv_texel_size\: :ref:`float` = 0.1\ ) +|void| **make_baked_meshes**\ (\ gen_lightmap_uv\: :ref:`bool` = false, lightmap_uv_texel_size\: :ref:`float` = 0.1\ ) :ref:`🔗` Bakes lightmap data for all meshes in the assigned :ref:`MeshLibrary`. @@ -613,7 +613,7 @@ Bakes lightmap data for all meshes in the assigned :ref:`MeshLibrary` **map_to_local**\ (\ map_position\: :ref:`Vector3i`\ ) |const| +:ref:`Vector3` **map_to_local**\ (\ map_position\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node3D.to_global`. See also :ref:`local_to_map`. @@ -625,7 +625,7 @@ Returns the position of a grid cell in the GridMap's local coordinate space. To .. rst-class:: classref-method -|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) +|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` **Deprecated:** Use :ref:`Resource.changed` instead. @@ -639,7 +639,7 @@ This method does nothing. .. rst-class:: classref-method -|void| **set_cell_item**\ (\ position\: :ref:`Vector3i`, item\: :ref:`int`, orientation\: :ref:`int` = 0\ ) +|void| **set_cell_item**\ (\ position\: :ref:`Vector3i`, item\: :ref:`int`, orientation\: :ref:`int` = 0\ ) :ref:`🔗` Sets the mesh index for the cell referenced by its grid coordinates. @@ -655,7 +655,7 @@ Optionally, the item's orientation can be passed. For valid orientation values, .. rst-class:: classref-method -|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -667,7 +667,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -679,7 +679,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this GridMap node should use for its cell baked navigation meshes. diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 1e4e339e1a6..fced7fb7979 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **initial_offset** = ``25.0`` +:ref:`float` **initial_offset** = ``25.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ The body B's initial anchor position defined by the joint's origin and a local o .. rst-class:: classref-property -:ref:`float` **length** = ``50.0`` +:ref:`float` **length** = ``50.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index 4068e670192..bf5d5b98ac5 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -105,7 +105,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **HashType**: +enum **HashType**: :ref:`🔗` .. _class_HashingContext_constant_HASH_MD5: @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **finish**\ (\ ) +:ref:`PackedByteArray` **finish**\ (\ ) :ref:`🔗` Closes the current context, and return the computed hash. @@ -156,7 +156,7 @@ Closes the current context, and return the computed hash. .. rst-class:: classref-method -:ref:`Error` **start**\ (\ type\: :ref:`HashType`\ ) +:ref:`Error` **start**\ (\ type\: :ref:`HashType`\ ) :ref:`🔗` Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` to start computation of an SHA-256). @@ -168,7 +168,7 @@ Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` **update**\ (\ chunk\: :ref:`PackedByteArray`\ ) +:ref:`Error` **update**\ (\ chunk\: :ref:`PackedByteArray`\ ) :ref:`🔗` Updates the computation with the given ``chunk`` of data. diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst index fba539c0f5f..9dcf81af058 100644 --- a/classes/class_heightmapshape3d.rst +++ b/classes/class_heightmapshape3d.rst @@ -86,7 +86,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedFloat32Array` **map_data** = ``PackedFloat32Array(0, 0, 0, 0)`` +:ref:`PackedFloat32Array` **map_data** = ``PackedFloat32Array(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ Height map data. The array's size must be equal to :ref:`map_width` **map_depth** = ``2`` +:ref:`int` **map_depth** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Number of vertices in the depth of the height map. Changing this will resize the .. rst-class:: classref-property -:ref:`int` **map_width** = ``2`` +:ref:`int` **map_width** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_max_height**\ (\ ) |const| +:ref:`float` **get_max_height**\ (\ ) |const| :ref:`🔗` Returns the largest height value found in :ref:`map_data`. Recalculates only when :ref:`map_data` changes. @@ -156,7 +156,7 @@ Returns the largest height value found in :ref:`map_data` **get_min_height**\ (\ ) |const| +:ref:`float` **get_min_height**\ (\ ) |const| :ref:`🔗` Returns the smallest height value found in :ref:`map_data`. Recalculates only when :ref:`map_data` changes. @@ -168,7 +168,7 @@ Returns the smallest height value found in :ref:`map_data`, height_min\: :ref:`float`, height_max\: :ref:`float`\ ) +|void| **update_map_data_from_image**\ (\ image\: :ref:`Image`, height_min\: :ref:`float`, height_max\: :ref:`float`\ ) :ref:`🔗` Updates :ref:`map_data` with data read from an :ref:`Image` reference. Automatically resizes heightmap :ref:`map_width` and :ref:`map_depth` to fit the full image width and height. diff --git a/classes/class_hingejoint3d.rst b/classes/class_hingejoint3d.rst index 21c4895e39b..54d81a194fa 100644 --- a/classes/class_hingejoint3d.rst +++ b/classes/class_hingejoint3d.rst @@ -82,7 +82,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Param**: +enum **Param**: :ref:`🔗` .. _class_HingeJoint3D_constant_PARAM_BIAS: @@ -166,7 +166,7 @@ Represents the size of the :ref:`Param` enum. .. rst-class:: classref-enumeration -enum **Flag**: +enum **Flag**: :ref:`🔗` .. _class_HingeJoint3D_constant_FLAG_USE_LIMIT: @@ -205,7 +205,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_limit/bias** = ``0.3`` +:ref:`float` **angular_limit/bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ The speed with which the rotation across the axis perpendicular to the hinge get .. rst-class:: classref-property -:ref:`bool` **angular_limit/enable** = ``false`` +:ref:`bool` **angular_limit/enable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_l .. rst-class:: classref-property -:ref:`float` **angular_limit/lower** = ``-1.5708`` +:ref:`float` **angular_limit/lower** = ``-1.5708`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -256,7 +256,7 @@ The minimum rotation. Only active if :ref:`angular_limit/enable` **angular_limit/relaxation** = ``1.0`` +:ref:`float` **angular_limit/relaxation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -273,7 +273,7 @@ The lower this value, the more the rotation gets slowed down. .. rst-class:: classref-property -:ref:`float` **angular_limit/softness** = ``0.9`` +:ref:`float` **angular_limit/softness** = ``0.9`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ The lower this value, the more the rotation gets slowed down. .. rst-class:: classref-property -:ref:`float` **angular_limit/upper** = ``1.5708`` +:ref:`float` **angular_limit/upper** = ``1.5708`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -307,7 +307,7 @@ The maximum rotation. Only active if :ref:`angular_limit/enable` **motor/enable** = ``false`` +:ref:`bool` **motor/enable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ When activated, a motor turns the hinge. .. rst-class:: classref-property -:ref:`float` **motor/max_impulse** = ``1.0`` +:ref:`float` **motor/max_impulse** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -341,7 +341,7 @@ Maximum acceleration for the motor. .. rst-class:: classref-property -:ref:`float` **motor/target_velocity** = ``1.0`` +:ref:`float` **motor/target_velocity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ Target speed for the motor. .. rst-class:: classref-property -:ref:`float` **params/bias** = ``0.3`` +:ref:`float` **params/bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -380,7 +380,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| +:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| :ref:`🔗` Returns the value of the specified flag. @@ -392,7 +392,7 @@ Returns the value of the specified flag. .. rst-class:: classref-method -:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the specified parameter. @@ -404,7 +404,7 @@ Returns the value of the specified parameter. .. rst-class:: classref-method -|void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) +|void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables the specified flag. @@ -416,7 +416,7 @@ If ``true``, enables the specified flag. .. rst-class:: classref-method -|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the specified parameter. diff --git a/classes/class_hmaccontext.rst b/classes/class_hmaccontext.rst index 7fb461bf6be..310823d5618 100644 --- a/classes/class_hmaccontext.rst +++ b/classes/class_hmaccontext.rst @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **finish**\ (\ ) +:ref:`PackedByteArray` **finish**\ (\ ) :ref:`🔗` Returns the resulting HMAC. If the HMAC failed, an empty :ref:`PackedByteArray` is returned. @@ -111,7 +111,7 @@ Returns the resulting HMAC. If the HMAC failed, an empty :ref:`PackedByteArray` **start**\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`\ ) +:ref:`Error` **start**\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`\ ) :ref:`🔗` Initializes the HMACContext. This method cannot be called again on the same HMACContext until :ref:`finish` has been called. @@ -123,7 +123,7 @@ Initializes the HMACContext. This method cannot be called again on the same HMAC .. rst-class:: classref-method -:ref:`Error` **update**\ (\ data\: :ref:`PackedByteArray`\ ) +:ref:`Error` **update**\ (\ data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Updates the message to be HMACed. This can be called multiple times before :ref:`finish` is called to append ``data`` to the message, but cannot be called until :ref:`start` has been called. diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 45189d38c6b..e91837ea0dd 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -119,7 +119,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Method**: +enum **Method**: :ref:`🔗` .. _class_HTTPClient_constant_METHOD_GET: @@ -209,7 +209,7 @@ Represents the size of the :ref:`Method` enum. .. rst-class:: classref-enumeration -enum **Status**: +enum **Status**: :ref:`🔗` .. _class_HTTPClient_constant_STATUS_DISCONNECTED: @@ -299,7 +299,7 @@ Status: Error in TLS handshake. .. rst-class:: classref-enumeration -enum **ResponseCode**: +enum **ResponseCode**: :ref:`🔗` .. _class_HTTPClient_constant_RESPONSE_CONTINUE: @@ -806,7 +806,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **blocking_mode_enabled** = ``false`` +:ref:`bool` **blocking_mode_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -823,7 +823,7 @@ If ``true``, execution will block until all data is read from the response. .. rst-class:: classref-property -:ref:`StreamPeer` **connection** +:ref:`StreamPeer` **connection** :ref:`🔗` .. rst-class:: classref-property-setget @@ -840,7 +840,7 @@ The connection to use for this client. .. rst-class:: classref-property -:ref:`int` **read_chunk_size** = ``65536`` +:ref:`int` **read_chunk_size** = ``65536`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -862,7 +862,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **close**\ (\ ) +|void| **close**\ (\ ) :ref:`🔗` Closes the current connection, allowing reuse of this **HTTPClient**. @@ -874,7 +874,7 @@ Closes the current connection, allowing reuse of this **HTTPClient**. .. rst-class:: classref-method -:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int` = -1, tls_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int` = -1, tls_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Connects to a host. This needs to be done before any requests are sent. @@ -888,7 +888,7 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f .. rst-class:: classref-method -:ref:`int` **get_response_body_length**\ (\ ) |const| +:ref:`int` **get_response_body_length**\ (\ ) |const| :ref:`🔗` Returns the response's body length. @@ -904,7 +904,7 @@ Returns the response's body length. .. rst-class:: classref-method -:ref:`int` **get_response_code**\ (\ ) |const| +:ref:`int` **get_response_code**\ (\ ) |const| :ref:`🔗` Returns the response's HTTP status code. @@ -916,7 +916,7 @@ Returns the response's HTTP status code. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_response_headers**\ (\ ) +:ref:`PackedStringArray` **get_response_headers**\ (\ ) :ref:`🔗` Returns the response headers. @@ -928,7 +928,7 @@ Returns the response headers. .. rst-class:: classref-method -:ref:`Dictionary` **get_response_headers_as_dictionary**\ (\ ) +:ref:`Dictionary` **get_response_headers_as_dictionary**\ (\ ) :ref:`🔗` Returns all response headers as a Dictionary of structure ``{ "key": "value1; value2" }`` where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. @@ -949,7 +949,7 @@ Returns all response headers as a Dictionary of structure ``{ "key": "value1; va .. rst-class:: classref-method -:ref:`Status` **get_status**\ (\ ) |const| +:ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Status` constant. Need to call :ref:`poll` in order to get status updates. @@ -961,7 +961,7 @@ Returns a :ref:`Status` constant. Need to call :ref:`pol .. rst-class:: classref-method -:ref:`bool` **has_response**\ (\ ) |const| +:ref:`bool` **has_response**\ (\ ) |const| :ref:`🔗` If ``true``, this **HTTPClient** has a response available. @@ -973,7 +973,7 @@ If ``true``, this **HTTPClient** has a response available. .. rst-class:: classref-method -:ref:`bool` **is_response_chunked**\ (\ ) |const| +:ref:`bool` **is_response_chunked**\ (\ ) |const| :ref:`🔗` If ``true``, this **HTTPClient** has a response that is chunked. @@ -985,7 +985,7 @@ If ``true``, this **HTTPClient** has a response that is chunked. .. rst-class:: classref-method -:ref:`Error` **poll**\ (\ ) +:ref:`Error` **poll**\ (\ ) :ref:`🔗` This needs to be called in order to have any request processed. Check results with :ref:`get_status`. @@ -997,7 +997,7 @@ This needs to be called in order to have any request processed. Check results wi .. rst-class:: classref-method -:ref:`String` **query_string_from_dict**\ (\ fields\: :ref:`Dictionary`\ ) +:ref:`String` **query_string_from_dict**\ (\ fields\: :ref:`Dictionary`\ ) :ref:`🔗` Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: @@ -1050,7 +1050,7 @@ Furthermore, if a key has a ``null`` value, only the key itself is added, withou .. rst-class:: classref-method -:ref:`PackedByteArray` **read_response_body_chunk**\ (\ ) +:ref:`PackedByteArray` **read_response_body_chunk**\ (\ ) :ref:`🔗` Reads one chunk from the response. @@ -1062,7 +1062,7 @@ Reads one chunk from the response. .. rst-class:: classref-method -:ref:`Error` **request**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`String` = ""\ ) +:ref:`Error` **request**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`String` = ""\ ) :ref:`🔗` Sends a request to the connected host. @@ -1101,7 +1101,7 @@ To create a POST request with query strings to push to the server, do: .. rst-class:: classref-method -:ref:`Error` **request_raw**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) +:ref:`Error` **request_raw**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sends a raw request to the connected host. @@ -1119,7 +1119,7 @@ Sends the body data raw, as a byte array and does not encode it in any way. .. rst-class:: classref-method -|void| **set_http_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +|void| **set_http_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Sets the proxy server for HTTP requests. @@ -1133,7 +1133,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. rst-class:: classref-method -|void| **set_https_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +|void| **set_https_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Sets the proxy server for HTTPS requests. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 5d64db6e7c8..26947c36b42 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -257,7 +257,7 @@ Signals .. rst-class:: classref-signal -**request_completed**\ (\ result\: :ref:`int`, response_code\: :ref:`int`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) +**request_completed**\ (\ result\: :ref:`int`, response_code\: :ref:`int`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) :ref:`🔗` Emitted when a request is completed. @@ -274,7 +274,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Result**: +enum **Result**: :ref:`🔗` .. _class_HTTPRequest_constant_RESULT_SUCCESS: @@ -409,7 +409,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **accept_gzip** = ``true`` +:ref:`bool` **accept_gzip** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -432,7 +432,7 @@ If ``false`` no header will be added, and no decompression will be performed on .. rst-class:: classref-property -:ref:`int` **body_size_limit** = ``-1`` +:ref:`int` **body_size_limit** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -449,7 +449,7 @@ Maximum allowed size for response bodies. If the response body is compressed, th .. rst-class:: classref-property -:ref:`int` **download_chunk_size** = ``65536`` +:ref:`int` **download_chunk_size** = ``65536`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -468,7 +468,7 @@ Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to .. rst-class:: classref-property -:ref:`String` **download_file** = ``""`` +:ref:`String` **download_file** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -485,7 +485,7 @@ The file to download into. Will output any received file into it. .. rst-class:: classref-property -:ref:`int` **max_redirects** = ``8`` +:ref:`int` **max_redirects** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -502,7 +502,7 @@ Maximum number of allowed redirects. .. rst-class:: classref-property -:ref:`float` **timeout** = ``0.0`` +:ref:`float` **timeout** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -519,7 +519,7 @@ The duration to wait in seconds before a request times out. If :ref:`timeout` **use_threads** = ``false`` +:ref:`bool` **use_threads** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -541,7 +541,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **cancel_request**\ (\ ) +|void| **cancel_request**\ (\ ) :ref:`🔗` Cancels the current request. @@ -553,7 +553,7 @@ Cancels the current request. .. rst-class:: classref-method -:ref:`int` **get_body_size**\ (\ ) |const| +:ref:`int` **get_body_size**\ (\ ) |const| :ref:`🔗` Returns the response body length. @@ -567,7 +567,7 @@ Returns the response body length. .. rst-class:: classref-method -:ref:`int` **get_downloaded_bytes**\ (\ ) |const| +:ref:`int` **get_downloaded_bytes**\ (\ ) |const| :ref:`🔗` Returns the number of bytes this HTTPRequest downloaded. @@ -579,7 +579,7 @@ Returns the number of bytes this HTTPRequest downloaded. .. rst-class:: classref-method -:ref:`Status` **get_http_client_status**\ (\ ) |const| +:ref:`Status` **get_http_client_status**\ (\ ) |const| :ref:`🔗` Returns the current status of the underlying :ref:`HTTPClient`. See :ref:`Status`. @@ -591,7 +591,7 @@ Returns the current status of the underlying :ref:`HTTPClient` .. rst-class:: classref-method -:ref:`Error` **request**\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data\: :ref:`String` = ""\ ) +:ref:`Error` **request**\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data\: :ref:`String` = ""\ ) :ref:`🔗` Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. @@ -609,7 +609,7 @@ Returns :ref:`@GlobalScope.OK` if request is suc .. rst-class:: classref-method -:ref:`Error` **request_raw**\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data_raw\: :ref:`PackedByteArray` = PackedByteArray()\ ) +:ref:`Error` **request_raw**\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data_raw\: :ref:`PackedByteArray` = PackedByteArray()\ ) :ref:`🔗` Creates request on the underlying :ref:`HTTPClient` using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. @@ -623,7 +623,7 @@ Returns :ref:`@GlobalScope.OK` if request is suc .. rst-class:: classref-method -|void| **set_http_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +|void| **set_http_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Sets the proxy server for HTTP requests. @@ -637,7 +637,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. rst-class:: classref-method -|void| **set_https_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +|void| **set_https_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Sets the proxy server for HTTPS requests. @@ -651,7 +651,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. rst-class:: classref-method -|void| **set_tls_options**\ (\ client_options\: :ref:`TLSOptions`\ ) +|void| **set_tls_options**\ (\ client_options\: :ref:`TLSOptions`\ ) :ref:`🔗` Sets the :ref:`TLSOptions` to be used when connecting to an HTTPS server. See :ref:`TLSOptions.client`. diff --git a/classes/class_image.rst b/classes/class_image.rst index 979901a50ff..62546896d48 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -207,7 +207,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Format**: +enum **Format**: :ref:`🔗` .. _class_Image_constant_FORMAT_L8: @@ -555,7 +555,7 @@ Represents the size of the :ref:`Format` enum. .. rst-class:: classref-enumeration -enum **Interpolation**: +enum **Interpolation**: :ref:`🔗` .. _class_Image_constant_INTERPOLATE_NEAREST: @@ -613,7 +613,7 @@ Performs Lanczos interpolation. This is the slowest image resizing mode, but it .. rst-class:: classref-enumeration -enum **AlphaMode**: +enum **AlphaMode**: :ref:`🔗` .. _class_Image_constant_ALPHA_NONE: @@ -647,7 +647,7 @@ Image uses alpha. .. rst-class:: classref-enumeration -enum **CompressMode**: +enum **CompressMode**: :ref:`🔗` .. _class_Image_constant_COMPRESS_S3TC: @@ -705,7 +705,7 @@ Represents the size of the :ref:`CompressMode` enum. .. rst-class:: classref-enumeration -enum **UsedChannels**: +enum **UsedChannels**: :ref:`🔗` .. _class_Image_constant_USED_CHANNELS_L: @@ -763,7 +763,7 @@ The image uses four channels for red, green, blue, and alpha. .. rst-class:: classref-enumeration -enum **CompressSource**: +enum **CompressSource**: :ref:`🔗` .. _class_Image_constant_COMPRESS_SOURCE_GENERIC: @@ -797,7 +797,7 @@ Source texture (before compression) is a normal texture (e.g. it can be compress .. rst-class:: classref-enumeration -enum **ASTCFormat**: +enum **ASTCFormat**: :ref:`🔗` .. _class_Image_constant_ASTC_FORMAT_4x4: @@ -828,7 +828,7 @@ Constants .. rst-class:: classref-constant -**MAX_WIDTH** = ``16777216`` +**MAX_WIDTH** = ``16777216`` :ref:`🔗` The maximal width allowed for **Image** resources. @@ -836,7 +836,7 @@ The maximal width allowed for **Image** resources. .. rst-class:: classref-constant -**MAX_HEIGHT** = ``16777216`` +**MAX_HEIGHT** = ``16777216`` :ref:`🔗` The maximal height allowed for **Image** resources. @@ -853,7 +853,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Dictionary` **data** = ``{ "data": PackedByteArray(), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 }`` +:ref:`Dictionary` **data** = ``{ "data": PackedByteArray(), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 }`` :ref:`🔗` Holds all the image's color data in a given format. See :ref:`Format` constants. @@ -870,7 +870,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **adjust_bcs**\ (\ brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`\ ) +|void| **adjust_bcs**\ (\ brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`\ ) :ref:`🔗` Adjusts this image's ``brightness``, ``contrast``, and ``saturation`` by the given values. Does not work if the image is compressed (see :ref:`is_compressed`). @@ -882,7 +882,7 @@ Adjusts this image's ``brightness``, ``contrast``, and ``saturation`` by the giv .. rst-class:: classref-method -|void| **blend_rect**\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) +|void| **blend_rect**\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) :ref:`🔗` Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dst``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with non-positive size is treated as empty. @@ -894,7 +894,7 @@ Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dst` .. rst-class:: classref-method -|void| **blend_rect_mask**\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) +|void| **blend_rect_mask**\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) :ref:`🔗` Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image at coordinates ``dst``, clipped accordingly to both image bounds. Alpha channels are required for both ``src`` and ``mask``. ``dst`` pixels and ``src`` pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and ``src`` image **must** have the same format. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. ``src_rect`` with non-positive size is treated as empty. @@ -906,7 +906,7 @@ Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image .. rst-class:: classref-method -|void| **blit_rect**\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) +|void| **blit_rect**\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) :ref:`🔗` Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with non-positive size is treated as empty. @@ -918,7 +918,7 @@ Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``, cli .. rst-class:: classref-method -|void| **blit_rect_mask**\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) +|void| **blit_rect_mask**\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) :ref:`🔗` Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``, clipped accordingly to both image bounds. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. This image and ``src`` image **must** have the same format. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. ``src_rect`` with non-positive size is treated as empty. @@ -930,7 +930,7 @@ Blits ``src_rect`` area from ``src`` image to this image at the coordinates give .. rst-class:: classref-method -|void| **bump_map_to_normal_map**\ (\ bump_scale\: :ref:`float` = 1.0\ ) +|void| **bump_map_to_normal_map**\ (\ bump_scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel. @@ -942,7 +942,7 @@ Converts a bump map to a normal map. A bump map provides a height offset per-pix .. rst-class:: classref-method -|void| **clear_mipmaps**\ (\ ) +|void| **clear_mipmaps**\ (\ ) :ref:`🔗` Removes the image's mipmaps. @@ -954,7 +954,7 @@ Removes the image's mipmaps. .. rst-class:: classref-method -:ref:`Error` **compress**\ (\ mode\: :ref:`CompressMode`, source\: :ref:`CompressSource` = 0, astc_format\: :ref:`ASTCFormat` = 0\ ) +:ref:`Error` **compress**\ (\ mode\: :ref:`CompressMode`, source\: :ref:`CompressSource` = 0, astc_format\: :ref:`ASTCFormat` = 0\ ) :ref:`🔗` Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. @@ -970,7 +970,7 @@ For ASTC compression, the ``astc_format`` parameter must be supplied. .. rst-class:: classref-method -:ref:`Error` **compress_from_channels**\ (\ mode\: :ref:`CompressMode`, channels\: :ref:`UsedChannels`, astc_format\: :ref:`ASTCFormat` = 0\ ) +:ref:`Error` **compress_from_channels**\ (\ mode\: :ref:`CompressMode`, channels\: :ref:`UsedChannels`, astc_format\: :ref:`ASTCFormat` = 0\ ) :ref:`🔗` Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. @@ -986,7 +986,7 @@ For ASTC compression, the ``astc_format`` parameter must be supplied. .. rst-class:: classref-method -:ref:`Dictionary` **compute_image_metrics**\ (\ compared_image\: :ref:`Image`, use_luma\: :ref:`bool`\ ) +:ref:`Dictionary` **compute_image_metrics**\ (\ compared_image\: :ref:`Image`, use_luma\: :ref:`bool`\ ) :ref:`🔗` Compute image metrics on the current image and the compared image. @@ -1000,7 +1000,7 @@ The dictionary contains ``max``, ``mean``, ``mean_squared``, ``root_mean_squared .. rst-class:: classref-method -|void| **convert**\ (\ format\: :ref:`Format`\ ) +|void| **convert**\ (\ format\: :ref:`Format`\ ) :ref:`🔗` Converts the image's format. See :ref:`Format` constants. @@ -1012,7 +1012,7 @@ Converts the image's format. See :ref:`Format` constants. .. rst-class:: classref-method -|void| **copy_from**\ (\ src\: :ref:`Image`\ ) +|void| **copy_from**\ (\ src\: :ref:`Image`\ ) :ref:`🔗` Copies ``src`` image to this image. @@ -1024,7 +1024,7 @@ Copies ``src`` image to this image. .. rst-class:: classref-method -:ref:`Image` **create**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| +:ref:`Image` **create**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| :ref:`🔗` Creates an empty image of given size and format. See :ref:`Format` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps`. @@ -1036,7 +1036,7 @@ Creates an empty image of given size and format. See :ref:`Format` **create_from_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) |static| +:ref:`Image` **create_from_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` Creates a new image of given size and format. See :ref:`Format` constants. Fills the image with the given raw data. If ``use_mipmaps`` is ``true`` then loads mipmaps for this image from ``data``. See :ref:`generate_mipmaps`. @@ -1048,7 +1048,7 @@ Creates a new image of given size and format. See :ref:`Format`, height\: :ref:`int`\ ) +|void| **crop**\ (\ width\: :ref:`int`, height\: :ref:`int`\ ) :ref:`🔗` Crops the image to the given ``width`` and ``height``. If the specified size is larger than the current size, the extra area is filled with black pixels. @@ -1060,7 +1060,7 @@ Crops the image to the given ``width`` and ``height``. If the specified size is .. rst-class:: classref-method -:ref:`Error` **decompress**\ (\ ) +:ref:`Error` **decompress**\ (\ ) :ref:`🔗` Decompresses the image if it is VRAM compressed in a supported format. Returns :ref:`@GlobalScope.OK` if the format is supported, otherwise :ref:`@GlobalScope.ERR_UNAVAILABLE`. @@ -1074,7 +1074,7 @@ Decompresses the image if it is VRAM compressed in a supported format. Returns : .. rst-class:: classref-method -:ref:`AlphaMode` **detect_alpha**\ (\ ) |const| +:ref:`AlphaMode` **detect_alpha**\ (\ ) |const| :ref:`🔗` Returns :ref:`ALPHA_BLEND` if the image has data for alpha values. Returns :ref:`ALPHA_BIT` if all the alpha values are stored in a single bit. Returns :ref:`ALPHA_NONE` if no data for alpha values is found. @@ -1086,7 +1086,7 @@ Returns :ref:`ALPHA_BLEND` if the image has da .. rst-class:: classref-method -:ref:`UsedChannels` **detect_used_channels**\ (\ source\: :ref:`CompressSource` = 0\ ) |const| +:ref:`UsedChannels` **detect_used_channels**\ (\ source\: :ref:`CompressSource` = 0\ ) |const| :ref:`🔗` Returns the color channels used by this image, as one of the :ref:`UsedChannels` constants. If the image is compressed, the original ``source`` must be specified. @@ -1098,7 +1098,7 @@ Returns the color channels used by this image, as one of the :ref:`UsedChannels< .. rst-class:: classref-method -|void| **fill**\ (\ color\: :ref:`Color`\ ) +|void| **fill**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Fills the image with ``color``. @@ -1110,7 +1110,7 @@ Fills the image with ``color``. .. rst-class:: classref-method -|void| **fill_rect**\ (\ rect\: :ref:`Rect2i`, color\: :ref:`Color`\ ) +|void| **fill_rect**\ (\ rect\: :ref:`Rect2i`, color\: :ref:`Color`\ ) :ref:`🔗` Fills ``rect`` with ``color``. @@ -1122,7 +1122,7 @@ Fills ``rect`` with ``color``. .. rst-class:: classref-method -|void| **fix_alpha_edges**\ (\ ) +|void| **fix_alpha_edges**\ (\ ) :ref:`🔗` Blends low-alpha pixels with nearby pixels. @@ -1134,7 +1134,7 @@ Blends low-alpha pixels with nearby pixels. .. rst-class:: classref-method -|void| **flip_x**\ (\ ) +|void| **flip_x**\ (\ ) :ref:`🔗` Flips the image horizontally. @@ -1146,7 +1146,7 @@ Flips the image horizontally. .. rst-class:: classref-method -|void| **flip_y**\ (\ ) +|void| **flip_y**\ (\ ) :ref:`🔗` Flips the image vertically. @@ -1158,7 +1158,7 @@ Flips the image vertically. .. rst-class:: classref-method -:ref:`Error` **generate_mipmaps**\ (\ renormalize\: :ref:`bool` = false\ ) +:ref:`Error` **generate_mipmaps**\ (\ renormalize\: :ref:`bool` = false\ ) :ref:`🔗` Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is ``0``. Enabling ``renormalize`` when generating mipmaps for normal map textures will make sure all resulting vector values are normalized. @@ -1172,7 +1172,7 @@ It is possible to check if the image has mipmaps by calling :ref:`has_mipmaps` **get_data**\ (\ ) |const| +:ref:`PackedByteArray` **get_data**\ (\ ) |const| :ref:`🔗` Returns a copy of the image's raw data. @@ -1184,7 +1184,7 @@ Returns a copy of the image's raw data. .. rst-class:: classref-method -:ref:`Format` **get_format**\ (\ ) |const| +:ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` Returns the image's format. See :ref:`Format` constants. @@ -1196,7 +1196,7 @@ Returns the image's format. See :ref:`Format` constants. .. rst-class:: classref-method -:ref:`int` **get_height**\ (\ ) |const| +:ref:`int` **get_height**\ (\ ) |const| :ref:`🔗` Returns the image's height. @@ -1208,7 +1208,7 @@ Returns the image's height. .. rst-class:: classref-method -:ref:`int` **get_mipmap_count**\ (\ ) |const| +:ref:`int` **get_mipmap_count**\ (\ ) |const| :ref:`🔗` Returns the number of mipmap levels or 0 if the image has no mipmaps. The largest main level image is not counted as a mipmap level by this method, so if you want to include it you can add 1 to this count. @@ -1220,7 +1220,7 @@ Returns the number of mipmap levels or 0 if the image has no mipmaps. The larges .. rst-class:: classref-method -:ref:`int` **get_mipmap_offset**\ (\ mipmap\: :ref:`int`\ ) |const| +:ref:`int` **get_mipmap_offset**\ (\ mipmap\: :ref:`int`\ ) |const| :ref:`🔗` Returns the offset where the image's mipmap with index ``mipmap`` is stored in the :ref:`data` dictionary. @@ -1232,7 +1232,7 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t .. rst-class:: classref-method -:ref:`Color` **get_pixel**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| +:ref:`Color` **get_pixel**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| :ref:`🔗` Returns the color of the pixel at ``(x, y)``. @@ -1246,7 +1246,7 @@ This is the same as :ref:`get_pixelv`, but with t .. rst-class:: classref-method -:ref:`Color` **get_pixelv**\ (\ point\: :ref:`Vector2i`\ ) |const| +:ref:`Color` **get_pixelv**\ (\ point\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the color of the pixel at ``point``. @@ -1260,7 +1260,7 @@ This is the same as :ref:`get_pixel`, but with a : .. rst-class:: classref-method -:ref:`Image` **get_region**\ (\ region\: :ref:`Rect2i`\ ) |const| +:ref:`Image` **get_region**\ (\ region\: :ref:`Rect2i`\ ) |const| :ref:`🔗` Returns a new **Image** that is a copy of this **Image**'s area specified with ``region``. @@ -1272,7 +1272,7 @@ Returns a new **Image** that is a copy of this **Image**'s area specified with ` .. rst-class:: classref-method -:ref:`Vector2i` **get_size**\ (\ ) |const| +:ref:`Vector2i` **get_size**\ (\ ) |const| :ref:`🔗` Returns the image's size (width and height). @@ -1284,7 +1284,7 @@ Returns the image's size (width and height). .. rst-class:: classref-method -:ref:`Rect2i` **get_used_rect**\ (\ ) |const| +:ref:`Rect2i` **get_used_rect**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Rect2i` enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible. @@ -1296,7 +1296,7 @@ Returns a :ref:`Rect2i` enclosing the visible portion of the image .. rst-class:: classref-method -:ref:`int` **get_width**\ (\ ) |const| +:ref:`int` **get_width**\ (\ ) |const| :ref:`🔗` Returns the image's width. @@ -1308,7 +1308,7 @@ Returns the image's width. .. rst-class:: classref-method -:ref:`bool` **has_mipmaps**\ (\ ) |const| +:ref:`bool` **has_mipmaps**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the image has generated mipmaps. @@ -1320,7 +1320,7 @@ Returns ``true`` if the image has generated mipmaps. .. rst-class:: classref-method -:ref:`bool` **is_compressed**\ (\ ) |const| +:ref:`bool` **is_compressed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the image is compressed. @@ -1332,7 +1332,7 @@ Returns ``true`` if the image is compressed. .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the image has no data. @@ -1344,7 +1344,7 @@ Returns ``true`` if the image has no data. .. rst-class:: classref-method -:ref:`bool` **is_invisible**\ (\ ) |const| +:ref:`bool` **is_invisible**\ (\ ) |const| :ref:`🔗` Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``false`` if any pixel has an alpha value higher than 0. @@ -1356,7 +1356,7 @@ Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``f .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads an image from file ``path``. See `Supported image formats <../tutorials/assets_pipeline/importing_images.html#supported-image-formats>`__ for a list of supported image formats and limitations. @@ -1372,7 +1372,7 @@ See also :ref:`ImageTexture` description for usage examples. .. rst-class:: classref-method -:ref:`Error` **load_bmp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_bmp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads an image from the binary contents of a BMP file. @@ -1388,7 +1388,7 @@ Loads an image from the binary contents of a BMP file. .. rst-class:: classref-method -:ref:`Image` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| +:ref:`Image` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Creates a new **Image** and loads data from the specified file. @@ -1400,7 +1400,7 @@ Creates a new **Image** and loads data from the specified file. .. rst-class:: classref-method -:ref:`Error` **load_jpg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_jpg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads an image from the binary contents of a JPEG file. @@ -1412,7 +1412,7 @@ Loads an image from the binary contents of a JPEG file. .. rst-class:: classref-method -:ref:`Error` **load_ktx_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_ktx_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads an image from the binary contents of a `KTX `__ file. Unlike most image formats, KTX can store VRAM-compressed data and embed mipmaps. @@ -1428,7 +1428,7 @@ Loads an image from the binary contents of a `KTX ` **load_png_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_png_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads an image from the binary contents of a PNG file. @@ -1440,7 +1440,7 @@ Loads an image from the binary contents of a PNG file. .. rst-class:: classref-method -:ref:`Error` **load_svg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`, scale\: :ref:`float` = 1.0\ ) +:ref:`Error` **load_svg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`, scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (**.svg**). @@ -1456,7 +1456,7 @@ Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (* .. rst-class:: classref-method -:ref:`Error` **load_svg_from_string**\ (\ svg_str\: :ref:`String`, scale\: :ref:`float` = 1.0\ ) +:ref:`Error` **load_svg_from_string**\ (\ svg_str\: :ref:`String`, scale\: :ref:`float` = 1.0\ ) :ref:`🔗` Loads an image from the string contents of an SVG file (**.svg**). @@ -1470,7 +1470,7 @@ Loads an image from the string contents of an SVG file (**.svg**). .. rst-class:: classref-method -:ref:`Error` **load_tga_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_tga_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads an image from the binary contents of a TGA file. @@ -1484,7 +1484,7 @@ Loads an image from the binary contents of a TGA file. .. rst-class:: classref-method -:ref:`Error` **load_webp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **load_webp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Loads an image from the binary contents of a WebP file. @@ -1496,7 +1496,7 @@ Loads an image from the binary contents of a WebP file. .. rst-class:: classref-method -|void| **normal_map_to_xy**\ (\ ) +|void| **normal_map_to_xy**\ (\ ) :ref:`🔗` Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normal map. A normal map can add lots of detail to a 3D surface without increasing the polygon count. @@ -1508,7 +1508,7 @@ Converts the image's data to represent coordinates on a 3D plane. This is used w .. rst-class:: classref-method -|void| **premultiply_alpha**\ (\ ) +|void| **premultiply_alpha**\ (\ ) :ref:`🔗` Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. See also :ref:`CanvasItemMaterial.blend_mode`. @@ -1520,7 +1520,7 @@ Multiplies color values with alpha values. Resulting color values for a pixel ar .. rst-class:: classref-method -|void| **resize**\ (\ width\: :ref:`int`, height\: :ref:`int`, interpolation\: :ref:`Interpolation` = 1\ ) +|void| **resize**\ (\ width\: :ref:`int`, height\: :ref:`int`, interpolation\: :ref:`Interpolation` = 1\ ) :ref:`🔗` Resizes the image to the given ``width`` and ``height``. New pixels are calculated using the ``interpolation`` mode defined via :ref:`Interpolation` constants. @@ -1532,7 +1532,7 @@ Resizes the image to the given ``width`` and ``height``. New pixels are calculat .. rst-class:: classref-method -|void| **resize_to_po2**\ (\ square\: :ref:`bool` = false, interpolation\: :ref:`Interpolation` = 1\ ) +|void| **resize_to_po2**\ (\ square\: :ref:`bool` = false, interpolation\: :ref:`Interpolation` = 1\ ) :ref:`🔗` Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. New pixels are calculated using the ``interpolation`` mode defined via :ref:`Interpolation` constants. @@ -1544,7 +1544,7 @@ Resizes the image to the nearest power of 2 for the width and height. If ``squar .. rst-class:: classref-method -:ref:`Image` **rgbe_to_srgb**\ (\ ) +:ref:`Image` **rgbe_to_srgb**\ (\ ) :ref:`🔗` Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. @@ -1556,7 +1556,7 @@ Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. .. rst-class:: classref-method -|void| **rotate_90**\ (\ direction\: :ref:`ClockDirection`\ ) +|void| **rotate_90**\ (\ direction\: :ref:`ClockDirection`\ ) :ref:`🔗` Rotates the image in the specified ``direction`` by ``90`` degrees. The width and height of the image must be greater than ``1``. If the width and height are not equal, the image will be resized. @@ -1568,7 +1568,7 @@ Rotates the image in the specified ``direction`` by ``90`` degrees. The width an .. rst-class:: classref-method -|void| **rotate_180**\ (\ ) +|void| **rotate_180**\ (\ ) :ref:`🔗` Rotates the image by ``180`` degrees. The width and height of the image must be greater than ``1``. @@ -1580,7 +1580,7 @@ Rotates the image by ``180`` degrees. The width and height of the image must be .. rst-class:: classref-method -:ref:`Error` **save_exr**\ (\ path\: :ref:`String`, grayscale\: :ref:`bool` = false\ ) |const| +:ref:`Error` **save_exr**\ (\ path\: :ref:`String`, grayscale\: :ref:`bool` = false\ ) |const| :ref:`🔗` Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the TinyEXR module. @@ -1594,7 +1594,7 @@ Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the .. rst-class:: classref-method -:ref:`PackedByteArray` **save_exr_to_buffer**\ (\ grayscale\: :ref:`bool` = false\ ) |const| +:ref:`PackedByteArray` **save_exr_to_buffer**\ (\ grayscale\: :ref:`bool` = false\ ) |const| :ref:`🔗` Saves the image as an EXR file to a byte array. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module. @@ -1608,7 +1608,7 @@ Saves the image as an EXR file to a byte array. If ``grayscale`` is ``true`` and .. rst-class:: classref-method -:ref:`Error` **save_jpg**\ (\ path\: :ref:`String`, quality\: :ref:`float` = 0.75\ ) |const| +:ref:`Error` **save_jpg**\ (\ path\: :ref:`String`, quality\: :ref:`float` = 0.75\ ) |const| :ref:`🔗` Saves the image as a JPEG file to ``path`` with the specified ``quality`` between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger file sizes. Recommended ``quality`` values are between ``0.75`` and ``0.90``. Even at quality ``1.00``, JPEG compression remains lossy. @@ -1622,7 +1622,7 @@ Saves the image as a JPEG file to ``path`` with the specified ``quality`` betwee .. rst-class:: classref-method -:ref:`PackedByteArray` **save_jpg_to_buffer**\ (\ quality\: :ref:`float` = 0.75\ ) |const| +:ref:`PackedByteArray` **save_jpg_to_buffer**\ (\ quality\: :ref:`float` = 0.75\ ) |const| :ref:`🔗` Saves the image as a JPEG file to a byte array with the specified ``quality`` between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended ``quality`` values are between ``0.75`` and ``0.90``. Even at quality ``1.00``, JPEG compression remains lossy. @@ -1636,7 +1636,7 @@ Saves the image as a JPEG file to a byte array with the specified ``quality`` be .. rst-class:: classref-method -:ref:`Error` **save_png**\ (\ path\: :ref:`String`\ ) |const| +:ref:`Error` **save_png**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Saves the image as a PNG file to the file at ``path``. @@ -1648,7 +1648,7 @@ Saves the image as a PNG file to the file at ``path``. .. rst-class:: classref-method -:ref:`PackedByteArray` **save_png_to_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **save_png_to_buffer**\ (\ ) |const| :ref:`🔗` Saves the image as a PNG file to a byte array. @@ -1660,7 +1660,7 @@ Saves the image as a PNG file to a byte array. .. rst-class:: classref-method -:ref:`Error` **save_webp**\ (\ path\: :ref:`String`, lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| +:ref:`Error` **save_webp**\ (\ path\: :ref:`String`, lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| :ref:`🔗` Saves the image as a WebP (Web Picture) file to the file at ``path``. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). Lossless WebP offers more efficient compression than PNG. @@ -1674,7 +1674,7 @@ Saves the image as a WebP (Web Picture) file to the file at ``path``. By default .. rst-class:: classref-method -:ref:`PackedByteArray` **save_webp_to_buffer**\ (\ lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| +:ref:`PackedByteArray` **save_webp_to_buffer**\ (\ lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| :ref:`🔗` Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). Lossless WebP offers more efficient compression than PNG. @@ -1688,7 +1688,7 @@ Saves the image as a WebP (Web Picture) file to a byte array. By default it will .. rst-class:: classref-method -|void| **set_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) +|void| **set_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Overwrites data of an existing **Image**. Non-static equivalent of :ref:`create_from_data`. @@ -1700,7 +1700,7 @@ Overwrites data of an existing **Image**. Non-static equivalent of :ref:`create_ .. rst-class:: classref-method -|void| **set_pixel**\ (\ x\: :ref:`int`, y\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_pixel**\ (\ x\: :ref:`int`, y\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the :ref:`Color` of the pixel at ``(x, y)`` to ``color``. @@ -1737,7 +1737,7 @@ This is the same as :ref:`set_pixelv`, but with a .. rst-class:: classref-method -|void| **set_pixelv**\ (\ point\: :ref:`Vector2i`, color\: :ref:`Color`\ ) +|void| **set_pixelv**\ (\ point\: :ref:`Vector2i`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the :ref:`Color` of the pixel at ``point`` to ``color``. @@ -1774,7 +1774,7 @@ This is the same as :ref:`set_pixel`, but with a : .. rst-class:: classref-method -|void| **shrink_x2**\ (\ ) +|void| **shrink_x2**\ (\ ) :ref:`🔗` Shrinks the image by a factor of 2 on each axis (this divides the pixel count by 4). @@ -1786,7 +1786,7 @@ Shrinks the image by a factor of 2 on each axis (this divides the pixel count by .. rst-class:: classref-method -|void| **srgb_to_linear**\ (\ ) +|void| **srgb_to_linear**\ (\ ) :ref:`🔗` Converts the raw data from the sRGB colorspace to a linear scale. diff --git a/classes/class_imageformatloader.rst b/classes/class_imageformatloader.rst index 856ec54a435..52b11cf891b 100644 --- a/classes/class_imageformatloader.rst +++ b/classes/class_imageformatloader.rst @@ -36,7 +36,7 @@ Enumerations .. rst-class:: classref-enumeration -flags **LoaderFlags**: +flags **LoaderFlags**: :ref:`🔗` .. _class_ImageFormatLoader_constant_FLAG_NONE: diff --git a/classes/class_imageformatloaderextension.rst b/classes/class_imageformatloaderextension.rst index 2c7fcd0ab42..79e32a34b75 100644 --- a/classes/class_imageformatloaderextension.rst +++ b/classes/class_imageformatloaderextension.rst @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| :ref:`🔗` Returns the list of file extensions for this image format. Files with the given extensions will be treated as image file and loaded using this class. @@ -66,7 +66,7 @@ Returns the list of file extensions for this image format. Files with the given .. rst-class:: classref-method -:ref:`Error` **_load_image**\ (\ image\: :ref:`Image`, fileaccess\: :ref:`FileAccess`, flags\: |bitfield|\[:ref:`LoaderFlags`\], scale\: :ref:`float`\ ) |virtual| +:ref:`Error` **_load_image**\ (\ image\: :ref:`Image`, fileaccess\: :ref:`FileAccess`, flags\: |bitfield|\[:ref:`LoaderFlags`\], scale\: :ref:`float`\ ) |virtual| :ref:`🔗` Loads the content of ``fileaccess`` into the provided ``image``. @@ -78,7 +78,7 @@ Loads the content of ``fileaccess`` into the provided ``image``. .. rst-class:: classref-method -|void| **add_format_loader**\ (\ ) +|void| **add_format_loader**\ (\ ) :ref:`🔗` Add this format loader to the engine, allowing it to recognize the file extensions returned by :ref:`_get_recognized_extensions`. @@ -90,7 +90,7 @@ Add this format loader to the engine, allowing it to recognize the file extensio .. rst-class:: classref-method -|void| **remove_format_loader**\ (\ ) +|void| **remove_format_loader**\ (\ ) :ref:`🔗` Remove this format loader from the engine. diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 9dd4a3bbbb5..753245ec503 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -101,7 +101,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ImageTexture` **create_from_image**\ (\ image\: :ref:`Image`\ ) |static| +:ref:`ImageTexture` **create_from_image**\ (\ image\: :ref:`Image`\ ) |static| :ref:`🔗` Creates a new **ImageTexture** and initializes it by allocating and setting the data from an :ref:`Image`. @@ -113,7 +113,7 @@ Creates a new **ImageTexture** and initializes it by allocating and setting the .. rst-class:: classref-method -:ref:`Format` **get_format**\ (\ ) |const| +:ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` Returns the format of the texture, one of :ref:`Format`. @@ -125,7 +125,7 @@ Returns the format of the texture, one of :ref:`Format`. .. rst-class:: classref-method -|void| **set_image**\ (\ image\: :ref:`Image`\ ) +|void| **set_image**\ (\ image\: :ref:`Image`\ ) :ref:`🔗` Replaces the texture's data with a new :ref:`Image`. This will re-allocate new memory for the texture. @@ -139,7 +139,7 @@ If you want to update the image, but don't need to change its parameters (format .. rst-class:: classref-method -|void| **set_size_override**\ (\ size\: :ref:`Vector2i`\ ) +|void| **set_size_override**\ (\ size\: :ref:`Vector2i`\ ) :ref:`🔗` Resizes the texture to the specified dimensions. @@ -151,7 +151,7 @@ Resizes the texture to the specified dimensions. .. rst-class:: classref-method -|void| **update**\ (\ image\: :ref:`Image`\ ) +|void| **update**\ (\ image\: :ref:`Image`\ ) :ref:`🔗` Replaces the texture's data with a new :ref:`Image`. diff --git a/classes/class_imagetexture3d.rst b/classes/class_imagetexture3d.rst index 1c9521c3dcd..8079cb052e5 100644 --- a/classes/class_imagetexture3d.rst +++ b/classes/class_imagetexture3d.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, use_mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) +:ref:`Error` **create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, use_mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` Creates the **ImageTexture3D** with specified ``width``, ``height``, and ``depth``. See :ref:`Format` for ``format`` options. If ``use_mipmaps`` is ``true``, then generate mipmaps for the **ImageTexture3D**. @@ -62,7 +62,7 @@ Creates the **ImageTexture3D** with specified ``width``, ``height``, and ``depth .. rst-class:: classref-method -|void| **update**\ (\ data\: :ref:`Array`\[:ref:`Image`\]\ ) +|void| **update**\ (\ data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` Replaces the texture's existing data with the layers specified in ``data``. The size of ``data`` must match the parameters that were used for :ref:`create`. In other words, the texture cannot be resized or have its format changed by calling :ref:`update`. diff --git a/classes/class_imagetexturelayered.rst b/classes/class_imagetexturelayered.rst index 7c186000e21..18674b2b103 100644 --- a/classes/class_imagetexturelayered.rst +++ b/classes/class_imagetexturelayered.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **create_from_images**\ (\ images\: :ref:`Array`\[:ref:`Image`\]\ ) +:ref:`Error` **create_from_images**\ (\ images\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` Creates an **ImageTextureLayered** from an array of :ref:`Image`\ s. See :ref:`Image.create` for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images *must* have the same width, height, image format and mipmapping setting. @@ -64,7 +64,7 @@ Each :ref:`Image` represents one ``layer``. .. rst-class:: classref-method -|void| **update_layer**\ (\ image\: :ref:`Image`, layer\: :ref:`int`\ ) +|void| **update_layer**\ (\ image\: :ref:`Image`, layer\: :ref:`int`\ ) :ref:`🔗` Replaces the existing :ref:`Image` data at the given ``layer`` with this new image. diff --git a/classes/class_immediatemesh.rst b/classes/class_immediatemesh.rst index 2b27437601c..0f9221a7030 100644 --- a/classes/class_immediatemesh.rst +++ b/classes/class_immediatemesh.rst @@ -98,7 +98,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_surfaces**\ (\ ) +|void| **clear_surfaces**\ (\ ) :ref:`🔗` Clear all surfaces. @@ -110,7 +110,7 @@ Clear all surfaces. .. rst-class:: classref-method -|void| **surface_add_vertex**\ (\ vertex\: :ref:`Vector3`\ ) +|void| **surface_add_vertex**\ (\ vertex\: :ref:`Vector3`\ ) :ref:`🔗` Add a 3D vertex using the current attributes previously set. @@ -122,7 +122,7 @@ Add a 3D vertex using the current attributes previously set. .. rst-class:: classref-method -|void| **surface_add_vertex_2d**\ (\ vertex\: :ref:`Vector2`\ ) +|void| **surface_add_vertex_2d**\ (\ vertex\: :ref:`Vector2`\ ) :ref:`🔗` Add a 2D vertex using the current attributes previously set. @@ -134,7 +134,7 @@ Add a 2D vertex using the current attributes previously set. .. rst-class:: classref-method -|void| **surface_begin**\ (\ primitive\: :ref:`PrimitiveType`, material\: :ref:`Material` = null\ ) +|void| **surface_begin**\ (\ primitive\: :ref:`PrimitiveType`, material\: :ref:`Material` = null\ ) :ref:`🔗` Begin a new surface. @@ -146,7 +146,7 @@ Begin a new surface. .. rst-class:: classref-method -|void| **surface_end**\ (\ ) +|void| **surface_end**\ (\ ) :ref:`🔗` End and commit current surface. Note that surface being created will not be visible until this function is called. @@ -158,7 +158,7 @@ End and commit current surface. Note that surface being created will not be visi .. rst-class:: classref-method -|void| **surface_set_color**\ (\ color\: :ref:`Color`\ ) +|void| **surface_set_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Set the color attribute that will be pushed with the next vertex. @@ -170,7 +170,7 @@ Set the color attribute that will be pushed with the next vertex. .. rst-class:: classref-method -|void| **surface_set_normal**\ (\ normal\: :ref:`Vector3`\ ) +|void| **surface_set_normal**\ (\ normal\: :ref:`Vector3`\ ) :ref:`🔗` Set the normal attribute that will be pushed with the next vertex. @@ -182,7 +182,7 @@ Set the normal attribute that will be pushed with the next vertex. .. rst-class:: classref-method -|void| **surface_set_tangent**\ (\ tangent\: :ref:`Plane`\ ) +|void| **surface_set_tangent**\ (\ tangent\: :ref:`Plane`\ ) :ref:`🔗` Set the tangent attribute that will be pushed with the next vertex. @@ -194,7 +194,7 @@ Set the tangent attribute that will be pushed with the next vertex. .. rst-class:: classref-method -|void| **surface_set_uv**\ (\ uv\: :ref:`Vector2`\ ) +|void| **surface_set_uv**\ (\ uv\: :ref:`Vector2`\ ) :ref:`🔗` Set the UV attribute that will be pushed with the next vertex. @@ -206,7 +206,7 @@ Set the UV attribute that will be pushed with the next vertex. .. rst-class:: classref-method -|void| **surface_set_uv2**\ (\ uv2\: :ref:`Vector2`\ ) +|void| **surface_set_uv2**\ (\ uv2\: :ref:`Vector2`\ ) :ref:`🔗` Set the UV2 attribute that will be pushed with the next vertex. diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index e31833ba6af..45246548813 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -104,7 +104,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Dictionary` **_data** = ``{ "surfaces": [] }`` +:ref:`Dictionary` **_data** = ``{ "surfaces": [] }`` :ref:`🔗` .. container:: contribute @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_blend_shape**\ (\ name\: :ref:`String`\ ) +|void| **add_blend_shape**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Adds name for a blend shape that will be added with :ref:`add_surface`. Must be called before surface is added. @@ -135,7 +135,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, material\: :ref:`Material` = null, name\: :ref:`String` = "", flags\: :ref:`int` = 0\ ) +|void| **add_surface**\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, material\: :ref:`Material` = null, name\: :ref:`String` = "", flags\: :ref:`int` = 0\ ) :ref:`🔗` Creates a new surface. :ref:`Mesh.get_surface_count` will become the ``surf_idx`` for this new surface. @@ -159,7 +159,7 @@ The ``flags`` argument is the bitwise or of, as required: One value of :ref:`Arr .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Removes all surfaces and blend shapes from this **ImporterMesh**. @@ -171,7 +171,7 @@ Removes all surfaces and blend shapes from this **ImporterMesh**. .. rst-class:: classref-method -|void| **generate_lods**\ (\ normal_merge_angle\: :ref:`float`, normal_split_angle\: :ref:`float`, bone_transform_array\: :ref:`Array`\ ) +|void| **generate_lods**\ (\ normal_merge_angle\: :ref:`float`, normal_split_angle\: :ref:`float`, bone_transform_array\: :ref:`Array`\ ) :ref:`🔗` Generates all lods for this ImporterMesh. @@ -189,7 +189,7 @@ The number of generated lods can be accessed using :ref:`get_surface_lod_count` **get_blend_shape_count**\ (\ ) |const| +:ref:`int` **get_blend_shape_count**\ (\ ) |const| :ref:`🔗` Returns the number of blend shapes that the mesh holds. @@ -201,7 +201,7 @@ Returns the number of blend shapes that the mesh holds. .. rst-class:: classref-method -:ref:`BlendShapeMode` **get_blend_shape_mode**\ (\ ) |const| +:ref:`BlendShapeMode` **get_blend_shape_mode**\ (\ ) |const| :ref:`🔗` Returns the blend shape mode for this Mesh. @@ -213,7 +213,7 @@ Returns the blend shape mode for this Mesh. .. rst-class:: classref-method -:ref:`String` **get_blend_shape_name**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_blend_shape_name**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the blend shape at this index. @@ -225,7 +225,7 @@ Returns the name of the blend shape at this index. .. rst-class:: classref-method -:ref:`Vector2i` **get_lightmap_size_hint**\ (\ ) |const| +:ref:`Vector2i` **get_lightmap_size_hint**\ (\ ) |const| :ref:`🔗` Returns the size hint of this mesh for lightmap-unwrapping in UV-space. @@ -237,7 +237,7 @@ Returns the size hint of this mesh for lightmap-unwrapping in UV-space. .. rst-class:: classref-method -:ref:`ArrayMesh` **get_mesh**\ (\ base_mesh\: :ref:`ArrayMesh` = null\ ) +:ref:`ArrayMesh` **get_mesh**\ (\ base_mesh\: :ref:`ArrayMesh` = null\ ) :ref:`🔗` Returns the mesh data represented by this **ImporterMesh** as a usable :ref:`ArrayMesh`. @@ -253,7 +253,7 @@ If not yet cached and ``base_mesh`` is provided, ``base_mesh`` will be used and .. rst-class:: classref-method -:ref:`Array` **get_surface_arrays**\ (\ surface_idx\: :ref:`int`\ ) |const| +:ref:`Array` **get_surface_arrays**\ (\ surface_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface. See :ref:`add_surface`. @@ -265,7 +265,7 @@ Returns the arrays for the vertices, normals, UVs, etc. that make up the request .. rst-class:: classref-method -:ref:`Array` **get_surface_blend_shape_arrays**\ (\ surface_idx\: :ref:`int`, blend_shape_idx\: :ref:`int`\ ) |const| +:ref:`Array` **get_surface_blend_shape_arrays**\ (\ surface_idx\: :ref:`int`, blend_shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a single set of blend shape arrays for the requested blend shape index for a surface. @@ -277,7 +277,7 @@ Returns a single set of blend shape arrays for the requested blend shape index f .. rst-class:: classref-method -:ref:`int` **get_surface_count**\ (\ ) |const| +:ref:`int` **get_surface_count**\ (\ ) |const| :ref:`🔗` Returns the number of surfaces that the mesh holds. @@ -289,7 +289,7 @@ Returns the number of surfaces that the mesh holds. .. rst-class:: classref-method -:ref:`int` **get_surface_format**\ (\ surface_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_surface_format**\ (\ surface_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the format of the surface that the mesh holds. @@ -301,7 +301,7 @@ Returns the format of the surface that the mesh holds. .. rst-class:: classref-method -:ref:`int` **get_surface_lod_count**\ (\ surface_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_surface_lod_count**\ (\ surface_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of lods that the mesh holds on a given surface. @@ -313,7 +313,7 @@ Returns the number of lods that the mesh holds on a given surface. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_surface_lod_indices**\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_surface_lod_indices**\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the index buffer of a lod for a surface. @@ -325,7 +325,7 @@ Returns the index buffer of a lod for a surface. .. rst-class:: classref-method -:ref:`float` **get_surface_lod_size**\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_surface_lod_size**\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the screen ratio which activates a lod for a surface. @@ -337,7 +337,7 @@ Returns the screen ratio which activates a lod for a surface. .. rst-class:: classref-method -:ref:`Material` **get_surface_material**\ (\ surface_idx\: :ref:`int`\ ) |const| +:ref:`Material` **get_surface_material**\ (\ surface_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`Material` in a given surface. Surface is rendered using this material. @@ -349,7 +349,7 @@ Returns a :ref:`Material` in a given surface. Surface is rendere .. rst-class:: classref-method -:ref:`String` **get_surface_name**\ (\ surface_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_surface_name**\ (\ surface_idx\: :ref:`int`\ ) |const| :ref:`🔗` Gets the name assigned to this surface. @@ -361,7 +361,7 @@ Gets the name assigned to this surface. .. rst-class:: classref-method -:ref:`PrimitiveType` **get_surface_primitive_type**\ (\ surface_idx\: :ref:`int`\ ) +:ref:`PrimitiveType` **get_surface_primitive_type**\ (\ surface_idx\: :ref:`int`\ ) :ref:`🔗` Returns the primitive type of the requested surface (see :ref:`add_surface`). @@ -373,7 +373,7 @@ Returns the primitive type of the requested surface (see :ref:`add_surface`\ ) +|void| **set_blend_shape_mode**\ (\ mode\: :ref:`BlendShapeMode`\ ) :ref:`🔗` Sets the blend shape mode to one of :ref:`BlendShapeMode`. @@ -385,7 +385,7 @@ Sets the blend shape mode to one of :ref:`BlendShapeMode`\ ) +|void| **set_lightmap_size_hint**\ (\ size\: :ref:`Vector2i`\ ) :ref:`🔗` Sets the size hint of this mesh for lightmap-unwrapping in UV-space. @@ -397,7 +397,7 @@ Sets the size hint of this mesh for lightmap-unwrapping in UV-space. .. rst-class:: classref-method -|void| **set_surface_material**\ (\ surface_idx\: :ref:`int`, material\: :ref:`Material`\ ) +|void| **set_surface_material**\ (\ surface_idx\: :ref:`int`, material\: :ref:`Material`\ ) :ref:`🔗` Sets a :ref:`Material` for a given surface. Surface will be rendered using this material. @@ -409,7 +409,7 @@ Sets a :ref:`Material` for a given surface. Surface will be rend .. rst-class:: classref-method -|void| **set_surface_name**\ (\ surface_idx\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_surface_name**\ (\ surface_idx\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets a name for a given surface. diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index 785f643fde2..82ba3c9b15f 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ShadowCastingSetting` **cast_shadow** = ``1`` +:ref:`ShadowCastingSetting` **cast_shadow** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -78,7 +78,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **layer_mask** = ``1`` +:ref:`int` **layer_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ImporterMesh` **mesh** +:ref:`ImporterMesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **skeleton_path** = ``NodePath("")`` +:ref:`NodePath` **skeleton_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -135,7 +135,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Skin` **skin** +:ref:`Skin` **skin** :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **visibility_range_begin** = ``0.0`` +:ref:`float` **visibility_range_begin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **visibility_range_begin_margin** = ``0.0`` +:ref:`float` **visibility_range_begin_margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **visibility_range_end** = ``0.0`` +:ref:`float` **visibility_range_end** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -211,7 +211,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **visibility_range_end_margin** = ``0.0`` +:ref:`float` **visibility_range_end_margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`VisibilityRangeFadeMode` **visibility_range_fade_mode** = ``0`` +:ref:`VisibilityRangeFadeMode` **visibility_range_fade_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_input.rst b/classes/class_input.rst index 381fc562744..c33486b02f1 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -167,7 +167,7 @@ Signals .. rst-class:: classref-signal -**joy_connection_changed**\ (\ device\: :ref:`int`, connected\: :ref:`bool`\ ) +**joy_connection_changed**\ (\ device\: :ref:`int`, connected\: :ref:`bool`\ ) :ref:`🔗` Emitted when a joypad device has been connected or disconnected. @@ -184,7 +184,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MouseMode**: +enum **MouseMode**: :ref:`🔗` .. _class_Input_constant_MOUSE_MODE_VISIBLE: @@ -236,7 +236,7 @@ Confines the mouse cursor to the game window, and make it hidden. .. rst-class:: classref-enumeration -enum **CursorShape**: +enum **CursorShape**: :ref:`🔗` .. _class_Input_constant_CURSOR_ARROW: @@ -389,7 +389,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **emulate_mouse_from_touch** +:ref:`bool` **emulate_mouse_from_touch** :ref:`🔗` .. rst-class:: classref-property-setget @@ -406,7 +406,7 @@ If ``true``, sends mouse input events when tapping or swiping on the touchscreen .. rst-class:: classref-property -:ref:`bool` **emulate_touch_from_mouse** +:ref:`bool` **emulate_touch_from_mouse** :ref:`🔗` .. rst-class:: classref-property-setget @@ -423,7 +423,7 @@ If ``true``, sends touch input events when clicking or dragging the mouse. See a .. rst-class:: classref-property -:ref:`MouseMode` **mouse_mode** +:ref:`MouseMode` **mouse_mode** :ref:`🔗` .. rst-class:: classref-property-setget @@ -440,7 +440,7 @@ Controls the mouse mode. See :ref:`MouseMode` for more inf .. rst-class:: classref-property -:ref:`bool` **use_accumulated_input** +:ref:`bool` **use_accumulated_input** :ref:`🔗` .. rst-class:: classref-property-setget @@ -466,7 +466,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **action_press**\ (\ action\: :ref:`StringName`, strength\: :ref:`float` = 1.0\ ) +|void| **action_press**\ (\ action\: :ref:`StringName`, strength\: :ref:`float` = 1.0\ ) :ref:`🔗` This will simulate pressing the specified action. @@ -482,7 +482,7 @@ The strength can be used for non-boolean actions, it's ranged between 0 and 1 re .. rst-class:: classref-method -|void| **action_release**\ (\ action\: :ref:`StringName`\ ) +|void| **action_release**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` If the specified action is already pressed, this will release it. @@ -494,7 +494,7 @@ If the specified action is already pressed, this will release it. .. rst-class:: classref-method -|void| **add_joy_mapping**\ (\ mapping\: :ref:`String`, update_existing\: :ref:`bool` = false\ ) +|void| **add_joy_mapping**\ (\ mapping\: :ref:`String`, update_existing\: :ref:`bool` = false\ ) :ref:`🔗` Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. @@ -506,7 +506,7 @@ Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally up .. rst-class:: classref-method -|void| **flush_buffered_events**\ (\ ) +|void| **flush_buffered_events**\ (\ ) :ref:`🔗` Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input (:ref:`use_accumulated_input`) or agile input flushing (:ref:`ProjectSettings.input_devices/buffering/agile_event_flushing`). @@ -520,7 +520,7 @@ The engine will already do this itself at key execution points (at least once pe .. rst-class:: classref-method -:ref:`Vector3` **get_accelerometer**\ (\ ) |const| +:ref:`Vector3` **get_accelerometer**\ (\ ) |const| :ref:`🔗` Returns the acceleration in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -536,7 +536,7 @@ Note this method returns an empty :ref:`Vector3` when running fro .. rst-class:: classref-method -:ref:`float` **get_action_raw_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`float` **get_action_raw_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use :ref:`get_action_strength` instead. @@ -550,7 +550,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`float` **get_action_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`float` **get_action_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis such as the keyboard, the value returned will be 0 or 1. @@ -564,7 +564,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`float` **get_axis**\ (\ negative_action\: :ref:`StringName`, positive_action\: :ref:`StringName`\ ) |const| +:ref:`float` **get_axis**\ (\ negative_action\: :ref:`StringName`, positive_action\: :ref:`StringName`\ ) |const| :ref:`🔗` Get axis input by specifying two actions, one negative and one positive. @@ -578,7 +578,7 @@ This is a shorthand for writing ``Input.get_action_strength("positive_action") - .. rst-class:: classref-method -:ref:`Array`\[:ref:`int`\] **get_connected_joypads**\ (\ ) +:ref:`Array`\[:ref:`int`\] **get_connected_joypads**\ (\ ) :ref:`🔗` Returns an :ref:`Array` containing the device IDs of all currently connected joypads. @@ -590,7 +590,7 @@ Returns an :ref:`Array` containing the device IDs of all currently .. rst-class:: classref-method -:ref:`CursorShape` **get_current_cursor_shape**\ (\ ) |const| +:ref:`CursorShape` **get_current_cursor_shape**\ (\ ) |const| :ref:`🔗` Returns the currently assigned cursor shape (see :ref:`CursorShape`). @@ -602,7 +602,7 @@ Returns the currently assigned cursor shape (see :ref:`CursorShape` **get_gravity**\ (\ ) |const| +:ref:`Vector3` **get_gravity**\ (\ ) |const| :ref:`🔗` Returns the gravity in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -616,7 +616,7 @@ Returns the gravity in m/s² of the device's accelerometer sensor, if the device .. rst-class:: classref-method -:ref:`Vector3` **get_gyroscope**\ (\ ) |const| +:ref:`Vector3` **get_gyroscope**\ (\ ) |const| :ref:`🔗` Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyroscope sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -630,7 +630,7 @@ Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyr .. rst-class:: classref-method -:ref:`float` **get_joy_axis**\ (\ device\: :ref:`int`, axis\: :ref:`JoyAxis`\ ) |const| +:ref:`float` **get_joy_axis**\ (\ device\: :ref:`int`, axis\: :ref:`JoyAxis`\ ) |const| :ref:`🔗` Returns the current value of the joypad axis at given index (see :ref:`JoyAxis`). @@ -642,7 +642,7 @@ Returns the current value of the joypad axis at given index (see :ref:`JoyAxis` **get_joy_guid**\ (\ device\: :ref:`int`\ ) |const| +:ref:`String` **get_joy_guid**\ (\ device\: :ref:`int`\ ) |const| :ref:`🔗` Returns an SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. ``030000004c050000c405000000010000``. Returns ``"Default Gamepad"`` otherwise. Godot uses the `SDL2 game controller database `__ to determine gamepad names and mappings based on this GUID. @@ -654,7 +654,7 @@ Returns an SDL2-compatible device GUID on platforms that use gamepad remapping, .. rst-class:: classref-method -:ref:`Dictionary` **get_joy_info**\ (\ device\: :ref:`int`\ ) |const| +:ref:`Dictionary` **get_joy_info**\ (\ device\: :ref:`int`\ ) |const| :ref:`🔗` Returns a dictionary with extra platform-specific information about the device, e.g. the raw gamepad name from the OS or the Steam Input index. @@ -680,7 +680,7 @@ On Linux: .. rst-class:: classref-method -:ref:`String` **get_joy_name**\ (\ device\: :ref:`int`\ ) +:ref:`String` **get_joy_name**\ (\ device\: :ref:`int`\ ) :ref:`🔗` Returns the name of the joypad at the specified device index, e.g. ``PS4 Controller``. Godot uses the `SDL2 game controller database `__ to determine gamepad names. @@ -692,7 +692,7 @@ Returns the name of the joypad at the specified device index, e.g. ``PS4 Control .. rst-class:: classref-method -:ref:`float` **get_joy_vibration_duration**\ (\ device\: :ref:`int`\ ) +:ref:`float` **get_joy_vibration_duration**\ (\ device\: :ref:`int`\ ) :ref:`🔗` Returns the duration of the current vibration effect in seconds. @@ -704,7 +704,7 @@ Returns the duration of the current vibration effect in seconds. .. rst-class:: classref-method -:ref:`Vector2` **get_joy_vibration_strength**\ (\ device\: :ref:`int`\ ) +:ref:`Vector2` **get_joy_vibration_strength**\ (\ device\: :ref:`int`\ ) :ref:`🔗` Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. @@ -716,7 +716,7 @@ Returns the strength of the joypad vibration: x is the strength of the weak moto .. rst-class:: classref-method -:ref:`Vector2` **get_last_mouse_screen_velocity**\ (\ ) +:ref:`Vector2` **get_last_mouse_screen_velocity**\ (\ ) :ref:`🔗` Returns the last mouse velocity in screen coordinates. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements. @@ -728,7 +728,7 @@ Returns the last mouse velocity in screen coordinates. To provide a precise and .. rst-class:: classref-method -:ref:`Vector2` **get_last_mouse_velocity**\ (\ ) +:ref:`Vector2` **get_last_mouse_velocity**\ (\ ) :ref:`🔗` Returns the last mouse velocity. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements. @@ -740,7 +740,7 @@ Returns the last mouse velocity. To provide a precise and jitter-free velocity, .. rst-class:: classref-method -:ref:`Vector3` **get_magnetometer**\ (\ ) |const| +:ref:`Vector3` **get_magnetometer**\ (\ ) |const| :ref:`🔗` Returns the magnetic field strength in micro-Tesla for all axes of the device's magnetometer sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -754,7 +754,7 @@ Returns the magnetic field strength in micro-Tesla for all axes of the device's .. rst-class:: classref-method -|bitfield|\[:ref:`MouseButtonMask`\] **get_mouse_button_mask**\ (\ ) |const| +|bitfield|\[:ref:`MouseButtonMask`\] **get_mouse_button_mask**\ (\ ) |const| :ref:`🔗` Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to :ref:`DisplayServer.mouse_get_button_state`. @@ -766,7 +766,7 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the .. rst-class:: classref-method -:ref:`Vector2` **get_vector**\ (\ negative_x\: :ref:`StringName`, positive_x\: :ref:`StringName`, negative_y\: :ref:`StringName`, positive_y\: :ref:`StringName`, deadzone\: :ref:`float` = -1.0\ ) |const| +:ref:`Vector2` **get_vector**\ (\ negative_x\: :ref:`StringName`, positive_x\: :ref:`StringName`, negative_y\: :ref:`StringName`, positive_y\: :ref:`StringName`, deadzone\: :ref:`float` = -1.0\ ) |const| :ref:`🔗` Gets an input vector by specifying four actions for the positive and negative X and Y axes. @@ -782,7 +782,7 @@ By default, the deadzone is automatically calculated from the average of the act .. rst-class:: classref-method -:ref:`bool` **is_action_just_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_action_just_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` when the user has *started* pressing the action event in the current frame or physics tick. It will only return ``true`` on the frame or tick that the user pressed down the button. @@ -804,7 +804,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_just_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_action_just_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` when the user *stops* pressing the action event in the current frame or physics tick. It will only return ``true`` on the frame or tick that the user releases the button. @@ -822,7 +822,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if you are pressing the action event. @@ -838,7 +838,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_anything_pressed**\ (\ ) |const| +:ref:`bool` **is_anything_pressed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if any action, key, joypad button, or mouse button is being pressed. This will also return ``true`` if any action is simulated via code by calling :ref:`action_press`. @@ -850,7 +850,7 @@ Returns ``true`` if any action, key, joypad button, or mouse button is being pre .. rst-class:: classref-method -:ref:`bool` **is_joy_button_pressed**\ (\ device\: :ref:`int`, button\: :ref:`JoyButton`\ ) |const| +:ref:`bool` **is_joy_button_pressed**\ (\ device\: :ref:`int`, button\: :ref:`JoyButton`\ ) |const| :ref:`🔗` Returns ``true`` if you are pressing the joypad button (see :ref:`JoyButton`). @@ -862,7 +862,7 @@ Returns ``true`` if you are pressing the joypad button (see :ref:`JoyButton` **is_joy_known**\ (\ device\: :ref:`int`\ ) +:ref:`bool` **is_joy_known**\ (\ device\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. @@ -874,7 +874,7 @@ Returns ``true`` if the system knows the specified device. This means that it se .. rst-class:: classref-method -:ref:`bool` **is_key_label_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| +:ref:`bool` **is_key_label_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| :ref:`🔗` Returns ``true`` if you are pressing the key with the ``keycode`` printed on it. You can pass a :ref:`Key` constant or any Unicode character code. @@ -886,7 +886,7 @@ Returns ``true`` if you are pressing the key with the ``keycode`` printed on it. .. rst-class:: classref-method -:ref:`bool` **is_key_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| +:ref:`bool` **is_key_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| :ref:`🔗` Returns ``true`` if you are pressing the Latin key in the current keyboard layout. You can pass a :ref:`Key` constant. @@ -902,7 +902,7 @@ Returns ``true`` if you are pressing the Latin key in the current keyboard layou .. rst-class:: classref-method -:ref:`bool` **is_mouse_button_pressed**\ (\ button\: :ref:`MouseButton`\ ) |const| +:ref:`bool` **is_mouse_button_pressed**\ (\ button\: :ref:`MouseButton`\ ) |const| :ref:`🔗` Returns ``true`` if you are pressing the mouse button specified with :ref:`MouseButton`. @@ -914,7 +914,7 @@ Returns ``true`` if you are pressing the mouse button specified with :ref:`Mouse .. rst-class:: classref-method -:ref:`bool` **is_physical_key_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| +:ref:`bool` **is_physical_key_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| :ref:`🔗` Returns ``true`` if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a :ref:`Key` constant. @@ -930,7 +930,7 @@ Returns ``true`` if you are pressing the key in the physical location on the 101 .. rst-class:: classref-method -|void| **parse_input_event**\ (\ event\: :ref:`InputEvent`\ ) +|void| **parse_input_event**\ (\ event\: :ref:`InputEvent`\ ) :ref:`🔗` Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. Also generates :ref:`Node._input` calls. @@ -965,7 +965,7 @@ Feeds an :ref:`InputEvent` to the game. Can be used to artific .. rst-class:: classref-method -|void| **remove_joy_mapping**\ (\ guid\: :ref:`String`\ ) +|void| **remove_joy_mapping**\ (\ guid\: :ref:`String`\ ) :ref:`🔗` Removes all mappings from the internal database that match the given GUID. @@ -977,7 +977,7 @@ Removes all mappings from the internal database that match the given GUID. .. rst-class:: classref-method -|void| **set_accelerometer**\ (\ value\: :ref:`Vector3`\ ) +|void| **set_accelerometer**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` 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. @@ -991,7 +991,7 @@ Sets the acceleration value of the accelerometer sensor. Can be used for debuggi .. rst-class:: classref-method -|void| **set_custom_mouse_cursor**\ (\ image\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **set_custom_mouse_cursor**\ (\ image\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing ``null`` to the image parameter resets to the system cursor. See :ref:`CursorShape` for the list of shapes. @@ -1013,7 +1013,7 @@ Sets a custom mouse cursor image, which is only visible inside the game window. .. rst-class:: classref-method -|void| **set_default_cursor_shape**\ (\ shape\: :ref:`CursorShape` = 0\ ) +|void| **set_default_cursor_shape**\ (\ shape\: :ref:`CursorShape` = 0\ ) :ref:`🔗` Sets the default cursor shape to be used in the viewport instead of :ref:`CURSOR_ARROW`. @@ -1029,7 +1029,7 @@ Sets the default cursor shape to be used in the viewport instead of :ref:`CURSOR .. rst-class:: classref-method -|void| **set_gravity**\ (\ value\: :ref:`Vector3`\ ) +|void| **set_gravity**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` 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. @@ -1043,7 +1043,7 @@ Sets the gravity value of the accelerometer sensor. Can be used for debugging on .. rst-class:: classref-method -|void| **set_gyroscope**\ (\ value\: :ref:`Vector3`\ ) +|void| **set_gyroscope**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` 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. @@ -1057,7 +1057,7 @@ Sets the value of the rotation rate of the gyroscope sensor. Can be used for deb .. rst-class:: classref-method -|void| **set_magnetometer**\ (\ value\: :ref:`Vector3`\ ) +|void| **set_magnetometer**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` 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. @@ -1071,7 +1071,7 @@ Sets the value of the magnetic field of the magnetometer sensor. Can be used for .. rst-class:: classref-method -:ref:`bool` **should_ignore_device**\ (\ vendor_id\: :ref:`int`, product_id\: :ref:`int`\ ) |const| +:ref:`bool` **should_ignore_device**\ (\ vendor_id\: :ref:`int`, product_id\: :ref:`int`\ ) |const| :ref:`🔗` Queries whether an input device should be ignored or not. Devices can be ignored by setting the environment variable ``SDL_GAMECONTROLLER_IGNORE_DEVICES``. Read the `SDL documentation `__ for more information. @@ -1085,7 +1085,7 @@ Queries whether an input device should be ignored or not. Devices can be ignored .. rst-class:: classref-method -|void| **start_joy_vibration**\ (\ device\: :ref:`int`, weak_magnitude\: :ref:`float`, strong_magnitude\: :ref:`float`, duration\: :ref:`float` = 0\ ) +|void| **start_joy_vibration**\ (\ device\: :ref:`int`, weak_magnitude\: :ref:`float`, strong_magnitude\: :ref:`float`, duration\: :ref:`float` = 0\ ) :ref:`🔗` Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. ``weak_magnitude`` is the strength of the weak motor (between 0 and 1) and ``strong_magnitude`` is the strength of the strong motor (between 0 and 1). ``duration`` is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). The vibration can be stopped early by calling :ref:`stop_joy_vibration`. @@ -1101,7 +1101,7 @@ Starts to vibrate the joypad. Joypads usually come with two rumble motors, a str .. rst-class:: classref-method -|void| **stop_joy_vibration**\ (\ device\: :ref:`int`\ ) +|void| **stop_joy_vibration**\ (\ device\: :ref:`int`\ ) :ref:`🔗` Stops the vibration of the joypad started with :ref:`start_joy_vibration`. @@ -1113,7 +1113,7 @@ Stops the vibration of the joypad started with :ref:`start_joy_vibration` = 500, amplitude\: :ref:`float` = -1.0\ ) +|void| **vibrate_handheld**\ (\ duration_ms\: :ref:`int` = 500, amplitude\: :ref:`float` = -1.0\ ) :ref:`🔗` **Note:** While ``amplitude`` expects a value between 0 and 1, -1 does the default amplitude for the device. @@ -1137,7 +1137,7 @@ Vibrate the handheld device for the specified duration in milliseconds. .. rst-class:: classref-method -|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) +|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the currently focused Window Manager game window. diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 6e9dfacaea2..9084aecf512 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -97,7 +97,7 @@ Constants .. rst-class:: classref-constant -**DEVICE_ID_EMULATION** = ``-1`` +**DEVICE_ID_EMULATION** = ``-1`` :ref:`🔗` Device ID used for emulated mouse input from a touchscreen, or for emulated touch input from a mouse. This can be used to distinguish emulated mouse input from physical mouse input, or emulated touch input from physical touch input. @@ -114,7 +114,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **device** = ``0`` +:ref:`int` **device** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **accumulate**\ (\ with_event\: :ref:`InputEvent`\ ) +:ref:`bool` **accumulate**\ (\ with_event\: :ref:`InputEvent`\ ) :ref:`🔗` Returns ``true`` if the given input event and this input event can be added together (only for events of type :ref:`InputEventMouseMotion`). @@ -152,7 +152,7 @@ The given input event's position, global position and speed will be copied. The .. rst-class:: classref-method -:ref:`String` **as_text**\ (\ ) |const| +:ref:`String` **as_text**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` representation of the event. @@ -164,7 +164,7 @@ Returns a :ref:`String` representation of the event. .. rst-class:: classref-method -:ref:`float` **get_action_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`float` **get_action_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion`. @@ -178,7 +178,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_action**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if this input event matches a pre-defined action of any type. @@ -192,7 +192,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, allow_echo\: :ref:`bool` = false, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, allow_echo\: :ref:`bool` = false, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if the given action is being pressed (and is not an echo event for :ref:`InputEventKey` events, unless ``allow_echo`` is ``true``). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -208,7 +208,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_action_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -222,7 +222,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_type**\ (\ ) |const| +:ref:`bool` **is_action_type**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this input event's type is one that can be assigned to an input action. @@ -234,7 +234,7 @@ Returns ``true`` if this input event's type is one that can be assigned to an in .. rst-class:: classref-method -:ref:`bool` **is_canceled**\ (\ ) |const| +:ref:`bool` **is_canceled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this input event has been canceled. @@ -246,7 +246,7 @@ Returns ``true`` if this input event has been canceled. .. rst-class:: classref-method -:ref:`bool` **is_echo**\ (\ ) |const| +:ref:`bool` **is_echo**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this input event is an echo event (only for events of type :ref:`InputEventKey`). Any other event type returns ``false``. @@ -258,7 +258,7 @@ Returns ``true`` if this input event is an echo event (only for events of type : .. rst-class:: classref-method -:ref:`bool` **is_match**\ (\ event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = true\ ) |const| +:ref:`bool` **is_match**\ (\ event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``event`` matches this event. Only valid for action events i.e key (:ref:`InputEventKey`), button (:ref:`InputEventMouseButton` or :ref:`InputEventJoypadButton`), axis :ref:`InputEventJoypadMotion` or action (:ref:`InputEventAction`) events. @@ -272,7 +272,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_pressed**\ (\ ) |const| +:ref:`bool` **is_pressed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this input event is pressed. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -286,7 +286,7 @@ Returns ``true`` if this input event is pressed. Not relevant for events of type .. rst-class:: classref-method -:ref:`bool` **is_released**\ (\ ) |const| +:ref:`bool` **is_released**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this input event is released. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -298,7 +298,7 @@ Returns ``true`` if this input event is released. Not relevant for events of typ .. rst-class:: classref-method -:ref:`InputEvent` **xformed_by**\ (\ xform\: :ref:`Transform2D`, local_ofs\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| +:ref:`InputEvent` **xformed_by**\ (\ xform\: :ref:`Transform2D`, local_ofs\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| :ref:`🔗` Returns a copy of the given input event which has been offset by ``local_ofs`` and transformed by ``xform``. Relevant for events of type :ref:`InputEventMouseButton`, :ref:`InputEventMouseMotion`, :ref:`InputEventScreenTouch`, :ref:`InputEventScreenDrag`, :ref:`InputEventMagnifyGesture` and :ref:`InputEventPanGesture`. diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index d87748430af..670b5fe0a82 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -42,13 +42,15 @@ Properties .. table:: :widths: auto - +-------------------------------------+-----------------------------------------------------------+-----------+ - | :ref:`StringName` | :ref:`action` | ``&""`` | - +-------------------------------------+-----------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`pressed` | ``false`` | - +-------------------------------------+-----------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`strength` | ``1.0`` | - +-------------------------------------+-----------------------------------------------------------+-----------+ + +-------------------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`StringName` | :ref:`action` | ``&""`` | + +-------------------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`event_index` | ``-1`` | + +-------------------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pressed` | ``false`` | + +-------------------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`strength` | ``1.0`` | + +-------------------------------------+-----------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator @@ -63,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **action** = ``&""`` +:ref:`StringName` **action** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -76,11 +78,28 @@ The action's name. Actions are accessed via this :ref:`String`. ---- +.. _class_InputEventAction_property_event_index: + +.. rst-class:: classref-property + +:ref:`int` **event_index** = ``-1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_event_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_event_index**\ (\ ) + +The real event index in action this event corresponds to (from events defined for this action in the :ref:`InputMap`). If ``-1``, a unique ID will be used and actions pressed with this ID will need to be released with another **InputEventAction**. + +.. rst-class:: classref-item-separator + +---- + .. _class_InputEventAction_property_pressed: .. rst-class:: classref-property -:ref:`bool` **pressed** = ``false`` +:ref:`bool` **pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +116,7 @@ If ``true``, the action's state is pressed. If ``false``, the action's state is .. rst-class:: classref-property -:ref:`float` **strength** = ``1.0`` +:ref:`float` **strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventfromwindow.rst b/classes/class_inputeventfromwindow.rst index 77bb2adfc7c..f05d6f793fd 100644 --- a/classes/class_inputeventfromwindow.rst +++ b/classes/class_inputeventfromwindow.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **window_id** = ``0`` +:ref:`int` **window_id** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 82bd255fa43..c283f82aae9 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 6be15fee2a1..43e7c4ed3f9 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`JoyButton` **button_index** = ``0`` +:ref:`JoyButton` **button_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -77,7 +77,7 @@ Button identifier. One of the :ref:`JoyButton` butt .. rst-class:: classref-property -:ref:`bool` **pressed** = ``false`` +:ref:`bool` **pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is .. rst-class:: classref-property -:ref:`float` **pressure** = ``0.0`` +:ref:`float` **pressure** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index c3d7ff10d4e..c1c828373fb 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -58,7 +58,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`JoyAxis` **axis** = ``0`` +:ref:`JoyAxis` **axis** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ Axis identifier. Use one of the :ref:`JoyAxis` axis c .. rst-class:: classref-property -:ref:`float` **axis_value** = ``0.0`` +:ref:`float` **axis_value** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index feeeb1c03f1..b889662fb89 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -93,7 +93,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **echo** = ``false`` +:ref:`bool` **echo** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ If ``true``, the key was already pressed before this event. It means the user is .. rst-class:: classref-property -:ref:`Key` **key_label** = ``0`` +:ref:`Key` **key_label** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ To get a human-readable representation of the **InputEventKey**, use ``OS.get_ke .. rst-class:: classref-property -:ref:`Key` **keycode** = ``0`` +:ref:`Key` **keycode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ To get a human-readable representation of the **InputEventKey**, use ``OS.get_ke .. rst-class:: classref-property -:ref:`KeyLocation` **location** = ``0`` +:ref:`KeyLocation` **location** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ Represents the location of a key which has both left and right versions, such as .. rst-class:: classref-property -:ref:`Key` **physical_keycode** = ``0`` +:ref:`Key` **physical_keycode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ To get a human-readable representation of the **InputEventKey**, use :ref:`OS.ge .. rst-class:: classref-property -:ref:`bool` **pressed** = ``false`` +:ref:`bool` **pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas .. rst-class:: classref-property -:ref:`int` **unicode** = ``0`` +:ref:`int` **unicode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -262,7 +262,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **as_text_key_label**\ (\ ) |const| +:ref:`String` **as_text_key_label**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` representation of the event's :ref:`key_label` and modifiers. @@ -274,7 +274,7 @@ Returns a :ref:`String` representation of the event's :ref:`key_la .. rst-class:: classref-method -:ref:`String` **as_text_keycode**\ (\ ) |const| +:ref:`String` **as_text_keycode**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` representation of the event's :ref:`keycode` and modifiers. @@ -286,7 +286,7 @@ Returns a :ref:`String` representation of the event's :ref:`keycod .. rst-class:: classref-method -:ref:`String` **as_text_location**\ (\ ) |const| +:ref:`String` **as_text_location**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` representation of the event's :ref:`location`. This will be a blank string if the event is not specific to a location. @@ -298,7 +298,7 @@ Returns a :ref:`String` representation of the event's :ref:`locati .. rst-class:: classref-method -:ref:`String` **as_text_physical_keycode**\ (\ ) |const| +:ref:`String` **as_text_physical_keycode**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` representation of the event's :ref:`physical_keycode` and modifiers. @@ -310,7 +310,7 @@ Returns a :ref:`String` representation of the event's :ref:`physic .. rst-class:: classref-method -:ref:`Key` **get_key_label_with_modifiers**\ (\ ) |const| +:ref:`Key` **get_key_label_with_modifiers**\ (\ ) |const| :ref:`🔗` Returns the localized key label combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers`. @@ -324,7 +324,7 @@ To get a human-readable representation of the **InputEventKey** with modifiers, .. rst-class:: classref-method -:ref:`Key` **get_keycode_with_modifiers**\ (\ ) |const| +:ref:`Key` **get_keycode_with_modifiers**\ (\ ) |const| :ref:`🔗` Returns the Latin keycode combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers`. @@ -338,7 +338,7 @@ To get a human-readable representation of the **InputEventKey** with modifiers, .. rst-class:: classref-method -:ref:`Key` **get_physical_keycode_with_modifiers**\ (\ ) |const| +:ref:`Key` **get_physical_keycode_with_modifiers**\ (\ ) |const| :ref:`🔗` 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 1287a65470b..795bf17615c 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **factor** = ``1.0`` +:ref:`float` **factor** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index b3099caca34..a42130f3296 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -132,7 +132,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **channel** = ``0`` +:ref:`int` **channel** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ The MIDI channel of this message, ranging from ``0`` to ``15``. MIDI channel ``9 .. rst-class:: classref-property -:ref:`int` **controller_number** = ``0`` +:ref:`int` **controller_number** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ The unique number of the controller, if :ref:`message` **controller_value** = ``0`` +:ref:`int` **controller_value** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ The value applied to the controller. If :ref:`message` **instrument** = ``0`` +:ref:`int` **instrument** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ To see what each value means, refer to the `General MIDI's instrument list ` **message** = ``0`` +:ref:`MIDIMessage` **message** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ For more information, see the `MIDI message status byte list chart ` **pitch** = ``0`` +:ref:`int` **pitch** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ On a piano, the **middle C** is ``60``, followed by a **C-sharp** (``61``), then .. rst-class:: classref-property -:ref:`int` **pressure** = ``0`` +:ref:`int` **pressure** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -259,7 +259,7 @@ The strength of the key being pressed. This value ranges from ``0`` to ``127``. .. rst-class:: classref-property -:ref:`int` **velocity** = ``0`` +:ref:`int` **velocity** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index ef00a730f93..2f821ea7482 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -|bitfield|\[:ref:`MouseButtonMask`\] **button_mask** = ``0`` +|bitfield|\[:ref:`MouseButtonMask`\] **button_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -76,7 +76,7 @@ The mouse button mask identifier, one of or a bitwise combination of the :ref:`M .. rst-class:: classref-property -:ref:`Vector2` **global_position** = ``Vector2(0, 0)`` +:ref:`Vector2` **global_position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -95,7 +95,7 @@ When received in :ref:`Control._gui_input` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index d9ecd1f33af..10ab963470f 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`MouseButton` **button_index** = ``0`` +:ref:`MouseButton` **button_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,7 +85,7 @@ The mouse button identifier, one of the :ref:`MouseButton` **canceled** = ``false`` +:ref:`bool` **canceled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ If ``true``, the mouse button event has been canceled. .. rst-class:: classref-property -:ref:`bool` **double_click** = ``false`` +:ref:`bool` **double_click** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -119,7 +119,7 @@ If ``true``, the mouse button's state is a double-click. .. rst-class:: classref-property -:ref:`float` **factor** = ``1.0`` +:ref:`float` **factor** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -136,7 +136,7 @@ The amount (or delta) of the event. When used for high-precision scroll events, .. rst-class:: classref-property -:ref:`bool` **pressed** = ``false`` +:ref:`bool` **pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index c50e81a72f2..c2a16ef66fb 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **pen_inverted** = ``false`` +:ref:`bool` **pen_inverted** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ Returns ``true`` when using the eraser end of a stylus pen. .. rst-class:: classref-property -:ref:`float` **pressure** = ``0.0`` +:ref:`float` **pressure** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0`` .. rst-class:: classref-property -:ref:`Vector2` **relative** = ``Vector2(0, 0)`` +:ref:`Vector2` **relative** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ The mouse position relative to the previous position (position at the last frame .. rst-class:: classref-property -:ref:`Vector2` **screen_relative** = ``Vector2(0, 0)`` +:ref:`Vector2` **screen_relative** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The unscaled mouse position relative to the previous position in the coordinate .. rst-class:: classref-property -:ref:`Vector2` **screen_velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **screen_velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The unscaled mouse velocity in pixels per second in screen coordinates. This vel .. rst-class:: classref-property -:ref:`Vector2` **tilt** = ``Vector2(0, 0)`` +:ref:`Vector2` **tilt** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ Represents the angles of tilt of the pen. Positive X-coordinate value indicates .. rst-class:: classref-property -:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index fc3edea6c7e..c229fe51da4 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **delta** = ``Vector2(0, 0)`` +:ref:`Vector2` **delta** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 8151ce81b2f..8f73f9c2b28 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -69,7 +69,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **index** = ``0`` +:ref:`int` **index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ The drag event index in the case of a multi-drag event. .. rst-class:: classref-property -:ref:`bool` **pen_inverted** = ``false`` +:ref:`bool` **pen_inverted** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Returns ``true`` when using the eraser end of a stylus pen. .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ The drag position in the viewport the node is in, using the coordinate system of .. rst-class:: classref-property -:ref:`float` **pressure** = ``0.0`` +:ref:`float` **pressure** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0`` .. rst-class:: classref-property -:ref:`Vector2` **relative** = ``Vector2(0, 0)`` +:ref:`Vector2` **relative** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The drag position relative to the previous position (position at the last frame) .. rst-class:: classref-property -:ref:`Vector2` **screen_relative** = ``Vector2(0, 0)`` +:ref:`Vector2` **screen_relative** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ The unscaled drag position relative to the previous position in screen coordinat .. rst-class:: classref-property -:ref:`Vector2` **screen_velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **screen_velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ The unscaled drag velocity in pixels per second in screen coordinates. This velo .. rst-class:: classref-property -:ref:`Vector2` **tilt** = ``Vector2(0, 0)`` +:ref:`Vector2` **tilt** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -207,7 +207,7 @@ Represents the angles of tilt of the pen. Positive X-coordinate value indicates .. rst-class:: classref-property -:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index ec44a0c5c4b..7433de280fa 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -61,7 +61,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **canceled** = ``false`` +:ref:`bool` **canceled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -78,7 +78,7 @@ If ``true``, the touch event has been canceled. .. rst-class:: classref-property -:ref:`bool` **double_tap** = ``false`` +:ref:`bool` **double_tap** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -95,7 +95,7 @@ If ``true``, the touch's state is a double tap. .. rst-class:: classref-property -:ref:`int` **index** = ``0`` +:ref:`int` **index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -112,7 +112,7 @@ The touch index in the case of a multi-touch event. One index = one finger. .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -129,7 +129,7 @@ The touch position in the viewport the node is in, using the coordinate system o .. rst-class:: classref-property -:ref:`bool` **pressed** = ``false`` +:ref:`bool` **pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventshortcut.rst b/classes/class_inputeventshortcut.rst index 97fc7f725a9..8a1170f1f5d 100644 --- a/classes/class_inputeventshortcut.rst +++ b/classes/class_inputeventshortcut.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Shortcut` **shortcut** +:ref:`Shortcut` **shortcut** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 976a81da167..51bad3bd495 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -77,7 +77,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **alt_pressed** = ``false`` +:ref:`bool` **alt_pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ State of the :kbd:`Alt` modifier. .. rst-class:: classref-property -:ref:`bool` **command_or_control_autoremap** = ``false`` +:ref:`bool` **command_or_control_autoremap** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Automatically use :kbd:`Meta` (:kbd:`Cmd`) on macOS and :kbd:`Ctrl` on other pla .. rst-class:: classref-property -:ref:`bool` **ctrl_pressed** = ``false`` +:ref:`bool` **ctrl_pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ State of the :kbd:`Ctrl` modifier. .. rst-class:: classref-property -:ref:`bool` **meta_pressed** = ``false`` +:ref:`bool` **meta_pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ State of the :kbd:`Meta` modifier. On Windows and Linux, this represents the Win .. rst-class:: classref-property -:ref:`bool` **shift_pressed** = ``false`` +:ref:`bool` **shift_pressed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -|bitfield|\[:ref:`KeyModifierMask`\] **get_modifiers_mask**\ (\ ) |const| +|bitfield|\[:ref:`KeyModifierMask`\] **get_modifiers_mask**\ (\ ) |const| :ref:`🔗` Returns the keycode combination of modifier keys. @@ -179,7 +179,7 @@ Returns the keycode combination of modifier keys. .. rst-class:: classref-method -:ref:`bool` **is_command_or_control_pressed**\ (\ ) |const| +:ref:`bool` **is_command_or_control_pressed**\ (\ ) |const| :ref:`🔗` On macOS, returns ``true`` if :kbd:`Meta` (:kbd:`Cmd`) is pressed. diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 1adf0c770ab..e28b63284fb 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -77,7 +77,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **action_add_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) +|void| **action_add_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) :ref:`🔗` Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. @@ -89,7 +89,7 @@ Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent< .. rst-class:: classref-method -|void| **action_erase_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) +|void| **action_erase_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) :ref:`🔗` Removes an :ref:`InputEvent` from an action. @@ -101,7 +101,7 @@ Removes an :ref:`InputEvent` from an action. .. rst-class:: classref-method -|void| **action_erase_events**\ (\ action\: :ref:`StringName`\ ) +|void| **action_erase_events**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` Removes all events from an action. @@ -113,7 +113,7 @@ Removes all events from an action. .. rst-class:: classref-method -:ref:`float` **action_get_deadzone**\ (\ action\: :ref:`StringName`\ ) +:ref:`float` **action_get_deadzone**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` Returns a deadzone value for the action. @@ -125,7 +125,7 @@ Returns a deadzone value for the action. .. rst-class:: classref-method -:ref:`Array`\[:ref:`InputEvent`\] **action_get_events**\ (\ action\: :ref:`StringName`\ ) +:ref:`Array`\[:ref:`InputEvent`\] **action_get_events**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` Returns an array of :ref:`InputEvent`\ s associated with a given action. @@ -139,7 +139,7 @@ Returns an array of :ref:`InputEvent`\ s associated with a giv .. rst-class:: classref-method -:ref:`bool` **action_has_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) +:ref:`bool` **action_has_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) :ref:`🔗` Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. @@ -151,7 +151,7 @@ Returns ``true`` if the action has the given :ref:`InputEvent` .. rst-class:: classref-method -|void| **action_set_deadzone**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float`\ ) +|void| **action_set_deadzone**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float`\ ) :ref:`🔗` Sets a deadzone value for the action. @@ -163,7 +163,7 @@ Sets a deadzone value for the action. .. rst-class:: classref-method -|void| **add_action**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.5\ ) +|void| **add_action**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.5\ ) :ref:`🔗` Adds an empty action to the **InputMap** with a configurable ``deadzone``. @@ -177,7 +177,7 @@ An :ref:`InputEvent` can then be added to this action with :re .. rst-class:: classref-method -|void| **erase_action**\ (\ action\: :ref:`StringName`\ ) +|void| **erase_action**\ (\ action\: :ref:`StringName`\ ) :ref:`🔗` Removes an action from the **InputMap**. @@ -189,7 +189,7 @@ Removes an action from the **InputMap**. .. rst-class:: classref-method -:ref:`bool` **event_is_action**\ (\ event\: :ref:`InputEvent`, action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| +:ref:`bool` **event_is_action**\ (\ event\: :ref:`InputEvent`, action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. @@ -203,7 +203,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_actions**\ (\ ) +:ref:`Array`\[:ref:`StringName`\] **get_actions**\ (\ ) :ref:`🔗` Returns an array of all actions in the **InputMap**. @@ -215,7 +215,7 @@ Returns an array of all actions in the **InputMap**. .. rst-class:: classref-method -:ref:`bool` **has_action**\ (\ action\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_action**\ (\ action\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the **InputMap** has a registered action with the given name. @@ -227,7 +227,7 @@ Returns ``true`` if the **InputMap** has a registered action with the given name .. rst-class:: classref-method -|void| **load_from_project_settings**\ (\ ) +|void| **load_from_project_settings**\ (\ ) :ref:`🔗` Clears all :ref:`InputEventAction` in the **InputMap** and load it anew from :ref:`ProjectSettings`. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 8df042defc1..ae0381674a1 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Node` **create_instance**\ (\ replace\: :ref:`bool` = false, custom_scene\: :ref:`PackedScene` = null\ ) +:ref:`Node` **create_instance**\ (\ replace\: :ref:`bool` = false, custom_scene\: :ref:`PackedScene` = null\ ) :ref:`🔗` Call this method to actually load in the node. The created node will be placed as a sibling *above* the **InstancePlaceholder** in the scene tree. The :ref:`Node`'s reference is also returned for convenience. @@ -66,7 +66,7 @@ Call this method to actually load in the node. The created node will be placed a .. rst-class:: classref-method -:ref:`String` **get_instance_path**\ (\ ) |const| +:ref:`String` **get_instance_path**\ (\ ) |const| :ref:`🔗` Gets the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`create_instance`. Not thread-safe. Use :ref:`Object.call_deferred` if calling from a thread. @@ -78,7 +78,7 @@ Gets the path to the :ref:`PackedScene` resource file that is .. rst-class:: classref-method -:ref:`Dictionary` **get_stored_values**\ (\ with_order\: :ref:`bool` = false\ ) +:ref:`Dictionary` **get_stored_values**\ (\ with_order\: :ref:`bool` = false\ ) :ref:`🔗` Returns the list of properties that will be applied to the node when :ref:`create_instance` is called. diff --git a/classes/class_int.rst b/classes/class_int.rst index da558945d13..0a32c039fac 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -189,7 +189,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`int` **int**\ (\ ) +:ref:`int` **int**\ (\ ) :ref:`🔗` Constructs an **int** set to ``0``. @@ -246,7 +246,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the **int** is not equivalent to the :ref:`float`. @@ -258,7 +258,7 @@ Returns ``true`` if the **int** is not equivalent to the :ref:`float` **operator !=**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the **int**\ s are not equal. @@ -270,7 +270,7 @@ Returns ``true`` if the **int**\ s are not equal. .. rst-class:: classref-operator -:ref:`int` **operator %**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator %**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns the remainder after dividing two **int**\ s. Uses truncated division, which returns a negative number if the dividend is negative. If this is not desired, consider using :ref:`@GlobalScope.posmod`. @@ -288,7 +288,7 @@ Returns the remainder after dividing two **int**\ s. Uses truncated division, wh .. rst-class:: classref-operator -:ref:`int` **operator &**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator &**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Performs the bitwise ``AND`` operation. @@ -313,7 +313,7 @@ This is useful for retrieving binary flags from a variable. .. rst-class:: classref-operator -:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) +:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) :ref:`🔗` Multiplies each component of the :ref:`Color` by the **int**. @@ -325,7 +325,7 @@ Multiplies each component of the :ref:`Color` by the **int**. .. rst-class:: classref-operator -:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Multiplies each component of the :ref:`Quaternion` by the **int**. This operation is not meaningful on its own, but it can be used as a part of a larger expression. @@ -337,7 +337,7 @@ Multiplies each component of the :ref:`Quaternion` by the **in .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector2` by the **int**. @@ -353,7 +353,7 @@ Multiplies each component of the :ref:`Vector2` by the **int**. .. rst-class:: classref-operator -:ref:`Vector2i` **operator ***\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2i` **operator ***\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector2i` by the **int**. @@ -365,7 +365,7 @@ Multiplies each component of the :ref:`Vector2i` by the **int**. .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector3` by the **int**. @@ -377,7 +377,7 @@ Multiplies each component of the :ref:`Vector3` by the **int**. .. rst-class:: classref-operator -:ref:`Vector3i` **operator ***\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3i` **operator ***\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector3i` by the **int**. @@ -389,7 +389,7 @@ Multiplies each component of the :ref:`Vector3i` by the **int**. .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector4` by the **int**. @@ -401,7 +401,7 @@ Multiplies each component of the :ref:`Vector4` by the **int**. .. rst-class:: classref-operator -:ref:`Vector4i` **operator ***\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4i` **operator ***\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Multiplies each component of the :ref:`Vector4i` by the **int**. @@ -413,7 +413,7 @@ Multiplies each component of the :ref:`Vector4i` by the **int**. .. rst-class:: classref-operator -:ref:`float` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies the :ref:`float` by the **int**. The result is a :ref:`float`. @@ -425,7 +425,7 @@ Multiplies the :ref:`float` by the **int**. The result is a :ref:`f .. rst-class:: classref-operator -:ref:`int` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies the two **int**\ s. @@ -437,7 +437,7 @@ Multiplies the two **int**\ s. .. rst-class:: classref-operator -:ref:`float` **operator ****\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator ****\ (\ right\: :ref:`float`\ ) :ref:`🔗` Raises an **int** to a power of a :ref:`float`. The result is a :ref:`float`. @@ -453,7 +453,7 @@ Raises an **int** to a power of a :ref:`float`. The result is a :re .. rst-class:: classref-operator -:ref:`int` **operator ****\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator ****\ (\ right\: :ref:`int`\ ) :ref:`🔗` Raises the left **int** to a power of the right **int**. @@ -469,7 +469,7 @@ Raises the left **int** to a power of the right **int**. .. rst-class:: classref-operator -:ref:`float` **operator +**\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator +**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Adds the **int** and the :ref:`float`. The result is a :ref:`float`. @@ -481,7 +481,7 @@ Adds the **int** and the :ref:`float`. The result is a :ref:`float< .. rst-class:: classref-operator -:ref:`int` **operator +**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator +**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Adds the two **int**\ s. @@ -493,7 +493,7 @@ Adds the two **int**\ s. .. rst-class:: classref-operator -:ref:`float` **operator -**\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator -**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Subtracts the :ref:`float` from the **int**. The result is a :ref:`float`. @@ -505,7 +505,7 @@ Subtracts the :ref:`float` from the **int**. The result is a :ref:` .. rst-class:: classref-operator -:ref:`int` **operator -**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator -**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Subtracts the two **int**\ s. @@ -517,7 +517,7 @@ Subtracts the two **int**\ s. .. rst-class:: classref-operator -:ref:`float` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`float` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides the **int** by the :ref:`float`. The result is a :ref:`float`. @@ -533,7 +533,7 @@ Divides the **int** by the :ref:`float`. The result is a :ref:`floa .. rst-class:: classref-operator -:ref:`int` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides the two **int**\ s. The result is an **int**. This will truncate the :ref:`float`, discarding anything after the floating point. @@ -550,7 +550,7 @@ Divides the two **int**\ s. The result is an **int**. This will truncate the :re .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the **int** is less than the :ref:`float`. @@ -562,7 +562,7 @@ Returns ``true`` if the **int** is less than the :ref:`float`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the left **int** is less than the right **int**. @@ -574,7 +574,7 @@ Returns ``true`` if the left **int** is less than the right **int**. .. rst-class:: classref-operator -:ref:`int` **operator <<**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator <<**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Performs the bitwise shift left operation. Effectively the same as multiplying by a power of 2. @@ -591,7 +591,7 @@ Performs the bitwise shift left operation. Effectively the same as multiplying b .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the **int** is less than or equal to the :ref:`float`. @@ -603,7 +603,7 @@ Returns ``true`` if the **int** is less than or equal to the :ref:`float` **operator <=**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the left **int** is less than or equal to the right **int**. @@ -615,7 +615,7 @@ Returns ``true`` if the left **int** is less than or equal to the right **int**. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the **int** is equal to the :ref:`float`. @@ -627,7 +627,7 @@ Returns ``true`` if the **int** is equal to the :ref:`float`. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the two **int**\ s are equal. @@ -639,7 +639,7 @@ Returns ``true`` if the two **int**\ s are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the **int** is greater than the :ref:`float`. @@ -651,7 +651,7 @@ Returns ``true`` if the **int** is greater than the :ref:`float`. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the left **int** is greater than the right **int**. @@ -663,7 +663,7 @@ Returns ``true`` if the left **int** is greater than the right **int**. .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`float`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Returns ``true`` if the **int** is greater than or equal to the :ref:`float`. @@ -675,7 +675,7 @@ Returns ``true`` if the **int** is greater than or equal to the :ref:`float` **operator >=**\ (\ right\: :ref:`int`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the left **int** is greater than or equal to the right **int**. @@ -687,7 +687,7 @@ Returns ``true`` if the left **int** is greater than or equal to the right **int .. rst-class:: classref-operator -:ref:`int` **operator >>**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator >>**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Performs the bitwise shift right operation. Effectively the same as dividing by a power of 2. @@ -704,7 +704,7 @@ Performs the bitwise shift right operation. Effectively the same as dividing by .. rst-class:: classref-operator -:ref:`int` **operator ^**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator ^**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Performs the bitwise ``XOR`` operation. @@ -720,7 +720,7 @@ Performs the bitwise ``XOR`` operation. .. rst-class:: classref-operator -:ref:`int` **operator unary+**\ (\ ) +:ref:`int` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -732,7 +732,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`int` **operator unary-**\ (\ ) +:ref:`int` **operator unary-**\ (\ ) :ref:`🔗` Returns the negated value of the **int**. If positive, turns the number negative. If negative, turns the number positive. If zero, does nothing. @@ -744,7 +744,7 @@ Returns the negated value of the **int**. If positive, turns the number negative .. rst-class:: classref-operator -:ref:`int` **operator |**\ (\ right\: :ref:`int`\ ) +:ref:`int` **operator |**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Performs the bitwise ``OR`` operation. @@ -767,7 +767,7 @@ This is useful for storing binary flags in a variable. .. rst-class:: classref-operator -:ref:`int` **operator ~**\ (\ ) +:ref:`int` **operator ~**\ (\ ) :ref:`🔗` Performs the bitwise ``NOT`` operation on the **int**. Due to `2's complement `__, it's effectively equal to ``-(int + 1)``. diff --git a/classes/class_ip.rst b/classes/class_ip.rst index de86b72f5c4..fec8e40572a 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -67,7 +67,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ResolverStatus**: +enum **ResolverStatus**: :ref:`🔗` .. _class_IP_constant_RESOLVER_STATUS_NONE: @@ -109,7 +109,7 @@ DNS hostname resolver status: Error. .. rst-class:: classref-enumeration -enum **Type**: +enum **Type**: :ref:`🔗` .. _class_IP_constant_TYPE_NONE: @@ -156,7 +156,7 @@ Constants .. rst-class:: classref-constant -**RESOLVER_MAX_QUERIES** = ``256`` +**RESOLVER_MAX_QUERIES** = ``256`` :ref:`🔗` Maximum number of concurrent DNS resolver queries allowed, :ref:`RESOLVER_INVALID_ID` is returned if exceeded. @@ -164,7 +164,7 @@ Maximum number of concurrent DNS resolver queries allowed, :ref:`RESOLVER_INVALI .. rst-class:: classref-constant -**RESOLVER_INVALID_ID** = ``-1`` +**RESOLVER_INVALID_ID** = ``-1`` :ref:`🔗` Invalid ID constant. Returned if :ref:`RESOLVER_MAX_QUERIES` is exceeded. @@ -181,7 +181,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_cache**\ (\ hostname\: :ref:`String` = ""\ ) +|void| **clear_cache**\ (\ hostname\: :ref:`String` = ""\ ) :ref:`🔗` Removes all of a ``hostname``'s cached references. If no ``hostname`` is given, all cached IP addresses are removed. @@ -193,7 +193,7 @@ Removes all of a ``hostname``'s cached references. If no ``hostname`` is given, .. rst-class:: classref-method -|void| **erase_resolve_item**\ (\ id\: :ref:`int`\ ) +|void| **erase_resolve_item**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes a given item ``id`` from the queue. This should be used to free a queue after it has completed to enable more queries to happen. @@ -205,7 +205,7 @@ Removes a given item ``id`` from the queue. This should be used to free a queue .. rst-class:: classref-method -:ref:`PackedStringArray` **get_local_addresses**\ (\ ) |const| +:ref:`PackedStringArray` **get_local_addresses**\ (\ ) |const| :ref:`🔗` Returns all the user's current IPv4 and IPv6 addresses as an array. @@ -217,7 +217,7 @@ Returns all the user's current IPv4 and IPv6 addresses as an array. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_local_interfaces**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_local_interfaces**\ (\ ) |const| :ref:`🔗` Returns all network adapters as an array. @@ -240,7 +240,7 @@ Each adapter is a dictionary of the form: .. rst-class:: classref-method -:ref:`String` **get_resolve_item_address**\ (\ id\: :ref:`int`\ ) |const| +:ref:`String` **get_resolve_item_address**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns a queued hostname's IP address, given its queue ``id``. Returns an empty string on error or if resolution hasn't happened yet (see :ref:`get_resolve_item_status`). @@ -252,7 +252,7 @@ Returns a queued hostname's IP address, given its queue ``id``. Returns an empty .. rst-class:: classref-method -:ref:`Array` **get_resolve_item_addresses**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Array` **get_resolve_item_addresses**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see :ref:`get_resolve_item_status`). @@ -264,7 +264,7 @@ Returns resolved addresses, or an empty array if an error happened or resolution .. rst-class:: classref-method -:ref:`ResolverStatus` **get_resolve_item_status**\ (\ id\: :ref:`int`\ ) |const| +:ref:`ResolverStatus` **get_resolve_item_status**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns a queued hostname's status as a :ref:`ResolverStatus` constant, given its queue ``id``. @@ -276,7 +276,7 @@ Returns a queued hostname's status as a :ref:`ResolverStatus` **resolve_hostname**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) +:ref:`String` **resolve_hostname**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) :ref:`🔗` Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the :ref:`Type` constant given as ``ip_type``. @@ -288,7 +288,7 @@ Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type met .. rst-class:: classref-method -:ref:`PackedStringArray` **resolve_hostname_addresses**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) +:ref:`PackedStringArray` **resolve_hostname_addresses**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) :ref:`🔗` Resolves a given hostname in a blocking way. Addresses are returned as an :ref:`Array` of IPv4 or IPv6 addresses depending on ``ip_type``. @@ -300,7 +300,7 @@ Resolves a given hostname in a blocking way. Addresses are returned as an :ref:` .. rst-class:: classref-method -:ref:`int` **resolve_hostname_queue_item**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) +:ref:`int` **resolve_hostname_queue_item**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) :ref:`🔗` Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the :ref:`Type` constant given as ``ip_type``. Returns the queue ID if successful, or :ref:`RESOLVER_INVALID_ID` on error. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index eb5bb71b9d3..85458737052 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -232,7 +232,7 @@ Signals .. rst-class:: classref-signal -**empty_clicked**\ (\ at_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) +**empty_clicked**\ (\ at_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Triggered when any mouse click is issued within the rect of the list but on empty space. @@ -244,7 +244,7 @@ Triggered when any mouse click is issued within the rect of the list but on empt .. rst-class:: classref-signal -**item_activated**\ (\ index\: :ref:`int`\ ) +**item_activated**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Triggered when specified list item is activated via double-clicking or by pressing :kbd:`Enter`. @@ -256,7 +256,7 @@ Triggered when specified list item is activated via double-clicking or by pressi .. rst-class:: classref-signal -**item_clicked**\ (\ index\: :ref:`int`, at_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) +**item_clicked**\ (\ index\: :ref:`int`, at_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Triggered when specified list item has been clicked with any mouse button. @@ -270,7 +270,7 @@ The click position is also provided to allow appropriate popup of context menus .. rst-class:: classref-signal -**item_selected**\ (\ index\: :ref:`int`\ ) +**item_selected**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Triggered when specified item has been selected. @@ -284,7 +284,7 @@ Triggered when specified item has been selected. .. rst-class:: classref-signal -**multi_selected**\ (\ index\: :ref:`int`, selected\: :ref:`bool`\ ) +**multi_selected**\ (\ index\: :ref:`int`, selected\: :ref:`bool`\ ) :ref:`🔗` Triggered when a multiple selection is altered on a list allowing multiple selection. @@ -301,7 +301,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **IconMode**: +enum **IconMode**: :ref:`🔗` .. _class_ItemList_constant_ICON_MODE_TOP: @@ -327,7 +327,7 @@ Icon is drawn to the left of the text. .. rst-class:: classref-enumeration -enum **SelectMode**: +enum **SelectMode**: :ref:`🔗` .. _class_ItemList_constant_SELECT_SINGLE: @@ -358,7 +358,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_reselect** = ``false`` +:ref:`bool` **allow_reselect** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ If ``true``, the currently selected item can be selected again. .. rst-class:: classref-property -:ref:`bool` **allow_rmb_select** = ``false`` +:ref:`bool` **allow_rmb_select** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ If ``true``, right mouse button click can select items. .. rst-class:: classref-property -:ref:`bool` **allow_search** = ``true`` +:ref:`bool` **allow_search** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -409,7 +409,7 @@ If ``true``, allows navigating the **ItemList** with letter keys through increme .. rst-class:: classref-property -:ref:`bool` **auto_height** = ``false`` +:ref:`bool` **auto_height** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -426,7 +426,7 @@ If ``true``, the control will automatically resize the height to fit its content .. rst-class:: classref-property -:ref:`int` **fixed_column_width** = ``0`` +:ref:`int` **fixed_column_width** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -445,7 +445,7 @@ A value of zero disables the adjustment, each item will have a width equal to th .. rst-class:: classref-property -:ref:`Vector2i` **fixed_icon_size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **fixed_icon_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -464,7 +464,7 @@ If either X or Y component is not greater than zero, icon size won't be affected .. rst-class:: classref-property -:ref:`IconMode` **icon_mode** = ``1`` +:ref:`IconMode` **icon_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -481,7 +481,7 @@ The icon position, whether above or to the left of the text. See the :ref:`IconM .. rst-class:: classref-property -:ref:`float` **icon_scale** = ``1.0`` +:ref:`float` **icon_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -498,7 +498,7 @@ The scale of icon applied after :ref:`fixed_icon_size` **item_count** = ``0`` +:ref:`int` **item_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -515,7 +515,7 @@ The number of items currently in the list. .. rst-class:: classref-property -:ref:`int` **max_columns** = ``1`` +:ref:`int` **max_columns** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -536,7 +536,7 @@ A value of zero means unlimited columns, i.e. all items will be put in the same .. rst-class:: classref-property -:ref:`int` **max_text_lines** = ``1`` +:ref:`int` **max_text_lines** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -555,7 +555,7 @@ Maximum lines of text allowed in each item. Space will be reserved even when the .. rst-class:: classref-property -:ref:`bool` **same_column_width** = ``false`` +:ref:`bool` **same_column_width** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -574,7 +574,7 @@ If ``true``, the width is equal to the largest column width of all columns. .. rst-class:: classref-property -:ref:`SelectMode` **select_mode** = ``0`` +:ref:`SelectMode` **select_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -591,7 +591,7 @@ Allows single or multiple item selection. See the :ref:`SelectMode` **text_overrun_behavior** = ``3`` +:ref:`OverrunBehavior` **text_overrun_behavior** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -613,7 +613,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_icon_item**\ (\ icon\: :ref:`Texture2D`, selectable\: :ref:`bool` = true\ ) +:ref:`int` **add_icon_item**\ (\ icon\: :ref:`Texture2D`, selectable\: :ref:`bool` = true\ ) :ref:`🔗` Adds an item to the item list with no text, only an icon. Returns the index of an added item. @@ -625,7 +625,7 @@ Adds an item to the item list with no text, only an icon. Returns the index of a .. rst-class:: classref-method -:ref:`int` **add_item**\ (\ text\: :ref:`String`, icon\: :ref:`Texture2D` = null, selectable\: :ref:`bool` = true\ ) +:ref:`int` **add_item**\ (\ text\: :ref:`String`, icon\: :ref:`Texture2D` = null, selectable\: :ref:`bool` = true\ ) :ref:`🔗` Adds an item to the item list with specified text. Returns the index of an added item. @@ -641,7 +641,7 @@ If selectable is ``true``, the list item will be selectable. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Removes all items from the list. @@ -653,7 +653,7 @@ Removes all items from the list. .. rst-class:: classref-method -|void| **deselect**\ (\ idx\: :ref:`int`\ ) +|void| **deselect**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Ensures the item associated with the specified index is not selected. @@ -665,7 +665,7 @@ Ensures the item associated with the specified index is not selected. .. rst-class:: classref-method -|void| **deselect_all**\ (\ ) +|void| **deselect_all**\ (\ ) :ref:`🔗` Ensures there are no items selected. @@ -677,7 +677,7 @@ Ensures there are no items selected. .. rst-class:: classref-method -|void| **ensure_current_is_visible**\ (\ ) +|void| **ensure_current_is_visible**\ (\ ) :ref:`🔗` Ensure current selection is visible, adjusting the scroll position as necessary. @@ -689,7 +689,7 @@ Ensure current selection is visible, adjusting the scroll position as necessary. .. rst-class:: classref-method -|void| **force_update_list_size**\ (\ ) +|void| **force_update_list_size**\ (\ ) :ref:`🔗` Forces an update to the list size based on its items. This happens automatically whenever size of the items, or other relevant settings like :ref:`auto_height`, change. The method can be used to trigger the update ahead of next drawing pass. @@ -701,7 +701,7 @@ Forces an update to the list size based on its items. This happens automatically .. rst-class:: classref-method -:ref:`int` **get_item_at_position**\ (\ position\: :ref:`Vector2`, exact\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_item_at_position**\ (\ position\: :ref:`Vector2`, exact\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the item index at the given ``position``. @@ -717,7 +717,7 @@ When there is no item at that point, -1 will be returned if ``exact`` is ``true` .. rst-class:: classref-method -:ref:`Color` **get_item_custom_bg_color**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Color` **get_item_custom_bg_color**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom background color of the item specified by ``idx`` index. @@ -729,7 +729,7 @@ Returns the custom background color of the item specified by ``idx`` index. .. rst-class:: classref-method -:ref:`Color` **get_item_custom_fg_color**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Color` **get_item_custom_fg_color**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom foreground color of the item specified by ``idx`` index. @@ -741,7 +741,7 @@ Returns the custom foreground color of the item specified by ``idx`` index. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_item_icon**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon associated with the specified index. @@ -753,7 +753,7 @@ Returns the icon associated with the specified index. .. rst-class:: classref-method -:ref:`Color` **get_item_icon_modulate**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Color` **get_item_icon_modulate**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`Color` modulating item's icon at the specified index. @@ -765,7 +765,7 @@ Returns a :ref:`Color` modulating item's icon at the specified inde .. rst-class:: classref-method -:ref:`Rect2` **get_item_icon_region**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Rect2` **get_item_icon_region**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the region of item's icon used. The whole icon will be used if the region has no area. @@ -777,7 +777,7 @@ Returns the region of item's icon used. The whole icon will be used if the regio .. rst-class:: classref-method -:ref:`String` **get_item_language**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_language**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text language code. @@ -789,7 +789,7 @@ Returns item's text language code. .. rst-class:: classref-method -:ref:`Variant` **get_item_metadata**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_item_metadata**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata value of the specified index. @@ -801,7 +801,7 @@ Returns the metadata value of the specified index. .. rst-class:: classref-method -:ref:`Rect2` **get_item_rect**\ (\ idx\: :ref:`int`, expand\: :ref:`bool` = true\ ) |const| +:ref:`Rect2` **get_item_rect**\ (\ idx\: :ref:`int`, expand\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns the position and size of the item with the specified index, in the coordinate system of the **ItemList** node. If ``expand`` is ``true`` the last column expands to fill the rest of the row. @@ -815,7 +815,7 @@ Returns the position and size of the item with the specified index, in the coord .. rst-class:: classref-method -:ref:`String` **get_item_text**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_text**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text associated with the specified index. @@ -827,7 +827,7 @@ Returns the text associated with the specified index. .. rst-class:: classref-method -:ref:`TextDirection` **get_item_text_direction**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`TextDirection` **get_item_text_direction**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text base writing direction. @@ -839,7 +839,7 @@ Returns item's text base writing direction. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_tooltip**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip hint associated with the specified index. @@ -851,7 +851,7 @@ Returns the tooltip hint associated with the specified index. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_selected_items**\ (\ ) +:ref:`PackedInt32Array` **get_selected_items**\ (\ ) :ref:`🔗` Returns an array with the indexes of the selected items. @@ -863,7 +863,7 @@ Returns an array with the indexes of the selected items. .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) :ref:`🔗` Returns the vertical scrollbar. @@ -877,7 +877,7 @@ Returns the vertical scrollbar. .. rst-class:: classref-method -:ref:`bool` **is_anything_selected**\ (\ ) +:ref:`bool` **is_anything_selected**\ (\ ) :ref:`🔗` Returns ``true`` if one or more items are selected. @@ -889,7 +889,7 @@ Returns ``true`` if one or more items are selected. .. rst-class:: classref-method -:ref:`bool` **is_item_disabled**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_disabled**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the specified index is disabled. @@ -901,7 +901,7 @@ Returns ``true`` if the item at the specified index is disabled. .. rst-class:: classref-method -:ref:`bool` **is_item_icon_transposed**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_icon_transposed**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. @@ -913,7 +913,7 @@ Returns ``true`` if the item icon will be drawn transposed, i.e. the X and Y axe .. rst-class:: classref-method -:ref:`bool` **is_item_selectable**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_selectable**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the specified index is selectable. @@ -925,7 +925,7 @@ Returns ``true`` if the item at the specified index is selectable. .. rst-class:: classref-method -:ref:`bool` **is_item_tooltip_enabled**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_tooltip_enabled**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the tooltip is enabled for specified item index. @@ -937,7 +937,7 @@ Returns ``true`` if the tooltip is enabled for specified item index. .. rst-class:: classref-method -:ref:`bool` **is_selected**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_selected**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the specified index is currently selected. @@ -949,7 +949,7 @@ Returns ``true`` if the item at the specified index is currently selected. .. rst-class:: classref-method -|void| **move_item**\ (\ from_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) +|void| **move_item**\ (\ from_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) :ref:`🔗` Moves item from index ``from_idx`` to ``to_idx``. @@ -961,7 +961,7 @@ Moves item from index ``from_idx`` to ``to_idx``. .. rst-class:: classref-method -|void| **remove_item**\ (\ idx\: :ref:`int`\ ) +|void| **remove_item**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Removes the item specified by ``idx`` index from the list. @@ -973,7 +973,7 @@ Removes the item specified by ``idx`` index from the list. .. rst-class:: classref-method -|void| **select**\ (\ idx\: :ref:`int`, single\: :ref:`bool` = true\ ) +|void| **select**\ (\ idx\: :ref:`int`, single\: :ref:`bool` = true\ ) :ref:`🔗` Select the item at the specified index. @@ -987,7 +987,7 @@ Select the item at the specified index. .. rst-class:: classref-method -|void| **set_item_custom_bg_color**\ (\ idx\: :ref:`int`, custom_bg_color\: :ref:`Color`\ ) +|void| **set_item_custom_bg_color**\ (\ idx\: :ref:`int`, custom_bg_color\: :ref:`Color`\ ) :ref:`🔗` Sets the background color of the item specified by ``idx`` index to the specified :ref:`Color`. @@ -999,7 +999,7 @@ Sets the background color of the item specified by ``idx`` index to the specifie .. rst-class:: classref-method -|void| **set_item_custom_fg_color**\ (\ idx\: :ref:`int`, custom_fg_color\: :ref:`Color`\ ) +|void| **set_item_custom_fg_color**\ (\ idx\: :ref:`int`, custom_fg_color\: :ref:`Color`\ ) :ref:`🔗` Sets the foreground color of the item specified by ``idx`` index to the specified :ref:`Color`. @@ -1011,7 +1011,7 @@ Sets the foreground color of the item specified by ``idx`` index to the specifie .. rst-class:: classref-method -|void| **set_item_disabled**\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_item_disabled**\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Disables (or enables) the item at the specified index. @@ -1025,7 +1025,7 @@ Disabled items cannot be selected and do not trigger activation signals (when do .. rst-class:: classref-method -|void| **set_item_icon**\ (\ idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_item_icon**\ (\ idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets (or replaces) the icon's :ref:`Texture2D` associated with the specified index. @@ -1037,7 +1037,7 @@ Sets (or replaces) the icon's :ref:`Texture2D` associated with .. rst-class:: classref-method -|void| **set_item_icon_modulate**\ (\ idx\: :ref:`int`, modulate\: :ref:`Color`\ ) +|void| **set_item_icon_modulate**\ (\ idx\: :ref:`int`, modulate\: :ref:`Color`\ ) :ref:`🔗` Sets a modulating :ref:`Color` of the item associated with the specified index. @@ -1049,7 +1049,7 @@ Sets a modulating :ref:`Color` of the item associated with the spec .. rst-class:: classref-method -|void| **set_item_icon_region**\ (\ idx\: :ref:`int`, rect\: :ref:`Rect2`\ ) +|void| **set_item_icon_region**\ (\ idx\: :ref:`int`, rect\: :ref:`Rect2`\ ) :ref:`🔗` Sets the region of item's icon used. The whole icon will be used if the region has no area. @@ -1061,7 +1061,7 @@ Sets the region of item's icon used. The whole icon will be used if the region h .. rst-class:: classref-method -|void| **set_item_icon_transposed**\ (\ idx\: :ref:`int`, transposed\: :ref:`bool`\ ) +|void| **set_item_icon_transposed**\ (\ idx\: :ref:`int`, transposed\: :ref:`bool`\ ) :ref:`🔗` Sets whether the item icon will be drawn transposed. @@ -1073,7 +1073,7 @@ Sets whether the item icon will be drawn transposed. .. rst-class:: classref-method -|void| **set_item_language**\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) +|void| **set_item_language**\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1085,7 +1085,7 @@ Sets language code of item's text used for line-breaking and text shaping algori .. rst-class:: classref-method -|void| **set_item_metadata**\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) +|void| **set_item_metadata**\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) :ref:`🔗` Sets a value (of any type) to be stored with the item associated with the specified index. @@ -1097,7 +1097,7 @@ Sets a value (of any type) to be stored with the item associated with the specif .. rst-class:: classref-method -|void| **set_item_selectable**\ (\ idx\: :ref:`int`, selectable\: :ref:`bool`\ ) +|void| **set_item_selectable**\ (\ idx\: :ref:`int`, selectable\: :ref:`bool`\ ) :ref:`🔗` Allows or disallows selection of the item associated with the specified index. @@ -1109,7 +1109,7 @@ Allows or disallows selection of the item associated with the specified index. .. rst-class:: classref-method -|void| **set_item_text**\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_item_text**\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets text of the item associated with the specified index. @@ -1121,7 +1121,7 @@ Sets text of the item associated with the specified index. .. rst-class:: classref-method -|void| **set_item_text_direction**\ (\ idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) +|void| **set_item_text_direction**\ (\ idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) :ref:`🔗` Sets item's text base writing direction. @@ -1133,7 +1133,7 @@ Sets item's text base writing direction. .. rst-class:: classref-method -|void| **set_item_tooltip**\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_item_tooltip**\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the tooltip hint for the item associated with the specified index. @@ -1145,7 +1145,7 @@ Sets the tooltip hint for the item associated with the specified index. .. rst-class:: classref-method -|void| **set_item_tooltip_enabled**\ (\ idx\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_item_tooltip_enabled**\ (\ idx\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the tooltip hint is enabled for specified item index. @@ -1157,7 +1157,7 @@ Sets whether the tooltip hint is enabled for specified item index. .. rst-class:: classref-method -|void| **sort_items_by_text**\ (\ ) +|void| **sort_items_by_text**\ (\ ) :ref:`🔗` Sorts items in the list by their text. @@ -1174,7 +1174,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.65, 0.65, 0.65, 1)`` +:ref:`Color` **font_color** = ``Color(0.65, 0.65, 0.65, 1)`` :ref:`🔗` Default text :ref:`Color` of the item. @@ -1186,7 +1186,7 @@ Default text :ref:`Color` of the item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Text :ref:`Color` used when the item is hovered and not selected yet. @@ -1198,7 +1198,7 @@ Text :ref:`Color` used when the item is hovered and not selected ye .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the item. @@ -1210,7 +1210,7 @@ The tint of text outline of the item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_selected_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the item is selected. @@ -1222,7 +1222,7 @@ Text :ref:`Color` used when the item is selected. .. rst-class:: classref-themeproperty -:ref:`Color` **guide_color** = ``Color(0.7, 0.7, 0.7, 0.25)`` +:ref:`Color` **guide_color** = ``Color(0.7, 0.7, 0.7, 0.25)`` :ref:`🔗` :ref:`Color` of the guideline. The guideline is a line drawn between each row of items. @@ -1234,7 +1234,7 @@ Text :ref:`Color` used when the item is selected. .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal spacing between items. @@ -1246,7 +1246,7 @@ The horizontal spacing between items. .. rst-class:: classref-themeproperty -:ref:`int` **icon_margin** = ``4`` +:ref:`int` **icon_margin** = ``4`` :ref:`🔗` The spacing between item's icon and text. @@ -1258,7 +1258,7 @@ The spacing between item's icon and text. .. rst-class:: classref-themeproperty -:ref:`int` **line_separation** = ``2`` +:ref:`int` **line_separation** = ``2`` :ref:`🔗` The vertical spacing between each line of text. @@ -1270,7 +1270,7 @@ The vertical spacing between each line of text. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the item text outline. @@ -1284,7 +1284,7 @@ The size of the item text outline. .. rst-class:: classref-themeproperty -:ref:`int` **v_separation** = ``4`` +:ref:`int` **v_separation** = ``4`` :ref:`🔗` The vertical spacing between items. @@ -1296,7 +1296,7 @@ The vertical spacing between items. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` of the item's text. @@ -1308,7 +1308,7 @@ The vertical spacing between items. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the item's text. @@ -1320,7 +1320,7 @@ Font size of the item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **cursor** +:ref:`StyleBox` **cursor** :ref:`🔗` :ref:`StyleBox` used for the cursor, when the **ItemList** is being focused. @@ -1332,7 +1332,7 @@ Font size of the item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **cursor_unfocused** +:ref:`StyleBox` **cursor_unfocused** :ref:`🔗` :ref:`StyleBox` used for the cursor, when the **ItemList** is not being focused. @@ -1344,7 +1344,7 @@ Font size of the item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` The focused style for the **ItemList**, drawn on top of the background, but below everything else. @@ -1356,7 +1356,7 @@ The focused style for the **ItemList**, drawn on top of the background, but belo .. rst-class:: classref-themeproperty -:ref:`StyleBox` **hovered** +:ref:`StyleBox` **hovered** :ref:`🔗` :ref:`StyleBox` for the hovered, but not selected items. @@ -1368,7 +1368,7 @@ The focused style for the **ItemList**, drawn on top of the background, but belo .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The background style for the **ItemList**. @@ -1380,7 +1380,7 @@ The background style for the **ItemList**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **selected** +:ref:`StyleBox` **selected** :ref:`🔗` :ref:`StyleBox` for the selected items, used when the **ItemList** is not being focused. @@ -1392,7 +1392,7 @@ The background style for the **ItemList**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **selected_focus** +:ref:`StyleBox` **selected_focus** :ref:`🔗` :ref:`StyleBox` for the selected items, used when the **ItemList** is being focused. diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index 05c371a0f66..de7c0c2146c 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -48,7 +48,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`JavaClass` **wrap**\ (\ name\: :ref:`String`\ ) +:ref:`JavaClass` **wrap**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Wraps a class defined in Java, and returns it as a :ref:`JavaClass` :ref:`Object` type that Godot can interact with. diff --git a/classes/class_javascriptbridge.rst b/classes/class_javascriptbridge.rst index d35cb5627ef..fe3546d0981 100644 --- a/classes/class_javascriptbridge.rst +++ b/classes/class_javascriptbridge.rst @@ -69,7 +69,7 @@ Signals .. rst-class:: classref-signal -**pwa_update_available**\ (\ ) +**pwa_update_available**\ (\ ) :ref:`🔗` Emitted when an update for this progressive web app has been detected but is waiting to be activated because a previous version is active. See :ref:`pwa_update` to force the update to take place immediately. @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`JavaScriptObject` **create_callback**\ (\ callable\: :ref:`Callable`\ ) +:ref:`JavaScriptObject` **create_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Creates a reference to a :ref:`Callable` that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See :ref:`JavaScriptObject` for usage. @@ -98,7 +98,7 @@ Creates a reference to a :ref:`Callable` that can be used as a c .. rst-class:: classref-method -:ref:`Variant` **create_object**\ (\ object\: :ref:`String`, ...\ ) |vararg| +:ref:`Variant` **create_object**\ (\ object\: :ref:`String`, ...\ ) |vararg| :ref:`🔗` Creates a new JavaScript object using the ``new`` constructor. The ``object`` must a valid property of the JavaScript ``window``. See :ref:`JavaScriptObject` for usage. @@ -110,7 +110,7 @@ Creates a new JavaScript object using the ``new`` constructor. The ``object`` mu .. rst-class:: classref-method -|void| **download_buffer**\ (\ buffer\: :ref:`PackedByteArray`, name\: :ref:`String`, mime\: :ref:`String` = "application/octet-stream"\ ) +|void| **download_buffer**\ (\ buffer\: :ref:`PackedByteArray`, name\: :ref:`String`, mime\: :ref:`String` = "application/octet-stream"\ ) :ref:`🔗` Prompts the user to download a file containing the specified ``buffer``. The file will have the given ``name`` and ``mime`` type. @@ -128,7 +128,7 @@ Prompts the user to download a file containing the specified ``buffer``. The fil .. rst-class:: classref-method -:ref:`Variant` **eval**\ (\ code\: :ref:`String`, use_global_execution_context\: :ref:`bool` = false\ ) +:ref:`Variant` **eval**\ (\ code\: :ref:`String`, use_global_execution_context\: :ref:`bool` = false\ ) :ref:`🔗` Execute the string ``code`` as JavaScript code within the browser window. This is a call to the actual global JavaScript function ``eval()``. @@ -142,7 +142,7 @@ If ``use_global_execution_context`` is ``true``, the code will be evaluated in t .. rst-class:: classref-method -|void| **force_fs_sync**\ (\ ) +|void| **force_fs_sync**\ (\ ) :ref:`🔗` Force synchronization of the persistent file system (when enabled). @@ -156,7 +156,7 @@ Force synchronization of the persistent file system (when enabled). .. rst-class:: classref-method -:ref:`JavaScriptObject` **get_interface**\ (\ interface\: :ref:`String`\ ) +:ref:`JavaScriptObject` **get_interface**\ (\ interface\: :ref:`String`\ ) :ref:`🔗` Returns an interface to a JavaScript object that can be used by scripts. The ``interface`` must be a valid property of the JavaScript ``window``. The callback must accept a single :ref:`Array` argument, which will contain the JavaScript ``arguments``. See :ref:`JavaScriptObject` for usage. @@ -168,7 +168,7 @@ Returns an interface to a JavaScript object that can be used by scripts. The ``i .. rst-class:: classref-method -:ref:`bool` **pwa_needs_update**\ (\ ) |const| +:ref:`bool` **pwa_needs_update**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a new version of the progressive web app is waiting to be activated. @@ -182,7 +182,7 @@ Returns ``true`` if a new version of the progressive web app is waiting to be ac .. rst-class:: classref-method -:ref:`Error` **pwa_update**\ (\ ) +:ref:`Error` **pwa_update**\ (\ ) :ref:`🔗` Performs the live update of the progressive web app. Forcing the new version to be installed and the page to be reloaded. diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 66b34f9132f..0c58b8b8586 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -21,7 +21,7 @@ Abstract base class for all 2D physics joints. Description ----------- -Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies and apply a constraint. +Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies (:ref:`node_a` and :ref:`node_b`) and apply a constraint. .. rst-class:: classref-reftable-group @@ -66,7 +66,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bias** = ``0.0`` +:ref:`float` **bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,14 +85,14 @@ When set to ``0``, the default value from :ref:`ProjectSettings.physics/2d/solve .. rst-class:: classref-property -:ref:`bool` **disable_collision** = ``true`` +:ref:`bool` **disable_collision** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_exclude_nodes_from_collision**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_exclude_nodes_from_collision**\ (\ ) -If ``true``, :ref:`node_a` and :ref:`node_b` can not collide. +If ``true``, the two bodies bound together do not collide with each other. .. rst-class:: classref-item-separator @@ -102,14 +102,14 @@ If ``true``, :ref:`node_a` and :ref:`node_b` **node_a** = ``NodePath("")`` +:ref:`NodePath` **node_a** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_node_a**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_node_a**\ (\ ) -The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +Path to the first body (A) attached to the joint. The node must inherit :ref:`PhysicsBody2D`. .. rst-class:: classref-item-separator @@ -119,14 +119,14 @@ The first body attached to the joint. Must derive from :ref:`PhysicsBody2D` **node_b** = ``NodePath("")`` +:ref:`NodePath` **node_b** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_node_b**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_node_b**\ (\ ) -The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +Path to the second body (B) attached to the joint. The node must inherit :ref:`PhysicsBody2D`. .. rst-class:: classref-section-separator @@ -141,9 +141,9 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` -Returns the joint's :ref:`RID`. +Returns the joint's internal :ref:`RID` from the :ref:`PhysicsServer2D`. .. |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_joint3d.rst b/classes/class_joint3d.rst index 54b1bbc6d53..411ce34a298 100644 --- a/classes/class_joint3d.rst +++ b/classes/class_joint3d.rst @@ -21,7 +21,7 @@ Abstract base class for all 3D physics joints. Description ----------- -Abstract base class for all joints in 3D physics. 3D joints bind together two physics bodies and apply a constraint. +Abstract base class for all joints in 3D physics. 3D joints bind together two physics bodies (:ref:`node_a` and :ref:`node_b`) and apply a constraint. If only one body is defined, it is attached to a fixed :ref:`StaticBody3D` without collision shapes. .. rst-class:: classref-introduction-group @@ -73,14 +73,14 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **exclude_nodes_from_collision** = ``true`` +:ref:`bool` **exclude_nodes_from_collision** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_exclude_nodes_from_collision**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_exclude_nodes_from_collision**\ (\ ) -If ``true``, the two bodies of the nodes are not able to collide with each other. +If ``true``, the two bodies bound together do not collide with each other. .. rst-class:: classref-item-separator @@ -90,14 +90,16 @@ If ``true``, the two bodies of the nodes are not able to collide with each other .. rst-class:: classref-property -:ref:`NodePath` **node_a** = ``NodePath("")`` +:ref:`NodePath` **node_a** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_node_a**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_node_a**\ (\ ) -The node attached to the first side (A) of the joint. +Path to the first node (A) attached to the joint. The node must inherit :ref:`PhysicsBody3D`. + +If left empty and :ref:`node_b` is set, the body is attached to a fixed :ref:`StaticBody3D` without collision shapes. .. rst-class:: classref-item-separator @@ -107,14 +109,16 @@ The node attached to the first side (A) of the joint. .. rst-class:: classref-property -:ref:`NodePath` **node_b** = ``NodePath("")`` +:ref:`NodePath` **node_b** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_node_b**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_node_b**\ (\ ) -The node attached to the second side (B) of the joint. +Path to the second node (B) attached to the joint. The node must inherit :ref:`PhysicsBody3D`. + +If left empty and :ref:`node_a` is set, the body is attached to a fixed :ref:`StaticBody3D` without collision shapes. .. rst-class:: classref-item-separator @@ -124,7 +128,7 @@ The node attached to the second side (B) of the joint. .. rst-class:: classref-property -:ref:`int` **solver_priority** = ``1`` +:ref:`int` **solver_priority** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -146,9 +150,9 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` -Returns the joint's :ref:`RID`. +Returns the joint's internal :ref:`RID` from the :ref:`PhysicsServer3D`. .. |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_json.rst b/classes/class_json.rst index ed96cb18eb5..8276d936dcf 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -108,7 +108,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Variant` **data** = ``null`` +:ref:`Variant` **data** = ``null`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_error_line**\ (\ ) |const| +:ref:`int` **get_error_line**\ (\ ) |const| :ref:`🔗` Returns ``0`` if the last call to :ref:`parse` was successful, or the line number where the parse failed. @@ -142,7 +142,7 @@ Returns ``0`` if the last call to :ref:`parse` was succ .. rst-class:: classref-method -:ref:`String` **get_error_message**\ (\ ) |const| +:ref:`String` **get_error_message**\ (\ ) |const| :ref:`🔗` Returns an empty string if the last call to :ref:`parse` was successful, or the error message if it failed. @@ -154,7 +154,7 @@ Returns an empty string if the last call to :ref:`parse .. rst-class:: classref-method -:ref:`String` **get_parsed_text**\ (\ ) |const| +:ref:`String` **get_parsed_text**\ (\ ) |const| :ref:`🔗` Return the text parsed by :ref:`parse` as long as the function is instructed to keep it. @@ -166,7 +166,7 @@ Return the text parsed by :ref:`parse` as long as the f .. rst-class:: classref-method -:ref:`Error` **parse**\ (\ json_text\: :ref:`String`, keep_text\: :ref:`bool` = false\ ) +:ref:`Error` **parse**\ (\ json_text\: :ref:`String`, keep_text\: :ref:`bool` = false\ ) :ref:`🔗` Attempts to parse the ``json_text`` provided. @@ -184,7 +184,7 @@ The optional ``keep_text`` argument instructs the parser to keep a copy of the o .. rst-class:: classref-method -:ref:`Variant` **parse_string**\ (\ json_string\: :ref:`String`\ ) |static| +:ref:`Variant` **parse_string**\ (\ json_string\: :ref:`String`\ ) |static| :ref:`🔗` Attempts to parse the ``json_string`` provided and returns the parsed data. Returns ``null`` if parse failed. @@ -196,7 +196,7 @@ Attempts to parse the ``json_string`` provided and returns the parsed data. Retu .. rst-class:: classref-method -:ref:`String` **stringify**\ (\ data\: :ref:`Variant`, indent\: :ref:`String` = "", sort_keys\: :ref:`bool` = true, full_precision\: :ref:`bool` = false\ ) |static| +:ref:`String` **stringify**\ (\ data\: :ref:`Variant`, indent\: :ref:`String` = "", sort_keys\: :ref:`bool` = true, full_precision\: :ref:`bool` = false\ ) |static| :ref:`🔗` Converts a :ref:`Variant` var to JSON text and returns the result. Useful for serializing data to store or send over the network. diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index 9859db02712..00523578a71 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -58,7 +58,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ErrorCode**: +enum **ErrorCode**: :ref:`🔗` .. _class_JSONRPC_constant_PARSE_ERROR: @@ -113,7 +113,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **make_notification**\ (\ method\: :ref:`String`, params\: :ref:`Variant`\ ) +:ref:`Dictionary` **make_notification**\ (\ method\: :ref:`String`, params\: :ref:`Variant`\ ) :ref:`🔗` Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response. @@ -129,7 +129,7 @@ Returns a dictionary in the form of a JSON-RPC notification. Notifications are o .. rst-class:: classref-method -:ref:`Dictionary` **make_request**\ (\ method\: :ref:`String`, params\: :ref:`Variant`, id\: :ref:`Variant`\ ) +:ref:`Dictionary` **make_request**\ (\ method\: :ref:`String`, params\: :ref:`Variant`, id\: :ref:`Variant`\ ) :ref:`🔗` Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to. @@ -147,7 +147,7 @@ Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a s .. rst-class:: classref-method -:ref:`Dictionary` **make_response**\ (\ result\: :ref:`Variant`, id\: :ref:`Variant`\ ) +:ref:`Dictionary` **make_response**\ (\ result\: :ref:`Variant`, id\: :ref:`Variant`\ ) :ref:`🔗` When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead. @@ -163,7 +163,7 @@ When a server has received and processed a request, it is expected to send a res .. rst-class:: classref-method -:ref:`Dictionary` **make_response_error**\ (\ code\: :ref:`int`, message\: :ref:`String`, id\: :ref:`Variant` = null\ ) |const| +:ref:`Dictionary` **make_response_error**\ (\ code\: :ref:`int`, message\: :ref:`String`, id\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Creates a response which indicates a previous reply has failed in some way. @@ -181,7 +181,7 @@ Creates a response which indicates a previous reply has failed in some way. .. rst-class:: classref-method -:ref:`Variant` **process_action**\ (\ action\: :ref:`Variant`, recurse\: :ref:`bool` = false\ ) +:ref:`Variant` **process_action**\ (\ action\: :ref:`Variant`, recurse\: :ref:`bool` = false\ ) :ref:`🔗` Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called. @@ -197,7 +197,7 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act .. rst-class:: classref-method -:ref:`String` **process_string**\ (\ action\: :ref:`String`\ ) +:ref:`String` **process_string**\ (\ action\: :ref:`String`\ ) :ref:`🔗` .. container:: contribute @@ -211,7 +211,7 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act .. rst-class:: classref-method -|void| **set_scope**\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) +|void| **set_scope**\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index ba925d9954a..4964234c545 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_angle**\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| +:ref:`float` **get_angle**\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| :ref:`🔗` Returns the collision angle according to ``up_direction``, which is :ref:`Vector2.UP` by default. This value is always positive. @@ -84,7 +84,7 @@ Returns the collision angle according to ``up_direction``, which is :ref:`Vector .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ ) |const| +:ref:`Object` **get_collider**\ (\ ) |const| :ref:`🔗` Returns the colliding body's attached :ref:`Object`. @@ -96,7 +96,7 @@ Returns the colliding body's attached :ref:`Object`. .. rst-class:: classref-method -:ref:`int` **get_collider_id**\ (\ ) |const| +:ref:`int` **get_collider_id**\ (\ ) |const| :ref:`🔗` Returns the unique instance ID of the colliding body's attached :ref:`Object`. See :ref:`Object.get_instance_id`. @@ -108,7 +108,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid**\ (\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| :ref:`🔗` Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer2D`. @@ -120,7 +120,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`Object` **get_collider_shape**\ (\ ) |const| +:ref:`Object` **get_collider_shape**\ (\ ) |const| :ref:`🔗` Returns the colliding body's shape. @@ -132,7 +132,7 @@ Returns the colliding body's shape. .. rst-class:: classref-method -:ref:`int` **get_collider_shape_index**\ (\ ) |const| +:ref:`int` **get_collider_shape_index**\ (\ ) |const| :ref:`🔗` Returns the colliding body's shape index. See :ref:`CollisionObject2D`. @@ -144,7 +144,7 @@ Returns the colliding body's shape index. See :ref:`CollisionObject2D` **get_collider_velocity**\ (\ ) |const| +:ref:`Vector2` **get_collider_velocity**\ (\ ) |const| :ref:`🔗` Returns the colliding body's velocity. @@ -156,7 +156,7 @@ Returns the colliding body's velocity. .. rst-class:: classref-method -:ref:`float` **get_depth**\ (\ ) |const| +:ref:`float` **get_depth**\ (\ ) |const| :ref:`🔗` Returns the colliding body's length of overlap along the collision normal. @@ -168,7 +168,7 @@ Returns the colliding body's length of overlap along the collision normal. .. rst-class:: classref-method -:ref:`Object` **get_local_shape**\ (\ ) |const| +:ref:`Object` **get_local_shape**\ (\ ) |const| :ref:`🔗` Returns the moving object's colliding shape. @@ -180,7 +180,7 @@ Returns the moving object's colliding shape. .. rst-class:: classref-method -:ref:`Vector2` **get_normal**\ (\ ) |const| +:ref:`Vector2` **get_normal**\ (\ ) |const| :ref:`🔗` Returns the colliding body's shape's normal at the point of collision. @@ -192,7 +192,7 @@ Returns the colliding body's shape's normal at the point of collision. .. rst-class:: classref-method -:ref:`Vector2` **get_position**\ (\ ) |const| +:ref:`Vector2` **get_position**\ (\ ) |const| :ref:`🔗` Returns the point of collision in global coordinates. @@ -204,7 +204,7 @@ Returns the point of collision in global coordinates. .. rst-class:: classref-method -:ref:`Vector2` **get_remainder**\ (\ ) |const| +:ref:`Vector2` **get_remainder**\ (\ ) |const| :ref:`🔗` Returns the moving object's remaining movement vector. @@ -216,7 +216,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector2` **get_travel**\ (\ ) |const| +:ref:`Vector2` **get_travel**\ (\ ) |const| :ref:`🔗` Returns the moving object's travel before collision. diff --git a/classes/class_kinematiccollision3d.rst b/classes/class_kinematiccollision3d.rst index 0c9db3b4bd8..167bb1af9f7 100644 --- a/classes/class_kinematiccollision3d.rst +++ b/classes/class_kinematiccollision3d.rst @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_angle**\ (\ collision_index\: :ref:`int` = 0, up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| +:ref:`float` **get_angle**\ (\ collision_index\: :ref:`int` = 0, up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| :ref:`🔗` Returns the collision angle according to ``up_direction``, which is :ref:`Vector3.UP` by default. This value is always positive. @@ -86,7 +86,7 @@ Returns the collision angle according to ``up_direction``, which is :ref:`Vector .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default). @@ -98,7 +98,7 @@ Returns the colliding body's attached :ref:`Object` given a collis .. rst-class:: classref-method -:ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the unique instance ID of the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default). See :ref:`Object.get_instance_id`. @@ -110,7 +110,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer3D` given a collision index (the deepest collision by default). @@ -122,7 +122,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`Object` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Object` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape given a collision index (the deepest collision by default). @@ -134,7 +134,7 @@ Returns the colliding body's shape given a collision index (the deepest collisio .. rst-class:: classref-method -:ref:`int` **get_collider_shape_index**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_collider_shape_index**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape index given a collision index (the deepest collision by default). See :ref:`CollisionObject3D`. @@ -146,7 +146,7 @@ Returns the colliding body's shape index given a collision index (the deepest co .. rst-class:: classref-method -:ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's velocity given a collision index (the deepest collision by default). @@ -158,7 +158,7 @@ Returns the colliding body's velocity given a collision index (the deepest colli .. rst-class:: classref-method -:ref:`int` **get_collision_count**\ (\ ) |const| +:ref:`int` **get_collision_count**\ (\ ) |const| :ref:`🔗` Returns the number of detected collisions. @@ -170,7 +170,7 @@ Returns the number of detected collisions. .. rst-class:: classref-method -:ref:`float` **get_depth**\ (\ ) |const| +:ref:`float` **get_depth**\ (\ ) |const| :ref:`🔗` Returns the colliding body's length of overlap along the collision normal. @@ -182,7 +182,7 @@ Returns the colliding body's length of overlap along the collision normal. .. rst-class:: classref-method -:ref:`Object` **get_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Object` **get_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the moving object's colliding shape given a collision index (the deepest collision by default). @@ -194,7 +194,7 @@ Returns the moving object's colliding shape given a collision index (the deepest .. rst-class:: classref-method -:ref:`Vector3` **get_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector3` **get_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). @@ -206,7 +206,7 @@ Returns the colliding body's shape's normal at the point of collision given a co .. rst-class:: classref-method -:ref:`Vector3` **get_position**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector3` **get_position**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the point of collision in global coordinates given a collision index (the deepest collision by default). @@ -218,7 +218,7 @@ Returns the point of collision in global coordinates given a collision index (th .. rst-class:: classref-method -:ref:`Vector3` **get_remainder**\ (\ ) |const| +:ref:`Vector3` **get_remainder**\ (\ ) |const| :ref:`🔗` Returns the moving object's remaining movement vector. @@ -230,7 +230,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector3` **get_travel**\ (\ ) |const| +:ref:`Vector3` **get_travel**\ (\ ) |const| :ref:`🔗` Returns the moving object's travel before collision. diff --git a/classes/class_label.rst b/classes/class_label.rst index 6435cb43a09..909c66b28b5 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -150,7 +150,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AutowrapMode` **autowrap_mode** = ``0`` +:ref:`AutowrapMode` **autowrap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` **clip_text** = ``false`` +:ref:`bool` **clip_text** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ If ``true``, the Label only shows the text that fits inside its bounding rectang .. rst-class:: classref-property -:ref:`String` **ellipsis_char** = ``"…"`` +:ref:`String` **ellipsis_char** = ``"…"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ Ellipsis character used for text clipping. .. rst-class:: classref-property -:ref:`HorizontalAlignment` **horizontal_alignment** = ``0`` +:ref:`HorizontalAlignment` **horizontal_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill .. rst-class:: classref-property -|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -235,7 +235,7 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` **label_settings** +:ref:`LabelSettings` **label_settings** :ref:`🔗` .. rst-class:: classref-property-setget @@ -252,7 +252,7 @@ A :ref:`LabelSettings` resource that can be shared between .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -269,7 +269,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`int` **lines_skipped** = ``0`` +:ref:`int` **lines_skipped** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -286,7 +286,7 @@ The number of the lines ignored and not displayed from the start of the :ref:`te .. rst-class:: classref-property -:ref:`int` **max_lines_visible** = ``-1`` +:ref:`int` **max_lines_visible** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -303,7 +303,7 @@ Limits the lines of text the node shows on screen. .. rst-class:: classref-property -:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -320,7 +320,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -337,7 +337,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`PackedFloat32Array` **tab_stops** = ``PackedFloat32Array()`` +:ref:`PackedFloat32Array` **tab_stops** = ``PackedFloat32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +356,7 @@ Aligns text to the given tab-stops. .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -373,7 +373,7 @@ The text to display on screen. .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -390,7 +390,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` +:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -407,7 +407,7 @@ Sets the clipping behavior when the text exceeds the node's bounding rectangle. .. rst-class:: classref-property -:ref:`bool` **uppercase** = ``false`` +:ref:`bool` **uppercase** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -424,7 +424,7 @@ If ``true``, all the text displays as UPPERCASE. .. rst-class:: classref-property -:ref:`VerticalAlignment` **vertical_alignment** = ``0`` +:ref:`VerticalAlignment` **vertical_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -441,7 +441,7 @@ Controls the text's vertical alignment. Supports top, center, bottom, and fill. .. rst-class:: classref-property -:ref:`int` **visible_characters** = ``-1`` +:ref:`int` **visible_characters** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -460,7 +460,7 @@ The number of characters to display. If set to ``-1``, all characters are displa .. rst-class:: classref-property -:ref:`VisibleCharactersBehavior` **visible_characters_behavior** = ``0`` +:ref:`VisibleCharactersBehavior` **visible_characters_behavior** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -477,7 +477,7 @@ Sets the clipping behavior when :ref:`visible_characters` **visible_ratio** = ``1.0`` +:ref:`float` **visible_ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -501,7 +501,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_character_bounds**\ (\ pos\: :ref:`int`\ ) |const| +:ref:`Rect2` **get_character_bounds**\ (\ pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns the bounding rectangle of the character at position ``pos``. If the character is a non-visual character or ``pos`` is outside the valid range, an empty :ref:`Rect2` is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned. @@ -513,7 +513,7 @@ Returns the bounding rectangle of the character at position ``pos``. If the char .. rst-class:: classref-method -:ref:`int` **get_line_count**\ (\ ) |const| +:ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` Returns the number of lines of text the Label has. @@ -525,7 +525,7 @@ Returns the number of lines of text the Label has. .. rst-class:: classref-method -:ref:`int` **get_line_height**\ (\ line\: :ref:`int` = -1\ ) |const| +:ref:`int` **get_line_height**\ (\ line\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the height of the line ``line``. @@ -541,7 +541,7 @@ If there are no lines, returns font size in pixels. .. rst-class:: classref-method -:ref:`int` **get_total_character_count**\ (\ ) |const| +:ref:`int` **get_total_character_count**\ (\ ) |const| :ref:`🔗` Returns the total number of printable characters in the text (excluding spaces and newlines). @@ -553,7 +553,7 @@ Returns the total number of printable characters in the text (excluding spaces a .. rst-class:: classref-method -:ref:`int` **get_visible_line_count**\ (\ ) |const| +:ref:`int` **get_visible_line_count**\ (\ ) |const| :ref:`🔗` Returns the number of lines shown. Useful if the **Label**'s height cannot currently display all lines. @@ -570,7 +570,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Default text :ref:`Color` of the **Label**. @@ -582,7 +582,7 @@ Default text :ref:`Color` of the **Label**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The color of text outline. @@ -594,7 +594,7 @@ The color of text outline. .. rst-class:: classref-themeproperty -:ref:`Color` **font_shadow_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **font_shadow_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` :ref:`Color` of the text's shadow effect. @@ -606,7 +606,7 @@ The color of text outline. .. rst-class:: classref-themeproperty -:ref:`int` **line_spacing** = ``3`` +:ref:`int` **line_spacing** = ``3`` :ref:`🔗` Vertical space between lines in multiline **Label**. @@ -618,7 +618,7 @@ Vertical space between lines in multiline **Label**. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` Text outline size. @@ -634,7 +634,7 @@ Text outline size. .. rst-class:: classref-themeproperty -:ref:`int` **shadow_offset_x** = ``1`` +:ref:`int` **shadow_offset_x** = ``1`` :ref:`🔗` The horizontal offset of the text's shadow. @@ -646,7 +646,7 @@ The horizontal offset of the text's shadow. .. rst-class:: classref-themeproperty -:ref:`int` **shadow_offset_y** = ``1`` +:ref:`int` **shadow_offset_y** = ``1`` :ref:`🔗` The vertical offset of the text's shadow. @@ -658,7 +658,7 @@ The vertical offset of the text's shadow. .. rst-class:: classref-themeproperty -:ref:`int` **shadow_outline_size** = ``1`` +:ref:`int` **shadow_outline_size** = ``1`` :ref:`🔗` The size of the shadow outline. @@ -670,7 +670,7 @@ The size of the shadow outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` used for the **Label**'s text. @@ -682,7 +682,7 @@ The size of the shadow outline. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the **Label**'s text. @@ -694,7 +694,7 @@ Font size of the **Label**'s text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **normal** +:ref:`StyleBox` **normal** :ref:`🔗` Background :ref:`StyleBox` for the **Label**. diff --git a/classes/class_label3d.rst b/classes/class_label3d.rst index c66eab83e43..594fc95ac52 100644 --- a/classes/class_label3d.rst +++ b/classes/class_label3d.rst @@ -138,7 +138,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawFlags**: +enum **DrawFlags**: :ref:`🔗` .. _class_Label3D_constant_FLAG_SHADED: @@ -188,7 +188,7 @@ Represents the size of the :ref:`DrawFlags` enum. .. rst-class:: classref-enumeration -enum **AlphaCutMode**: +enum **AlphaCutMode**: :ref:`🔗` .. _class_Label3D_constant_ALPHA_CUT_DISABLED: @@ -241,7 +241,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **alpha_antialiasing_edge** = ``0.0`` +:ref:`float` **alpha_antialiasing_edge** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ Threshold at which antialiasing will be applied on the alpha channel. .. rst-class:: classref-property -:ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** = ``0`` +:ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -275,7 +275,7 @@ The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing` **alpha_cut** = ``0`` +:ref:`AlphaCutMode` **alpha_cut** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ The alpha cutting mode to use for the sprite. See :ref:`AlphaCutMode` **alpha_hash_scale** = ``1.0`` +:ref:`float` **alpha_hash_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -309,7 +309,7 @@ The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. .. rst-class:: classref-property -:ref:`float` **alpha_scissor_threshold** = ``0.5`` +:ref:`float` **alpha_scissor_threshold** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -326,7 +326,7 @@ Threshold at which the alpha scissor will discard values. .. rst-class:: classref-property -:ref:`AutowrapMode` **autowrap_mode** = ``0`` +:ref:`AutowrapMode` **autowrap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -343,7 +343,7 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` **billboard** = ``0`` +:ref:`BillboardMode` **billboard** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -360,7 +360,7 @@ The billboard mode to use for the label. See :ref:`BillboardMode` **double_sided** = ``true`` +:ref:`bool` **double_sided** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -377,7 +377,7 @@ If ``true``, text can be seen from the back as well, if ``false``, it is invisib .. rst-class:: classref-property -:ref:`bool` **fixed_size** = ``false`` +:ref:`bool` **fixed_size** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -394,7 +394,7 @@ If ``true``, the label is rendered at the same size regardless of distance. .. rst-class:: classref-property -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` .. rst-class:: classref-property-setget @@ -411,7 +411,7 @@ Font configuration used to display text. .. rst-class:: classref-property -:ref:`int` **font_size** = ``32`` +:ref:`int` **font_size** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -430,7 +430,7 @@ Higher font sizes require more time to render new characters, which can cause st .. rst-class:: classref-property -:ref:`HorizontalAlignment` **horizontal_alignment** = ``1`` +:ref:`HorizontalAlignment` **horizontal_alignment** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -447,7 +447,7 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill .. rst-class:: classref-property -|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -464,7 +464,7 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -481,7 +481,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`float` **line_spacing** = ``0.0`` +:ref:`float` **line_spacing** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -498,7 +498,7 @@ Vertical space between lines in multiline **Label3D**. .. rst-class:: classref-property -:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -515,7 +515,7 @@ Text :ref:`Color` of the **Label3D**. .. rst-class:: classref-property -:ref:`bool` **no_depth_test** = ``false`` +:ref:`bool` **no_depth_test** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -532,7 +532,7 @@ If ``true``, depth testing is disabled and the object will be drawn in render or .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -549,7 +549,7 @@ The text drawing offset (in pixels). .. rst-class:: classref-property -:ref:`Color` **outline_modulate** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **outline_modulate** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -566,7 +566,7 @@ The tint of text outline. .. rst-class:: classref-property -:ref:`int` **outline_render_priority** = ``-1`` +:ref:`int` **outline_render_priority** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -587,7 +587,7 @@ Sets the render priority for the text outline. Higher priority objects will be s .. rst-class:: classref-property -:ref:`int` **outline_size** = ``12`` +:ref:`int` **outline_size** = ``12`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -604,7 +604,7 @@ Text outline size. .. rst-class:: classref-property -:ref:`float` **pixel_size** = ``0.005`` +:ref:`float` **pixel_size** = ``0.005`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -621,7 +621,7 @@ The size of one pixel's width on the label to scale it in 3D. To make the font l .. rst-class:: classref-property -:ref:`int` **render_priority** = ``0`` +:ref:`int` **render_priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -642,7 +642,7 @@ Sets the render priority for the text. Higher priority objects will be sorted in .. rst-class:: classref-property -:ref:`bool` **shaded** = ``false`` +:ref:`bool` **shaded** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -659,7 +659,7 @@ If ``true``, the :ref:`Light3D` in the :ref:`Environment` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -676,7 +676,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -693,7 +693,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -710,7 +710,7 @@ The text to display on screen. .. rst-class:: classref-property -:ref:`Direction` **text_direction** = ``0`` +:ref:`Direction` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -727,7 +727,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`TextureFilter` **texture_filter** = ``3`` +:ref:`TextureFilter` **texture_filter** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -744,7 +744,7 @@ Filter flags for the texture. See :ref:`TextureFilter` **uppercase** = ``false`` +:ref:`bool` **uppercase** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -761,7 +761,7 @@ If ``true``, all the text displays as UPPERCASE. .. rst-class:: classref-property -:ref:`VerticalAlignment` **vertical_alignment** = ``1`` +:ref:`VerticalAlignment` **vertical_alignment** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -778,7 +778,7 @@ Controls the text's vertical alignment. Supports top, center, bottom. Set it to .. rst-class:: classref-property -:ref:`float` **width** = ``500.0`` +:ref:`float` **width** = ``500.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -800,7 +800,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| +:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| :ref:`🔗` Returns a :ref:`TriangleMesh` with the label's vertices following its current configuration (such as its :ref:`pixel_size`). @@ -812,7 +812,7 @@ Returns a :ref:`TriangleMesh` with the label's vertices foll .. rst-class:: classref-method -:ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| +:ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| :ref:`🔗` Returns the value of the specified flag. @@ -824,7 +824,7 @@ Returns the value of the specified flag. .. rst-class:: classref-method -|void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +|void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the specified flag will be enabled. See :ref:`DrawFlags` for a list of flags. diff --git a/classes/class_labelsettings.rst b/classes/class_labelsettings.rst index 3a7ba795e11..f05cae06895 100644 --- a/classes/class_labelsettings.rst +++ b/classes/class_labelsettings.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Color of the text. .. rst-class:: classref-property -:ref:`int` **font_size** = ``16`` +:ref:`int` **font_size** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ Size of the text. .. rst-class:: classref-property -:ref:`float` **line_spacing** = ``3.0`` +:ref:`float` **line_spacing** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Vertical space between lines when the text is multiline. .. rst-class:: classref-property -:ref:`Color` **outline_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **outline_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The color of the outline. .. rst-class:: classref-property -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ Text outline size. .. rst-class:: classref-property -:ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ Color of the shadow effect. If alpha is ``0``, no shadow will be drawn. .. rst-class:: classref-property -:ref:`Vector2` **shadow_offset** = ``Vector2(1, 1)`` +:ref:`Vector2` **shadow_offset** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ Offset of the shadow effect, in pixels. .. rst-class:: classref-property -:ref:`int` **shadow_size** = ``1`` +:ref:`int` **shadow_size** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index be870dd0fe2..1d3e10ea0c4 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -97,7 +97,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ShadowFilter**: +enum **ShadowFilter**: :ref:`🔗` .. _class_Light2D_constant_SHADOW_FILTER_NONE: @@ -131,7 +131,7 @@ Percentage closer filtering (13 samples) applies to the shadow map. This is the .. rst-class:: classref-enumeration -enum **BlendMode**: +enum **BlendMode**: :ref:`🔗` .. _class_Light2D_constant_BLEND_MODE_ADD: @@ -170,7 +170,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BlendMode` **blend_mode** = ``0`` +:ref:`BlendMode` **blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -187,7 +187,7 @@ The Light2D's blend mode. See :ref:`BlendMode` constants .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -204,7 +204,7 @@ The Light2D's :ref:`Color`. .. rst-class:: classref-property -:ref:`bool` **editor_only** = ``false`` +:ref:`bool` **editor_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ If ``true``, Light2D will only appear when editing the scene. .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ If ``true``, Light2D will emit light. .. rst-class:: classref-property -:ref:`float` **energy** = ``1.0`` +:ref:`float` **energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -255,7 +255,7 @@ The Light2D's energy value. The larger the value, the stronger the light. .. rst-class:: classref-property -:ref:`int` **range_item_cull_mask** = ``1`` +:ref:`int` **range_item_cull_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -274,7 +274,7 @@ The layer mask. Only objects with a matching :ref:`CanvasItem.light_mask` **range_layer_max** = ``0`` +:ref:`int` **range_layer_max** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -291,7 +291,7 @@ Maximum layer value of objects that are affected by the Light2D. .. rst-class:: classref-property -:ref:`int` **range_layer_min** = ``0`` +:ref:`int` **range_layer_min** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -308,7 +308,7 @@ Minimum layer value of objects that are affected by the Light2D. .. rst-class:: classref-property -:ref:`int` **range_z_max** = ``1024`` +:ref:`int` **range_z_max** = ``1024`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -325,7 +325,7 @@ Maximum ``z`` value of objects that are affected by the Light2D. .. rst-class:: classref-property -:ref:`int` **range_z_min** = ``-1024`` +:ref:`int` **range_z_min** = ``-1024`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -342,7 +342,7 @@ Minimum ``z`` value of objects that are affected by the Light2D. .. rst-class:: classref-property -:ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -359,7 +359,7 @@ Minimum ``z`` value of objects that are affected by the Light2D. .. rst-class:: classref-property -:ref:`bool` **shadow_enabled** = ``false`` +:ref:`bool` **shadow_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -376,7 +376,7 @@ If ``true``, the Light2D will cast shadows. .. rst-class:: classref-property -:ref:`ShadowFilter` **shadow_filter** = ``0`` +:ref:`ShadowFilter` **shadow_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -393,7 +393,7 @@ Shadow filter type. See :ref:`ShadowFilter` for possi .. rst-class:: classref-property -:ref:`float` **shadow_filter_smooth** = ``0.0`` +:ref:`float` **shadow_filter_smooth** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -410,7 +410,7 @@ Smoothing value for shadows. Higher values will result in softer shadows, at the .. rst-class:: classref-property -:ref:`int` **shadow_item_cull_mask** = ``1`` +:ref:`int` **shadow_item_cull_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -432,7 +432,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_height**\ (\ ) |const| +:ref:`float` **get_height**\ (\ ) |const| :ref:`🔗` Returns the light's height, which is used in 2D normal mapping. See :ref:`PointLight2D.height` and :ref:`DirectionalLight2D.height`. @@ -444,7 +444,7 @@ Returns the light's height, which is used in 2D normal mapping. See :ref:`PointL .. rst-class:: classref-method -|void| **set_height**\ (\ height\: :ref:`float`\ ) +|void| **set_height**\ (\ height\: :ref:`float`\ ) :ref:`🔗` Sets the light's height, which is used in 2D normal mapping. See :ref:`PointLight2D.height` and :ref:`DirectionalLight2D.height`. diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index fda2638d2ae..01e15d35d7b 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -125,7 +125,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Param**: +enum **Param**: :ref:`🔗` .. _class_Light3D_constant_PARAM_ENERGY: @@ -311,7 +311,7 @@ Represents the size of the :ref:`Param` enum. .. rst-class:: classref-enumeration -enum **BakeMode**: +enum **BakeMode**: :ref:`🔗` .. _class_Light3D_constant_BAKE_DISABLED: @@ -321,7 +321,7 @@ enum **BakeMode**: Light is ignored when baking. This is the fastest mode, but the light will be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights. -\ **Note:** Hiding a light does *not* affect baking :ref:`LightmapGI`. Hiding a light will still affect baking :ref:`VoxelGI` and SDFGI (see [member Environment.sdfgi_enabled). +\ **Note:** Hiding a light does *not* affect baking :ref:`LightmapGI`. Hiding a light will still affect baking :ref:`VoxelGI` and SDFGI (see :ref:`Environment.sdfgi_enabled`). .. _class_Light3D_constant_BAKE_STATIC: @@ -354,7 +354,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **distance_fade_begin** = ``40.0`` +:ref:`float` **distance_fade_begin** = ``40.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -373,7 +373,7 @@ The distance from the camera at which the light begins to fade away (in 3D units .. rst-class:: classref-property -:ref:`bool` **distance_fade_enabled** = ``false`` +:ref:`bool` **distance_fade_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ If ``true``, the light will smoothly fade away when far from the active :ref:`Ca .. rst-class:: classref-property -:ref:`float` **distance_fade_length** = ``10.0`` +:ref:`float` **distance_fade_length** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -411,7 +411,7 @@ Distance over which the light and its shadow fades. The light's energy and shado .. rst-class:: classref-property -:ref:`float` **distance_fade_shadow** = ``50.0`` +:ref:`float` **distance_fade_shadow** = ``50.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -430,7 +430,7 @@ The distance from the camera at which the light's shadow cuts off (in 3D units). .. rst-class:: classref-property -:ref:`bool` **editor_only** = ``false`` +:ref:`bool` **editor_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -447,7 +447,7 @@ If ``true``, the light only appears in the editor and will not be visible at run .. rst-class:: classref-property -:ref:`float` **light_angular_distance** = ``0.0`` +:ref:`float` **light_angular_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -468,7 +468,7 @@ The light's angular size in degrees. Increasing this will make shadows softer at .. rst-class:: classref-property -:ref:`BakeMode` **light_bake_mode** = ``2`` +:ref:`BakeMode` **light_bake_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -487,7 +487,7 @@ The light's bake mode. This will affect the global illumination techniques that .. rst-class:: classref-property -:ref:`Color` **light_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **light_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -504,7 +504,7 @@ The light's color. An *overbright* color can be used to achieve a result equival .. rst-class:: classref-property -:ref:`int` **light_cull_mask** = ``4294967295`` +:ref:`int` **light_cull_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -521,7 +521,7 @@ The light will affect objects in the selected layers. .. rst-class:: classref-property -:ref:`float` **light_energy** = ``1.0`` +:ref:`float` **light_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -538,7 +538,7 @@ The light's strength multiplier (this is not a physical unit). For :ref:`OmniLig .. rst-class:: classref-property -:ref:`float` **light_indirect_energy** = ``1.0`` +:ref:`float` **light_indirect_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -557,7 +557,7 @@ Secondary multiplier used with indirect light (light bounces). Used with :ref:`V .. rst-class:: classref-property -:ref:`float` **light_intensity_lumens** +:ref:`float` **light_intensity_lumens** :ref:`🔗` .. rst-class:: classref-property-setget @@ -578,7 +578,7 @@ A typical household lightbulb can range from around 600 lumens to 1,200 lumens, .. rst-class:: classref-property -:ref:`float` **light_intensity_lux** +:ref:`float` **light_intensity_lux** :ref:`🔗` .. rst-class:: classref-property-setget @@ -597,7 +597,7 @@ On a clear sunny day a surface in direct sunlight may be approximately 100,000 l .. rst-class:: classref-property -:ref:`bool` **light_negative** = ``false`` +:ref:`bool` **light_negative** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -614,7 +614,7 @@ If ``true``, the light's effect is reversed, darkening areas and casting bright .. rst-class:: classref-property -:ref:`Texture2D` **light_projector** +:ref:`Texture2D` **light_projector** :ref:`🔗` .. rst-class:: classref-property-setget @@ -635,7 +635,7 @@ If ``true``, the light's effect is reversed, darkening areas and casting bright .. rst-class:: classref-property -:ref:`float` **light_size** = ``0.0`` +:ref:`float` **light_size** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -656,7 +656,7 @@ The size of the light in Godot units. Only available for :ref:`OmniLight3D` **light_specular** = ``0.5`` +:ref:`float` **light_specular** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -673,7 +673,7 @@ The intensity of the specular blob in objects affected by the light. At ``0``, t .. rst-class:: classref-property -:ref:`float` **light_temperature** +:ref:`float` **light_temperature** :ref:`🔗` .. rst-class:: classref-property-setget @@ -692,7 +692,7 @@ The sun on a cloudy day is approximately 6500 Kelvin, on a clear day it is betwe .. rst-class:: classref-property -:ref:`float` **light_volumetric_fog_energy** = ``1.0`` +:ref:`float` **light_volumetric_fog_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -711,7 +711,7 @@ Secondary multiplier multiplied with :ref:`light_energy` **shadow_bias** = ``0.1`` +:ref:`float` **shadow_bias** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -728,7 +728,7 @@ Used to adjust shadow appearance. Too small a value results in self-shadowing (" .. rst-class:: classref-property -:ref:`float` **shadow_blur** = ``1.0`` +:ref:`float` **shadow_blur** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -745,7 +745,7 @@ Blurs the edges of the shadow. Can be used to hide pixel artifacts in low-resolu .. rst-class:: classref-property -:ref:`bool` **shadow_enabled** = ``false`` +:ref:`bool` **shadow_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -762,7 +762,7 @@ If ``true``, the light will cast real-time shadows. This has a significant perfo .. rst-class:: classref-property -:ref:`float` **shadow_normal_bias** = ``2.0`` +:ref:`float` **shadow_normal_bias** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -779,7 +779,7 @@ Offsets the lookup into the shadow map by the object's normal. This can be used .. rst-class:: classref-property -:ref:`float` **shadow_opacity** = ``1.0`` +:ref:`float` **shadow_opacity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -796,7 +796,7 @@ The opacity to use when rendering the light's shadow map. Values lower than ``1. .. rst-class:: classref-property -:ref:`bool` **shadow_reverse_cull_face** = ``false`` +:ref:`bool` **shadow_reverse_cull_face** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -813,7 +813,7 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when .. rst-class:: classref-property -:ref:`float` **shadow_transmittance_bias** = ``0.05`` +:ref:`float` **shadow_transmittance_bias** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -837,7 +837,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Color` **get_correlated_color**\ (\ ) |const| +:ref:`Color` **get_correlated_color**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Color` of an idealized blackbody at the given :ref:`light_temperature`. This value is calculated internally based on the :ref:`light_temperature`. This :ref:`Color` is multiplied by :ref:`light_color` before being sent to the :ref:`RenderingServer`. @@ -849,7 +849,7 @@ Returns the :ref:`Color` of an idealized blackbody at the given :re .. rst-class:: classref-method -:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the specified :ref:`Param` parameter. @@ -861,7 +861,7 @@ Returns the value of the specified :ref:`Param` parameter. .. rst-class:: classref-method -|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the specified :ref:`Param` parameter. diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index e0030910db1..94ffc9b8123 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -99,7 +99,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BakeQuality**: +enum **BakeQuality**: :ref:`🔗` .. _class_LightmapGI_constant_BAKE_QUALITY_LOW: @@ -141,7 +141,7 @@ Highest bake quality (slowest bake times). The quality of this preset can be adj .. rst-class:: classref-enumeration -enum **GenerateProbes**: +enum **GenerateProbes**: :ref:`🔗` .. _class_LightmapGI_constant_GENERATE_PROBES_DISABLED: @@ -191,7 +191,7 @@ Highest level of subdivision (slowest bake times, largest file sizes). .. rst-class:: classref-enumeration -enum **BakeError**: +enum **BakeError**: :ref:`🔗` .. _class_LightmapGI_constant_BAKE_ERROR_OK: @@ -281,7 +281,7 @@ Lightmap baking failed as the maximum texture size is too small to fit some of t .. rst-class:: classref-enumeration -enum **EnvironmentMode**: +enum **EnvironmentMode**: :ref:`🔗` .. _class_LightmapGI_constant_ENVIRONMENT_MODE_DISABLED: @@ -330,7 +330,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bias** = ``0.0005`` +:ref:`float` **bias** = ``0.0005`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +347,7 @@ The bias to use when computing shadows. Increasing :ref:`bias` **bounce_indirect_energy** = ``1.0`` +:ref:`float` **bounce_indirect_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -366,7 +366,7 @@ The energy multiplier for each bounce. Higher values will make indirect lighting .. rst-class:: classref-property -:ref:`int` **bounces** = ``3`` +:ref:`int` **bounces** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -383,7 +383,7 @@ Number of light bounces that are taken into account during baking. Higher values .. rst-class:: classref-property -:ref:`CameraAttributes` **camera_attributes** +:ref:`CameraAttributes` **camera_attributes** :ref:`🔗` .. rst-class:: classref-property-setget @@ -400,7 +400,7 @@ The :ref:`CameraAttributes` resource that specifies expo .. rst-class:: classref-property -:ref:`int` **denoiser_range** = ``10`` +:ref:`int` **denoiser_range** = ``10`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -417,7 +417,7 @@ The distance in pixels from which the denoiser samples. Lower values preserve mo .. rst-class:: classref-property -:ref:`float` **denoiser_strength** = ``0.1`` +:ref:`float` **denoiser_strength** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -434,7 +434,7 @@ The strength of denoising step applied to the generated lightmaps. Only effectiv .. rst-class:: classref-property -:ref:`bool` **directional** = ``false`` +:ref:`bool` **directional** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -453,7 +453,7 @@ If ``true``, bakes lightmaps to contain directional information as spherical har .. rst-class:: classref-property -:ref:`Color` **environment_custom_color** +:ref:`Color` **environment_custom_color** :ref:`🔗` .. rst-class:: classref-property-setget @@ -470,7 +470,7 @@ The color to use for environment lighting. Only effective if :ref:`environment_m .. rst-class:: classref-property -:ref:`float` **environment_custom_energy** +:ref:`float` **environment_custom_energy** :ref:`🔗` .. rst-class:: classref-property-setget @@ -487,7 +487,7 @@ The color multiplier to use for environment lighting. Only effective if :ref:`en .. rst-class:: classref-property -:ref:`Sky` **environment_custom_sky** +:ref:`Sky` **environment_custom_sky** :ref:`🔗` .. rst-class:: classref-property-setget @@ -504,7 +504,7 @@ The sky to use as a source of environment lighting. Only effective if :ref:`envi .. rst-class:: classref-property -:ref:`EnvironmentMode` **environment_mode** = ``1`` +:ref:`EnvironmentMode` **environment_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -521,7 +521,7 @@ The environment mode to use when baking lightmaps. .. rst-class:: classref-property -:ref:`GenerateProbes` **generate_probes_subdiv** = ``2`` +:ref:`GenerateProbes` **generate_probes_subdiv** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -542,7 +542,7 @@ The level of subdivision to use when automatically generating :ref:`LightmapProb .. rst-class:: classref-property -:ref:`bool` **interior** = ``false`` +:ref:`bool` **interior** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -559,7 +559,7 @@ If ``true``, ignore environment lighting when baking lightmaps. .. rst-class:: classref-property -:ref:`LightmapGIData` **light_data** +:ref:`LightmapGIData` **light_data** :ref:`🔗` .. rst-class:: classref-property-setget @@ -576,7 +576,7 @@ The :ref:`LightmapGIData` associated to this **LightmapGI* .. rst-class:: classref-property -:ref:`int` **max_texture_size** = ``16384`` +:ref:`int` **max_texture_size** = ``16384`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -593,7 +593,7 @@ The maximum texture size for the generated texture atlas. Higher values will res .. rst-class:: classref-property -:ref:`BakeQuality` **quality** = ``1`` +:ref:`BakeQuality` **quality** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -612,7 +612,7 @@ To further speed up bake times, decrease :ref:`bounces` **texel_scale** = ``1.0`` +:ref:`float` **texel_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -629,7 +629,7 @@ Scales the lightmap texel density of all meshes for the current bake. This is a .. rst-class:: classref-property -:ref:`bool` **use_denoiser** = ``true`` +:ref:`bool` **use_denoiser** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -646,7 +646,7 @@ If ``true``, uses a GPU-based denoising algorithm on the generated lightmap. Thi .. rst-class:: classref-property -:ref:`bool` **use_texture_for_bounces** = ``true`` +:ref:`bool` **use_texture_for_bounces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_lightmapgidata.rst b/classes/class_lightmapgidata.rst index 1b53b51ea15..5464710a4b6 100644 --- a/classes/class_lightmapgidata.rst +++ b/classes/class_lightmapgidata.rst @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`TextureLayered` **light_texture** +:ref:`TextureLayered` **light_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -89,7 +89,7 @@ The lightmap atlas texture generated by the lightmapper. .. rst-class:: classref-property -:ref:`Array`\[:ref:`TextureLayered`\] **lightmap_textures** = ``[]`` +:ref:`Array`\[:ref:`TextureLayered`\] **lightmap_textures** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_user**\ (\ path\: :ref:`NodePath`, uv_scale\: :ref:`Rect2`, slice_index\: :ref:`int`, sub_instance\: :ref:`int`\ ) +|void| **add_user**\ (\ path\: :ref:`NodePath`, uv_scale\: :ref:`Rect2`, slice_index\: :ref:`int`, sub_instance\: :ref:`int`\ ) :ref:`🔗` Adds an object that is considered baked within this **LightmapGIData**. @@ -123,7 +123,7 @@ Adds an object that is considered baked within this **LightmapGIData**. .. rst-class:: classref-method -|void| **clear_users**\ (\ ) +|void| **clear_users**\ (\ ) :ref:`🔗` Clear all objects that are considered baked within this **LightmapGIData**. @@ -135,7 +135,7 @@ Clear all objects that are considered baked within this **LightmapGIData**. .. rst-class:: classref-method -:ref:`int` **get_user_count**\ (\ ) |const| +:ref:`int` **get_user_count**\ (\ ) |const| :ref:`🔗` Returns the number of objects that are considered baked within this **LightmapGIData**. @@ -147,7 +147,7 @@ Returns the number of objects that are considered baked within this **LightmapGI .. rst-class:: classref-method -:ref:`NodePath` **get_user_path**\ (\ user_idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_user_path**\ (\ user_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`NodePath` of the baked object at index ``user_idx``. @@ -159,7 +159,7 @@ Returns the :ref:`NodePath` of the baked object at index ``user_ .. rst-class:: classref-method -:ref:`bool` **is_using_spherical_harmonics**\ (\ ) |const| +:ref:`bool` **is_using_spherical_harmonics**\ (\ ) |const| :ref:`🔗` If ``true``, lightmaps were baked with directional information. See also :ref:`LightmapGI.directional`. @@ -171,7 +171,7 @@ If ``true``, lightmaps were baked with directional information. See also :ref:`L .. rst-class:: classref-method -|void| **set_uses_spherical_harmonics**\ (\ uses_spherical_harmonics\: :ref:`bool`\ ) +|void| **set_uses_spherical_harmonics**\ (\ uses_spherical_harmonics\: :ref:`bool`\ ) :ref:`🔗` If ``uses_spherical_harmonics`` is ``true``, tells the engine to treat the lightmap data as if it was baked with directional information. diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 1dd3d414b04..694773969cc 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OccluderPolygon2D` **occluder** +:ref:`OccluderPolygon2D` **occluder** :ref:`🔗` .. rst-class:: classref-property-setget @@ -74,7 +74,7 @@ The :ref:`OccluderPolygon2D` used to compute the shadow .. rst-class:: classref-property -:ref:`int` **occluder_light_mask** = ``1`` +:ref:`int` **occluder_light_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -91,7 +91,7 @@ The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows .. rst-class:: classref-property -:ref:`bool` **sdf_collision** = ``true`` +:ref:`bool` **sdf_collision** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index ebdfae3c337..94a6f0a3ac6 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -107,7 +107,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **LineJointMode**: +enum **LineJointMode**: :ref:`🔗` .. _class_Line2D_constant_LINE_JOINT_SHARP: @@ -141,7 +141,7 @@ Makes the polyline's joints rounded, connecting the sides of the two segments wi .. rst-class:: classref-enumeration -enum **LineCapMode**: +enum **LineCapMode**: :ref:`🔗` .. _class_Line2D_constant_LINE_CAP_NONE: @@ -175,7 +175,7 @@ Draws the line cap as a semicircle attached to the first/last segment. .. rst-class:: classref-enumeration -enum **LineTextureMode**: +enum **LineTextureMode**: :ref:`🔗` .. _class_Line2D_constant_LINE_TEXTURE_NONE: @@ -214,7 +214,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **antialiased** = ``false`` +:ref:`bool` **antialiased** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -233,7 +233,7 @@ If ``true``, the polyline's border will be anti-aliased. .. rst-class:: classref-property -:ref:`LineCapMode` **begin_cap_mode** = ``0`` +:ref:`LineCapMode` **begin_cap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -250,7 +250,7 @@ The style of the beginning of the polyline, if :ref:`closed` **closed** = ``false`` +:ref:`bool` **closed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ If ``true`` and the polyline has more than 2 points, the last point and the firs .. rst-class:: classref-property -:ref:`Color` **default_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **default_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -288,7 +288,7 @@ The color of the polyline. Will not be used if a gradient is set. .. rst-class:: classref-property -:ref:`LineCapMode` **end_cap_mode** = ``0`` +:ref:`LineCapMode` **end_cap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -305,7 +305,7 @@ The style of the end of the polyline, if :ref:`closed` **gradient** +:ref:`Gradient` **gradient** :ref:`🔗` .. rst-class:: classref-property-setget @@ -322,7 +322,7 @@ The gradient is drawn through the whole line from start to finish. The :ref:`def .. rst-class:: classref-property -:ref:`LineJointMode` **joint_mode** = ``0`` +:ref:`LineJointMode` **joint_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -339,7 +339,7 @@ The style of the connections between segments of the polyline. Use :ref:`LineJoi .. rst-class:: classref-property -:ref:`PackedVector2Array` **points** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **points** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ The points of the polyline, interpreted in local 2D coordinates. Segments are dr .. rst-class:: classref-property -:ref:`int` **round_precision** = ``8`` +:ref:`int` **round_precision** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ The smoothness used for rounded joints and caps. Higher values result in smoothe .. rst-class:: classref-property -:ref:`float` **sharp_limit** = ``2.0`` +:ref:`float` **sharp_limit** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ Determines the miter limit of the polyline. Normally, when :ref:`joint_mode` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -409,7 +409,7 @@ The texture used for the polyline. Uses :ref:`texture_mode` **texture_mode** = ``0`` +:ref:`LineTextureMode` **texture_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -426,7 +426,7 @@ The style to render the :ref:`texture` of the pol .. rst-class:: classref-property -:ref:`float` **width** = ``10.0`` +:ref:`float` **width** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -443,7 +443,7 @@ The polyline's width. .. rst-class:: classref-property -:ref:`Curve` **width_curve** +:ref:`Curve` **width_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -465,7 +465,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_point**\ (\ position\: :ref:`Vector2`, index\: :ref:`int` = -1\ ) +|void| **add_point**\ (\ position\: :ref:`Vector2`, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a point with the specified ``position`` relative to the polyline's own position. If no ``index`` is provided, the new point will be added to the end of the points array. @@ -479,7 +479,7 @@ If ``index`` is given, the new point is inserted before the existing point ident .. rst-class:: classref-method -|void| **clear_points**\ (\ ) +|void| **clear_points**\ (\ ) :ref:`🔗` Removes all points from the polyline, making it empty. @@ -491,7 +491,7 @@ Removes all points from the polyline, making it empty. .. rst-class:: classref-method -:ref:`int` **get_point_count**\ (\ ) |const| +:ref:`int` **get_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of points in the polyline. @@ -503,7 +503,7 @@ Returns the number of points in the polyline. .. rst-class:: classref-method -:ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the point at index ``index``. @@ -515,7 +515,7 @@ Returns the position of the point at index ``index``. .. rst-class:: classref-method -|void| **remove_point**\ (\ index\: :ref:`int`\ ) +|void| **remove_point**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes the point at index ``index`` from the polyline. @@ -527,7 +527,7 @@ Removes the point at index ``index`` from the polyline. .. rst-class:: classref-method -|void| **set_point_position**\ (\ index\: :ref:`int`, position\: :ref:`Vector2`\ ) +|void| **set_point_position**\ (\ index\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Overwrites the position of the point at the given ``index`` with the supplied ``position``. diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 3a954fe09dc..a084669c4cc 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -239,7 +239,7 @@ Signals .. rst-class:: classref-signal -**text_change_rejected**\ (\ rejected_substring\: :ref:`String`\ ) +**text_change_rejected**\ (\ rejected_substring\: :ref:`String`\ ) :ref:`🔗` Emitted when appending text that overflows the :ref:`max_length`. The appended text is truncated to fit :ref:`max_length`, and the part that couldn't fit is passed as the ``rejected_substring`` argument. @@ -251,7 +251,7 @@ Emitted when appending text that overflows the :ref:`max_length`\ ) +**text_changed**\ (\ new_text\: :ref:`String`\ ) :ref:`🔗` Emitted when the text changes. @@ -263,7 +263,7 @@ Emitted when the text changes. .. rst-class:: classref-signal -**text_submitted**\ (\ new_text\: :ref:`String`\ ) +**text_submitted**\ (\ new_text\: :ref:`String`\ ) :ref:`🔗` Emitted when the user presses :ref:`@GlobalScope.KEY_ENTER` on the **LineEdit**. @@ -280,7 +280,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MenuItems**: +enum **MenuItems**: :ref:`🔗` .. _class_LineEdit_constant_MENU_CUT: @@ -540,7 +540,7 @@ Represents the size of the :ref:`MenuItems` enum. .. rst-class:: classref-enumeration -enum **VirtualKeyboardType**: +enum **VirtualKeyboardType**: :ref:`🔗` .. _class_LineEdit_constant_KEYBOARD_TYPE_DEFAULT: @@ -621,7 +621,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`HorizontalAlignment` **alignment** = ``0`` +:ref:`HorizontalAlignment` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -638,7 +638,7 @@ Text alignment as defined in the :ref:`HorizontalAlignment` **caret_blink** = ``false`` +:ref:`bool` **caret_blink** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -655,7 +655,7 @@ If ``true``, makes the caret blink. .. rst-class:: classref-property -:ref:`float` **caret_blink_interval** = ``0.65`` +:ref:`float` **caret_blink_interval** = ``0.65`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -672,7 +672,7 @@ The interval at which the caret blinks (in seconds). .. rst-class:: classref-property -:ref:`int` **caret_column** = ``0`` +:ref:`int` **caret_column** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -689,7 +689,7 @@ The caret's column position inside the **LineEdit**. When set, the text may scro .. rst-class:: classref-property -:ref:`bool` **caret_force_displayed** = ``false`` +:ref:`bool` **caret_force_displayed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -706,7 +706,7 @@ If ``true``, the **LineEdit** will always show the caret, even if focus is lost. .. rst-class:: classref-property -:ref:`bool` **caret_mid_grapheme** = ``false`` +:ref:`bool` **caret_mid_grapheme** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -725,7 +725,7 @@ Allow moving caret, selecting and removing the individual composite character co .. rst-class:: classref-property -:ref:`bool` **clear_button_enabled** = ``false`` +:ref:`bool` **clear_button_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -742,7 +742,7 @@ If ``true``, the **LineEdit** will show a clear button if :ref:`text` **context_menu_enabled** = ``true`` +:ref:`bool` **context_menu_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -759,7 +759,7 @@ If ``true``, the context menu will appear when right-clicked. .. rst-class:: classref-property -:ref:`bool` **deselect_on_focus_loss_enabled** = ``true`` +:ref:`bool` **deselect_on_focus_loss_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -776,7 +776,7 @@ If ``true``, the selected text will be deselected when focus is lost. .. rst-class:: classref-property -:ref:`bool` **drag_and_drop_selection_enabled** = ``true`` +:ref:`bool` **drag_and_drop_selection_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -793,7 +793,7 @@ If ``true``, allow drag and drop of selected text. .. rst-class:: classref-property -:ref:`bool` **draw_control_chars** = ``false`` +:ref:`bool` **draw_control_chars** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -810,7 +810,7 @@ If ``true``, control characters are displayed. .. rst-class:: classref-property -:ref:`bool` **editable** = ``true`` +:ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -827,7 +827,7 @@ If ``false``, existing text cannot be modified and new text cannot be added. .. rst-class:: classref-property -:ref:`bool` **expand_to_text_length** = ``false`` +:ref:`bool` **expand_to_text_length** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -844,7 +844,7 @@ If ``true``, the **LineEdit** width will increase to stay longer than the :ref:` .. rst-class:: classref-property -:ref:`bool` **flat** = ``false`` +:ref:`bool` **flat** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -861,7 +861,7 @@ If ``true``, the **LineEdit** doesn't display decoration. .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -878,7 +878,7 @@ Language code used for line-breaking and text shaping algorithms. If left empty, .. rst-class:: classref-property -:ref:`int` **max_length** = ``0`` +:ref:`int` **max_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -924,7 +924,7 @@ When a limit is defined, characters that would exceed :ref:`max_length` **middle_mouse_paste_enabled** = ``true`` +:ref:`bool` **middle_mouse_paste_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -943,7 +943,7 @@ If ``false``, using middle mouse button to paste clipboard will be disabled. .. rst-class:: classref-property -:ref:`String` **placeholder_text** = ``""`` +:ref:`String` **placeholder_text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -960,7 +960,7 @@ Text shown when the **LineEdit** is empty. It is **not** the **LineEdit**'s defa .. rst-class:: classref-property -:ref:`Texture2D` **right_icon** +:ref:`Texture2D` **right_icon** :ref:`🔗` .. rst-class:: classref-property-setget @@ -977,7 +977,7 @@ Sets the icon that will appear in the right end of the **LineEdit** if there's n .. rst-class:: classref-property -:ref:`bool` **secret** = ``false`` +:ref:`bool` **secret** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -994,7 +994,7 @@ If ``true``, every character is replaced with the secret character (see :ref:`se .. rst-class:: classref-property -:ref:`String` **secret_character** = ``"•"`` +:ref:`String` **secret_character** = ``"•"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1011,7 +1011,7 @@ The character to use to mask secret input. Only a single character can be used a .. rst-class:: classref-property -:ref:`bool` **select_all_on_focus** = ``false`` +:ref:`bool` **select_all_on_focus** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1028,7 +1028,7 @@ If ``true``, the **LineEdit** will select the whole text when it gains focus. .. rst-class:: classref-property -:ref:`bool` **selecting_enabled** = ``true`` +:ref:`bool` **selecting_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1045,7 +1045,7 @@ If ``false``, it's impossible to select the text using mouse nor keyboard. .. rst-class:: classref-property -:ref:`bool` **shortcut_keys_enabled** = ``true`` +:ref:`bool` **shortcut_keys_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1062,7 +1062,7 @@ If ``false``, using shortcuts will be disabled. .. rst-class:: classref-property -:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1079,7 +1079,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1096,7 +1096,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1115,7 +1115,7 @@ String value of the **LineEdit**. .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1132,7 +1132,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`bool` **virtual_keyboard_enabled** = ``true`` +:ref:`bool` **virtual_keyboard_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1149,7 +1149,7 @@ If ``true``, the native virtual keyboard is shown when focused on platforms that .. rst-class:: classref-property -:ref:`VirtualKeyboardType` **virtual_keyboard_type** = ``0`` +:ref:`VirtualKeyboardType` **virtual_keyboard_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1171,7 +1171,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Erases the **LineEdit**'s :ref:`text`. @@ -1183,7 +1183,7 @@ Erases the **LineEdit**'s :ref:`text`. .. rst-class:: classref-method -|void| **delete_char_at_caret**\ (\ ) +|void| **delete_char_at_caret**\ (\ ) :ref:`🔗` Deletes one character at the caret's current position (equivalent to pressing :kbd:`Delete`). @@ -1195,7 +1195,7 @@ Deletes one character at the caret's current position (equivalent to pressing :k .. rst-class:: classref-method -|void| **delete_text**\ (\ from_column\: :ref:`int`, to_column\: :ref:`int`\ ) +|void| **delete_text**\ (\ from_column\: :ref:`int`, to_column\: :ref:`int`\ ) :ref:`🔗` Deletes a section of the :ref:`text` going from position ``from_column`` to ``to_column``. Both parameters should be within the text's length. @@ -1207,7 +1207,7 @@ Deletes a section of the :ref:`text` going from po .. rst-class:: classref-method -|void| **deselect**\ (\ ) +|void| **deselect**\ (\ ) :ref:`🔗` Clears the current selection. @@ -1219,7 +1219,7 @@ Clears the current selection. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu**\ (\ ) |const| +:ref:`PopupMenu` **get_menu**\ (\ ) |const| :ref:`🔗` Returns the :ref:`PopupMenu` of this **LineEdit**. By default, this menu is displayed when right-clicking on the **LineEdit**. @@ -1278,7 +1278,7 @@ You can add custom menu items or remove standard ones. Make sure your IDs don't .. rst-class:: classref-method -:ref:`float` **get_scroll_offset**\ (\ ) |const| +:ref:`float` **get_scroll_offset**\ (\ ) |const| :ref:`🔗` Returns the scroll offset due to :ref:`caret_column`, as a number of characters. @@ -1290,7 +1290,7 @@ Returns the scroll offset due to :ref:`caret_column` **get_selected_text**\ (\ ) +:ref:`String` **get_selected_text**\ (\ ) :ref:`🔗` Returns the text inside the selection. @@ -1302,7 +1302,7 @@ Returns the text inside the selection. .. rst-class:: classref-method -:ref:`int` **get_selection_from_column**\ (\ ) |const| +:ref:`int` **get_selection_from_column**\ (\ ) |const| :ref:`🔗` Returns the selection begin column. @@ -1314,7 +1314,7 @@ Returns the selection begin column. .. rst-class:: classref-method -:ref:`int` **get_selection_to_column**\ (\ ) |const| +:ref:`int` **get_selection_to_column**\ (\ ) |const| :ref:`🔗` Returns the selection end column. @@ -1326,7 +1326,7 @@ Returns the selection end column. .. rst-class:: classref-method -:ref:`bool` **has_selection**\ (\ ) |const| +:ref:`bool` **has_selection**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the user has selected text. @@ -1338,7 +1338,7 @@ Returns ``true`` if the user has selected text. .. rst-class:: classref-method -|void| **insert_text_at_caret**\ (\ text\: :ref:`String`\ ) +|void| **insert_text_at_caret**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Inserts ``text`` at the caret. If the resulting value is longer than :ref:`max_length`, nothing happens. @@ -1350,7 +1350,7 @@ Inserts ``text`` at the caret. If the resulting value is longer than :ref:`max_l .. rst-class:: classref-method -:ref:`bool` **is_menu_visible**\ (\ ) |const| +:ref:`bool` **is_menu_visible**\ (\ ) |const| :ref:`🔗` Returns whether the menu is visible. Use this instead of ``get_menu().visible`` to improve performance (so the creation of the menu is avoided). @@ -1362,7 +1362,7 @@ Returns whether the menu is visible. Use this instead of ``get_menu().visible`` .. rst-class:: classref-method -|void| **menu_option**\ (\ option\: :ref:`int`\ ) +|void| **menu_option**\ (\ option\: :ref:`int`\ ) :ref:`🔗` Executes a given action as defined in the :ref:`MenuItems` enum. @@ -1374,7 +1374,7 @@ Executes a given action as defined in the :ref:`MenuItems` = 0, to\: :ref:`int` = -1\ ) +|void| **select**\ (\ from\: :ref:`int` = 0, to\: :ref:`int` = -1\ ) :ref:`🔗` Selects characters inside **LineEdit** between ``from`` and ``to``. By default, ``from`` is at the beginning and ``to`` at the end. @@ -1405,7 +1405,7 @@ Selects characters inside **LineEdit** between ``from`` and ``to``. By default, .. rst-class:: classref-method -|void| **select_all**\ (\ ) +|void| **select_all**\ (\ ) :ref:`🔗` Selects the whole :ref:`String`. @@ -1422,7 +1422,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **caret_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **caret_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Color of the **LineEdit**'s caret (text cursor). This can be set to a fully transparent color to hide the caret entirely. @@ -1434,7 +1434,7 @@ Color of the **LineEdit**'s caret (text cursor). This can be set to a fully tran .. rst-class:: classref-themeproperty -:ref:`Color` **clear_button_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **clear_button_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Color used as default tint for the clear button. @@ -1446,7 +1446,7 @@ Color used as default tint for the clear button. .. rst-class:: classref-themeproperty -:ref:`Color` **clear_button_color_pressed** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **clear_button_color_pressed** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Color used for the clear button when it's pressed. @@ -1458,7 +1458,7 @@ Color used for the clear button when it's pressed. .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Default font color. @@ -1470,7 +1470,7 @@ Default font color. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the **LineEdit**. @@ -1482,7 +1482,7 @@ The tint of text outline of the **LineEdit**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_placeholder_color** = ``Color(0.875, 0.875, 0.875, 0.6)`` +:ref:`Color` **font_placeholder_color** = ``Color(0.875, 0.875, 0.875, 0.6)`` :ref:`🔗` Font color for :ref:`placeholder_text`. @@ -1494,7 +1494,7 @@ Font color for :ref:`placeholder_text` .. rst-class:: classref-themeproperty -:ref:`Color` **font_selected_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Font color for selected text (inside the selection rectangle). @@ -1506,7 +1506,7 @@ Font color for selected text (inside the selection rectangle). .. rst-class:: classref-themeproperty -:ref:`Color` **font_uneditable_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_uneditable_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Font color when editing is disabled. @@ -1518,7 +1518,7 @@ Font color when editing is disabled. .. rst-class:: classref-themeproperty -:ref:`Color` **selection_color** = ``Color(0.5, 0.5, 0.5, 1)`` +:ref:`Color` **selection_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` Color of the selection rectangle. @@ -1530,7 +1530,7 @@ Color of the selection rectangle. .. rst-class:: classref-themeproperty -:ref:`int` **caret_width** = ``1`` +:ref:`int` **caret_width** = ``1`` :ref:`🔗` The caret's width in pixels. Greater values can be used to improve accessibility by ensuring the caret is easily visible, or to ensure consistency with a large font size. @@ -1542,7 +1542,7 @@ The caret's width in pixels. Greater values can be used to improve accessibility .. rst-class:: classref-themeproperty -:ref:`int` **minimum_character_width** = ``4`` +:ref:`int` **minimum_character_width** = ``4`` :ref:`🔗` Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of 'M' characters (i.e. this number of 'M' characters can be displayed without scrolling). @@ -1554,7 +1554,7 @@ Minimum horizontal space for the text (not counting the clear button and content .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -1568,7 +1568,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` Font used for the text. @@ -1580,7 +1580,7 @@ Font used for the text. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the **LineEdit**'s text. @@ -1592,7 +1592,7 @@ Font size of the **LineEdit**'s text. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **clear** +:ref:`Texture2D` **clear** :ref:`🔗` Texture for the clear button. See :ref:`clear_button_enabled`. @@ -1604,7 +1604,7 @@ Texture for the clear button. See :ref:`clear_button_enabled` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` Background used when **LineEdit** has GUI focus. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -1616,7 +1616,7 @@ Background used when **LineEdit** has GUI focus. The :ref:`focus` **normal** +:ref:`StyleBox` **normal** :ref:`🔗` Default background for the **LineEdit**. @@ -1628,7 +1628,7 @@ Default background for the **LineEdit**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **read_only** +:ref:`StyleBox` **read_only** :ref:`🔗` Background used when **LineEdit** is in read-only mode (:ref:`editable` is set to ``false``). diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index d01853feb62..6a6f3fca4d4 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -98,7 +98,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **UnderlineMode**: +enum **UnderlineMode**: :ref:`🔗` .. _class_LinkButton_constant_UNDERLINE_MODE_ALWAYS: @@ -137,7 +137,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ The button's text that will be displayed inside the button's area. .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`UnderlineMode` **underline** = ``0`` +:ref:`UnderlineMode` **underline** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ The underline mode to use for the text. See :ref:`UnderlineMode` **uri** = ``""`` +:ref:`String` **uri** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -280,7 +280,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Default text :ref:`Color` of the **LinkButton**. @@ -292,7 +292,7 @@ Default text :ref:`Color` of the **LinkButton**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_disabled_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_disabled_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` Text :ref:`Color` used when the **LinkButton** is disabled. @@ -304,7 +304,7 @@ Text :ref:`Color` used when the **LinkButton** is disabled. .. rst-class:: classref-themeproperty -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` 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. @@ -316,7 +316,7 @@ Text :ref:`Color` used when the **LinkButton** is focused. Only rep .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Text :ref:`Color` used when the **LinkButton** is being hovered. @@ -328,7 +328,7 @@ Text :ref:`Color` used when the **LinkButton** is being hovered. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_pressed_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_hover_pressed_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` Text :ref:`Color` used when the **LinkButton** is being hovered and pressed. @@ -340,7 +340,7 @@ Text :ref:`Color` used when the **LinkButton** is being hovered and .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the **LinkButton**. @@ -352,7 +352,7 @@ The tint of text outline of the **LinkButton**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the **LinkButton** is being pressed. @@ -364,7 +364,7 @@ Text :ref:`Color` used when the **LinkButton** is being pressed. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -378,7 +378,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`int` **underline_spacing** = ``2`` +:ref:`int` **underline_spacing** = ``2`` :ref:`🔗` The vertical space between the baseline of text and the underline. @@ -390,7 +390,7 @@ The vertical space between the baseline of text and the underline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` of the **LinkButton**'s text. @@ -402,7 +402,7 @@ The vertical space between the baseline of text and the underline. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the **LinkButton**'s text. @@ -414,7 +414,7 @@ Font size of the **LinkButton**'s text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` :ref:`StyleBox` used when the **LinkButton** is focused. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 98ba40d049b..87540476895 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -112,7 +112,7 @@ Signals .. rst-class:: classref-signal -**on_request_permissions_result**\ (\ permission\: :ref:`String`, granted\: :ref:`bool`\ ) +**on_request_permissions_result**\ (\ permission\: :ref:`String`, granted\: :ref:`bool`\ ) :ref:`🔗` Emitted when a user responds to a permission request. @@ -129,7 +129,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_OS_MEMORY_WARNING** = ``2009`` +**NOTIFICATION_OS_MEMORY_WARNING** = ``2009`` :ref:`🔗` Notification received from the OS when the application is exceeding its allocated memory. @@ -139,7 +139,7 @@ Specific to the iOS platform. .. rst-class:: classref-constant -**NOTIFICATION_TRANSLATION_CHANGED** = ``2010`` +**NOTIFICATION_TRANSLATION_CHANGED** = ``2010`` :ref:`🔗` Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. @@ -147,7 +147,7 @@ Notification received when translations may have changed. Can be triggered by th .. rst-class:: classref-constant -**NOTIFICATION_WM_ABOUT** = ``2011`` +**NOTIFICATION_WM_ABOUT** = ``2011`` :ref:`🔗` Notification received from the OS when a request for "About" information is sent. @@ -157,7 +157,7 @@ Specific to the macOS platform. .. rst-class:: classref-constant -**NOTIFICATION_CRASH** = ``2012`` +**NOTIFICATION_CRASH** = ``2012`` :ref:`🔗` Notification received from Godot's crash handler when the engine is about to crash. @@ -167,7 +167,7 @@ Implemented on desktop platforms if the crash handler is enabled. .. rst-class:: classref-constant -**NOTIFICATION_OS_IME_UPDATE** = ``2013`` +**NOTIFICATION_OS_IME_UPDATE** = ``2013`` :ref:`🔗` Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). @@ -177,7 +177,7 @@ Specific to the macOS platform. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_RESUMED** = ``2014`` +**NOTIFICATION_APPLICATION_RESUMED** = ``2014`` :ref:`🔗` Notification received from the OS when the application is resumed. @@ -187,7 +187,7 @@ Specific to the Android and iOS platforms. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_PAUSED** = ``2015`` +**NOTIFICATION_APPLICATION_PAUSED** = ``2015`` :ref:`🔗` Notification received from the OS when the application is paused. @@ -199,7 +199,7 @@ Specific to the Android and iOS platforms. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_FOCUS_IN** = ``2016`` +**NOTIFICATION_APPLICATION_FOCUS_IN** = ``2016`` :ref:`🔗` Notification received from the OS when the application is focused, i.e. when changing the focus from the OS desktop or a thirdparty application to any open window of the Godot instance. @@ -209,7 +209,7 @@ Implemented on desktop and mobile platforms. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_FOCUS_OUT** = ``2017`` +**NOTIFICATION_APPLICATION_FOCUS_OUT** = ``2017`` :ref:`🔗` Notification received from the OS when the application is defocused, i.e. when changing the focus from any open window of the Godot instance to the OS desktop or a thirdparty application. @@ -219,7 +219,7 @@ Implemented on desktop and mobile platforms. .. rst-class:: classref-constant -**NOTIFICATION_TEXT_SERVER_CHANGED** = ``2018`` +**NOTIFICATION_TEXT_SERVER_CHANGED** = ``2018`` :ref:`🔗` Notification received when text server is changed. @@ -236,7 +236,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_finalize**\ (\ ) |virtual| +|void| **_finalize**\ (\ ) |virtual| :ref:`🔗` Called before the program exits. @@ -248,7 +248,7 @@ Called before the program exits. .. rst-class:: classref-method -|void| **_initialize**\ (\ ) |virtual| +|void| **_initialize**\ (\ ) |virtual| :ref:`🔗` Called once during initialization. @@ -260,7 +260,7 @@ Called once during initialization. .. rst-class:: classref-method -:ref:`bool` **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| +:ref:`bool` **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` Called each physics frame with the time since the last physics frame as argument (``delta``, in seconds). Equivalent to :ref:`Node._physics_process`. @@ -274,7 +274,7 @@ If implemented, the method must return a boolean value. ``true`` ends the main l .. rst-class:: classref-method -:ref:`bool` **_process**\ (\ delta\: :ref:`float`\ ) |virtual| +:ref:`bool` **_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` Called each process (idle) frame with the time since the last process frame as argument (in seconds). Equivalent to :ref:`Node._process`. diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 8269695ce5e..c3a1faaa121 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -87,7 +87,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **margin_bottom** = ``0`` +:ref:`int` **margin_bottom** = ``0`` :ref:`🔗` Offsets towards the inside direct children of the container by this amount of pixels from the bottom. @@ -99,7 +99,7 @@ Offsets towards the inside direct children of the container by this amount of pi .. rst-class:: classref-themeproperty -:ref:`int` **margin_left** = ``0`` +:ref:`int` **margin_left** = ``0`` :ref:`🔗` Offsets towards the inside direct children of the container by this amount of pixels from the left. @@ -111,7 +111,7 @@ Offsets towards the inside direct children of the container by this amount of pi .. rst-class:: classref-themeproperty -:ref:`int` **margin_right** = ``0`` +:ref:`int` **margin_right** = ``0`` :ref:`🔗` Offsets towards the inside direct children of the container by this amount of pixels from the right. @@ -123,7 +123,7 @@ Offsets towards the inside direct children of the container by this amount of pi .. rst-class:: classref-themeproperty -:ref:`int` **margin_top** = ``0`` +:ref:`int` **margin_top** = ``0`` :ref:`🔗` Offsets towards the inside direct children of the container by this amount of pixels from the top. diff --git a/classes/class_marker2d.rst b/classes/class_marker2d.rst index 6bf588f94e1..2f3bb6d1aab 100644 --- a/classes/class_marker2d.rst +++ b/classes/class_marker2d.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **gizmo_extents** = ``10.0`` +:ref:`float` **gizmo_extents** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_marker3d.rst b/classes/class_marker3d.rst index 0077ebb3fd0..da67a12828d 100644 --- a/classes/class_marker3d.rst +++ b/classes/class_marker3d.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **gizmo_extents** = ``0.25`` +:ref:`float` **gizmo_extents** = ``0.25`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 59d0d562d1b..98d1a81a7d6 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **base64_to_raw**\ (\ base64_str\: :ref:`String`\ ) +:ref:`PackedByteArray` **base64_to_raw**\ (\ base64_str\: :ref:`String`\ ) :ref:`🔗` Returns a decoded :ref:`PackedByteArray` corresponding to the Base64-encoded string ``base64_str``. @@ -68,7 +68,7 @@ Returns a decoded :ref:`PackedByteArray` corresponding to .. rst-class:: classref-method -:ref:`String` **base64_to_utf8**\ (\ base64_str\: :ref:`String`\ ) +:ref:`String` **base64_to_utf8**\ (\ base64_str\: :ref:`String`\ ) :ref:`🔗` Returns a decoded string corresponding to the Base64-encoded string ``base64_str``. @@ -80,7 +80,7 @@ Returns a decoded string corresponding to the Base64-encoded string ``base64_str .. rst-class:: classref-method -:ref:`Variant` **base64_to_variant**\ (\ base64_str\: :ref:`String`, allow_objects\: :ref:`bool` = false\ ) +:ref:`Variant` **base64_to_variant**\ (\ base64_str\: :ref:`String`, allow_objects\: :ref:`bool` = false\ ) :ref:`🔗` Returns a decoded :ref:`Variant` corresponding to the Base64-encoded string ``base64_str``. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -96,7 +96,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -:ref:`String` **raw_to_base64**\ (\ array\: :ref:`PackedByteArray`\ ) +:ref:`String` **raw_to_base64**\ (\ array\: :ref:`PackedByteArray`\ ) :ref:`🔗` Returns a Base64-encoded string of a given :ref:`PackedByteArray`. @@ -108,7 +108,7 @@ Returns a Base64-encoded string of a given :ref:`PackedByteArray` **utf8_to_base64**\ (\ utf8_str\: :ref:`String`\ ) +:ref:`String` **utf8_to_base64**\ (\ utf8_str\: :ref:`String`\ ) :ref:`🔗` Returns a Base64-encoded string of the UTF-8 string ``utf8_str``. @@ -120,7 +120,7 @@ Returns a Base64-encoded string of the UTF-8 string ``utf8_str``. .. rst-class:: classref-method -:ref:`String` **variant_to_base64**\ (\ variant\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) +:ref:`String` **variant_to_base64**\ (\ variant\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) :ref:`🔗` Returns a Base64-encoded string of the :ref:`Variant` ``variant``. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). diff --git a/classes/class_material.rst b/classes/class_material.rst index cb16e96a823..659b2dc8ceb 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -83,7 +83,7 @@ Constants .. rst-class:: classref-constant -**RENDER_PRIORITY_MAX** = ``127`` +**RENDER_PRIORITY_MAX** = ``127`` :ref:`🔗` Maximum value for the :ref:`render_priority` parameter. @@ -91,7 +91,7 @@ Maximum value for the :ref:`render_priority` Minimum value for the :ref:`render_priority` parameter. @@ -108,7 +108,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Material` **next_pass** +:ref:`Material` **next_pass** :ref:`🔗` .. rst-class:: classref-property-setget @@ -129,14 +129,14 @@ Sets the **Material** to be used for the next pass. This renders the object agai .. rst-class:: classref-property -:ref:`int` **render_priority** +:ref:`int` **render_priority** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_render_priority**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_render_priority**\ (\ ) -Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with :ref:`render_priority` ``1`` will render before all objects with :ref:`render_priority` ``0``). +Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with :ref:`render_priority` ``1`` will render before all objects with :ref:`render_priority` ``0``. \ **Note:** This only applies to :ref:`StandardMaterial3D`\ s and :ref:`ShaderMaterial`\ s with type "Spatial". @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_do_next_pass**\ (\ ) |virtual| |const| +:ref:`bool` **_can_do_next_pass**\ (\ ) |virtual| |const| :ref:`🔗` Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if :ref:`next_pass` should be shown in the editor or not. @@ -167,7 +167,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`bool` **_can_use_render_priority**\ (\ ) |virtual| |const| +:ref:`bool` **_can_use_render_priority**\ (\ ) |virtual| |const| :ref:`🔗` Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if :ref:`render_priority` should be shown in the editor or not. @@ -179,7 +179,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`Mode` **_get_shader_mode**\ (\ ) |virtual| |const| +:ref:`Mode` **_get_shader_mode**\ (\ ) |virtual| |const| :ref:`🔗` Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. @@ -191,7 +191,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`RID` **_get_shader_rid**\ (\ ) |virtual| |const| +:ref:`RID` **_get_shader_rid**\ (\ ) |virtual| |const| :ref:`🔗` Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. Used to access the RID of the **Material**'s :ref:`Shader`. @@ -203,7 +203,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderMaterial`). @@ -215,7 +215,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderMaterial` Only available when running in the editor. Opens a popup that visualizes the generated shader code, including all variants and internal shader code. diff --git a/classes/class_menubar.rst b/classes/class_menubar.rst index 6061d287d03..24c7825ed93 100644 --- a/classes/class_menubar.rst +++ b/classes/class_menubar.rst @@ -142,7 +142,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **flat** = ``false`` +:ref:`bool` **flat** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Flat **MenuBar** don't display item decoration. .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`bool` **prefer_global_menu** = ``true`` +:ref:`bool` **prefer_global_menu** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ If ``true``, **MenuBar** will use system global menu when supported. .. rst-class:: classref-property -:ref:`int` **start_index** = ``-1`` +:ref:`int` **start_index** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ Position in the global menu to insert first **MenuBar** item at. .. rst-class:: classref-property -:ref:`bool` **switch_on_hover** = ``true`` +:ref:`bool` **switch_on_hover** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -227,7 +227,7 @@ If ``true``, when the cursor hovers above menu item, it will close the current : .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -249,7 +249,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_menu_count**\ (\ ) |const| +:ref:`int` **get_menu_count**\ (\ ) |const| :ref:`🔗` Returns number of menu items. @@ -261,7 +261,7 @@ Returns number of menu items. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu_popup**\ (\ menu\: :ref:`int`\ ) |const| +:ref:`PopupMenu` **get_menu_popup**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` Returns :ref:`PopupMenu` associated with menu item. @@ -273,7 +273,7 @@ Returns :ref:`PopupMenu` associated with menu item. .. rst-class:: classref-method -:ref:`String` **get_menu_title**\ (\ menu\: :ref:`int`\ ) |const| +:ref:`String` **get_menu_title**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` Returns menu item title. @@ -285,7 +285,7 @@ Returns menu item title. .. rst-class:: classref-method -:ref:`String` **get_menu_tooltip**\ (\ menu\: :ref:`int`\ ) |const| +:ref:`String` **get_menu_tooltip**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` Returns menu item tooltip. @@ -297,7 +297,7 @@ Returns menu item tooltip. .. rst-class:: classref-method -:ref:`bool` **is_menu_disabled**\ (\ menu\: :ref:`int`\ ) |const| +:ref:`bool` **is_menu_disabled**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true``, if menu item is disabled. @@ -309,7 +309,7 @@ Returns ``true``, if menu item is disabled. .. rst-class:: classref-method -:ref:`bool` **is_menu_hidden**\ (\ menu\: :ref:`int`\ ) |const| +:ref:`bool` **is_menu_hidden**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true``, if menu item is hidden. @@ -321,7 +321,7 @@ Returns ``true``, if menu item is hidden. .. rst-class:: classref-method -:ref:`bool` **is_native_menu**\ (\ ) |const| +:ref:`bool` **is_native_menu**\ (\ ) |const| :ref:`🔗` Returns ``true``, if system global menu is supported and used by this **MenuBar**. @@ -333,7 +333,7 @@ Returns ``true``, if system global menu is supported and used by this **MenuBar* .. rst-class:: classref-method -|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) +|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, shortcuts are disabled and cannot be used to trigger the button. @@ -345,7 +345,7 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. .. rst-class:: classref-method -|void| **set_menu_disabled**\ (\ menu\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_menu_disabled**\ (\ menu\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, menu item is disabled. @@ -357,7 +357,7 @@ If ``true``, menu item is disabled. .. rst-class:: classref-method -|void| **set_menu_hidden**\ (\ menu\: :ref:`int`, hidden\: :ref:`bool`\ ) +|void| **set_menu_hidden**\ (\ menu\: :ref:`int`, hidden\: :ref:`bool`\ ) :ref:`🔗` If ``true``, menu item is hidden. @@ -369,7 +369,7 @@ If ``true``, menu item is hidden. .. rst-class:: classref-method -|void| **set_menu_title**\ (\ menu\: :ref:`int`, title\: :ref:`String`\ ) +|void| **set_menu_title**\ (\ menu\: :ref:`int`, title\: :ref:`String`\ ) :ref:`🔗` Sets menu item title. @@ -381,7 +381,7 @@ Sets menu item title. .. rst-class:: classref-method -|void| **set_menu_tooltip**\ (\ menu\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_menu_tooltip**\ (\ menu\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets menu item tooltip. @@ -398,7 +398,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Default text :ref:`Color` of the menu item. @@ -410,7 +410,7 @@ Default text :ref:`Color` of the menu item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Text :ref:`Color` used when the menu item is disabled. @@ -422,7 +422,7 @@ Text :ref:`Color` used when the menu item is disabled. .. rst-class:: classref-themeproperty -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Text :ref:`Color` used when the menu item is focused. Only replaces the normal text color of the menu item. Disabled, hovered, and pressed states take precedence over this color. @@ -434,7 +434,7 @@ Text :ref:`Color` used when the menu item is focused. Only replaces .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Text :ref:`Color` used when the menu item is being hovered. @@ -446,7 +446,7 @@ Text :ref:`Color` used when the menu item is being hovered. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the menu item is being hovered and pressed. @@ -458,7 +458,7 @@ Text :ref:`Color` used when the menu item is being hovered and pres .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the menu item. @@ -470,7 +470,7 @@ The tint of text outline of the menu item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the menu item is being pressed. @@ -482,7 +482,7 @@ Text :ref:`Color` used when the menu item is being pressed. .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal space between menu items. @@ -494,7 +494,7 @@ The horizontal space between menu items. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -508,7 +508,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` of the menu item's text. @@ -520,7 +520,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the menu item's text. @@ -532,7 +532,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **disabled** +:ref:`StyleBox` **disabled** :ref:`🔗` :ref:`StyleBox` used when the menu item is disabled. @@ -544,7 +544,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **disabled_mirrored** +:ref:`StyleBox` **disabled_mirrored** :ref:`🔗` :ref:`StyleBox` used when the menu item is disabled (for right-to-left layouts). @@ -556,7 +556,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **hover** +:ref:`StyleBox` **hover** :ref:`🔗` :ref:`StyleBox` used when the menu item is being hovered. @@ -568,7 +568,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **hover_mirrored** +:ref:`StyleBox` **hover_mirrored** :ref:`🔗` :ref:`StyleBox` used when the menu item is being hovered (for right-to-left layouts). @@ -580,7 +580,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **hover_pressed** +:ref:`StyleBox` **hover_pressed** :ref:`🔗` :ref:`StyleBox` used when the menu item is being pressed and hovered at the same time. @@ -592,7 +592,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **hover_pressed_mirrored** +:ref:`StyleBox` **hover_pressed_mirrored** :ref:`🔗` :ref:`StyleBox` used when the menu item is being pressed and hovered at the same time (for right-to-left layouts). @@ -604,7 +604,7 @@ Font size of the menu item's text. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **normal** +:ref:`StyleBox` **normal** :ref:`🔗` Default :ref:`StyleBox` for the menu item. @@ -616,7 +616,7 @@ Default :ref:`StyleBox` for the menu item. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **normal_mirrored** +:ref:`StyleBox` **normal_mirrored** :ref:`🔗` Default :ref:`StyleBox` for the menu item (for right-to-left layouts). @@ -628,7 +628,7 @@ Default :ref:`StyleBox` for the menu item (for right-to-left lay .. rst-class:: classref-themeproperty -:ref:`StyleBox` **pressed** +:ref:`StyleBox` **pressed** :ref:`🔗` :ref:`StyleBox` used when the menu item is being pressed. @@ -640,7 +640,7 @@ Default :ref:`StyleBox` for the menu item (for right-to-left lay .. rst-class:: classref-themeproperty -:ref:`StyleBox` **pressed_mirrored** +:ref:`StyleBox` **pressed_mirrored** :ref:`🔗` :ref:`StyleBox` used when the menu item is being pressed (for right-to-left layouts). diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 158c9b88d81..c46ad6361d4 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -74,7 +74,7 @@ Signals .. rst-class:: classref-signal -**about_to_popup**\ (\ ) +**about_to_popup**\ (\ ) :ref:`🔗` Emitted when the :ref:`PopupMenu` of this MenuButton is about to show. @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **item_count** = ``0`` +:ref:`int` **item_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ The number of items currently in the list. .. rst-class:: classref-property -:ref:`bool` **switch_on_hover** = ``false`` +:ref:`bool` **switch_on_hover** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PopupMenu` **get_popup**\ (\ ) |const| +:ref:`PopupMenu` **get_popup**\ (\ ) |const| :ref:`🔗` Returns the :ref:`PopupMenu` contained in this button. @@ -144,7 +144,7 @@ Returns the :ref:`PopupMenu` contained in this button. .. rst-class:: classref-method -|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) +|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, shortcuts are disabled and cannot be used to trigger the button. @@ -156,7 +156,7 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. .. rst-class:: classref-method -|void| **show_popup**\ (\ ) +|void| **show_popup**\ (\ ) :ref:`🔗` Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index da40b52103e..ced3064f9a2 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -21,7 +21,7 @@ A :ref:`Resource` that contains vertex array-based geometry. Description ----------- -Mesh is a type of :ref:`Resource` that contains vertex array-based geometry, divided in *surfaces*. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. +Mesh is a type of :ref:`Resource` that contains vertex array-based geometry, divided in *surfaces*. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. The maximum number of surfaces per mesh is :ref:`RenderingServer.MAX_MESH_SURFACES`. .. rst-class:: classref-introduction-group @@ -123,7 +123,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PrimitiveType**: +enum **PrimitiveType**: :ref:`🔗` .. _class_Mesh_constant_PRIMITIVE_POINTS: @@ -173,7 +173,7 @@ Render array as triangle strips. .. rst-class:: classref-enumeration -enum **ArrayType**: +enum **ArrayType**: :ref:`🔗` .. _class_Mesh_constant_ARRAY_VERTEX: @@ -297,7 +297,7 @@ Represents the size of the :ref:`ArrayType` enum. .. rst-class:: classref-enumeration -enum **ArrayCustomFormat**: +enum **ArrayCustomFormat**: :ref:`🔗` .. _class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM: @@ -379,7 +379,7 @@ Represents the size of the :ref:`ArrayCustomFormat` .. rst-class:: classref-enumeration -flags **ArrayFormat**: +flags **ArrayFormat**: :ref:`🔗` .. _class_Mesh_constant_ARRAY_FORMAT_VERTEX: @@ -605,7 +605,7 @@ Flag used to mark that a mesh is using compressed attributes (vertices, normals, .. rst-class:: classref-enumeration -enum **BlendShapeMode**: +enum **BlendShapeMode**: :ref:`🔗` .. _class_Mesh_constant_BLEND_SHAPE_MODE_NORMALIZED: @@ -636,7 +636,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2i` **lightmap_size_hint** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **lightmap_size_hint** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -658,7 +658,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| +:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method to override the :ref:`AABB` for a custom class extending **Mesh**. @@ -670,7 +670,7 @@ Virtual method to override the :ref:`AABB` for a custom class extend .. rst-class:: classref-method -:ref:`int` **_get_blend_shape_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_blend_shape_count**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method to override the number of blend shapes for a custom class extending **Mesh**. @@ -682,7 +682,7 @@ Virtual method to override the number of blend shapes for a custom class extendi .. rst-class:: classref-method -:ref:`StringName` **_get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`StringName` **_get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the retrieval of blend shape names for a custom class extending **Mesh**. @@ -694,7 +694,7 @@ Virtual method to override the retrieval of blend shape names for a custom class .. rst-class:: classref-method -:ref:`int` **_get_surface_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_surface_count**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface count for a custom class extending **Mesh**. @@ -706,7 +706,7 @@ Virtual method to override the surface count for a custom class extending **Mesh .. rst-class:: classref-method -|void| **_set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| +|void| **_set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| :ref:`🔗` Virtual method to override the names of blend shapes for a custom class extending **Mesh**. @@ -718,7 +718,7 @@ Virtual method to override the names of blend shapes for a custom class extendin .. rst-class:: classref-method -:ref:`int` **_surface_get_array_index_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_surface_get_array_index_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface array index length for a custom class extending **Mesh**. @@ -730,7 +730,7 @@ Virtual method to override the surface array index length for a custom class ext .. rst-class:: classref-method -:ref:`int` **_surface_get_array_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_surface_get_array_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface array length for a custom class extending **Mesh**. @@ -742,7 +742,7 @@ Virtual method to override the surface array length for a custom class extending .. rst-class:: classref-method -:ref:`Array` **_surface_get_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`Array` **_surface_get_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface arrays for a custom class extending **Mesh**. @@ -754,7 +754,7 @@ Virtual method to override the surface arrays for a custom class extending **Mes .. rst-class:: classref-method -:ref:`Array`\[:ref:`Array`\] **_surface_get_blend_shape_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Array`\] **_surface_get_blend_shape_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the blend shape arrays for a custom class extending **Mesh**. @@ -766,7 +766,7 @@ Virtual method to override the blend shape arrays for a custom class extending * .. rst-class:: classref-method -:ref:`int` **_surface_get_format**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_surface_get_format**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface format for a custom class extending **Mesh**. @@ -778,7 +778,7 @@ Virtual method to override the surface format for a custom class extending **Mes .. rst-class:: classref-method -:ref:`Dictionary` **_surface_get_lods**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`Dictionary` **_surface_get_lods**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface LODs for a custom class extending **Mesh**. @@ -790,7 +790,7 @@ Virtual method to override the surface LODs for a custom class extending **Mesh* .. rst-class:: classref-method -:ref:`Material` **_surface_get_material**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`Material` **_surface_get_material**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface material for a custom class extending **Mesh**. @@ -802,7 +802,7 @@ Virtual method to override the surface material for a custom class extending **M .. rst-class:: classref-method -:ref:`int` **_surface_get_primitive_type**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_surface_get_primitive_type**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method to override the surface primitive type for a custom class extending **Mesh**. @@ -814,7 +814,7 @@ Virtual method to override the surface primitive type for a custom class extendi .. rst-class:: classref-method -|void| **_surface_set_material**\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| +|void| **_surface_set_material**\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| :ref:`🔗` Virtual method to override the setting of a ``material`` at the given ``index`` for a custom class extending **Mesh**. @@ -826,7 +826,7 @@ Virtual method to override the setting of a ``material`` at the given ``index`` .. rst-class:: classref-method -:ref:`ConvexPolygonShape3D` **create_convex_shape**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) |const| +:ref:`ConvexPolygonShape3D` **create_convex_shape**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) |const| :ref:`🔗` Calculate a :ref:`ConvexPolygonShape3D` from the mesh. @@ -842,7 +842,7 @@ If ``simplify`` is ``true``, the geometry can be further simplified to reduce th .. rst-class:: classref-method -:ref:`Mesh` **create_outline**\ (\ margin\: :ref:`float`\ ) |const| +:ref:`Mesh` **create_outline**\ (\ margin\: :ref:`float`\ ) |const| :ref:`🔗` Calculate an outline mesh at a defined offset (margin) from the original mesh. @@ -856,7 +856,7 @@ Calculate an outline mesh at a defined offset (margin) from the original mesh. .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderMesh`). @@ -868,7 +868,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderMesh` **create_trimesh_shape**\ (\ ) |const| +:ref:`ConcavePolygonShape3D` **create_trimesh_shape**\ (\ ) |const| :ref:`🔗` Calculate a :ref:`ConcavePolygonShape3D` from the mesh. @@ -880,7 +880,7 @@ Calculate a :ref:`ConcavePolygonShape3D` from the m .. rst-class:: classref-method -:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| +:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| :ref:`🔗` Generate a :ref:`TriangleMesh` from the mesh. Considers only surfaces using one of these primitive types: :ref:`PRIMITIVE_TRIANGLES`, :ref:`PRIMITIVE_TRIANGLE_STRIP`. @@ -892,7 +892,7 @@ Generate a :ref:`TriangleMesh` from the mesh. Considers only .. rst-class:: classref-method -:ref:`AABB` **get_aabb**\ (\ ) |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| :ref:`🔗` Returns the smallest :ref:`AABB` enclosing this mesh in local space. Not affected by ``custom_aabb``. @@ -906,7 +906,7 @@ Returns the smallest :ref:`AABB` enclosing this mesh in local space. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| +:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| :ref:`🔗` Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. @@ -918,7 +918,7 @@ Returns all the vertices that make up the faces of the mesh. Each three vertices .. rst-class:: classref-method -:ref:`int` **get_surface_count**\ (\ ) |const| +:ref:`int` **get_surface_count**\ (\ ) |const| :ref:`🔗` Returns the number of surfaces that the **Mesh** holds. This is equivalent to :ref:`MeshInstance3D.get_surface_override_material_count`. @@ -930,7 +930,7 @@ Returns the number of surfaces that the **Mesh** holds. This is equivalent to :r .. rst-class:: classref-method -:ref:`Array` **surface_get_arrays**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`Array` **surface_get_arrays**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface (see :ref:`ArrayMesh.add_surface_from_arrays`). @@ -942,7 +942,7 @@ Returns the arrays for the vertices, normals, UVs, etc. that make up the request .. rst-class:: classref-method -:ref:`Array`\[:ref:`Array`\] **surface_get_blend_shape_arrays**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Array`\] **surface_get_blend_shape_arrays**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the blend shape arrays for the requested surface. @@ -954,7 +954,7 @@ Returns the blend shape arrays for the requested surface. .. rst-class:: classref-method -:ref:`Material` **surface_get_material**\ (\ surf_idx\: :ref:`int`\ ) |const| +:ref:`Material` **surface_get_material**\ (\ surf_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`Material` in a given surface. Surface is rendered using this material. @@ -968,7 +968,7 @@ Returns a :ref:`Material` in a given surface. Surface is rendere .. rst-class:: classref-method -|void| **surface_set_material**\ (\ surf_idx\: :ref:`int`, material\: :ref:`Material`\ ) +|void| **surface_set_material**\ (\ surf_idx\: :ref:`int`, material\: :ref:`Material`\ ) :ref:`🔗` Sets a :ref:`Material` for a given surface. Surface will be rendered using this material. diff --git a/classes/class_meshconvexdecompositionsettings.rst b/classes/class_meshconvexdecompositionsettings.rst index c8f55269548..bb906617373 100644 --- a/classes/class_meshconvexdecompositionsettings.rst +++ b/classes/class_meshconvexdecompositionsettings.rst @@ -70,7 +70,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_MeshConvexDecompositionSettings_constant_CONVEX_DECOMPOSITION_MODE_VOXEL: @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **convex_hull_approximation** = ``true`` +:ref:`bool` **convex_hull_approximation** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -118,7 +118,7 @@ If ``true``, uses approximation for computing convex hulls. .. rst-class:: classref-property -:ref:`int` **convex_hull_downsampling** = ``4`` +:ref:`int` **convex_hull_downsampling** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -135,7 +135,7 @@ Controls the precision of the convex-hull generation process during the clipping .. rst-class:: classref-property -:ref:`float` **max_concavity** = ``1.0`` +:ref:`float` **max_concavity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ Maximum concavity. Ranges from ``0.0`` to ``1.0``. .. rst-class:: classref-property -:ref:`int` **max_convex_hulls** = ``1`` +:ref:`int` **max_convex_hulls** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ The maximum number of convex hulls to produce from the merge operation. .. rst-class:: classref-property -:ref:`int` **max_num_vertices_per_convex_hull** = ``32`` +:ref:`int` **max_num_vertices_per_convex_hull** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -186,7 +186,7 @@ Controls the maximum number of triangles per convex-hull. Ranges from ``4`` to ` .. rst-class:: classref-property -:ref:`float` **min_volume_per_convex_hull** = ``0.0001`` +:ref:`float` **min_volume_per_convex_hull** = ``0.0001`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -203,7 +203,7 @@ Controls the adaptive sampling of the generated convex-hulls. Ranges from ``0.0` .. rst-class:: classref-property -:ref:`Mode` **mode** = ``0`` +:ref:`Mode` **mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ Mode for the approximate convex decomposition. .. rst-class:: classref-property -:ref:`bool` **normalize_mesh** = ``false`` +:ref:`bool` **normalize_mesh** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ If ``true``, normalizes the mesh before applying the convex decomposition. .. rst-class:: classref-property -:ref:`int` **plane_downsampling** = ``4`` +:ref:`int` **plane_downsampling** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ Controls the granularity of the search for the "best" clipping plane. Ranges fro .. rst-class:: classref-property -:ref:`bool` **project_hull_vertices** = ``true`` +:ref:`bool` **project_hull_vertices** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ If ``true``, projects output convex hull vertices onto the original source mesh .. rst-class:: classref-property -:ref:`int` **resolution** = ``10000`` +:ref:`int` **resolution** = ``10000`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -288,7 +288,7 @@ Maximum number of voxels generated during the voxelization stage. .. rst-class:: classref-property -:ref:`float` **revolution_axes_clipping_bias** = ``0.05`` +:ref:`float` **revolution_axes_clipping_bias** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -305,7 +305,7 @@ Controls the bias toward clipping along revolution axes. Ranges from ``0.0`` to .. rst-class:: classref-property -:ref:`float` **symmetry_planes_clipping_bias** = ``0.05`` +:ref:`float` **symmetry_planes_clipping_bias** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index a7b1ac5bd0f..befab3f9868 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -178,7 +178,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears all data currently in MeshDataTool. @@ -190,7 +190,7 @@ Clears all data currently in MeshDataTool. .. rst-class:: classref-method -:ref:`Error` **commit_to_surface**\ (\ mesh\: :ref:`ArrayMesh`, compression_flags\: :ref:`int` = 0\ ) +:ref:`Error` **commit_to_surface**\ (\ mesh\: :ref:`ArrayMesh`, compression_flags\: :ref:`int` = 0\ ) :ref:`🔗` Adds a new surface to specified :ref:`Mesh` with edited data. @@ -202,7 +202,7 @@ Adds a new surface to specified :ref:`Mesh` with edited data. .. rst-class:: classref-method -:ref:`Error` **create_from_surface**\ (\ mesh\: :ref:`ArrayMesh`, surface\: :ref:`int`\ ) +:ref:`Error` **create_from_surface**\ (\ mesh\: :ref:`ArrayMesh`, surface\: :ref:`int`\ ) :ref:`🔗` Uses specified surface of given :ref:`Mesh` to populate data for MeshDataTool. @@ -216,7 +216,7 @@ Requires :ref:`Mesh` with primitive type :ref:`Mesh.PRIMITIVE_TRIANG .. rst-class:: classref-method -:ref:`int` **get_edge_count**\ (\ ) |const| +:ref:`int` **get_edge_count**\ (\ ) |const| :ref:`🔗` Returns the number of edges in this :ref:`Mesh`. @@ -228,7 +228,7 @@ Returns the number of edges in this :ref:`Mesh`. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_edge_faces**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_edge_faces**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns array of faces that touch given edge. @@ -240,7 +240,7 @@ Returns array of faces that touch given edge. .. rst-class:: classref-method -:ref:`Variant` **get_edge_meta**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_edge_meta**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns meta information assigned to given edge. @@ -252,7 +252,7 @@ Returns meta information assigned to given edge. .. rst-class:: classref-method -:ref:`int` **get_edge_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| +:ref:`int` **get_edge_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| :ref:`🔗` Returns index of specified vertex connected to given edge. @@ -266,7 +266,7 @@ Vertex argument can only be 0 or 1 because edges are comprised of two vertices. .. rst-class:: classref-method -:ref:`int` **get_face_count**\ (\ ) |const| +:ref:`int` **get_face_count**\ (\ ) |const| :ref:`🔗` Returns the number of faces in this :ref:`Mesh`. @@ -278,7 +278,7 @@ Returns the number of faces in this :ref:`Mesh`. .. rst-class:: classref-method -:ref:`int` **get_face_edge**\ (\ idx\: :ref:`int`, edge\: :ref:`int`\ ) |const| +:ref:`int` **get_face_edge**\ (\ idx\: :ref:`int`, edge\: :ref:`int`\ ) |const| :ref:`🔗` Returns specified edge associated with given face. @@ -292,7 +292,7 @@ Edge argument must be either 0, 1, or 2 because a face only has three edges. .. rst-class:: classref-method -:ref:`Variant` **get_face_meta**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_face_meta**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata associated with the given face. @@ -304,7 +304,7 @@ Returns the metadata associated with the given face. .. rst-class:: classref-method -:ref:`Vector3` **get_face_normal**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_face_normal**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Calculates and returns the face normal of the given face. @@ -316,7 +316,7 @@ Calculates and returns the face normal of the given face. .. rst-class:: classref-method -:ref:`int` **get_face_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| +:ref:`int` **get_face_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| :ref:`🔗` Returns the specified vertex index of the given face. @@ -349,7 +349,7 @@ Vertex argument must be either 0, 1, or 2 because faces contain three vertices. .. rst-class:: classref-method -:ref:`int` **get_format**\ (\ ) |const| +:ref:`int` **get_format**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Mesh`'s format as a combination of the :ref:`ArrayFormat` flags. For example, a mesh containing both vertices and normals would return a format of ``3`` because :ref:`Mesh.ARRAY_FORMAT_VERTEX` is ``1`` and :ref:`Mesh.ARRAY_FORMAT_NORMAL` is ``2``. @@ -361,7 +361,7 @@ Returns the :ref:`Mesh`'s format as a combination of the :ref:`Array .. rst-class:: classref-method -:ref:`Material` **get_material**\ (\ ) |const| +:ref:`Material` **get_material**\ (\ ) |const| :ref:`🔗` Returns the material assigned to the :ref:`Mesh`. @@ -373,7 +373,7 @@ Returns the material assigned to the :ref:`Mesh`. .. rst-class:: classref-method -:ref:`Vector3` **get_vertex**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_vertex**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the given vertex. @@ -385,7 +385,7 @@ Returns the position of the given vertex. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_vertex_bones**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_vertex_bones**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the bones of the given vertex. @@ -397,7 +397,7 @@ Returns the bones of the given vertex. .. rst-class:: classref-method -:ref:`Color` **get_vertex_color**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Color` **get_vertex_color**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the color of the given vertex. @@ -409,7 +409,7 @@ Returns the color of the given vertex. .. rst-class:: classref-method -:ref:`int` **get_vertex_count**\ (\ ) |const| +:ref:`int` **get_vertex_count**\ (\ ) |const| :ref:`🔗` Returns the total number of vertices in :ref:`Mesh`. @@ -421,7 +421,7 @@ Returns the total number of vertices in :ref:`Mesh`. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_vertex_edges**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_vertex_edges**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of edges that share the given vertex. @@ -433,7 +433,7 @@ Returns an array of edges that share the given vertex. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_vertex_faces**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_vertex_faces**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of faces that share the given vertex. @@ -445,7 +445,7 @@ Returns an array of faces that share the given vertex. .. rst-class:: classref-method -:ref:`Variant` **get_vertex_meta**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_vertex_meta**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata associated with the given vertex. @@ -457,7 +457,7 @@ Returns the metadata associated with the given vertex. .. rst-class:: classref-method -:ref:`Vector3` **get_vertex_normal**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_vertex_normal**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the normal of the given vertex. @@ -469,7 +469,7 @@ Returns the normal of the given vertex. .. rst-class:: classref-method -:ref:`Plane` **get_vertex_tangent**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Plane` **get_vertex_tangent**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tangent of the given vertex. @@ -481,7 +481,7 @@ Returns the tangent of the given vertex. .. rst-class:: classref-method -:ref:`Vector2` **get_vertex_uv**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_vertex_uv**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the UV of the given vertex. @@ -493,7 +493,7 @@ Returns the UV of the given vertex. .. rst-class:: classref-method -:ref:`Vector2` **get_vertex_uv2**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_vertex_uv2**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the UV2 of the given vertex. @@ -505,7 +505,7 @@ Returns the UV2 of the given vertex. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **get_vertex_weights**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedFloat32Array` **get_vertex_weights**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns bone weights of the given vertex. @@ -517,7 +517,7 @@ Returns bone weights of the given vertex. .. rst-class:: classref-method -|void| **set_edge_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) +|void| **set_edge_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata of the given edge. @@ -529,7 +529,7 @@ Sets the metadata of the given edge. .. rst-class:: classref-method -|void| **set_face_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) +|void| **set_face_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata of the given face. @@ -541,7 +541,7 @@ Sets the metadata of the given face. .. rst-class:: classref-method -|void| **set_material**\ (\ material\: :ref:`Material`\ ) +|void| **set_material**\ (\ material\: :ref:`Material`\ ) :ref:`🔗` Sets the material to be used by newly-constructed :ref:`Mesh`. @@ -553,7 +553,7 @@ Sets the material to be used by newly-constructed :ref:`Mesh`. .. rst-class:: classref-method -|void| **set_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`Vector3`\ ) +|void| **set_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`Vector3`\ ) :ref:`🔗` Sets the position of the given vertex. @@ -565,7 +565,7 @@ Sets the position of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_bones**\ (\ idx\: :ref:`int`, bones\: :ref:`PackedInt32Array`\ ) +|void| **set_vertex_bones**\ (\ idx\: :ref:`int`, bones\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Sets the bones of the given vertex. @@ -577,7 +577,7 @@ Sets the bones of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_color**\ (\ idx\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_vertex_color**\ (\ idx\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color of the given vertex. @@ -589,7 +589,7 @@ Sets the color of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) +|void| **set_vertex_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata associated with the given vertex. @@ -601,7 +601,7 @@ Sets the metadata associated with the given vertex. .. rst-class:: classref-method -|void| **set_vertex_normal**\ (\ idx\: :ref:`int`, normal\: :ref:`Vector3`\ ) +|void| **set_vertex_normal**\ (\ idx\: :ref:`int`, normal\: :ref:`Vector3`\ ) :ref:`🔗` Sets the normal of the given vertex. @@ -613,7 +613,7 @@ Sets the normal of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_tangent**\ (\ idx\: :ref:`int`, tangent\: :ref:`Plane`\ ) +|void| **set_vertex_tangent**\ (\ idx\: :ref:`int`, tangent\: :ref:`Plane`\ ) :ref:`🔗` Sets the tangent of the given vertex. @@ -625,7 +625,7 @@ Sets the tangent of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_uv**\ (\ idx\: :ref:`int`, uv\: :ref:`Vector2`\ ) +|void| **set_vertex_uv**\ (\ idx\: :ref:`int`, uv\: :ref:`Vector2`\ ) :ref:`🔗` Sets the UV of the given vertex. @@ -637,7 +637,7 @@ Sets the UV of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_uv2**\ (\ idx\: :ref:`int`, uv2\: :ref:`Vector2`\ ) +|void| **set_vertex_uv2**\ (\ idx\: :ref:`int`, uv2\: :ref:`Vector2`\ ) :ref:`🔗` Sets the UV2 of the given vertex. @@ -649,7 +649,7 @@ Sets the UV2 of the given vertex. .. rst-class:: classref-method -|void| **set_vertex_weights**\ (\ idx\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) +|void| **set_vertex_weights**\ (\ idx\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Sets the bone weights of the given vertex. diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 25efc1f05fc..f687023911b 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -55,7 +55,7 @@ Signals .. rst-class:: classref-signal -**texture_changed**\ (\ ) +**texture_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`texture` is changed. @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -89,7 +89,7 @@ The :ref:`Mesh` that will be drawn by the **MeshInstance2D**. .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index b6af87becd7..604d6978821 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -103,7 +103,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ The :ref:`Mesh` resource for the instance. .. rst-class:: classref-property -:ref:`NodePath` **skeleton** = ``NodePath("..")`` +:ref:`NodePath` **skeleton** = ``NodePath("..")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ The :ref:`Mesh` resource for the instance. .. rst-class:: classref-property -:ref:`Skin` **skin** +:ref:`Skin` **skin** :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ArrayMesh` **bake_mesh_from_current_blend_shape_mix**\ (\ existing\: :ref:`ArrayMesh` = null\ ) +:ref:`ArrayMesh` **bake_mesh_from_current_blend_shape_mix**\ (\ existing\: :ref:`ArrayMesh` = null\ ) :ref:`🔗` Takes a snapshot from the current :ref:`ArrayMesh` with all blend shapes applied according to their current weights and bakes it to the provided ``existing`` mesh. If no ``existing`` mesh is provided a new :ref:`ArrayMesh` is created, baked and returned. Mesh surface materials are not copied. @@ -173,7 +173,7 @@ Takes a snapshot from the current :ref:`ArrayMesh` with all ble .. rst-class:: classref-method -|void| **create_convex_collision**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) +|void| **create_convex_collision**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) :ref:`🔗` This helper creates a :ref:`StaticBody3D` child node with a :ref:`ConvexPolygonShape3D` collision shape calculated from the mesh geometry. It's mainly used for testing. @@ -189,7 +189,7 @@ If ``simplify`` is ``true``, the geometry can be further simplified to reduce th .. rst-class:: classref-method -|void| **create_debug_tangents**\ (\ ) +|void| **create_debug_tangents**\ (\ ) :ref:`🔗` This helper creates a **MeshInstance3D** child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. @@ -201,7 +201,7 @@ This helper creates a **MeshInstance3D** child node with gizmos at every vertex .. rst-class:: classref-method -|void| **create_multiple_convex_collisions**\ (\ settings\: :ref:`MeshConvexDecompositionSettings` = null\ ) +|void| **create_multiple_convex_collisions**\ (\ settings\: :ref:`MeshConvexDecompositionSettings` = null\ ) :ref:`🔗` This helper creates a :ref:`StaticBody3D` child node with multiple :ref:`ConvexPolygonShape3D` collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional ``settings``. @@ -213,7 +213,7 @@ This helper creates a :ref:`StaticBody3D` child node with mu .. rst-class:: classref-method -|void| **create_trimesh_collision**\ (\ ) +|void| **create_trimesh_collision**\ (\ ) :ref:`🔗` This helper creates a :ref:`StaticBody3D` child node with a :ref:`ConcavePolygonShape3D` collision shape calculated from the mesh geometry. It's mainly used for testing. @@ -225,7 +225,7 @@ This helper creates a :ref:`StaticBody3D` child node with a .. rst-class:: classref-method -:ref:`int` **find_blend_shape_by_name**\ (\ name\: :ref:`StringName`\ ) +:ref:`int` **find_blend_shape_by_name**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Returns the index of the blend shape with the given ``name``. Returns ``-1`` if no blend shape with this name exists, including when :ref:`mesh` is ``null``. @@ -237,7 +237,7 @@ Returns the index of the blend shape with the given ``name``. Returns ``-1`` if .. rst-class:: classref-method -:ref:`Material` **get_active_material**\ (\ surface\: :ref:`int`\ ) |const| +:ref:`Material` **get_active_material**\ (\ surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Material` that will be used by the :ref:`Mesh` when drawing. This can return the :ref:`GeometryInstance3D.material_override`, the surface override :ref:`Material` defined in this **MeshInstance3D**, or the surface :ref:`Material` defined in the :ref:`mesh`. For example, if :ref:`GeometryInstance3D.material_override` is used, all surfaces will return the override material. @@ -251,7 +251,7 @@ Returns ``null`` if no material is active, including when :ref:`mesh` **get_blend_shape_count**\ (\ ) |const| +:ref:`int` **get_blend_shape_count**\ (\ ) |const| :ref:`🔗` Returns the number of blend shapes available. Produces an error if :ref:`mesh` is ``null``. @@ -263,7 +263,7 @@ Returns the number of blend shapes available. Produces an error if :ref:`mesh` **get_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of the blend shape at the given ``blend_shape_idx``. Returns ``0.0`` and produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. @@ -275,7 +275,7 @@ Returns the value of the blend shape at the given ``blend_shape_idx``. Returns ` .. rst-class:: classref-method -:ref:`SkinReference` **get_skin_reference**\ (\ ) |const| +:ref:`SkinReference` **get_skin_reference**\ (\ ) |const| :ref:`🔗` Returns the internal :ref:`SkinReference` containing the skeleton's :ref:`RID` attached to this RID. See also :ref:`Resource.get_rid`, :ref:`SkinReference.get_skeleton`, and :ref:`RenderingServer.instance_attach_skeleton`. @@ -287,7 +287,7 @@ Returns the internal :ref:`SkinReference` containing the sk .. rst-class:: classref-method -:ref:`Material` **get_surface_override_material**\ (\ surface\: :ref:`int`\ ) |const| +:ref:`Material` **get_surface_override_material**\ (\ surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns the override :ref:`Material` for the specified ``surface`` of the :ref:`Mesh` resource. See also :ref:`get_surface_override_material_count`. @@ -301,7 +301,7 @@ Returns the override :ref:`Material` for the specified ``surface .. rst-class:: classref-method -:ref:`int` **get_surface_override_material_count**\ (\ ) |const| +:ref:`int` **get_surface_override_material_count**\ (\ ) |const| :ref:`🔗` Returns the number of surface override materials. This is equivalent to :ref:`Mesh.get_surface_count`. See also :ref:`get_surface_override_material`. @@ -313,7 +313,7 @@ Returns the number of surface override materials. This is equivalent to :ref:`Me .. rst-class:: classref-method -|void| **set_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`, value\: :ref:`float`\ ) +|void| **set_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the blend shape at ``blend_shape_idx`` to ``value``. Produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. @@ -325,7 +325,7 @@ Sets the value of the blend shape at ``blend_shape_idx`` to ``value``. Produces .. rst-class:: classref-method -|void| **set_surface_override_material**\ (\ surface\: :ref:`int`, material\: :ref:`Material`\ ) +|void| **set_surface_override_material**\ (\ surface\: :ref:`int`, material\: :ref:`Material`\ ) :ref:`🔗` Sets the override ``material`` for the specified ``surface`` of the :ref:`Mesh` resource. This material is associated with this **MeshInstance3D** rather than with :ref:`mesh`. diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index e494b31f58f..bf39e2d7a81 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -97,7 +97,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the library. @@ -109,7 +109,7 @@ Clears the library. .. rst-class:: classref-method -|void| **create_item**\ (\ id\: :ref:`int`\ ) +|void| **create_item**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Creates a new item in the library with the given ID. @@ -123,9 +123,9 @@ You can get an unused ID from :ref:`get_last_unused_item_id` **find_item_by_name**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **find_item_by_name**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` -Returns the first item with the given name. +Returns the first item with the given name, or ``-1`` if no item is found. .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Returns the first item with the given name. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_item_list**\ (\ ) |const| +:ref:`PackedInt32Array` **get_item_list**\ (\ ) |const| :ref:`🔗` Returns the list of item IDs in use. @@ -147,7 +147,7 @@ Returns the list of item IDs in use. .. rst-class:: classref-method -:ref:`Mesh` **get_item_mesh**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Mesh` **get_item_mesh**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's mesh. @@ -159,7 +159,7 @@ Returns the item's mesh. .. rst-class:: classref-method -:ref:`Transform3D` **get_item_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_item_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transform applied to the item's mesh. @@ -171,7 +171,7 @@ Returns the transform applied to the item's mesh. .. rst-class:: classref-method -:ref:`String` **get_item_name**\ (\ id\: :ref:`int`\ ) |const| +:ref:`String` **get_item_name**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's name. @@ -183,7 +183,7 @@ Returns the item's name. .. rst-class:: classref-method -:ref:`int` **get_item_navigation_layers**\ (\ id\: :ref:`int`\ ) |const| +:ref:`int` **get_item_navigation_layers**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's navigation layers bitmask. @@ -195,7 +195,7 @@ Returns the item's navigation layers bitmask. .. rst-class:: classref-method -:ref:`NavigationMesh` **get_item_navigation_mesh**\ (\ id\: :ref:`int`\ ) |const| +:ref:`NavigationMesh` **get_item_navigation_mesh**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's navigation mesh. @@ -207,7 +207,7 @@ Returns the item's navigation mesh. .. rst-class:: classref-method -:ref:`Transform3D` **get_item_navigation_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_item_navigation_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transform applied to the item's navigation mesh. @@ -219,7 +219,7 @@ Returns the transform applied to the item's navigation mesh. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_preview**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_item_preview**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using :ref:`set_item_preview`. Returns an empty :ref:`Texture2D` if no preview was manually set in a running project. @@ -231,7 +231,7 @@ When running in the editor, returns a generated item preview (a 3D rendering in .. rst-class:: classref-method -:ref:`Array` **get_item_shapes**\ (\ id\: :ref:`int`\ ) |const| +:ref:`Array` **get_item_shapes**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns an item's collision shapes. @@ -245,7 +245,7 @@ The array consists of each :ref:`Shape3D` followed by its :ref:`T .. rst-class:: classref-method -:ref:`int` **get_last_unused_item_id**\ (\ ) |const| +:ref:`int` **get_last_unused_item_id**\ (\ ) |const| :ref:`🔗` Gets an unused ID for a new item. @@ -257,7 +257,7 @@ Gets an unused ID for a new item. .. rst-class:: classref-method -|void| **remove_item**\ (\ id\: :ref:`int`\ ) +|void| **remove_item**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the item. @@ -269,7 +269,7 @@ Removes the item. .. rst-class:: classref-method -|void| **set_item_mesh**\ (\ id\: :ref:`int`, mesh\: :ref:`Mesh`\ ) +|void| **set_item_mesh**\ (\ id\: :ref:`int`, mesh\: :ref:`Mesh`\ ) :ref:`🔗` Sets the item's mesh. @@ -281,7 +281,7 @@ Sets the item's mesh. .. rst-class:: classref-method -|void| **set_item_mesh_transform**\ (\ id\: :ref:`int`, mesh_transform\: :ref:`Transform3D`\ ) +|void| **set_item_mesh_transform**\ (\ id\: :ref:`int`, mesh_transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform to apply to the item's mesh. @@ -293,7 +293,7 @@ Sets the transform to apply to the item's mesh. .. rst-class:: classref-method -|void| **set_item_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_item_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the item's name. @@ -307,7 +307,7 @@ This name is shown in the editor. It can also be used to look up the item later .. rst-class:: classref-method -|void| **set_item_navigation_layers**\ (\ id\: :ref:`int`, navigation_layers\: :ref:`int`\ ) +|void| **set_item_navigation_layers**\ (\ id\: :ref:`int`, navigation_layers\: :ref:`int`\ ) :ref:`🔗` Sets the item's navigation layers bitmask. @@ -319,7 +319,7 @@ Sets the item's navigation layers bitmask. .. rst-class:: classref-method -|void| **set_item_navigation_mesh**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`NavigationMesh`\ ) +|void| **set_item_navigation_mesh**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`NavigationMesh`\ ) :ref:`🔗` Sets the item's navigation mesh. @@ -331,7 +331,7 @@ Sets the item's navigation mesh. .. rst-class:: classref-method -|void| **set_item_navigation_mesh_transform**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`Transform3D`\ ) +|void| **set_item_navigation_mesh_transform**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform to apply to the item's navigation mesh. @@ -343,7 +343,7 @@ Sets the transform to apply to the item's navigation mesh. .. rst-class:: classref-method -|void| **set_item_preview**\ (\ id\: :ref:`int`, texture\: :ref:`Texture2D`\ ) +|void| **set_item_preview**\ (\ id\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets a texture to use as the item's preview icon in the editor. @@ -355,7 +355,7 @@ Sets a texture to use as the item's preview icon in the editor. .. rst-class:: classref-method -|void| **set_item_shapes**\ (\ id\: :ref:`int`, shapes\: :ref:`Array`\ ) +|void| **set_item_shapes**\ (\ id\: :ref:`int`, shapes\: :ref:`Array`\ ) :ref:`🔗` Sets an item's collision shapes. diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index a1e7798f994..8536ba640b0 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture2D` **base_texture** +:ref:`Texture2D` **base_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ Sets the base texture that the Mesh will use to draw. .. rst-class:: classref-property -:ref:`Vector2` **image_size** = ``Vector2(0, 0)`` +:ref:`Vector2` **image_size** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ Sets the size of the image, needed for reference. .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_methodtweener.rst b/classes/class_methodtweener.rst index ebb94c6bb06..3e421a24b25 100644 --- a/classes/class_methodtweener.rst +++ b/classes/class_methodtweener.rst @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`MethodTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) +:ref:`MethodTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) :ref:`🔗` Sets the time in seconds after which the **MethodTweener** will start interpolating. By default there's no delay. @@ -66,7 +66,7 @@ Sets the time in seconds after which the **MethodTweener** will start interpolat .. rst-class:: classref-method -:ref:`MethodTweener` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) +:ref:`MethodTweener` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) :ref:`🔗` Sets the type of used easing from :ref:`EaseType`. If not set, the default easing is used from the :ref:`Tween` that contains this Tweener. @@ -78,7 +78,7 @@ Sets the type of used easing from :ref:`EaseType`. If not s .. rst-class:: classref-method -:ref:`MethodTweener` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) +:ref:`MethodTweener` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) :ref:`🔗` Sets the type of used transition from :ref:`TransitionType`. If not set, the default transition is used from the :ref:`Tween` that contains this Tweener. diff --git a/classes/class_missingnode.rst b/classes/class_missingnode.rst index 2d7c8d9ac71..a56c2edbc4c 100644 --- a/classes/class_missingnode.rst +++ b/classes/class_missingnode.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **original_class** +:ref:`String` **original_class** :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ The name of the class this node was supposed to be (see :ref:`Object.get_class` **original_scene** +:ref:`String` **original_scene** :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ Returns the path of the scene this node was instance of originally. .. rst-class:: classref-property -:ref:`bool` **recording_properties** +:ref:`bool` **recording_properties** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_missingresource.rst b/classes/class_missingresource.rst index c3856511c51..6037d41037e 100644 --- a/classes/class_missingresource.rst +++ b/classes/class_missingresource.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **original_class** +:ref:`String` **original_class** :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ The name of the class this resource was supposed to be (see :ref:`Object.get_cla .. rst-class:: classref-property -:ref:`bool` **recording_properties** +:ref:`bool` **recording_properties** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index e5fcbec793f..14b69591f74 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -76,7 +76,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **display_to_lens** = ``4.0`` +:ref:`float` **display_to_lens** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ The distance between the display and the lenses inside of the device in centimet .. rst-class:: classref-property -:ref:`float` **display_width** = ``14.5`` +:ref:`float` **display_width** = ``14.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ The width of the display in centimeters. .. rst-class:: classref-property -:ref:`float` **eye_height** = ``1.85`` +:ref:`float` **eye_height** = ``1.85`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ The height at which the camera is placed in relation to the ground (i.e. :ref:`X .. rst-class:: classref-property -:ref:`float` **iod** = ``6.0`` +:ref:`float` **iod** = ``6.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ The interocular distance, also known as the interpupillary distance. The distanc .. rst-class:: classref-property -:ref:`float` **k1** = ``0.215`` +:ref:`float` **k1** = ``0.215`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ The k1 lens factor is one of the two constants that define the strength of the l .. rst-class:: classref-property -:ref:`float` **k2** = ``0.215`` +:ref:`float` **k2** = ``0.215`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ The k2 lens factor, see k1. .. rst-class:: classref-property -:ref:`Rect2` **offset_rect** = ``Rect2(0, 0, 1, 1)`` +:ref:`Rect2` **offset_rect** = ``Rect2(0, 0, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ Set the offset rect relative to the area being rendered. A length of 1 represent .. rst-class:: classref-property -:ref:`float` **oversample** = ``1.5`` +:ref:`float` **oversample** = ``1.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ The oversample setting. Because of the lens distortion we have to render our buf .. rst-class:: classref-property -:ref:`float` **vrs_min_radius** = ``20.0`` +:ref:`float` **vrs_min_radius** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ The minimum radius around the focal point where full quality is guaranteed if VR .. rst-class:: classref-property -:ref:`float` **vrs_strength** = ``1.0`` +:ref:`float` **vrs_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_moviewriter.rst b/classes/class_moviewriter.rst index 8f21441e3ae..62b318c730e 100644 --- a/classes/class_moviewriter.rst +++ b/classes/class_moviewriter.rst @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_audio_mix_rate**\ (\ ) |virtual| |const| +:ref:`int` **_get_audio_mix_rate**\ (\ ) |virtual| |const| :ref:`🔗` Called when the audio sample rate used for recording the audio is requested by the engine. The value returned must be specified in Hz. Defaults to 48000 Hz if :ref:`_get_audio_mix_rate` is not overridden. @@ -82,7 +82,7 @@ Called when the audio sample rate used for recording the audio is requested by t .. rst-class:: classref-method -:ref:`SpeakerMode` **_get_audio_speaker_mode**\ (\ ) |virtual| |const| +:ref:`SpeakerMode` **_get_audio_speaker_mode**\ (\ ) |virtual| |const| :ref:`🔗` Called when the audio speaker mode used for recording the audio is requested by the engine. This can affect the number of output channels in the resulting audio file/stream. Defaults to :ref:`AudioServer.SPEAKER_MODE_STEREO` if :ref:`_get_audio_speaker_mode` is not overridden. @@ -94,7 +94,7 @@ Called when the audio speaker mode used for recording the audio is requested by .. rst-class:: classref-method -:ref:`bool` **_handles_file**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_handles_file**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Called when the engine determines whether this **MovieWriter** is able to handle the file at ``path``. Must return ``true`` if this **MovieWriter** is able to handle the given file path, ``false`` otherwise. Typically, :ref:`_handles_file` is overridden as follows to allow the user to record a file at any path with a given file extension: @@ -113,7 +113,7 @@ Called when the engine determines whether this **MovieWriter** is able to handle .. rst-class:: classref-method -:ref:`Error` **_write_begin**\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| +:ref:`Error` **_write_begin**\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| :ref:`🔗` Called once before the engine starts writing video and audio data. ``movie_size`` is the width and height of the video to save. ``fps`` is the number of frames per second specified in the project settings or using the ``--fixed-fps `` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. @@ -125,7 +125,7 @@ Called once before the engine starts writing video and audio data. ``movie_size` .. rst-class:: classref-method -|void| **_write_end**\ (\ ) |virtual| +|void| **_write_end**\ (\ ) |virtual| :ref:`🔗` Called when the engine finishes writing. This occurs when the engine quits by pressing the window manager's close button, or when :ref:`SceneTree.quit` is called. @@ -139,7 +139,7 @@ Called when the engine finishes writing. This occurs when the engine quits by pr .. rst-class:: classref-method -:ref:`Error` **_write_frame**\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| +:ref:`Error` **_write_frame**\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| :ref:`🔗` Called at the end of every rendered frame. The ``frame_image`` and ``audio_frame_block`` function arguments should be written to. @@ -151,7 +151,7 @@ Called at the end of every rendered frame. The ``frame_image`` and ``audio_frame .. rst-class:: classref-method -|void| **add_writer**\ (\ writer\: :ref:`MovieWriter`\ ) |static| +|void| **add_writer**\ (\ writer\: :ref:`MovieWriter`\ ) |static| :ref:`🔗` Adds a writer to be usable by the engine. The supported file extensions can be set by overriding :ref:`_handles_file`. diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 473860e10e6..e212c9e387b 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -120,7 +120,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TransformFormat**: +enum **TransformFormat**: :ref:`🔗` .. _class_MultiMesh_constant_TRANSFORM_2D: @@ -151,7 +151,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedFloat32Array` **buffer** = ``PackedFloat32Array()`` +:ref:`PackedFloat32Array` **buffer** = ``PackedFloat32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -170,7 +170,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedColorArray` **color_array** +:ref:`PackedColorArray` **color_array** :ref:`🔗` **Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_color` and :ref:`get_instance_color` instead. @@ -186,7 +186,7 @@ Array containing each :ref:`Color` used by all instances of this me .. rst-class:: classref-property -:ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -203,7 +203,7 @@ Custom AABB for this MultiMesh resource. Setting this manually prevents costly r .. rst-class:: classref-property -:ref:`PackedColorArray` **custom_data_array** +:ref:`PackedColorArray` **custom_data_array** :ref:`🔗` **Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_custom_data` and :ref:`get_instance_custom_data` instead. @@ -219,7 +219,7 @@ Array containing each custom data value used by all instances of this mesh, as a .. rst-class:: classref-property -:ref:`int` **instance_count** = ``0`` +:ref:`int` **instance_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ By default, all instances are drawn but you can limit this with :ref:`visible_in .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ The looks of the individual instances can be modified using :ref:`set_instance_c .. rst-class:: classref-property -:ref:`PackedVector2Array` **transform_2d_array** +:ref:`PackedVector2Array` **transform_2d_array** :ref:`🔗` **Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_transform_2d` and :ref:`get_instance_transform_2d` instead. @@ -273,7 +273,7 @@ Array containing each :ref:`Transform2D` value used by all in .. rst-class:: classref-property -:ref:`PackedVector3Array` **transform_array** +:ref:`PackedVector3Array` **transform_array** :ref:`🔗` **Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_transform` and :ref:`get_instance_transform` instead. @@ -289,7 +289,7 @@ Array containing each :ref:`Transform3D` value used by all in .. rst-class:: classref-property -:ref:`TransformFormat` **transform_format** = ``0`` +:ref:`TransformFormat` **transform_format** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ Format of transform used to transform mesh, either 2D or 3D. .. rst-class:: classref-property -:ref:`bool` **use_colors** = ``false`` +:ref:`bool` **use_colors** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ If ``true``, the **MultiMesh** will use color data (see :ref:`set_instance_color .. rst-class:: classref-property -:ref:`bool` **use_custom_data** = ``false`` +:ref:`bool` **use_custom_data** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ If ``true``, the **MultiMesh** will use custom data (see :ref:`set_instance_cust .. rst-class:: classref-property -:ref:`int` **visible_instance_count** = ``-1`` +:ref:`int` **visible_instance_count** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -362,7 +362,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **get_aabb**\ (\ ) |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| :ref:`🔗` Returns the visibility axis-aligned bounding box in local space. @@ -374,7 +374,7 @@ Returns the visibility axis-aligned bounding box in local space. .. rst-class:: classref-method -:ref:`Color` **get_instance_color**\ (\ instance\: :ref:`int`\ ) |const| +:ref:`Color` **get_instance_color**\ (\ instance\: :ref:`int`\ ) |const| :ref:`🔗` Gets a specific instance's color multiplier. @@ -386,7 +386,7 @@ Gets a specific instance's color multiplier. .. rst-class:: classref-method -:ref:`Color` **get_instance_custom_data**\ (\ instance\: :ref:`int`\ ) |const| +:ref:`Color` **get_instance_custom_data**\ (\ instance\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom data that has been set for a specific instance. @@ -398,7 +398,7 @@ Returns the custom data that has been set for a specific instance. .. rst-class:: classref-method -:ref:`Transform3D` **get_instance_transform**\ (\ instance\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_instance_transform**\ (\ instance\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Transform3D` of a specific instance. @@ -410,7 +410,7 @@ Returns the :ref:`Transform3D` of a specific instance. .. rst-class:: classref-method -:ref:`Transform2D` **get_instance_transform_2d**\ (\ instance\: :ref:`int`\ ) |const| +:ref:`Transform2D` **get_instance_transform_2d**\ (\ instance\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Transform2D` of a specific instance. @@ -422,7 +422,7 @@ Returns the :ref:`Transform2D` of a specific instance. .. rst-class:: classref-method -|void| **set_instance_color**\ (\ instance\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_instance_color**\ (\ instance\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color of a specific instance by *multiplying* the mesh's existing vertex colors. This allows for different color tinting per instance. @@ -436,7 +436,7 @@ For the color to take effect, ensure that :ref:`use_colors`, custom_data\: :ref:`Color`\ ) +|void| **set_instance_custom_data**\ (\ instance\: :ref:`int`, custom_data\: :ref:`Color`\ ) :ref:`🔗` Sets custom data for a specific instance. ``custom_data`` is a :ref:`Color` type only to contain 4 floating-point numbers. @@ -452,7 +452,7 @@ This custom instance data has to be manually accessed in your custom shader usin .. rst-class:: classref-method -|void| **set_instance_transform**\ (\ instance\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **set_instance_transform**\ (\ instance\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the :ref:`Transform3D` for a specific instance. @@ -464,7 +464,7 @@ Sets the :ref:`Transform3D` for a specific instance. .. rst-class:: classref-method -|void| **set_instance_transform_2d**\ (\ instance\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **set_instance_transform_2d**\ (\ instance\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the :ref:`Transform2D` for a specific instance. diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index 064b394415e..9e29da8416c 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -53,7 +53,7 @@ Signals .. rst-class:: classref-signal -**texture_changed**\ (\ ) +**texture_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`texture` is changed. @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`MultiMesh` **multimesh** +:ref:`MultiMesh` **multimesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -87,7 +87,7 @@ The :ref:`MultiMesh` that will be drawn by the **MultiMeshInsta .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_multimeshinstance3d.rst b/classes/class_multimeshinstance3d.rst index 7eaad349fe1..1484ec4102c 100644 --- a/classes/class_multimeshinstance3d.rst +++ b/classes/class_multimeshinstance3d.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`MultiMesh` **multimesh** +:ref:`MultiMesh` **multimesh** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index e0ce1b051f7..69bb3c49801 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -91,7 +91,7 @@ Signals .. rst-class:: classref-signal -**connected_to_server**\ (\ ) +**connected_to_server**\ (\ ) :ref:`🔗` Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` successfully connected to a server. Only emitted on clients. @@ -103,7 +103,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` fails to establish a connection to a server. Only emitted on clients. @@ -115,7 +115,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer`\ ) +**peer_connected**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). @@ -127,7 +127,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer`\ ) +**peer_disconnected**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. @@ -139,7 +139,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` disconnects from server. Only emitted on clients. @@ -156,7 +156,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **RPCMode**: +enum **RPCMode**: :ref:`🔗` .. _class_MultiplayerAPI_constant_RPC_MODE_DISABLED: @@ -195,7 +195,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`MultiplayerPeer` **multiplayer_peer** +:ref:`MultiplayerPeer` **multiplayer_peer** :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`MultiplayerAPI` **create_default_interface**\ (\ ) |static| +:ref:`MultiplayerAPI` **create_default_interface**\ (\ ) |static| :ref:`🔗` Returns a new instance of the default MultiplayerAPI. @@ -229,7 +229,7 @@ Returns a new instance of the default MultiplayerAPI. .. rst-class:: classref-method -:ref:`StringName` **get_default_interface**\ (\ ) |static| +:ref:`StringName` **get_default_interface**\ (\ ) |static| :ref:`🔗` Returns the default MultiplayerAPI implementation class name. This is usually ``"SceneMultiplayer"`` when :ref:`SceneMultiplayer` is available. See :ref:`set_default_interface`. @@ -241,7 +241,7 @@ Returns the default MultiplayerAPI implementation class name. This is usually `` .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_peers**\ (\ ) +:ref:`PackedInt32Array` **get_peers**\ (\ ) :ref:`🔗` Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`multiplayer_peer`. @@ -253,7 +253,7 @@ Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`multi .. rst-class:: classref-method -:ref:`int` **get_remote_sender_id**\ (\ ) +:ref:`int` **get_remote_sender_id**\ (\ ) :ref:`🔗` Returns the sender's peer ID for the RPC currently being executed. @@ -267,7 +267,7 @@ Returns the sender's peer ID for the RPC currently being executed. .. rst-class:: classref-method -:ref:`int` **get_unique_id**\ (\ ) +:ref:`int` **get_unique_id**\ (\ ) :ref:`🔗` Returns the unique peer ID of this MultiplayerAPI's :ref:`multiplayer_peer`. @@ -279,7 +279,7 @@ Returns the unique peer ID of this MultiplayerAPI's :ref:`multiplayer_peer` **has_multiplayer_peer**\ (\ ) +:ref:`bool` **has_multiplayer_peer**\ (\ ) :ref:`🔗` Returns ``true`` if there is a :ref:`multiplayer_peer` set. @@ -291,7 +291,7 @@ Returns ``true`` if there is a :ref:`multiplayer_peer` **is_server**\ (\ ) +:ref:`bool` **is_server**\ (\ ) :ref:`🔗` Returns ``true`` if this MultiplayerAPI's :ref:`multiplayer_peer` is valid and in server mode (listening for connections). @@ -303,7 +303,7 @@ Returns ``true`` if this MultiplayerAPI's :ref:`multiplayer_peer` **object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) +:ref:`Error` **object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) :ref:`🔗` Notifies the MultiplayerAPI of a new ``configuration`` for the given ``object``. This method is used internally by :ref:`SceneTree` to configure the root path for this MultiplayerAPI (passing ``null`` and a valid :ref:`NodePath` as ``configuration``). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. :ref:`SceneMultiplayer`) for details on how they use it. @@ -317,7 +317,7 @@ Notifies the MultiplayerAPI of a new ``configuration`` for the given ``object``. .. rst-class:: classref-method -:ref:`Error` **object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) +:ref:`Error` **object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) :ref:`🔗` Notifies the MultiplayerAPI to remove a ``configuration`` for the given ``object``. This method is used internally by :ref:`SceneTree` to configure the root path for this MultiplayerAPI (passing ``null`` and an empty :ref:`NodePath` as ``configuration``). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. :ref:`SceneMultiplayer`) for details on how they use it. @@ -331,7 +331,7 @@ Notifies the MultiplayerAPI to remove a ``configuration`` for the given ``object .. rst-class:: classref-method -:ref:`Error` **poll**\ (\ ) +:ref:`Error` **poll**\ (\ ) :ref:`🔗` Method used for polling the MultiplayerAPI. You only need to worry about this if you set :ref:`SceneTree.multiplayer_poll` to ``false``. By default, :ref:`SceneTree` will poll its MultiplayerAPI(s) for you. @@ -345,7 +345,7 @@ Method used for polling the MultiplayerAPI. You only need to worry about this if .. rst-class:: classref-method -:ref:`Error` **rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, arguments\: :ref:`Array` = []\ ) +:ref:`Error` **rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, arguments\: :ref:`Array` = []\ ) :ref:`🔗` Sends an RPC to the target ``peer``. The given ``method`` will be called on the remote ``object`` with the provided ``arguments``. The RPC may also be called locally depending on the implementation and RPC configuration. See :ref:`Node.rpc` and :ref:`Node.rpc_config`. @@ -359,7 +359,7 @@ Sends an RPC to the target ``peer``. The given ``method`` will be called on the .. rst-class:: classref-method -|void| **set_default_interface**\ (\ interface_name\: :ref:`StringName`\ ) |static| +|void| **set_default_interface**\ (\ interface_name\: :ref:`StringName`\ ) |static| :ref:`🔗` Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by :ref:`SceneTree` when the engine starts. diff --git a/classes/class_multiplayerapiextension.rst b/classes/class_multiplayerapiextension.rst index c58e3edc762..956a065341e 100644 --- a/classes/class_multiplayerapiextension.rst +++ b/classes/class_multiplayerapiextension.rst @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`MultiplayerPeer` **_get_multiplayer_peer**\ (\ ) |virtual| +:ref:`MultiplayerPeer` **_get_multiplayer_peer**\ (\ ) |virtual| :ref:`🔗` Called when the :ref:`MultiplayerAPI.multiplayer_peer` is retrieved. @@ -156,7 +156,7 @@ Called when the :ref:`MultiplayerAPI.multiplayer_peer` **_get_peer_ids**\ (\ ) |virtual| |const| +:ref:`PackedInt32Array` **_get_peer_ids**\ (\ ) |virtual| |const| :ref:`🔗` Callback for :ref:`MultiplayerAPI.get_peers`. @@ -168,7 +168,7 @@ Callback for :ref:`MultiplayerAPI.get_peers` **_get_remote_sender_id**\ (\ ) |virtual| |const| +:ref:`int` **_get_remote_sender_id**\ (\ ) |virtual| |const| :ref:`🔗` Callback for :ref:`MultiplayerAPI.get_remote_sender_id`. @@ -180,7 +180,7 @@ Callback for :ref:`MultiplayerAPI.get_remote_sender_id` **_get_unique_id**\ (\ ) |virtual| |const| +:ref:`int` **_get_unique_id**\ (\ ) |virtual| |const| :ref:`🔗` Callback for :ref:`MultiplayerAPI.get_unique_id`. @@ -192,7 +192,7 @@ Callback for :ref:`MultiplayerAPI.get_unique_id` **_object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| +:ref:`Error` **_object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.object_configuration_add`. @@ -204,7 +204,7 @@ Callback for :ref:`MultiplayerAPI.object_configuration_add` **_object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| +:ref:`Error` **_object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.object_configuration_remove`. @@ -216,7 +216,7 @@ Callback for :ref:`MultiplayerAPI.object_configuration_remove` **_poll**\ (\ ) |virtual| +:ref:`Error` **_poll**\ (\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.poll`. @@ -228,7 +228,7 @@ Callback for :ref:`MultiplayerAPI.poll`. .. rst-class:: classref-method -:ref:`Error` **_rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, args\: :ref:`Array`\ ) |virtual| +:ref:`Error` **_rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, args\: :ref:`Array`\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.rpc`. @@ -240,7 +240,7 @@ Callback for :ref:`MultiplayerAPI.rpc`. .. rst-class:: classref-method -|void| **_set_multiplayer_peer**\ (\ multiplayer_peer\: :ref:`MultiplayerPeer`\ ) |virtual| +|void| **_set_multiplayer_peer**\ (\ multiplayer_peer\: :ref:`MultiplayerPeer`\ ) |virtual| :ref:`🔗` Called when the :ref:`MultiplayerAPI.multiplayer_peer` is set. diff --git a/classes/class_multiplayerpeer.rst b/classes/class_multiplayerpeer.rst index 9da8b33e11a..fbd2b190a85 100644 --- a/classes/class_multiplayerpeer.rst +++ b/classes/class_multiplayerpeer.rst @@ -98,7 +98,7 @@ Signals .. rst-class:: classref-signal -**peer_connected**\ (\ id\: :ref:`int`\ ) +**peer_connected**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when a remote peer connects. @@ -110,7 +110,7 @@ Emitted when a remote peer connects. .. rst-class:: classref-signal -**peer_disconnected**\ (\ id\: :ref:`int`\ ) +**peer_disconnected**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when a remote peer has disconnected. @@ -127,7 +127,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ConnectionStatus**: +enum **ConnectionStatus**: :ref:`🔗` .. _class_MultiplayerPeer_constant_CONNECTION_DISCONNECTED: @@ -161,7 +161,7 @@ This MultiplayerPeer is connected. .. rst-class:: classref-enumeration -enum **TransferMode**: +enum **TransferMode**: :ref:`🔗` .. _class_MultiplayerPeer_constant_TRANSFER_MODE_UNRELIABLE: @@ -200,7 +200,7 @@ Constants .. rst-class:: classref-constant -**TARGET_PEER_BROADCAST** = ``0`` +**TARGET_PEER_BROADCAST** = ``0`` :ref:`🔗` Packets are sent to all connected peers. @@ -208,7 +208,7 @@ Packets are sent to all connected peers. .. rst-class:: classref-constant -**TARGET_PEER_SERVER** = ``1`` +**TARGET_PEER_SERVER** = ``1`` :ref:`🔗` Packets are sent to the remote peer acting as server. @@ -225,7 +225,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **refuse_new_connections** = ``false`` +:ref:`bool` **refuse_new_connections** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ If ``true``, this **MultiplayerPeer** refuses new connections. .. rst-class:: classref-property -:ref:`int` **transfer_channel** = ``0`` +:ref:`int` **transfer_channel** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -261,7 +261,7 @@ The channel to use to send packets. Many network APIs such as ENet and WebRTC al .. rst-class:: classref-property -:ref:`TransferMode` **transfer_mode** = ``2`` +:ref:`TransferMode` **transfer_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -283,7 +283,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **close**\ (\ ) +|void| **close**\ (\ ) :ref:`🔗` Immediately close the multiplayer peer returning to the state :ref:`CONNECTION_DISCONNECTED`. Connected peers will be dropped without emitting :ref:`peer_disconnected`. @@ -295,7 +295,7 @@ Immediately close the multiplayer peer returning to the state :ref:`CONNECTION_D .. rst-class:: classref-method -|void| **disconnect_peer**\ (\ peer\: :ref:`int`, force\: :ref:`bool` = false\ ) +|void| **disconnect_peer**\ (\ peer\: :ref:`int`, force\: :ref:`bool` = false\ ) :ref:`🔗` Disconnects the given ``peer`` from this host. If ``force`` is ``true`` the :ref:`peer_disconnected` signal will not be emitted for this peer. @@ -307,7 +307,7 @@ Disconnects the given ``peer`` from this host. If ``force`` is ``true`` the :ref .. rst-class:: classref-method -:ref:`int` **generate_unique_id**\ (\ ) |const| +:ref:`int` **generate_unique_id**\ (\ ) |const| :ref:`🔗` Returns a randomly generated integer that can be used as a network unique ID. @@ -319,7 +319,7 @@ Returns a randomly generated integer that can be used as a network unique ID. .. rst-class:: classref-method -:ref:`ConnectionStatus` **get_connection_status**\ (\ ) |const| +:ref:`ConnectionStatus` **get_connection_status**\ (\ ) |const| :ref:`🔗` Returns the current state of the connection. See :ref:`ConnectionStatus`. @@ -331,7 +331,7 @@ Returns the current state of the connection. See :ref:`ConnectionStatus` **get_packet_channel**\ (\ ) |const| +:ref:`int` **get_packet_channel**\ (\ ) |const| :ref:`🔗` Returns the channel over which the next available packet was received. See :ref:`PacketPeer.get_available_packet_count`. @@ -343,7 +343,7 @@ Returns the channel over which the next available packet was received. See :ref: .. rst-class:: classref-method -:ref:`TransferMode` **get_packet_mode**\ (\ ) |const| +:ref:`TransferMode` **get_packet_mode**\ (\ ) |const| :ref:`🔗` Returns the transfer mode the remote peer used to send the next available packet. See :ref:`PacketPeer.get_available_packet_count`. @@ -355,7 +355,7 @@ Returns the transfer mode the remote peer used to send the next available packet .. rst-class:: classref-method -:ref:`int` **get_packet_peer**\ (\ ) |const| +:ref:`int` **get_packet_peer**\ (\ ) |const| :ref:`🔗` Returns the ID of the **MultiplayerPeer** who sent the next available packet. See :ref:`PacketPeer.get_available_packet_count`. @@ -367,7 +367,7 @@ Returns the ID of the **MultiplayerPeer** who sent the next available packet. Se .. rst-class:: classref-method -:ref:`int` **get_unique_id**\ (\ ) |const| +:ref:`int` **get_unique_id**\ (\ ) |const| :ref:`🔗` Returns the ID of this **MultiplayerPeer**. @@ -379,7 +379,7 @@ Returns the ID of this **MultiplayerPeer**. .. rst-class:: classref-method -:ref:`bool` **is_server_relay_supported**\ (\ ) |const| +:ref:`bool` **is_server_relay_supported**\ (\ ) |const| :ref:`🔗` Returns true if the server can act as a relay in the current configuration (i.e. if the higher level :ref:`MultiplayerAPI` should notify connected clients of other peers, and implement a relay protocol to allow communication between them). @@ -391,7 +391,7 @@ Returns true if the server can act as a relay in the current configuration (i.e. .. rst-class:: classref-method -|void| **poll**\ (\ ) +|void| **poll**\ (\ ) :ref:`🔗` Waits up to 1 second to receive a new network event. @@ -403,7 +403,7 @@ Waits up to 1 second to receive a new network event. .. rst-class:: classref-method -|void| **set_target_peer**\ (\ id\: :ref:`int`\ ) +|void| **set_target_peer**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Sets the peer to which packets will be sent. diff --git a/classes/class_multiplayerpeerextension.rst b/classes/class_multiplayerpeerextension.rst index ec90bb4300f..3f6b528a147 100644 --- a/classes/class_multiplayerpeerextension.rst +++ b/classes/class_multiplayerpeerextension.rst @@ -93,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_close**\ (\ ) |virtual| +|void| **_close**\ (\ ) |virtual| :ref:`🔗` Called when the multiplayer peer should be immediately closed (see :ref:`MultiplayerPeer.close`). @@ -105,7 +105,7 @@ Called when the multiplayer peer should be immediately closed (see :ref:`Multipl .. rst-class:: classref-method -|void| **_disconnect_peer**\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| +|void| **_disconnect_peer**\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| :ref:`🔗` Called when the connected ``p_peer`` should be forcibly disconnected (see :ref:`MultiplayerPeer.disconnect_peer`). @@ -117,7 +117,7 @@ Called when the connected ``p_peer`` should be forcibly disconnected (see :ref:` .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| :ref:`🔗` Called when the available packet count is internally requested by the :ref:`MultiplayerAPI`. @@ -129,7 +129,7 @@ Called when the available packet count is internally requested by the :ref:`Mult .. rst-class:: classref-method -:ref:`ConnectionStatus` **_get_connection_status**\ (\ ) |virtual| |const| +:ref:`ConnectionStatus` **_get_connection_status**\ (\ ) |virtual| |const| :ref:`🔗` Called when the connection status is requested on the :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.get_connection_status`). @@ -141,7 +141,7 @@ Called when the connection status is requested on the :ref:`MultiplayerPeer` **_get_max_packet_size**\ (\ ) |virtual| |const| +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| :ref:`🔗` Called when the maximum allowed packet size (in bytes) is requested by the :ref:`MultiplayerAPI`. @@ -153,7 +153,7 @@ Called when the maximum allowed packet size (in bytes) is requested by the :ref: .. rst-class:: classref-method -:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| :ref:`🔗` Called when a packet needs to be received by the :ref:`MultiplayerAPI`, with ``r_buffer_size`` being the size of the binary ``r_buffer`` in bytes. @@ -165,7 +165,7 @@ Called when a packet needs to be received by the :ref:`MultiplayerAPI` **_get_packet_channel**\ (\ ) |virtual| |const| +:ref:`int` **_get_packet_channel**\ (\ ) |virtual| |const| :ref:`🔗` Called to get the channel over which the next available packet was received. See :ref:`MultiplayerPeer.get_packet_channel`. @@ -177,7 +177,7 @@ Called to get the channel over which the next available packet was received. See .. rst-class:: classref-method -:ref:`TransferMode` **_get_packet_mode**\ (\ ) |virtual| |const| +:ref:`TransferMode` **_get_packet_mode**\ (\ ) |virtual| |const| :ref:`🔗` Called to get the transfer mode the remote peer used to send the next available packet. See :ref:`MultiplayerPeer.get_packet_mode`. @@ -189,7 +189,7 @@ Called to get the transfer mode the remote peer used to send the next available .. rst-class:: classref-method -:ref:`int` **_get_packet_peer**\ (\ ) |virtual| |const| +:ref:`int` **_get_packet_peer**\ (\ ) |virtual| |const| :ref:`🔗` Called when the ID of the :ref:`MultiplayerPeer` who sent the most recent packet is requested (see :ref:`MultiplayerPeer.get_packet_peer`). @@ -201,7 +201,7 @@ Called when the ID of the :ref:`MultiplayerPeer` who sent .. rst-class:: classref-method -:ref:`PackedByteArray` **_get_packet_script**\ (\ ) |virtual| +:ref:`PackedByteArray` **_get_packet_script**\ (\ ) |virtual| :ref:`🔗` Called when a packet needs to be received by the :ref:`MultiplayerAPI`, if :ref:`_get_packet` isn't implemented. Use this when extending this class via GDScript. @@ -213,7 +213,7 @@ Called when a packet needs to be received by the :ref:`MultiplayerAPI` **_get_transfer_channel**\ (\ ) |virtual| |const| +:ref:`int` **_get_transfer_channel**\ (\ ) |virtual| |const| :ref:`🔗` Called when the transfer channel to use is read on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_channel`). @@ -225,7 +225,7 @@ Called when the transfer channel to use is read on this :ref:`MultiplayerPeer` **_get_transfer_mode**\ (\ ) |virtual| |const| +:ref:`TransferMode` **_get_transfer_mode**\ (\ ) |virtual| |const| :ref:`🔗` Called when the transfer mode to use is read on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_mode`). @@ -237,7 +237,7 @@ Called when the transfer mode to use is read on this :ref:`MultiplayerPeer` **_get_unique_id**\ (\ ) |virtual| |const| +:ref:`int` **_get_unique_id**\ (\ ) |virtual| |const| :ref:`🔗` Called when the unique ID of this :ref:`MultiplayerPeer` is requested (see :ref:`MultiplayerPeer.get_unique_id`). The value must be between ``1`` and ``2147483647``. @@ -249,7 +249,7 @@ Called when the unique ID of this :ref:`MultiplayerPeer` .. rst-class:: classref-method -:ref:`bool` **_is_refusing_new_connections**\ (\ ) |virtual| |const| +:ref:`bool` **_is_refusing_new_connections**\ (\ ) |virtual| |const| :ref:`🔗` Called when the "refuse new connections" status is requested on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.refuse_new_connections`). @@ -261,7 +261,7 @@ Called when the "refuse new connections" status is requested on this :ref:`Multi .. rst-class:: classref-method -:ref:`bool` **_is_server**\ (\ ) |virtual| |const| +:ref:`bool` **_is_server**\ (\ ) |virtual| |const| :ref:`🔗` Called when the "is server" status is requested on the :ref:`MultiplayerAPI`. See :ref:`MultiplayerAPI.is_server`. @@ -273,7 +273,7 @@ Called when the "is server" status is requested on the :ref:`MultiplayerAPI` **_is_server_relay_supported**\ (\ ) |virtual| |const| +:ref:`bool` **_is_server_relay_supported**\ (\ ) |virtual| |const| :ref:`🔗` Called to check if the server can act as a relay in the current configuration. See :ref:`MultiplayerPeer.is_server_relay_supported`. @@ -285,7 +285,7 @@ Called to check if the server can act as a relay in the current configuration. S .. rst-class:: classref-method -|void| **_poll**\ (\ ) |virtual| +|void| **_poll**\ (\ ) |virtual| :ref:`🔗` Called when the :ref:`MultiplayerAPI` is polled. See :ref:`MultiplayerAPI.poll`. @@ -297,7 +297,7 @@ Called when the :ref:`MultiplayerAPI` is polled. See :ref: .. rst-class:: classref-method -:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| +:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| :ref:`🔗` Called when a packet needs to be sent by the :ref:`MultiplayerAPI`, with ``p_buffer_size`` being the size of the binary ``p_buffer`` in bytes. @@ -309,7 +309,7 @@ Called when a packet needs to be sent by the :ref:`MultiplayerAPI` **_put_packet_script**\ (\ p_buffer\: :ref:`PackedByteArray`\ ) |virtual| +:ref:`Error` **_put_packet_script**\ (\ p_buffer\: :ref:`PackedByteArray`\ ) |virtual| :ref:`🔗` Called when a packet needs to be sent by the :ref:`MultiplayerAPI`, if :ref:`_put_packet` isn't implemented. Use this when extending this class via GDScript. @@ -321,7 +321,7 @@ Called when a packet needs to be sent by the :ref:`MultiplayerAPI`\ ) |virtual| +|void| **_set_refuse_new_connections**\ (\ p_enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` Called when the "refuse new connections" status is set on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.refuse_new_connections`). @@ -333,7 +333,7 @@ Called when the "refuse new connections" status is set on this :ref:`Multiplayer .. rst-class:: classref-method -|void| **_set_target_peer**\ (\ p_peer\: :ref:`int`\ ) |virtual| +|void| **_set_target_peer**\ (\ p_peer\: :ref:`int`\ ) |virtual| :ref:`🔗` Called when the target peer to use is set for this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.set_target_peer`). @@ -345,7 +345,7 @@ Called when the target peer to use is set for this :ref:`MultiplayerPeer`\ ) |virtual| +|void| **_set_transfer_channel**\ (\ p_channel\: :ref:`int`\ ) |virtual| :ref:`🔗` Called when the channel to use is set for this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_channel`). @@ -357,7 +357,7 @@ Called when the channel to use is set for this :ref:`MultiplayerPeer`\ ) |virtual| +|void| **_set_transfer_mode**\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| :ref:`🔗` Called when the transfer mode is set on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_mode`). diff --git a/classes/class_multiplayerspawner.rst b/classes/class_multiplayerspawner.rst index 88c67d53cb3..557d860fb72 100644 --- a/classes/class_multiplayerspawner.rst +++ b/classes/class_multiplayerspawner.rst @@ -77,7 +77,7 @@ Signals .. rst-class:: classref-signal -**despawned**\ (\ node\: :ref:`Node`\ ) +**despawned**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when a spawnable scene or custom spawn was despawned by the multiplayer authority. Only called on puppets. @@ -89,7 +89,7 @@ Emitted when a spawnable scene or custom spawn was despawned by the multiplayer .. rst-class:: classref-signal -**spawned**\ (\ node\: :ref:`Node`\ ) +**spawned**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when a spawnable scene or custom spawn was spawned by the multiplayer authority. Only called on puppets. @@ -106,7 +106,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Callable` **spawn_function** +:ref:`Callable` **spawn_function** :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ Method called on all peers when for every custom :ref:`spawn` **spawn_limit** = ``0`` +:ref:`int` **spawn_limit** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ When set to ``0`` (the default), there is no limit. .. rst-class:: classref-property -:ref:`NodePath` **spawn_path** = ``NodePath("")`` +:ref:`NodePath` **spawn_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_spawnable_scene**\ (\ path\: :ref:`String`\ ) +|void| **add_spawnable_scene**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Adds a scene path to spawnable scenes, making it automatically replicated from the multiplayer authority to other peers when added as children of the node pointed by :ref:`spawn_path`. @@ -178,7 +178,7 @@ Adds a scene path to spawnable scenes, making it automatically replicated from t .. rst-class:: classref-method -|void| **clear_spawnable_scenes**\ (\ ) +|void| **clear_spawnable_scenes**\ (\ ) :ref:`🔗` Clears all spawnable scenes. Does not despawn existing instances on remote peers. @@ -190,7 +190,7 @@ Clears all spawnable scenes. Does not despawn existing instances on remote peers .. rst-class:: classref-method -:ref:`String` **get_spawnable_scene**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **get_spawnable_scene**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the spawnable scene path by index. @@ -202,7 +202,7 @@ Returns the spawnable scene path by index. .. rst-class:: classref-method -:ref:`int` **get_spawnable_scene_count**\ (\ ) |const| +:ref:`int` **get_spawnable_scene_count**\ (\ ) |const| :ref:`🔗` Returns the count of spawnable scene paths. @@ -214,7 +214,7 @@ Returns the count of spawnable scene paths. .. rst-class:: classref-method -:ref:`Node` **spawn**\ (\ data\: :ref:`Variant` = null\ ) +:ref:`Node` **spawn**\ (\ data\: :ref:`Variant` = null\ ) :ref:`🔗` Requests a custom spawn, with ``data`` passed to :ref:`spawn_function` on all peers. Returns the locally spawned node instance already inside the scene tree, and added as a child of the node pointed by :ref:`spawn_path`. diff --git a/classes/class_multiplayersynchronizer.rst b/classes/class_multiplayersynchronizer.rst index e3029600bc9..fe1036fce01 100644 --- a/classes/class_multiplayersynchronizer.rst +++ b/classes/class_multiplayersynchronizer.rst @@ -87,7 +87,7 @@ Signals .. rst-class:: classref-signal -**delta_synchronized**\ (\ ) +**delta_synchronized**\ (\ ) :ref:`🔗` Emitted when a new delta synchronization state is received by this synchronizer after the properties have been updated. @@ -99,7 +99,7 @@ Emitted when a new delta synchronization state is received by this synchronizer .. rst-class:: classref-signal -**synchronized**\ (\ ) +**synchronized**\ (\ ) :ref:`🔗` Emitted when a new synchronization state is received by this synchronizer after the properties have been updated. @@ -111,7 +111,7 @@ Emitted when a new synchronization state is received by this synchronizer after .. rst-class:: classref-signal -**visibility_changed**\ (\ for_peer\: :ref:`int`\ ) +**visibility_changed**\ (\ for_peer\: :ref:`int`\ ) :ref:`🔗` Emitted when visibility of ``for_peer`` is updated. See :ref:`update_visibility`. @@ -128,7 +128,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **VisibilityUpdateMode**: +enum **VisibilityUpdateMode**: :ref:`🔗` .. _class_MultiplayerSynchronizer_constant_VISIBILITY_PROCESS_IDLE: @@ -167,7 +167,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **delta_interval** = ``0.0`` +:ref:`float` **delta_interval** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ Time interval between delta synchronizations. When set to ``0.0`` (the default), .. rst-class:: classref-property -:ref:`bool` **public_visibility** = ``true`` +:ref:`bool` **public_visibility** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ Whether synchronization should be visible to all peers by default. See :ref:`set .. rst-class:: classref-property -:ref:`SceneReplicationConfig` **replication_config** +:ref:`SceneReplicationConfig` **replication_config** :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Resource containing which properties to synchronize. .. rst-class:: classref-property -:ref:`float` **replication_interval** = ``0.0`` +:ref:`float` **replication_interval** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -235,7 +235,7 @@ Time interval between synchronizations. When set to ``0.0`` (the default), synch .. rst-class:: classref-property -:ref:`NodePath` **root_path** = ``NodePath("..")`` +:ref:`NodePath` **root_path** = ``NodePath("..")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ If :ref:`root_path` was spawne .. rst-class:: classref-property -:ref:`VisibilityUpdateMode` **visibility_update_mode** = ``0`` +:ref:`VisibilityUpdateMode` **visibility_update_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_visibility_filter**\ (\ filter\: :ref:`Callable`\ ) +|void| **add_visibility_filter**\ (\ filter\: :ref:`Callable`\ ) :ref:`🔗` Adds a peer visibility filter for this synchronizer. @@ -290,7 +290,7 @@ Adds a peer visibility filter for this synchronizer. .. rst-class:: classref-method -:ref:`bool` **get_visibility_for**\ (\ peer\: :ref:`int`\ ) |const| +:ref:`bool` **get_visibility_for**\ (\ peer\: :ref:`int`\ ) |const| :ref:`🔗` Queries the current visibility for peer ``peer``. @@ -302,7 +302,7 @@ Queries the current visibility for peer ``peer``. .. rst-class:: classref-method -|void| **remove_visibility_filter**\ (\ filter\: :ref:`Callable`\ ) +|void| **remove_visibility_filter**\ (\ filter\: :ref:`Callable`\ ) :ref:`🔗` Removes a peer visibility filter from this synchronizer. @@ -314,7 +314,7 @@ Removes a peer visibility filter from this synchronizer. .. rst-class:: classref-method -|void| **set_visibility_for**\ (\ peer\: :ref:`int`, visible\: :ref:`bool`\ ) +|void| **set_visibility_for**\ (\ peer\: :ref:`int`, visible\: :ref:`bool`\ ) :ref:`🔗` Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value of :ref:`public_visibility` will be updated instead. @@ -326,7 +326,7 @@ Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value .. rst-class:: classref-method -|void| **update_visibility**\ (\ for_peer\: :ref:`int` = 0\ ) +|void| **update_visibility**\ (\ for_peer\: :ref:`int` = 0\ ) :ref:`🔗` Updates the visibility of ``for_peer`` according to visibility filters. If ``for_peer`` is ``0`` (the default), all peers' visibilties are updated. diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 2aca65ceadb..aacea2cc3c7 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **lock**\ (\ ) +|void| **lock**\ (\ ) :ref:`🔗` Locks this **Mutex**, blocks until it is unlocked by the current owner. @@ -83,7 +83,7 @@ Locks this **Mutex**, blocks until it is unlocked by the current owner. .. rst-class:: classref-method -:ref:`bool` **try_lock**\ (\ ) +:ref:`bool` **try_lock**\ (\ ) :ref:`🔗` Tries locking this **Mutex**, but does not block. Returns ``true`` on success, ``false`` otherwise. @@ -97,7 +97,7 @@ Tries locking this **Mutex**, but does not block. Returns ``true`` on success, ` .. rst-class:: classref-method -|void| **unlock**\ (\ ) +|void| **unlock**\ (\ ) :ref:`🔗` Unlocks this **Mutex**, leaving it to other threads. diff --git a/classes/class_nativemenu.rst b/classes/class_nativemenu.rst index e2f0a7f95e6..fada3179b41 100644 --- a/classes/class_nativemenu.rst +++ b/classes/class_nativemenu.rst @@ -206,7 +206,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Feature**: +enum **Feature**: :ref:`🔗` .. _class_NativeMenu_constant_FEATURE_GLOBAL_MENU: @@ -256,7 +256,7 @@ enum **Feature**: .. rst-class:: classref-enumeration -enum **SystemMenus**: +enum **SystemMenus**: :ref:`🔗` .. _class_NativeMenu_constant_INVALID_MENU_ID: @@ -319,7 +319,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_check_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_check_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new checkable item with text ``label`` to the global menu ``rid``. @@ -341,7 +341,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_icon_check_item**\ (\ rid\: :ref:`RID`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_icon_check_item**\ (\ rid\: :ref:`RID`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu ``rid``. @@ -363,7 +363,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_icon_item**\ (\ rid\: :ref:`RID`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_icon_item**\ (\ rid\: :ref:`RID`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new item with text ``label`` and icon ``icon`` to the global menu ``rid``. @@ -385,7 +385,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_icon_radio_check_item**\ (\ rid\: :ref:`RID`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_icon_radio_check_item**\ (\ rid\: :ref:`RID`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu ``rid``. @@ -409,7 +409,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new item with text ``label`` to the global menu ``rid``. @@ -431,7 +431,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_multistate_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_multistate_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new item with text ``label`` to the global menu ``rid``. @@ -457,7 +457,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_radio_check_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) +:ref:`int` **add_radio_check_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new radio-checkable item with text ``label`` to the global menu ``rid``. @@ -481,7 +481,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **add_separator**\ (\ rid\: :ref:`RID`, index\: :ref:`int` = -1\ ) +:ref:`int` **add_separator**\ (\ rid\: :ref:`RID`, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a separator between items to the global menu ``rid``. Separators also occupy an index. @@ -497,7 +497,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. rst-class:: classref-method -:ref:`int` **add_submenu_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, submenu_rid\: :ref:`RID`, tag\: :ref:`Variant` = null, index\: :ref:`int` = -1\ ) +:ref:`int` **add_submenu_item**\ (\ rid\: :ref:`RID`, label\: :ref:`String`, submenu_rid\: :ref:`RID`, tag\: :ref:`Variant` = null, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds an item that will act as a submenu of the global menu ``rid``. The ``submenu_rid`` argument is the RID of the global menu that will be shown when the item is clicked. @@ -513,7 +513,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. rst-class:: classref-method -|void| **clear**\ (\ rid\: :ref:`RID`\ ) +|void| **clear**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Removes all items from the global menu ``rid``. @@ -527,7 +527,7 @@ Removes all items from the global menu ``rid``. .. rst-class:: classref-method -:ref:`RID` **create_menu**\ (\ ) +:ref:`RID` **create_menu**\ (\ ) :ref:`🔗` Creates a new global menu object. @@ -541,7 +541,7 @@ Creates a new global menu object. .. rst-class:: classref-method -:ref:`int` **find_item_index_with_submenu**\ (\ rid\: :ref:`RID`, submenu_rid\: :ref:`RID`\ ) |const| +:ref:`int` **find_item_index_with_submenu**\ (\ rid\: :ref:`RID`, submenu_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the index of the item with the submenu specified by ``submenu_rid``. Indices are automatically assigned to each item by the engine, and cannot be set manually. @@ -555,7 +555,7 @@ Returns the index of the item with the submenu specified by ``submenu_rid``. Ind .. rst-class:: classref-method -:ref:`int` **find_item_index_with_tag**\ (\ rid\: :ref:`RID`, tag\: :ref:`Variant`\ ) |const| +:ref:`int` **find_item_index_with_tag**\ (\ rid\: :ref:`RID`, tag\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns the index of the item with the specified ``tag``. Indices are automatically assigned to each item by the engine, and cannot be set manually. @@ -569,7 +569,7 @@ Returns the index of the item with the specified ``tag``. Indices are automatica .. rst-class:: classref-method -:ref:`int` **find_item_index_with_text**\ (\ rid\: :ref:`RID`, text\: :ref:`String`\ ) |const| +:ref:`int` **find_item_index_with_text**\ (\ rid\: :ref:`RID`, text\: :ref:`String`\ ) |const| :ref:`🔗` Returns the index of the item with the specified ``text``. Indices are automatically assigned to each item by the engine, and cannot be set manually. @@ -583,7 +583,7 @@ Returns the index of the item with the specified ``text``. Indices are automatic .. rst-class:: classref-method -|void| **free_menu**\ (\ rid\: :ref:`RID`\ ) +|void| **free_menu**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Frees a global menu object created by this **NativeMenu**. @@ -597,7 +597,7 @@ Frees a global menu object created by this **NativeMenu**. .. rst-class:: classref-method -:ref:`Key` **get_item_accelerator**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`Key` **get_item_accelerator**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` 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. @@ -611,7 +611,7 @@ Returns the accelerator of the item at index ``idx``. Accelerators are special c .. rst-class:: classref-method -:ref:`Callable` **get_item_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`Callable` **get_item_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the callback of the item at index ``idx``. @@ -625,7 +625,7 @@ Returns the callback of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_count**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`int` **get_item_count**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns number of items in the global menu ``rid``. @@ -639,7 +639,7 @@ Returns number of items in the global menu ``rid``. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_item_icon**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon of the item at index ``idx``. @@ -653,7 +653,7 @@ Returns the icon of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_indentation_level**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`int` **get_item_indentation_level**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the horizontal offset of the item at the given ``idx``. @@ -667,7 +667,7 @@ Returns the horizontal offset of the item at the given ``idx``. .. rst-class:: classref-method -:ref:`Callable` **get_item_key_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`Callable` **get_item_key_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the callback of the item accelerator at index ``idx``. @@ -681,7 +681,7 @@ Returns the callback of the item accelerator at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_max_states**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`int` **get_item_max_states**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns number of states of a multistate item. See :ref:`add_multistate_item` for details. @@ -695,7 +695,7 @@ Returns number of states of a multistate item. See :ref:`add_multistate_item` **get_item_state**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`int` **get_item_state**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the state of a multistate item. See :ref:`add_multistate_item` for details. @@ -709,7 +709,7 @@ Returns the state of a multistate item. See :ref:`add_multistate_item` **get_item_submenu**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`RID` **get_item_submenu**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the submenu ID of the item at index ``idx``. See :ref:`add_submenu_item` for more info on how to add a submenu. @@ -723,7 +723,7 @@ Returns the submenu ID of the item at index ``idx``. See :ref:`add_submenu_item< .. rst-class:: classref-method -:ref:`Variant` **get_item_tag**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_item_tag**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_tag`, which provides a simple way of assigning context data to items. @@ -737,7 +737,7 @@ Returns the metadata of the specified item, which might be of any type. You can .. rst-class:: classref-method -:ref:`String` **get_item_text**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_text**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text of the item at index ``idx``. @@ -751,7 +751,7 @@ Returns the text of the item at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_tooltip**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip associated with the specified index ``idx``. @@ -765,7 +765,7 @@ Returns the tooltip associated with the specified index ``idx``. .. rst-class:: classref-method -:ref:`float` **get_minimum_width**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`float` **get_minimum_width**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns global menu minimum width. @@ -779,7 +779,7 @@ Returns global menu minimum width. .. rst-class:: classref-method -:ref:`Callable` **get_popup_close_callback**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`Callable` **get_popup_close_callback**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns global menu close callback. @@ -793,7 +793,7 @@ b]Note:** This method is implemented only on macOS. .. rst-class:: classref-method -:ref:`Callable` **get_popup_open_callback**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`Callable` **get_popup_open_callback**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns global menu open callback. @@ -807,7 +807,7 @@ b]Note:** This method is implemented only on macOS. .. rst-class:: classref-method -:ref:`Vector2` **get_size**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`Vector2` **get_size**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns global menu size. @@ -821,7 +821,7 @@ Returns global menu size. .. rst-class:: classref-method -:ref:`RID` **get_system_menu**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| +:ref:`RID` **get_system_menu**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| :ref:`🔗` Returns RID of a special system menu. @@ -835,7 +835,7 @@ Returns RID of a special system menu. .. rst-class:: classref-method -:ref:`String` **get_system_menu_name**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| +:ref:`String` **get_system_menu_name**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| :ref:`🔗` Returns readable name of a special system menu. @@ -849,7 +849,7 @@ Returns readable name of a special system menu. .. rst-class:: classref-method -:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``feature`` is supported by the current **NativeMenu**, ``false`` otherwise. @@ -863,7 +863,7 @@ Returns ``true`` if the specified ``feature`` is supported by the current **Nati .. rst-class:: classref-method -:ref:`bool` **has_menu**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`bool` **has_menu**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if ``rid`` is valid global menu. @@ -877,7 +877,7 @@ Returns ``true`` if ``rid`` is valid global menu. .. rst-class:: classref-method -:ref:`bool` **has_system_menu**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| +:ref:`bool` **has_system_menu**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| :ref:`🔗` Returns ``true`` if a special system menu is supported. @@ -891,7 +891,7 @@ Returns ``true`` if a special system menu is supported. .. rst-class:: classref-method -:ref:`bool` **is_item_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button. @@ -905,7 +905,7 @@ Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if .. rst-class:: classref-method -:ref:`bool` **is_item_checked**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_checked**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` is checked. @@ -919,7 +919,7 @@ Returns ``true`` if the item at index ``idx`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_item_disabled**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_disabled**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked. @@ -935,7 +935,7 @@ See :ref:`set_item_disabled` for more .. rst-class:: classref-method -:ref:`bool` **is_item_hidden**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_hidden**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` is hidden. @@ -951,7 +951,7 @@ See :ref:`set_item_hidden` for more inf .. rst-class:: classref-method -:ref:`bool` **is_item_radio_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_radio_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` has radio button-style checkability. @@ -967,7 +967,7 @@ Returns ``true`` if the item at index ``idx`` has radio button-style checkabilit .. rst-class:: classref-method -:ref:`bool` **is_system_menu**\ (\ rid\: :ref:`RID`\ ) |const| +:ref:`bool` **is_system_menu**\ (\ rid\: :ref:`RID`\ ) |const| :ref:`🔗` Return ``true`` is global menu is a special system menu. @@ -981,7 +981,7 @@ Return ``true`` is global menu is a special system menu. .. rst-class:: classref-method -|void| **popup**\ (\ rid\: :ref:`RID`, position\: :ref:`Vector2i`\ ) +|void| **popup**\ (\ rid\: :ref:`RID`, position\: :ref:`Vector2i`\ ) :ref:`🔗` Shows the global menu at ``position`` in the screen coordinates. @@ -995,7 +995,7 @@ Shows the global menu at ``position`` in the screen coordinates. .. rst-class:: classref-method -|void| **remove_item**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) +|void| **remove_item**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) :ref:`🔗` Removes the item at index ``idx`` from the global menu ``rid``. @@ -1011,7 +1011,7 @@ Removes the item at index ``idx`` from the global menu ``rid``. .. rst-class:: classref-method -|void| **set_interface_direction**\ (\ rid\: :ref:`RID`, is_rtl\: :ref:`bool`\ ) +|void| **set_interface_direction**\ (\ rid\: :ref:`RID`, is_rtl\: :ref:`bool`\ ) :ref:`🔗` Sets the menu text layout direction from right-to-left if ``is_rtl`` is ``true``. @@ -1025,7 +1025,7 @@ Sets the menu text layout direction from right-to-left if ``is_rtl`` is ``true`` .. rst-class:: classref-method -|void| **set_item_accelerator**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) +|void| **set_item_accelerator**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) :ref:`🔗` Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single :ref:`Key`, or a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). @@ -1039,7 +1039,7 @@ Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single : .. rst-class:: classref-method -|void| **set_item_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) +|void| **set_item_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed. @@ -1055,7 +1055,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when an item .. rst-class:: classref-method -|void| **set_item_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) +|void| **set_item_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text. @@ -1069,7 +1069,7 @@ Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the ty .. rst-class:: classref-method -|void| **set_item_checked**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) +|void| **set_item_checked**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) :ref:`🔗` Sets the checkstate status of the item at index ``idx``. @@ -1083,7 +1083,7 @@ Sets the checkstate status of the item at index ``idx``. .. rst-class:: classref-method -|void| **set_item_disabled**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_item_disabled**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked. @@ -1097,7 +1097,7 @@ Enables/disables the item at index ``idx``. When it is disabled, it can't be sel .. rst-class:: classref-method -|void| **set_item_hidden**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) +|void| **set_item_hidden**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) :ref:`🔗` Hides/shows the item at index ``idx``. When it is hidden, an item does not appear in a menu and its action cannot be invoked. @@ -1111,7 +1111,7 @@ Hides/shows the item at index ``idx``. When it is hidden, an item does not appea .. rst-class:: classref-method -|void| **set_item_hover_callbacks**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) +|void| **set_item_hover_callbacks**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered. @@ -1127,7 +1127,7 @@ Sets the callback of the item at index ``idx``. The callback is emitted when an .. rst-class:: classref-method -|void| **set_item_icon**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_item_icon**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Replaces the :ref:`Texture2D` icon of the specified ``idx``. @@ -1143,7 +1143,7 @@ Replaces the :ref:`Texture2D` icon of the specified ``idx``. .. rst-class:: classref-method -|void| **set_item_indentation_level**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, level\: :ref:`int`\ ) +|void| **set_item_indentation_level**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, level\: :ref:`int`\ ) :ref:`🔗` Sets the horizontal offset of the item at the given ``idx``. @@ -1157,7 +1157,7 @@ Sets the horizontal offset of the item at the given ``idx``. .. rst-class:: classref-method -|void| **set_item_key_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) +|void| **set_item_key_callback**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated. @@ -1173,7 +1173,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when its acc .. rst-class:: classref-method -|void| **set_item_max_states**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) +|void| **set_item_max_states**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) :ref:`🔗` Sets number of state of a multistate item. See :ref:`add_multistate_item` for details. @@ -1187,7 +1187,7 @@ Sets number of state of a multistate item. See :ref:`add_multistate_item`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) +|void| **set_item_radio_checkable**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) :ref:`🔗` Sets the type of the item at the specified index ``idx`` to radio button. If ``false``, sets the type of the item to plain text. @@ -1203,7 +1203,7 @@ Sets the type of the item at the specified index ``idx`` to radio button. If ``f .. rst-class:: classref-method -|void| **set_item_state**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, state\: :ref:`int`\ ) +|void| **set_item_state**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, state\: :ref:`int`\ ) :ref:`🔗` Sets the state of a multistate item. See :ref:`add_multistate_item` for details. @@ -1217,7 +1217,7 @@ Sets the state of a multistate item. See :ref:`add_multistate_item`, idx\: :ref:`int`, submenu_rid\: :ref:`RID`\ ) +|void| **set_item_submenu**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, submenu_rid\: :ref:`RID`\ ) :ref:`🔗` Sets the submenu RID of the item at index ``idx``. The submenu is a global menu that would be shown when the item is clicked. @@ -1231,7 +1231,7 @@ Sets the submenu RID of the item at index ``idx``. The submenu is a global menu .. rst-class:: classref-method -|void| **set_item_tag**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) +|void| **set_item_tag**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata of an item, which may be of any type. You can later get it with :ref:`get_item_tag`, which provides a simple way of assigning context data to items. @@ -1245,7 +1245,7 @@ Sets the metadata of an item, which may be of any type. You can later get it wit .. rst-class:: classref-method -|void| **set_item_text**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_item_text**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets the text of the item at index ``idx``. @@ -1259,7 +1259,7 @@ Sets the text of the item at index ``idx``. .. rst-class:: classref-method -|void| **set_item_tooltip**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_item_tooltip**\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the :ref:`String` tooltip of the item at the specified index ``idx``. @@ -1273,7 +1273,7 @@ Sets the :ref:`String` tooltip of the item at the specified index .. rst-class:: classref-method -|void| **set_minimum_width**\ (\ rid\: :ref:`RID`, width\: :ref:`float`\ ) +|void| **set_minimum_width**\ (\ rid\: :ref:`RID`, width\: :ref:`float`\ ) :ref:`🔗` Sets the minimum width of the global menu. @@ -1287,7 +1287,7 @@ Sets the minimum width of the global menu. .. rst-class:: classref-method -|void| **set_popup_close_callback**\ (\ rid\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **set_popup_close_callback**\ (\ rid\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Registers callable to emit when the menu is about to show. @@ -1301,7 +1301,7 @@ Registers callable to emit when the menu is about to show. .. rst-class:: classref-method -|void| **set_popup_open_callback**\ (\ rid\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **set_popup_open_callback**\ (\ rid\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Registers callable to emit when the menu is about to closed. diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index d8829b453e1..c478eef2f29 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -157,7 +157,7 @@ Signals .. rst-class:: classref-signal -**link_reached**\ (\ details\: :ref:`Dictionary`\ ) +**link_reached**\ (\ details\: :ref:`Dictionary`\ ) :ref:`🔗` Signals that the agent reached a navigation link. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path when that position is a navigation link. @@ -183,7 +183,7 @@ The details dictionary may contain the following keys depending on the value of .. rst-class:: classref-signal -**navigation_finished**\ (\ ) +**navigation_finished**\ (\ ) :ref:`🔗` Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path. @@ -197,7 +197,7 @@ This signal will be emitted just after :ref:`target_reached` Emitted when the agent had to update the loaded path: @@ -215,7 +215,7 @@ Emitted when the agent had to update the loaded path: .. rst-class:: classref-signal -**target_reached**\ (\ ) +**target_reached**\ (\ ) :ref:`🔗` Signals that the agent reached the target, i.e. the agent moved within :ref:`target_desired_distance` of the :ref:`target_position`. This signal is emitted only once per loaded path. @@ -231,9 +231,9 @@ It may not always be possible to reach the target but it should always be possib .. rst-class:: classref-signal -**velocity_computed**\ (\ safe_velocity\: :ref:`Vector2`\ ) +**velocity_computed**\ (\ safe_velocity\: :ref:`Vector2`\ ) :ref:`🔗` -Notifies when the collision avoidance velocity is calculated. Emitted when :ref:`velocity` is set. Only emitted when :ref:`avoidance_enabled` is true. +Notifies when the collision avoidance velocity is calculated. Emitted every update as long as :ref:`avoidance_enabled` is ``true`` and the agent has a navigation map. .. rst-class:: classref-item-separator @@ -243,7 +243,7 @@ Notifies when the collision avoidance velocity is calculated. Emitted when :ref: .. rst-class:: classref-signal -**waypoint_reached**\ (\ details\: :ref:`Dictionary`\ ) +**waypoint_reached**\ (\ details\: :ref:`Dictionary`\ ) :ref:`🔗` Signals that the agent reached a waypoint. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path. @@ -270,7 +270,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **avoidance_enabled** = ``false`` +:ref:`bool` **avoidance_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -287,7 +287,7 @@ If ``true`` the agent is registered for an RVO avoidance callback on the :ref:`N .. rst-class:: classref-property -:ref:`int` **avoidance_layers** = ``1`` +:ref:`int` **avoidance_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ A bitfield determining the avoidance layers for this NavigationAgent. Other agen .. rst-class:: classref-property -:ref:`int` **avoidance_mask** = ``1`` +:ref:`int` **avoidance_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -321,7 +321,7 @@ A bitfield determining what other avoidance agents and obstacles this Navigation .. rst-class:: classref-property -:ref:`float` **avoidance_priority** = ``1.0`` +:ref:`float` **avoidance_priority** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -338,7 +338,7 @@ The agent does not adjust the velocity for other agents that would match the :re .. rst-class:: classref-property -:ref:`bool` **debug_enabled** = ``false`` +:ref:`bool` **debug_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -355,7 +355,7 @@ If ``true`` shows debug visuals for this agent. .. rst-class:: classref-property -:ref:`Color` **debug_path_custom_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **debug_path_custom_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -372,7 +372,7 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property -:ref:`float` **debug_path_custom_line_width** = ``-1.0`` +:ref:`float` **debug_path_custom_line_width** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -389,7 +389,7 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property -:ref:`float` **debug_path_custom_point_size** = ``4.0`` +:ref:`float` **debug_path_custom_point_size** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -406,7 +406,7 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property -:ref:`bool` **debug_use_custom** = ``false`` +:ref:`bool` **debug_use_custom** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -423,7 +423,7 @@ If ``true`` uses the defined :ref:`debug_path_custom_color` **max_neighbors** = ``10`` +:ref:`int` **max_neighbors** = ``10`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -440,7 +440,7 @@ The maximum number of neighbors for the agent to consider. .. rst-class:: classref-property -:ref:`float` **max_speed** = ``100.0`` +:ref:`float` **max_speed** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -457,7 +457,7 @@ The maximum speed that an agent can move. .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -474,7 +474,7 @@ A bitfield determining which navigation layers of navigation regions this agent .. rst-class:: classref-property -:ref:`float` **neighbor_distance** = ``500.0`` +:ref:`float` **neighbor_distance** = ``500.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -491,7 +491,7 @@ The distance to search for other agents. .. rst-class:: classref-property -:ref:`float` **path_desired_distance** = ``20.0`` +:ref:`float` **path_desired_distance** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -508,7 +508,7 @@ The distance threshold before a path point is considered to be reached. This all .. rst-class:: classref-property -:ref:`float` **path_max_distance** = ``100.0`` +:ref:`float` **path_max_distance** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -525,7 +525,7 @@ The maximum distance the agent is allowed away from the ideal path to the final .. rst-class:: classref-property -|bitfield|\[:ref:`PathMetadataFlags`\] **path_metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **path_metadata_flags** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -542,7 +542,7 @@ Additional information to return with the navigation path. .. rst-class:: classref-property -:ref:`PathPostProcessing` **path_postprocessing** = ``0`` +:ref:`PathPostProcessing` **path_postprocessing** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -559,7 +559,7 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property -:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` +:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -576,7 +576,7 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property -:ref:`float` **radius** = ``10.0`` +:ref:`float` **radius** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -595,7 +595,7 @@ Does not affect normal pathfinding. To change an actor's pathfinding radius bake .. rst-class:: classref-property -:ref:`float` **simplify_epsilon** = ``0.0`` +:ref:`float` **simplify_epsilon** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -612,7 +612,7 @@ The path simplification amount in worlds units. .. rst-class:: classref-property -:ref:`bool` **simplify_path** = ``false`` +:ref:`bool` **simplify_path** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -631,7 +631,7 @@ Path simplification can be helpful to mitigate various path following issues tha .. rst-class:: classref-property -:ref:`float` **target_desired_distance** = ``10.0`` +:ref:`float` **target_desired_distance** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -652,7 +652,7 @@ You can also make navigation end closer to the target than each individual path .. rst-class:: classref-property -:ref:`Vector2` **target_position** = ``Vector2(0, 0)`` +:ref:`Vector2` **target_position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -669,7 +669,7 @@ If set, a new navigation path from the current agent position to the :ref:`targe .. rst-class:: classref-property -:ref:`float` **time_horizon_agents** = ``1.0`` +:ref:`float` **time_horizon_agents** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -686,7 +686,7 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property -:ref:`float` **time_horizon_obstacles** = ``0.0`` +:ref:`float` **time_horizon_obstacles** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -703,7 +703,7 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property -:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -725,7 +725,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **distance_to_target**\ (\ ) |const| +:ref:`float` **distance_to_target**\ (\ ) |const| :ref:`🔗` Returns the distance to the target position, using the agent's global position. The user must set :ref:`target_position` in order for this to be accurate. @@ -737,7 +737,7 @@ Returns the distance to the target position, using the agent's global position. .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -749,7 +749,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_avoidance_mask_value**\ (\ mask_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_avoidance_mask_value**\ (\ mask_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified mask of the :ref:`avoidance_mask` bitmask is enabled, given a ``mask_number`` between 1 and 32. @@ -761,7 +761,7 @@ Returns whether or not the specified mask of the :ref:`avoidance_mask` **get_current_navigation_path**\ (\ ) |const| +:ref:`PackedVector2Array` **get_current_navigation_path**\ (\ ) |const| :ref:`🔗` Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended :ref:`get_next_path_position` once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. @@ -773,7 +773,7 @@ Returns this agent's current path from start to finish in global coordinates. Th .. rst-class:: classref-method -:ref:`int` **get_current_navigation_path_index**\ (\ ) |const| +:ref:`int` **get_current_navigation_path_index**\ (\ ) |const| :ref:`🔗` Returns which index the agent is currently on in the navigation path's :ref:`PackedVector2Array`. @@ -785,7 +785,7 @@ Returns which index the agent is currently on in the navigation path's :ref:`Pac .. rst-class:: classref-method -:ref:`NavigationPathQueryResult2D` **get_current_navigation_result**\ (\ ) |const| +:ref:`NavigationPathQueryResult2D` **get_current_navigation_result**\ (\ ) |const| :ref:`🔗` Returns the path query result for the path the agent is currently following. @@ -797,7 +797,7 @@ Returns the path query result for the path the agent is currently following. .. rst-class:: classref-method -:ref:`Vector2` **get_final_position**\ (\ ) +:ref:`Vector2` **get_final_position**\ (\ ) :ref:`🔗` Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the :ref:`path_changed` signal. @@ -809,7 +809,7 @@ Returns the reachable final position of the current navigation path in global co .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -821,7 +821,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. @@ -833,7 +833,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationAgent .. rst-class:: classref-method -:ref:`Vector2` **get_next_path_position**\ (\ ) +:ref:`Vector2` **get_next_path_position**\ (\ ) :ref:`🔗` Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. @@ -845,7 +845,7 @@ Returns the next position in global coordinates that can be moved to, making sur .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this agent on the :ref:`NavigationServer2D`. @@ -857,7 +857,7 @@ Returns the :ref:`RID` of this agent on the :ref:`NavigationServer2D< .. rst-class:: classref-method -:ref:`bool` **is_navigation_finished**\ (\ ) +:ref:`bool` **is_navigation_finished**\ (\ ) :ref:`🔗` Returns ``true`` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. @@ -871,7 +871,7 @@ Returns ``true`` if the agent's navigation has finished. If the target is reacha .. rst-class:: classref-method -:ref:`bool` **is_target_reachable**\ (\ ) +:ref:`bool` **is_target_reachable**\ (\ ) :ref:`🔗` Returns ``true`` if :ref:`get_final_position` is within :ref:`target_desired_distance` of the :ref:`target_position`. @@ -883,7 +883,7 @@ Returns ``true`` if :ref:`get_final_position` **is_target_reached**\ (\ ) |const| +:ref:`bool` **is_target_reached**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the agent reached the target, i.e. the agent moved within :ref:`target_desired_distance` of the :ref:`target_position`. It may not always be possible to reach the target but it should always be possible to reach the final position. See :ref:`get_final_position`. @@ -895,7 +895,7 @@ Returns ``true`` if the agent reached the target, i.e. the agent moved within :r .. rst-class:: classref-method -|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -907,7 +907,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -|void| **set_avoidance_mask_value**\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_avoidance_mask_value**\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified mask in the :ref:`avoidance_mask` bitmask, given a ``mask_number`` between 1 and 32. @@ -919,7 +919,7 @@ Based on ``value``, enables or disables the specified mask in the :ref:`avoidanc .. rst-class:: classref-method -|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -931,7 +931,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this NavigationAgent node should use and also updates the ``agent`` on the NavigationServer. @@ -943,7 +943,7 @@ Sets the :ref:`RID` of the navigation map this NavigationAgent node s .. rst-class:: classref-method -|void| **set_velocity_forced**\ (\ velocity\: :ref:`Vector2`\ ) +|void| **set_velocity_forced**\ (\ velocity\: :ref:`Vector2`\ ) :ref:`🔗` Replaces the internal velocity in the collision avoidance simulation with ``velocity``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. diff --git a/classes/class_navigationagent3d.rst b/classes/class_navigationagent3d.rst index 225c7813c8e..2d7ab5878cc 100644 --- a/classes/class_navigationagent3d.rst +++ b/classes/class_navigationagent3d.rst @@ -163,7 +163,7 @@ Signals .. rst-class:: classref-signal -**link_reached**\ (\ details\: :ref:`Dictionary`\ ) +**link_reached**\ (\ details\: :ref:`Dictionary`\ ) :ref:`🔗` Signals that the agent reached a navigation link. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path when that position is a navigation link. @@ -189,7 +189,7 @@ The details dictionary may contain the following keys depending on the value of .. rst-class:: classref-signal -**navigation_finished**\ (\ ) +**navigation_finished**\ (\ ) :ref:`🔗` Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path. @@ -203,7 +203,7 @@ This signal will be emitted just after :ref:`target_reached` Emitted when the agent had to update the loaded path: @@ -221,7 +221,7 @@ Emitted when the agent had to update the loaded path: .. rst-class:: classref-signal -**target_reached**\ (\ ) +**target_reached**\ (\ ) :ref:`🔗` Signals that the agent reached the target, i.e. the agent moved within :ref:`target_desired_distance` of the :ref:`target_position`. This signal is emitted only once per loaded path. @@ -237,9 +237,9 @@ It may not always be possible to reach the target but it should always be possib .. rst-class:: classref-signal -**velocity_computed**\ (\ safe_velocity\: :ref:`Vector3`\ ) +**velocity_computed**\ (\ safe_velocity\: :ref:`Vector3`\ ) :ref:`🔗` -Notifies when the collision avoidance velocity is calculated. Emitted when :ref:`velocity` is set. Only emitted when :ref:`avoidance_enabled` is true. +Notifies when the collision avoidance velocity is calculated. Emitted every update as long as :ref:`avoidance_enabled` is ``true`` and the agent has a navigation map. .. rst-class:: classref-item-separator @@ -249,7 +249,7 @@ Notifies when the collision avoidance velocity is calculated. Emitted when :ref: .. rst-class:: classref-signal -**waypoint_reached**\ (\ details\: :ref:`Dictionary`\ ) +**waypoint_reached**\ (\ details\: :ref:`Dictionary`\ ) :ref:`🔗` Signals that the agent reached a waypoint. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path. @@ -276,7 +276,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **avoidance_enabled** = ``false`` +:ref:`bool` **avoidance_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -293,7 +293,7 @@ If ``true`` the agent is registered for an RVO avoidance callback on the :ref:`N .. rst-class:: classref-property -:ref:`int` **avoidance_layers** = ``1`` +:ref:`int` **avoidance_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -310,7 +310,7 @@ A bitfield determining the avoidance layers for this NavigationAgent. Other agen .. rst-class:: classref-property -:ref:`int` **avoidance_mask** = ``1`` +:ref:`int` **avoidance_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -327,7 +327,7 @@ A bitfield determining what other avoidance agents and obstacles this Navigation .. rst-class:: classref-property -:ref:`float` **avoidance_priority** = ``1.0`` +:ref:`float` **avoidance_priority** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -344,7 +344,7 @@ The agent does not adjust the velocity for other agents that would match the :re .. rst-class:: classref-property -:ref:`bool` **debug_enabled** = ``false`` +:ref:`bool` **debug_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -361,7 +361,7 @@ If ``true`` shows debug visuals for this agent. .. rst-class:: classref-property -:ref:`Color` **debug_path_custom_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **debug_path_custom_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -378,7 +378,7 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property -:ref:`float` **debug_path_custom_point_size** = ``4.0`` +:ref:`float` **debug_path_custom_point_size** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -395,7 +395,7 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property -:ref:`bool` **debug_use_custom** = ``false`` +:ref:`bool` **debug_use_custom** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -412,7 +412,7 @@ If ``true`` uses the defined :ref:`debug_path_custom_color` **height** = ``1.0`` +:ref:`float` **height** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -429,7 +429,7 @@ The height of the avoidance agent. Agents will ignore other agents or obstacles .. rst-class:: classref-property -:ref:`bool` **keep_y_velocity** = ``true`` +:ref:`bool` **keep_y_velocity** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -446,7 +446,7 @@ If ``true``, and the agent uses 2D avoidance, it will remember the set y-axis ve .. rst-class:: classref-property -:ref:`int` **max_neighbors** = ``10`` +:ref:`int` **max_neighbors** = ``10`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -463,7 +463,7 @@ The maximum number of neighbors for the agent to consider. .. rst-class:: classref-property -:ref:`float` **max_speed** = ``10.0`` +:ref:`float` **max_speed** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -480,7 +480,7 @@ The maximum speed that an agent can move. .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -497,7 +497,7 @@ A bitfield determining which navigation layers of navigation regions this agent .. rst-class:: classref-property -:ref:`float` **neighbor_distance** = ``50.0`` +:ref:`float` **neighbor_distance** = ``50.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -514,7 +514,7 @@ The distance to search for other agents. .. rst-class:: classref-property -:ref:`float` **path_desired_distance** = ``1.0`` +:ref:`float` **path_desired_distance** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -531,7 +531,7 @@ The distance threshold before a path point is considered to be reached. This all .. rst-class:: classref-property -:ref:`float` **path_height_offset** = ``0.0`` +:ref:`float` **path_height_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -548,7 +548,7 @@ The height offset is subtracted from the y-axis value of any vector path positio .. rst-class:: classref-property -:ref:`float` **path_max_distance** = ``5.0`` +:ref:`float` **path_max_distance** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -565,7 +565,7 @@ The maximum distance the agent is allowed away from the ideal path to the final .. rst-class:: classref-property -|bitfield|\[:ref:`PathMetadataFlags`\] **path_metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **path_metadata_flags** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -582,7 +582,7 @@ Additional information to return with the navigation path. .. rst-class:: classref-property -:ref:`PathPostProcessing` **path_postprocessing** = ``0`` +:ref:`PathPostProcessing` **path_postprocessing** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -599,7 +599,7 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property -:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` +:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -616,7 +616,7 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -635,7 +635,7 @@ Does not affect normal pathfinding. To change an actor's pathfinding radius bake .. rst-class:: classref-property -:ref:`float` **simplify_epsilon** = ``0.0`` +:ref:`float` **simplify_epsilon** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -652,7 +652,7 @@ The path simplification amount in worlds units. .. rst-class:: classref-property -:ref:`bool` **simplify_path** = ``false`` +:ref:`bool` **simplify_path** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -671,7 +671,7 @@ Path simplification can be helpful to mitigate various path following issues tha .. rst-class:: classref-property -:ref:`float` **target_desired_distance** = ``1.0`` +:ref:`float` **target_desired_distance** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -692,7 +692,7 @@ You can also make navigation end closer to the target than each individual path .. rst-class:: classref-property -:ref:`Vector3` **target_position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **target_position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -709,7 +709,7 @@ If set, a new navigation path from the current agent position to the :ref:`targe .. rst-class:: classref-property -:ref:`float` **time_horizon_agents** = ``1.0`` +:ref:`float` **time_horizon_agents** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -726,7 +726,7 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property -:ref:`float` **time_horizon_obstacles** = ``0.0`` +:ref:`float` **time_horizon_obstacles** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -743,7 +743,7 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property -:ref:`bool` **use_3d_avoidance** = ``false`` +:ref:`bool` **use_3d_avoidance** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -762,7 +762,7 @@ If ``false``, the agent calculates avoidance velocities in 2D along the x and z- .. rst-class:: classref-property -:ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -784,7 +784,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **distance_to_target**\ (\ ) |const| +:ref:`float` **distance_to_target**\ (\ ) |const| :ref:`🔗` Returns the distance to the target position, using the agent's global position. The user must set :ref:`target_position` in order for this to be accurate. @@ -796,7 +796,7 @@ Returns the distance to the target position, using the agent's global position. .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -808,7 +808,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_avoidance_mask_value**\ (\ mask_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_avoidance_mask_value**\ (\ mask_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified mask of the :ref:`avoidance_mask` bitmask is enabled, given a ``mask_number`` between 1 and 32. @@ -820,7 +820,7 @@ Returns whether or not the specified mask of the :ref:`avoidance_mask` **get_current_navigation_path**\ (\ ) |const| +:ref:`PackedVector3Array` **get_current_navigation_path**\ (\ ) |const| :ref:`🔗` Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended :ref:`get_next_path_position` once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. @@ -832,7 +832,7 @@ Returns this agent's current path from start to finish in global coordinates. Th .. rst-class:: classref-method -:ref:`int` **get_current_navigation_path_index**\ (\ ) |const| +:ref:`int` **get_current_navigation_path_index**\ (\ ) |const| :ref:`🔗` Returns which index the agent is currently on in the navigation path's :ref:`PackedVector3Array`. @@ -844,7 +844,7 @@ Returns which index the agent is currently on in the navigation path's :ref:`Pac .. rst-class:: classref-method -:ref:`NavigationPathQueryResult3D` **get_current_navigation_result**\ (\ ) |const| +:ref:`NavigationPathQueryResult3D` **get_current_navigation_result**\ (\ ) |const| :ref:`🔗` Returns the path query result for the path the agent is currently following. @@ -856,7 +856,7 @@ Returns the path query result for the path the agent is currently following. .. rst-class:: classref-method -:ref:`Vector3` **get_final_position**\ (\ ) +:ref:`Vector3` **get_final_position**\ (\ ) :ref:`🔗` Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the :ref:`path_changed` signal. @@ -868,7 +868,7 @@ Returns the reachable final position of the current navigation path in global co .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -880,7 +880,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. @@ -892,7 +892,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationAgent .. rst-class:: classref-method -:ref:`Vector3` **get_next_path_position**\ (\ ) +:ref:`Vector3` **get_next_path_position**\ (\ ) :ref:`🔗` Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. @@ -904,7 +904,7 @@ Returns the next position in global coordinates that can be moved to, making sur .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this agent on the :ref:`NavigationServer3D`. @@ -916,7 +916,7 @@ Returns the :ref:`RID` of this agent on the :ref:`NavigationServer3D< .. rst-class:: classref-method -:ref:`bool` **is_navigation_finished**\ (\ ) +:ref:`bool` **is_navigation_finished**\ (\ ) :ref:`🔗` Returns ``true`` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. @@ -930,7 +930,7 @@ Returns ``true`` if the agent's navigation has finished. If the target is reacha .. rst-class:: classref-method -:ref:`bool` **is_target_reachable**\ (\ ) +:ref:`bool` **is_target_reachable**\ (\ ) :ref:`🔗` Returns ``true`` if :ref:`get_final_position` is within :ref:`target_desired_distance` of the :ref:`target_position`. @@ -942,7 +942,7 @@ Returns ``true`` if :ref:`get_final_position` **is_target_reached**\ (\ ) |const| +:ref:`bool` **is_target_reached**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the agent reached the target, i.e. the agent moved within :ref:`target_desired_distance` of the :ref:`target_position`. It may not always be possible to reach the target but it should always be possible to reach the final position. See :ref:`get_final_position`. @@ -954,7 +954,7 @@ Returns ``true`` if the agent reached the target, i.e. the agent moved within :r .. rst-class:: classref-method -|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -966,7 +966,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -|void| **set_avoidance_mask_value**\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_avoidance_mask_value**\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified mask in the :ref:`avoidance_mask` bitmask, given a ``mask_number`` between 1 and 32. @@ -978,7 +978,7 @@ Based on ``value``, enables or disables the specified mask in the :ref:`avoidanc .. rst-class:: classref-method -|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -990,7 +990,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this NavigationAgent node should use and also updates the ``agent`` on the NavigationServer. @@ -1002,7 +1002,7 @@ Sets the :ref:`RID` of the navigation map this NavigationAgent node s .. rst-class:: classref-method -|void| **set_velocity_forced**\ (\ velocity\: :ref:`Vector3`\ ) +|void| **set_velocity_forced**\ (\ velocity\: :ref:`Vector3`\ ) :ref:`🔗` Replaces the internal velocity in the collision avoidance simulation with ``velocity``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. diff --git a/classes/class_navigationlink2d.rst b/classes/class_navigationlink2d.rst index e397668b55a..ee524d16615 100644 --- a/classes/class_navigationlink2d.rst +++ b/classes/class_navigationlink2d.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **bidirectional** = ``true`` +:ref:`bool` **bidirectional** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ Whether this link can be traveled in both directions or only from :ref:`start_po .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ Whether this link is currently active. If ``false``, :ref:`NavigationServer2D.ma .. rst-class:: classref-property -:ref:`Vector2` **end_position** = ``Vector2(0, 0)`` +:ref:`Vector2` **end_position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -146,7 +146,7 @@ The distance the link will search is controlled by :ref:`NavigationServer2D.map_ .. rst-class:: classref-property -:ref:`float` **enter_cost** = ``0.0`` +:ref:`float` **enter_cost** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -163,7 +163,7 @@ When pathfinding enters this link from another regions navigation mesh the :ref: .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -180,7 +180,7 @@ A bitfield determining all navigation layers the link belongs to. These navigati .. rst-class:: classref-property -:ref:`Vector2` **start_position** = ``Vector2(0, 0)`` +:ref:`Vector2` **start_position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ The distance the link will search is controlled by :ref:`NavigationServer2D.map_ .. rst-class:: classref-property -:ref:`float` **travel_cost** = ``1.0`` +:ref:`float` **travel_cost** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_global_end_position**\ (\ ) |const| +:ref:`Vector2` **get_global_end_position**\ (\ ) |const| :ref:`🔗` Returns the :ref:`end_position` that is relative to the link as a global position. @@ -235,7 +235,7 @@ Returns the :ref:`end_position` th .. rst-class:: classref-method -:ref:`Vector2` **get_global_start_position**\ (\ ) |const| +:ref:`Vector2` **get_global_start_position**\ (\ ) |const| :ref:`🔗` Returns the :ref:`start_position` that is relative to the link as a global position. @@ -247,7 +247,7 @@ Returns the :ref:`start_position .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -259,7 +259,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this link on the :ref:`NavigationServer2D`. @@ -271,7 +271,7 @@ Returns the :ref:`RID` of this link on the :ref:`NavigationServer2D`\ ) +|void| **set_global_end_position**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the :ref:`end_position` that is relative to the link from a global ``position``. @@ -283,7 +283,7 @@ Sets the :ref:`end_position` that .. rst-class:: classref-method -|void| **set_global_start_position**\ (\ position\: :ref:`Vector2`\ ) +|void| **set_global_start_position**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the :ref:`start_position` that is relative to the link from a global ``position``. @@ -295,7 +295,7 @@ Sets the :ref:`start_position` t .. rst-class:: classref-method -|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_navigationlink3d.rst b/classes/class_navigationlink3d.rst index 2e8779d62e1..11a90a70ecd 100644 --- a/classes/class_navigationlink3d.rst +++ b/classes/class_navigationlink3d.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **bidirectional** = ``true`` +:ref:`bool` **bidirectional** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ Whether this link can be traveled in both directions or only from :ref:`start_po .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ Whether this link is currently active. If ``false``, :ref:`NavigationServer3D.ma .. rst-class:: classref-property -:ref:`Vector3` **end_position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **end_position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -146,7 +146,7 @@ The distance the link will search is controlled by :ref:`NavigationServer3D.map_ .. rst-class:: classref-property -:ref:`float` **enter_cost** = ``0.0`` +:ref:`float` **enter_cost** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -163,7 +163,7 @@ When pathfinding enters this link from another regions navigation mesh the :ref: .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -180,7 +180,7 @@ A bitfield determining all navigation layers the link belongs to. These navigati .. rst-class:: classref-property -:ref:`Vector3` **start_position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **start_position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ The distance the link will search is controlled by :ref:`NavigationServer3D.map_ .. rst-class:: classref-property -:ref:`float` **travel_cost** = ``1.0`` +:ref:`float` **travel_cost** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **get_global_end_position**\ (\ ) |const| +:ref:`Vector3` **get_global_end_position**\ (\ ) |const| :ref:`🔗` Returns the :ref:`end_position` that is relative to the link as a global position. @@ -235,7 +235,7 @@ Returns the :ref:`end_position` th .. rst-class:: classref-method -:ref:`Vector3` **get_global_start_position**\ (\ ) |const| +:ref:`Vector3` **get_global_start_position**\ (\ ) |const| :ref:`🔗` Returns the :ref:`start_position` that is relative to the link as a global position. @@ -247,7 +247,7 @@ Returns the :ref:`start_position .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -259,7 +259,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this link on the :ref:`NavigationServer3D`. @@ -271,7 +271,7 @@ Returns the :ref:`RID` of this link on the :ref:`NavigationServer3D`\ ) +|void| **set_global_end_position**\ (\ position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the :ref:`end_position` that is relative to the link from a global ``position``. @@ -283,7 +283,7 @@ Sets the :ref:`end_position` that .. rst-class:: classref-method -|void| **set_global_start_position**\ (\ position\: :ref:`Vector3`\ ) +|void| **set_global_start_position**\ (\ position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the :ref:`start_position` that is relative to the link from a global ``position``. @@ -295,7 +295,7 @@ Sets the :ref:`start_position` t .. rst-class:: classref-method -|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index d652174bc9a..1562e6021af 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -133,7 +133,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SamplePartitionType**: +enum **SamplePartitionType**: :ref:`🔗` .. _class_NavigationMesh_constant_SAMPLE_PARTITION_WATERSHED: @@ -175,7 +175,7 @@ Represents the size of the :ref:`SamplePartitionType` .. _class_NavigationMesh_constant_PARSED_GEOMETRY_MESH_INSTANCES: @@ -217,7 +217,7 @@ Represents the size of the :ref:`ParsedGeometryType` .. _class_NavigationMesh_constant_SOURCE_GEOMETRY_ROOT_NODE_CHILDREN: @@ -264,7 +264,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **agent_height** = ``1.5`` +:ref:`float` **agent_height** = ``1.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -283,7 +283,7 @@ The minimum floor to ceiling height that will still allow the floor area to be c .. rst-class:: classref-property -:ref:`float` **agent_max_climb** = ``0.25`` +:ref:`float` **agent_max_climb** = ``0.25`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -302,7 +302,7 @@ The minimum ledge height that is considered to still be traversable. .. rst-class:: classref-property -:ref:`float` **agent_max_slope** = ``45.0`` +:ref:`float` **agent_max_slope** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -319,7 +319,7 @@ The maximum slope that is considered walkable, in degrees. .. rst-class:: classref-property -:ref:`float` **agent_radius** = ``0.5`` +:ref:`float` **agent_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -338,7 +338,7 @@ The distance to erode/shrink the walkable area of the heightfield away from obst .. rst-class:: classref-property -:ref:`float` **border_size** = ``0.0`` +:ref:`float` **border_size** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -359,7 +359,7 @@ In conjunction with the :ref:`filter_baking_aabb` **cell_height** = ``0.25`` +:ref:`float` **cell_height** = ``0.25`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -376,7 +376,7 @@ The cell height used to rasterize the navigation mesh vertices on the Y axis. Mu .. rst-class:: classref-property -:ref:`float` **cell_size** = ``0.25`` +:ref:`float` **cell_size** = ``0.25`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -393,7 +393,7 @@ The cell size used to rasterize the navigation mesh vertices on the XZ plane. Mu .. rst-class:: classref-property -:ref:`float` **detail_sample_distance** = ``6.0`` +:ref:`float` **detail_sample_distance** = ``6.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -410,7 +410,7 @@ The sampling distance to use when generating the detail mesh, in cell unit. .. rst-class:: classref-property -:ref:`float` **detail_sample_max_error** = ``1.0`` +:ref:`float` **detail_sample_max_error** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -427,7 +427,7 @@ The maximum distance the detail mesh surface should deviate from heightfield, in .. rst-class:: classref-property -:ref:`float` **edge_max_error** = ``1.3`` +:ref:`float` **edge_max_error** = ``1.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -444,7 +444,7 @@ The maximum distance a simplified contour's border edges should deviate the orig .. rst-class:: classref-property -:ref:`float` **edge_max_length** = ``0.0`` +:ref:`float` **edge_max_length** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -463,7 +463,7 @@ The maximum allowed length for contour edges along the border of the mesh. A val .. rst-class:: classref-property -:ref:`AABB` **filter_baking_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **filter_baking_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -480,7 +480,7 @@ If the baking :ref:`AABB` has a volume the navigation mesh baking wi .. rst-class:: classref-property -:ref:`Vector3` **filter_baking_aabb_offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **filter_baking_aabb_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -497,7 +497,7 @@ The position offset applied to the :ref:`filter_baking_aabb` **filter_ledge_spans** = ``false`` +:ref:`bool` **filter_ledge_spans** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -514,7 +514,7 @@ If ``true``, marks spans that are ledges as non-walkable. .. rst-class:: classref-property -:ref:`bool` **filter_low_hanging_obstacles** = ``false`` +:ref:`bool` **filter_low_hanging_obstacles** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -531,7 +531,7 @@ If ``true``, marks non-walkable spans as walkable if their maximum is within :re .. rst-class:: classref-property -:ref:`bool` **filter_walkable_low_height_spans** = ``false`` +:ref:`bool` **filter_walkable_low_height_spans** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -548,7 +548,7 @@ If ``true``, marks walkable spans as not walkable if the clearance above the spa .. rst-class:: classref-property -:ref:`int` **geometry_collision_mask** = ``4294967295`` +:ref:`int` **geometry_collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -567,7 +567,7 @@ Only used when :ref:`geometry_parsed_geometry_type` **geometry_parsed_geometry_type** = ``0`` +:ref:`ParsedGeometryType` **geometry_parsed_geometry_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -584,7 +584,7 @@ Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeome .. rst-class:: classref-property -:ref:`SourceGeometryMode` **geometry_source_geometry_mode** = ``0`` +:ref:`SourceGeometryMode` **geometry_source_geometry_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -601,7 +601,7 @@ The source of the geometry used when baking. See :ref:`SourceGeometryMode` **geometry_source_group_name** = ``&"navigation_mesh_source_group"`` +:ref:`StringName` **geometry_source_group_name** = ``&"navigation_mesh_source_group"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -620,7 +620,7 @@ Only used when :ref:`geometry_source_geometry_mode` **region_merge_size** = ``20.0`` +:ref:`float` **region_merge_size** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -639,7 +639,7 @@ Any regions with a size smaller than this will be merged with larger regions if .. rst-class:: classref-property -:ref:`float` **region_min_size** = ``2.0`` +:ref:`float` **region_min_size** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -658,7 +658,7 @@ The minimum size of a region for it to be created. .. rst-class:: classref-property -:ref:`SamplePartitionType` **sample_partition_type** = ``0`` +:ref:`SamplePartitionType` **sample_partition_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -675,7 +675,7 @@ Partitioning algorithm for creating the navigation mesh polys. See :ref:`SampleP .. rst-class:: classref-property -:ref:`float` **vertices_per_polygon** = ``6.0`` +:ref:`float` **vertices_per_polygon** = ``6.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -697,7 +697,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_polygon**\ (\ polygon\: :ref:`PackedInt32Array`\ ) +|void| **add_polygon**\ (\ polygon\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. @@ -709,7 +709,7 @@ Adds a polygon using the indices of the vertices you get when calling :ref:`get_ .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the internal arrays for vertices and polygon indices. @@ -721,7 +721,7 @@ Clears the internal arrays for vertices and polygon indices. .. rst-class:: classref-method -|void| **clear_polygons**\ (\ ) +|void| **clear_polygons**\ (\ ) :ref:`🔗` Clears the array of polygons, but it doesn't clear the array of vertices. @@ -733,7 +733,7 @@ Clears the array of polygons, but it doesn't clear the array of vertices. .. rst-class:: classref-method -|void| **create_from_mesh**\ (\ mesh\: :ref:`Mesh`\ ) +|void| **create_from_mesh**\ (\ mesh\: :ref:`Mesh`\ ) :ref:`🔗` Initializes the navigation mesh by setting the vertices and indices according to a :ref:`Mesh`. @@ -747,7 +747,7 @@ Initializes the navigation mesh by setting the vertices and indices according to .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`geometry_collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -759,7 +759,7 @@ Returns whether or not the specified layer of the :ref:`geometry_collision_mask< .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_polygon**\ (\ idx\: :ref:`int`\ ) +:ref:`PackedInt32Array` **get_polygon**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns a :ref:`PackedInt32Array` containing the indices of the vertices of a created polygon. @@ -771,7 +771,7 @@ Returns a :ref:`PackedInt32Array` containing the indices .. rst-class:: classref-method -:ref:`int` **get_polygon_count**\ (\ ) |const| +:ref:`int` **get_polygon_count**\ (\ ) |const| :ref:`🔗` Returns the number of polygons in the navigation mesh. @@ -783,7 +783,7 @@ Returns the number of polygons in the navigation mesh. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_vertices**\ (\ ) |const| +:ref:`PackedVector3Array` **get_vertices**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedVector3Array` containing all the vertices being used to create the polygons. @@ -795,7 +795,7 @@ Returns a :ref:`PackedVector3Array` containing all the .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`geometry_collision_mask`, given a ``layer_number`` between 1 and 32. @@ -807,7 +807,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`geometr .. rst-class:: classref-method -|void| **set_vertices**\ (\ vertices\: :ref:`PackedVector3Array`\ ) +|void| **set_vertices**\ (\ vertices\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index 47ba8e78ced..69f5e44a213 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **bake**\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) +|void| **bake**\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) :ref:`🔗` **Deprecated:** This method is deprecated due to core threading changes. To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the :ref:`SceneTree` for nodes that should contribute to the navigation mesh baking. The :ref:`SceneTree` parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. @@ -83,7 +83,7 @@ Bakes the ``navigation_mesh`` with source geometry collected starting from the ` .. rst-class:: classref-method -|void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) +|void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. @@ -95,7 +95,7 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ .. rst-class:: classref-method -|void| **clear**\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) +|void| **clear**\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) :ref:`🔗` Removes all polygons and vertices from the provided ``navigation_mesh`` resource. @@ -107,7 +107,7 @@ Removes all polygons and vertices from the provided ``navigation_mesh`` resource .. rst-class:: classref-method -|void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) +|void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_mesh``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. diff --git a/classes/class_navigationmeshsourcegeometrydata2d.rst b/classes/class_navigationmeshsourcegeometrydata2d.rst index 6599b085428..557a839f4c5 100644 --- a/classes/class_navigationmeshsourcegeometrydata2d.rst +++ b/classes/class_navigationmeshsourcegeometrydata2d.rst @@ -76,7 +76,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_obstruction_outline**\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) +|void| **add_obstruction_outline**\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Adds the outline points of a shape as obstructed area. @@ -88,7 +88,7 @@ Adds the outline points of a shape as obstructed area. .. rst-class:: classref-method -|void| **add_projected_obstruction**\ (\ vertices\: :ref:`PackedVector2Array`, carve\: :ref:`bool`\ ) +|void| **add_projected_obstruction**\ (\ vertices\: :ref:`PackedVector2Array`, carve\: :ref:`bool`\ ) :ref:`🔗` Adds a projected obstruction shape to the source geometry. If ``carve`` is ``true`` the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. @@ -100,7 +100,7 @@ Adds a projected obstruction shape to the source geometry. If ``carve`` is ``tru .. rst-class:: classref-method -|void| **add_traversable_outline**\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) +|void| **add_traversable_outline**\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Adds the outline points of a shape as traversable area. @@ -112,7 +112,7 @@ Adds the outline points of a shape as traversable area. .. rst-class:: classref-method -|void| **append_obstruction_outlines**\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) +|void| **append_obstruction_outlines**\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) :ref:`🔗` Appends another array of ``obstruction_outlines`` at the end of the existing obstruction outlines array. @@ -124,7 +124,7 @@ Appends another array of ``obstruction_outlines`` at the end of the existing obs .. rst-class:: classref-method -|void| **append_traversable_outlines**\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) +|void| **append_traversable_outlines**\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) :ref:`🔗` Appends another array of ``traversable_outlines`` at the end of the existing traversable outlines array. @@ -136,7 +136,7 @@ Appends another array of ``traversable_outlines`` at the end of the existing tra .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the internal data. @@ -148,7 +148,7 @@ Clears the internal data. .. rst-class:: classref-method -|void| **clear_projected_obstructions**\ (\ ) +|void| **clear_projected_obstructions**\ (\ ) :ref:`🔗` Clears all projected obstructions. @@ -160,7 +160,7 @@ Clears all projected obstructions. .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **get_obstruction_outlines**\ (\ ) |const| +:ref:`Array`\[:ref:`PackedVector2Array`\] **get_obstruction_outlines**\ (\ ) |const| :ref:`🔗` Returns all the obstructed area outlines arrays. @@ -172,7 +172,7 @@ Returns all the obstructed area outlines arrays. .. rst-class:: classref-method -:ref:`Array` **get_projected_obstructions**\ (\ ) |const| +:ref:`Array` **get_projected_obstructions**\ (\ ) |const| :ref:`🔗` Returns the projected obstructions as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: @@ -188,7 +188,7 @@ Returns the projected obstructions as an :ref:`Array` of dictionari .. rst-class:: classref-method -:ref:`Array`\[:ref:`PackedVector2Array`\] **get_traversable_outlines**\ (\ ) |const| +:ref:`Array`\[:ref:`PackedVector2Array`\] **get_traversable_outlines**\ (\ ) |const| :ref:`🔗` Returns all the traversable area outlines arrays. @@ -200,7 +200,7 @@ Returns all the traversable area outlines arrays. .. rst-class:: classref-method -:ref:`bool` **has_data**\ (\ ) +:ref:`bool` **has_data**\ (\ ) :ref:`🔗` Returns ``true`` when parsed source geometry data exists. @@ -212,7 +212,7 @@ Returns ``true`` when parsed source geometry data exists. .. rst-class:: classref-method -|void| **merge**\ (\ other_geometry\: :ref:`NavigationMeshSourceGeometryData2D`\ ) +|void| **merge**\ (\ other_geometry\: :ref:`NavigationMeshSourceGeometryData2D`\ ) :ref:`🔗` Adds the geometry data of another **NavigationMeshSourceGeometryData2D** to the navigation mesh baking data. @@ -224,7 +224,7 @@ Adds the geometry data of another **NavigationMeshSourceGeometryData2D** to the .. rst-class:: classref-method -|void| **set_obstruction_outlines**\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) +|void| **set_obstruction_outlines**\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) :ref:`🔗` Sets all the obstructed area outlines arrays. @@ -236,7 +236,7 @@ Sets all the obstructed area outlines arrays. .. rst-class:: classref-method -|void| **set_projected_obstructions**\ (\ projected_obstructions\: :ref:`Array`\ ) +|void| **set_projected_obstructions**\ (\ projected_obstructions\: :ref:`Array`\ ) :ref:`🔗` Sets the projected obstructions with an Array of Dictionaries with the following key value pairs: @@ -258,7 +258,7 @@ Sets the projected obstructions with an Array of Dictionaries with the following .. rst-class:: classref-method -|void| **set_traversable_outlines**\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) +|void| **set_traversable_outlines**\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) :ref:`🔗` Sets all the traversable area outlines arrays. diff --git a/classes/class_navigationmeshsourcegeometrydata3d.rst b/classes/class_navigationmeshsourcegeometrydata3d.rst index 68bc9ab3cbf..1543fe5205e 100644 --- a/classes/class_navigationmeshsourcegeometrydata3d.rst +++ b/classes/class_navigationmeshsourcegeometrydata3d.rst @@ -76,7 +76,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_faces**\ (\ faces\: :ref:`PackedVector3Array`, xform\: :ref:`Transform3D`\ ) +|void| **add_faces**\ (\ faces\: :ref:`PackedVector3Array`, xform\: :ref:`Transform3D`\ ) :ref:`🔗` Adds an array of vertex positions to the geometry data for navigation mesh baking to form triangulated faces. For each face the array must have three vertex positions in clockwise winding order. Since :ref:`NavigationMesh` resources have no transform, all vertex positions need to be offset by the node's transform using ``xform``. @@ -88,7 +88,7 @@ Adds an array of vertex positions to the geometry data for navigation mesh bakin .. rst-class:: classref-method -|void| **add_mesh**\ (\ mesh\: :ref:`Mesh`, xform\: :ref:`Transform3D`\ ) +|void| **add_mesh**\ (\ mesh\: :ref:`Mesh`, xform\: :ref:`Transform3D`\ ) :ref:`🔗` Adds the geometry data of a :ref:`Mesh` resource to the navigation mesh baking data. The mesh must have valid triangulated mesh data to be considered. Since :ref:`NavigationMesh` resources have no transform, all vertex positions need to be offset by the node's transform using ``xform``. @@ -100,7 +100,7 @@ Adds the geometry data of a :ref:`Mesh` resource to the navigation m .. rst-class:: classref-method -|void| **add_mesh_array**\ (\ mesh_array\: :ref:`Array`, xform\: :ref:`Transform3D`\ ) +|void| **add_mesh_array**\ (\ mesh_array\: :ref:`Array`, xform\: :ref:`Transform3D`\ ) :ref:`🔗` Adds an :ref:`Array` the size of :ref:`Mesh.ARRAY_MAX` and with vertices at index :ref:`Mesh.ARRAY_VERTEX` and indices at index :ref:`Mesh.ARRAY_INDEX` to the navigation mesh baking data. The array must have valid triangulated mesh data to be considered. Since :ref:`NavigationMesh` resources have no transform, all vertex positions need to be offset by the node's transform using ``xform``. @@ -112,7 +112,7 @@ Adds an :ref:`Array` the size of :ref:`Mesh.ARRAY_MAX`, elevation\: :ref:`float`, height\: :ref:`float`, carve\: :ref:`bool`\ ) +|void| **add_projected_obstruction**\ (\ vertices\: :ref:`PackedVector3Array`, elevation\: :ref:`float`, height\: :ref:`float`, carve\: :ref:`bool`\ ) :ref:`🔗` Adds a projected obstruction shape to the source geometry. The ``vertices`` are considered projected on a xz-axes plane, placed at the global y-axis ``elevation`` and extruded by ``height``. If ``carve`` is ``true`` the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. @@ -124,7 +124,7 @@ Adds a projected obstruction shape to the source geometry. The ``vertices`` are .. rst-class:: classref-method -|void| **append_arrays**\ (\ vertices\: :ref:`PackedFloat32Array`, indices\: :ref:`PackedInt32Array`\ ) +|void| **append_arrays**\ (\ vertices\: :ref:`PackedFloat32Array`, indices\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Appends arrays of ``vertices`` and ``indices`` at the end of the existing arrays. Adds the existing index as an offset to the appended indices. @@ -136,7 +136,7 @@ Appends arrays of ``vertices`` and ``indices`` at the end of the existing arrays .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the internal data. @@ -148,7 +148,7 @@ Clears the internal data. .. rst-class:: classref-method -|void| **clear_projected_obstructions**\ (\ ) +|void| **clear_projected_obstructions**\ (\ ) :ref:`🔗` Clears all projected obstructions. @@ -160,7 +160,7 @@ Clears all projected obstructions. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_indices**\ (\ ) |const| +:ref:`PackedInt32Array` **get_indices**\ (\ ) |const| :ref:`🔗` Returns the parsed source geometry data indices array. @@ -172,7 +172,7 @@ Returns the parsed source geometry data indices array. .. rst-class:: classref-method -:ref:`Array` **get_projected_obstructions**\ (\ ) |const| +:ref:`Array` **get_projected_obstructions**\ (\ ) |const| :ref:`🔗` Returns the projected obstructions as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: @@ -192,7 +192,7 @@ Returns the projected obstructions as an :ref:`Array` of dictionari .. rst-class:: classref-method -:ref:`PackedFloat32Array` **get_vertices**\ (\ ) |const| +:ref:`PackedFloat32Array` **get_vertices**\ (\ ) |const| :ref:`🔗` Returns the parsed source geometry data vertices array. @@ -204,7 +204,7 @@ Returns the parsed source geometry data vertices array. .. rst-class:: classref-method -:ref:`bool` **has_data**\ (\ ) +:ref:`bool` **has_data**\ (\ ) :ref:`🔗` Returns ``true`` when parsed source geometry data exists. @@ -216,7 +216,7 @@ Returns ``true`` when parsed source geometry data exists. .. rst-class:: classref-method -|void| **merge**\ (\ other_geometry\: :ref:`NavigationMeshSourceGeometryData3D`\ ) +|void| **merge**\ (\ other_geometry\: :ref:`NavigationMeshSourceGeometryData3D`\ ) :ref:`🔗` Adds the geometry data of another **NavigationMeshSourceGeometryData3D** to the navigation mesh baking data. @@ -228,7 +228,7 @@ Adds the geometry data of another **NavigationMeshSourceGeometryData3D** to the .. rst-class:: classref-method -|void| **set_indices**\ (\ indices\: :ref:`PackedInt32Array`\ ) +|void| **set_indices**\ (\ indices\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Sets the parsed source geometry data indices. The indices need to be matched with appropriated vertices. @@ -242,7 +242,7 @@ Sets the parsed source geometry data indices. The indices need to be matched wit .. rst-class:: classref-method -|void| **set_projected_obstructions**\ (\ projected_obstructions\: :ref:`Array`\ ) +|void| **set_projected_obstructions**\ (\ projected_obstructions\: :ref:`Array`\ ) :ref:`🔗` Sets the projected obstructions with an Array of Dictionaries with the following key value pairs: @@ -266,7 +266,7 @@ Sets the projected obstructions with an Array of Dictionaries with the following .. rst-class:: classref-method -|void| **set_vertices**\ (\ vertices\: :ref:`PackedFloat32Array`\ ) +|void| **set_vertices**\ (\ vertices\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Sets the parsed source geometry data vertices. The vertices need to be matched with appropriated indices. diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index b4b3599f155..5ae629c5676 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **affect_navigation_mesh** = ``false`` +:ref:`bool` **affect_navigation_mesh** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ If enabled and parsed in a navigation mesh baking process the obstacle will disc .. rst-class:: classref-property -:ref:`bool` **avoidance_enabled** = ``true`` +:ref:`bool` **avoidance_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ If ``true`` the obstacle affects avoidance using agents. .. rst-class:: classref-property -:ref:`int` **avoidance_layers** = ``1`` +:ref:`int` **avoidance_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat .. rst-class:: classref-property -:ref:`bool` **carve_navigation_mesh** = ``false`` +:ref:`bool` **carve_navigation_mesh** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -163,7 +163,7 @@ Requires :ref:`affect_navigation_mesh` **radius** = ``0.0`` +:ref:`float` **radius** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -180,7 +180,7 @@ Sets the avoidance radius for the obstacle. .. rst-class:: classref-property -:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -197,7 +197,7 @@ Sets the wanted velocity for the obstacle so other agent's can better predict th .. rst-class:: classref-property -:ref:`PackedVector2Array` **vertices** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **vertices** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -233,7 +233,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer. @@ -245,7 +245,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationObsta .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer2D`. @@ -257,7 +257,7 @@ Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer .. rst-class:: classref-method -|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -269,7 +269,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this NavigationObstacle node should use and also updates the ``obstacle`` on the NavigationServer. diff --git a/classes/class_navigationobstacle3d.rst b/classes/class_navigationobstacle3d.rst index 25b55b1f8ab..4389920c21b 100644 --- a/classes/class_navigationobstacle3d.rst +++ b/classes/class_navigationobstacle3d.rst @@ -95,7 +95,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **affect_navigation_mesh** = ``false`` +:ref:`bool` **affect_navigation_mesh** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -112,7 +112,7 @@ If enabled and parsed in a navigation mesh baking process the obstacle will disc .. rst-class:: classref-property -:ref:`bool` **avoidance_enabled** = ``true`` +:ref:`bool` **avoidance_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -129,7 +129,7 @@ If ``true`` the obstacle affects avoidance using agents. .. rst-class:: classref-property -:ref:`int` **avoidance_layers** = ``1`` +:ref:`int` **avoidance_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -146,7 +146,7 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat .. rst-class:: classref-property -:ref:`bool` **carve_navigation_mesh** = ``false`` +:ref:`bool` **carve_navigation_mesh** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ Requires :ref:`affect_navigation_mesh` **height** = ``1.0`` +:ref:`float` **height** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ Sets the obstacle height used in 2D avoidance. 2D avoidance using agent's ignore .. rst-class:: classref-property -:ref:`float` **radius** = ``0.0`` +:ref:`float` **radius** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ Sets the avoidance radius for the obstacle. .. rst-class:: classref-property -:ref:`bool` **use_3d_avoidance** = ``false`` +:ref:`bool` **use_3d_avoidance** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ If ``false`` the obstacle affects 2D avoidance using agent's with both obstacle .. rst-class:: classref-property -:ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ Sets the wanted velocity for the obstacle so other agent's can better predict th .. rst-class:: classref-property -:ref:`PackedVector3Array` **vertices** = ``PackedVector3Array()`` +:ref:`PackedVector3Array` **vertices** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -261,7 +261,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -273,7 +273,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer. @@ -285,7 +285,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationObsta .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer3D`. @@ -297,7 +297,7 @@ Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer .. rst-class:: classref-method -|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -309,7 +309,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this NavigationObstacle node should use and also updates the ``obstacle`` on the NavigationServer. diff --git a/classes/class_navigationpathqueryparameters2d.rst b/classes/class_navigationpathqueryparameters2d.rst index 27cb9f229cc..cab547f0d07 100644 --- a/classes/class_navigationpathqueryparameters2d.rst +++ b/classes/class_navigationpathqueryparameters2d.rst @@ -71,7 +71,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PathfindingAlgorithm**: +enum **PathfindingAlgorithm**: :ref:`🔗` .. _class_NavigationPathQueryParameters2D_constant_PATHFINDING_ALGORITHM_ASTAR: @@ -89,7 +89,7 @@ The path query uses the default A\* pathfinding algorithm. .. rst-class:: classref-enumeration -enum **PathPostProcessing**: +enum **PathPostProcessing**: :ref:`🔗` .. _class_NavigationPathQueryParameters2D_constant_PATH_POSTPROCESSING_CORRIDORFUNNEL: @@ -115,7 +115,7 @@ Centers every path position in the middle of the traveled navigation mesh polygo .. rst-class:: classref-enumeration -flags **PathMetadataFlags**: +flags **PathMetadataFlags**: :ref:`🔗` .. _class_NavigationPathQueryParameters2D_constant_PATH_METADATA_INCLUDE_NONE: @@ -170,7 +170,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RID` **map** = ``RID()`` +:ref:`RID` **map** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -187,7 +187,7 @@ The navigation map :ref:`RID` used in the path query. .. rst-class:: classref-property -|bitfield|\[:ref:`PathMetadataFlags`\] **metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **metadata_flags** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -204,7 +204,7 @@ Additional information to include with the navigation path. .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ The navigation layers the query will use (as a bitmask). .. rst-class:: classref-property -:ref:`PathPostProcessing` **path_postprocessing** = ``0`` +:ref:`PathPostProcessing` **path_postprocessing** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property -:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` +:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -255,7 +255,7 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property -:ref:`float` **simplify_epsilon** = ``0.0`` +:ref:`float` **simplify_epsilon** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -272,7 +272,7 @@ The path simplification amount in worlds units. .. rst-class:: classref-property -:ref:`bool` **simplify_path** = ``false`` +:ref:`bool` **simplify_path** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -291,7 +291,7 @@ Path simplification can be helpful to mitigate various path following issues tha .. rst-class:: classref-property -:ref:`Vector2` **start_position** = ``Vector2(0, 0)`` +:ref:`Vector2` **start_position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -308,7 +308,7 @@ The pathfinding start position in global coordinates. .. rst-class:: classref-property -:ref:`Vector2` **target_position** = ``Vector2(0, 0)`` +:ref:`Vector2` **target_position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_navigationpathqueryparameters3d.rst b/classes/class_navigationpathqueryparameters3d.rst index 1c8c080f1f3..15599d6b393 100644 --- a/classes/class_navigationpathqueryparameters3d.rst +++ b/classes/class_navigationpathqueryparameters3d.rst @@ -71,7 +71,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PathfindingAlgorithm**: +enum **PathfindingAlgorithm**: :ref:`🔗` .. _class_NavigationPathQueryParameters3D_constant_PATHFINDING_ALGORITHM_ASTAR: @@ -89,7 +89,7 @@ The path query uses the default A\* pathfinding algorithm. .. rst-class:: classref-enumeration -enum **PathPostProcessing**: +enum **PathPostProcessing**: :ref:`🔗` .. _class_NavigationPathQueryParameters3D_constant_PATH_POSTPROCESSING_CORRIDORFUNNEL: @@ -115,7 +115,7 @@ Centers every path position in the middle of the traveled navigation mesh polygo .. rst-class:: classref-enumeration -flags **PathMetadataFlags**: +flags **PathMetadataFlags**: :ref:`🔗` .. _class_NavigationPathQueryParameters3D_constant_PATH_METADATA_INCLUDE_NONE: @@ -170,7 +170,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RID` **map** = ``RID()`` +:ref:`RID` **map** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -187,7 +187,7 @@ The navigation map :ref:`RID` used in the path query. .. rst-class:: classref-property -|bitfield|\[:ref:`PathMetadataFlags`\] **metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **metadata_flags** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -204,7 +204,7 @@ Additional information to include with the navigation path. .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ The navigation layers the query will use (as a bitmask). .. rst-class:: classref-property -:ref:`PathPostProcessing` **path_postprocessing** = ``0`` +:ref:`PathPostProcessing` **path_postprocessing** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property -:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` +:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -255,7 +255,7 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property -:ref:`float` **simplify_epsilon** = ``0.0`` +:ref:`float` **simplify_epsilon** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -272,7 +272,7 @@ The path simplification amount in worlds units. .. rst-class:: classref-property -:ref:`bool` **simplify_path** = ``false`` +:ref:`bool` **simplify_path** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -291,7 +291,7 @@ Path simplification can be helpful to mitigate various path following issues tha .. rst-class:: classref-property -:ref:`Vector3` **start_position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **start_position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -308,7 +308,7 @@ The pathfinding start position in global coordinates. .. rst-class:: classref-property -:ref:`Vector3` **target_position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **target_position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_navigationpathqueryresult2d.rst b/classes/class_navigationpathqueryresult2d.rst index 9d81187ed82..3ffb4050521 100644 --- a/classes/class_navigationpathqueryresult2d.rst +++ b/classes/class_navigationpathqueryresult2d.rst @@ -73,7 +73,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PathSegmentType**: +enum **PathSegmentType**: :ref:`🔗` .. _class_NavigationPathQueryResult2D_constant_PATH_SEGMENT_TYPE_REGION: @@ -104,7 +104,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedVector2Array` **path** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **path** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ The resulting path array from the navigation query. All path array positions are .. rst-class:: classref-property -:ref:`PackedInt64Array` **path_owner_ids** = ``PackedInt64Array()`` +:ref:`PackedInt64Array` **path_owner_ids** = ``PackedInt64Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regio .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ The :ref:`RID`\ s of the regions and links that each point of the pat .. rst-class:: classref-property -:ref:`PackedInt32Array` **path_types** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **path_types** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **reset**\ (\ ) +|void| **reset**\ (\ ) :ref:`🔗` Reset the result object to its initial state. This is useful to reuse the object across multiple queries. diff --git a/classes/class_navigationpathqueryresult3d.rst b/classes/class_navigationpathqueryresult3d.rst index d01fe630b6b..430593c65c2 100644 --- a/classes/class_navigationpathqueryresult3d.rst +++ b/classes/class_navigationpathqueryresult3d.rst @@ -73,7 +73,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PathSegmentType**: +enum **PathSegmentType**: :ref:`🔗` .. _class_NavigationPathQueryResult3D_constant_PATH_SEGMENT_TYPE_REGION: @@ -104,7 +104,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedVector3Array` **path** = ``PackedVector3Array()`` +:ref:`PackedVector3Array` **path** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ The resulting path array from the navigation query. All path array positions are .. rst-class:: classref-property -:ref:`PackedInt64Array` **path_owner_ids** = ``PackedInt64Array()`` +:ref:`PackedInt64Array` **path_owner_ids** = ``PackedInt64Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regio .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ The :ref:`RID`\ s of the regions and links that each point of the pat .. rst-class:: classref-property -:ref:`PackedInt32Array` **path_types** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **path_types** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **reset**\ (\ ) +|void| **reset**\ (\ ) :ref:`🔗` Reset the result object to its initial state. This is useful to reuse the object across multiple queries. diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 2838b33132f..b55607d9068 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -167,7 +167,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ParsedGeometryType**: +enum **ParsedGeometryType**: :ref:`🔗` .. _class_NavigationPolygon_constant_PARSED_GEOMETRY_MESH_INSTANCES: @@ -211,7 +211,7 @@ Represents the size of the :ref:`ParsedGeometryType` .. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_ROOT_NODE_CHILDREN: @@ -258,7 +258,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **agent_radius** = ``10.0`` +:ref:`float` **agent_radius** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -275,7 +275,7 @@ The distance to erode/shrink the walkable surface when baking the navigation mes .. rst-class:: classref-property -:ref:`Rect2` **baking_rect** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **baking_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ If the baking :ref:`Rect2` has an area the navigation mesh baking w .. rst-class:: classref-property -:ref:`Vector2` **baking_rect_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **baking_rect_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -309,7 +309,7 @@ The position offset applied to the :ref:`baking_rect` **border_size** = ``0.0`` +:ref:`float` **border_size** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -328,7 +328,7 @@ In conjunction with the :ref:`baking_rect` **cell_size** = ``1.0`` +:ref:`float` **cell_size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -345,7 +345,7 @@ The cell size used to rasterize the navigation mesh vertices. Must match with th .. rst-class:: classref-property -:ref:`int` **parsed_collision_mask** = ``4294967295`` +:ref:`int` **parsed_collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -364,7 +364,7 @@ Only used when :ref:`parsed_geometry_type` **parsed_geometry_type** = ``2`` +:ref:`ParsedGeometryType` **parsed_geometry_type** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -381,7 +381,7 @@ Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeome .. rst-class:: classref-property -:ref:`StringName` **source_geometry_group_name** = ``&"navigation_polygon_source_geometry_group"`` +:ref:`StringName` **source_geometry_group_name** = ``&"navigation_polygon_source_geometry_group"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -400,7 +400,7 @@ Only used when :ref:`source_geometry_mode` **source_geometry_mode** = ``0`` +:ref:`SourceGeometryMode` **source_geometry_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -422,7 +422,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_outline**\ (\ outline\: :ref:`PackedVector2Array`\ ) +|void| **add_outline**\ (\ outline\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Appends a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. @@ -434,7 +434,7 @@ Appends a :ref:`PackedVector2Array` that contains the .. rst-class:: classref-method -|void| **add_outline_at_index**\ (\ outline\: :ref:`PackedVector2Array`, index\: :ref:`int`\ ) +|void| **add_outline_at_index**\ (\ outline\: :ref:`PackedVector2Array`, index\: :ref:`int`\ ) :ref:`🔗` Adds a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. @@ -446,7 +446,7 @@ Adds a :ref:`PackedVector2Array` that contains the ver .. rst-class:: classref-method -|void| **add_polygon**\ (\ polygon\: :ref:`PackedInt32Array`\ ) +|void| **add_polygon**\ (\ polygon\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. @@ -458,7 +458,7 @@ Adds a polygon using the indices of the vertices you get when calling :ref:`get_ .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the internal arrays for vertices and polygon indices. @@ -470,7 +470,7 @@ Clears the internal arrays for vertices and polygon indices. .. rst-class:: classref-method -|void| **clear_outlines**\ (\ ) +|void| **clear_outlines**\ (\ ) :ref:`🔗` Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. @@ -482,7 +482,7 @@ Clears the array of the outlines, but it doesn't clear the vertices and the poly .. rst-class:: classref-method -|void| **clear_polygons**\ (\ ) +|void| **clear_polygons**\ (\ ) :ref:`🔗` Clears the array of polygons, but it doesn't clear the array of outlines and vertices. @@ -494,7 +494,7 @@ Clears the array of polygons, but it doesn't clear the array of outlines and ver .. rst-class:: classref-method -:ref:`NavigationMesh` **get_navigation_mesh**\ (\ ) +:ref:`NavigationMesh` **get_navigation_mesh**\ (\ ) :ref:`🔗` Returns the :ref:`NavigationMesh` resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the :ref:`NavigationServer3D.region_set_navigation_mesh` API directly (as 2D uses the 3D server behind the scene). @@ -506,7 +506,7 @@ Returns the :ref:`NavigationMesh` resulting from this navi .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_outline**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedVector2Array` **get_outline**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`PackedVector2Array` containing the vertices of an outline that was created in the editor or by script. @@ -518,7 +518,7 @@ Returns a :ref:`PackedVector2Array` containing the ver .. rst-class:: classref-method -:ref:`int` **get_outline_count**\ (\ ) |const| +:ref:`int` **get_outline_count**\ (\ ) |const| :ref:`🔗` Returns the number of outlines that were created in the editor or by script. @@ -530,7 +530,7 @@ Returns the number of outlines that were created in the editor or by script. .. rst-class:: classref-method -:ref:`bool` **get_parsed_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_parsed_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`parsed_collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -542,7 +542,7 @@ Returns whether or not the specified layer of the :ref:`parsed_collision_mask` **get_polygon**\ (\ idx\: :ref:`int`\ ) +:ref:`PackedInt32Array` **get_polygon**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns a :ref:`PackedInt32Array` containing the indices of the vertices of a created polygon. @@ -554,7 +554,7 @@ Returns a :ref:`PackedInt32Array` containing the indices .. rst-class:: classref-method -:ref:`int` **get_polygon_count**\ (\ ) |const| +:ref:`int` **get_polygon_count**\ (\ ) |const| :ref:`🔗` Returns the count of all polygons. @@ -566,7 +566,7 @@ Returns the count of all polygons. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_vertices**\ (\ ) |const| +:ref:`PackedVector2Array` **get_vertices**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedVector2Array` containing all the vertices being used to create the polygons. @@ -578,7 +578,7 @@ Returns a :ref:`PackedVector2Array` containing all the .. rst-class:: classref-method -|void| **make_polygons_from_outlines**\ (\ ) +|void| **make_polygons_from_outlines**\ (\ ) :ref:`🔗` **Deprecated:** Use :ref:`NavigationServer2D.parse_source_geometry_data` and :ref:`NavigationServer2D.bake_from_source_geometry_data` instead. @@ -592,7 +592,7 @@ Creates polygons from the outlines added in the editor or by script. .. rst-class:: classref-method -|void| **remove_outline**\ (\ idx\: :ref:`int`\ ) +|void| **remove_outline**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Removes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. @@ -604,7 +604,7 @@ Removes an outline created in the editor or by script. You have to call :ref:`ma .. rst-class:: classref-method -|void| **set_outline**\ (\ idx\: :ref:`int`, outline\: :ref:`PackedVector2Array`\ ) +|void| **set_outline**\ (\ idx\: :ref:`int`, outline\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Changes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. @@ -616,7 +616,7 @@ Changes an outline created in the editor or by script. You have to call :ref:`ma .. rst-class:: classref-method -|void| **set_parsed_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_parsed_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`parsed_collision_mask`, given a ``layer_number`` between 1 and 32. @@ -628,7 +628,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`parsed_ .. rst-class:: classref-method -|void| **set_vertices**\ (\ vertices\: :ref:`PackedVector2Array`\ ) +|void| **set_vertices**\ (\ vertices\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. diff --git a/classes/class_navigationregion2d.rst b/classes/class_navigationregion2d.rst index bd39901d32d..59fe054d2a5 100644 --- a/classes/class_navigationregion2d.rst +++ b/classes/class_navigationregion2d.rst @@ -103,7 +103,7 @@ Signals .. rst-class:: classref-signal -**bake_finished**\ (\ ) +**bake_finished**\ (\ ) :ref:`🔗` Emitted when a navigation polygon bake operation is completed. @@ -115,7 +115,7 @@ Emitted when a navigation polygon bake operation is completed. .. rst-class:: classref-signal -**navigation_polygon_changed**\ (\ ) +**navigation_polygon_changed**\ (\ ) :ref:`🔗` Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed. @@ -132,7 +132,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ Determines if the **NavigationRegion2D** is enabled or disabled. .. rst-class:: classref-property -:ref:`float` **enter_cost** = ``0.0`` +:ref:`float` **enter_cost** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ When pathfinding enters this region's navigation mesh from another regions navig .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ A bitfield determining all navigation layers the region belongs to. These naviga .. rst-class:: classref-property -:ref:`NavigationPolygon` **navigation_polygon** +:ref:`NavigationPolygon` **navigation_polygon** :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ The :ref:`NavigationPolygon` resource to use. .. rst-class:: classref-property -:ref:`float` **travel_cost** = ``1.0`` +:ref:`float` **travel_cost** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ When pathfinding moves inside this region's navigation mesh the traveled distanc .. rst-class:: classref-property -:ref:`bool` **use_edge_connections** = ``true`` +:ref:`bool` **use_edge_connections** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **bake_navigation_polygon**\ (\ on_thread\: :ref:`bool` = true\ ) +|void| **bake_navigation_polygon**\ (\ on_thread\: :ref:`bool` = true\ ) :ref:`🔗` Bakes the :ref:`NavigationPolygon`. If ``on_thread`` is set to ``true`` (default), the baking is done on a separate thread. @@ -251,7 +251,7 @@ Bakes the :ref:`NavigationPolygon`. If ``on_thread`` is .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -263,7 +263,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the current navigation map :ref:`RID` used by this region. @@ -275,7 +275,7 @@ Returns the current navigation map :ref:`RID` used by this region. .. rst-class:: classref-method -:ref:`RID` **get_region_rid**\ (\ ) |const| +:ref:`RID` **get_region_rid**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`get_rid` instead. @@ -289,7 +289,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer2D .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this region on the :ref:`NavigationServer2D`. Combined with :ref:`NavigationServer2D.map_get_closest_point_owner` can be used to identify the **NavigationRegion2D** closest to a point on the merged navigation map. @@ -301,7 +301,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer2D .. rst-class:: classref-method -:ref:`bool` **is_baking**\ (\ ) |const| +:ref:`bool` **is_baking**\ (\ ) |const| :ref:`🔗` Returns ``true`` when the :ref:`NavigationPolygon` is being baked on a background thread. @@ -313,7 +313,7 @@ Returns ``true`` when the :ref:`NavigationPolygon` is b .. rst-class:: classref-method -|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -325,7 +325,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this region should use. By default the region will automatically join the :ref:`World2D` default navigation map so this function is only required to override the default map. diff --git a/classes/class_navigationregion3d.rst b/classes/class_navigationregion3d.rst index 813ed23b6be..15f9a586c7a 100644 --- a/classes/class_navigationregion3d.rst +++ b/classes/class_navigationregion3d.rst @@ -103,7 +103,7 @@ Signals .. rst-class:: classref-signal -**bake_finished**\ (\ ) +**bake_finished**\ (\ ) :ref:`🔗` Notifies when the navigation mesh bake operation is completed. @@ -115,7 +115,7 @@ Notifies when the navigation mesh bake operation is completed. .. rst-class:: classref-signal -**navigation_mesh_changed**\ (\ ) +**navigation_mesh_changed**\ (\ ) :ref:`🔗` Notifies when the :ref:`NavigationMesh` has changed. @@ -132,7 +132,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ Determines if the **NavigationRegion3D** is enabled or disabled. .. rst-class:: classref-property -:ref:`float` **enter_cost** = ``0.0`` +:ref:`float` **enter_cost** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ When pathfinding enters this region's navigation mesh from another regions navig .. rst-class:: classref-property -:ref:`int` **navigation_layers** = ``1`` +:ref:`int` **navigation_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ A bitfield determining all navigation layers the region belongs to. These naviga .. rst-class:: classref-property -:ref:`NavigationMesh` **navigation_mesh** +:ref:`NavigationMesh` **navigation_mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ The :ref:`NavigationMesh` resource to use. .. rst-class:: classref-property -:ref:`float` **travel_cost** = ``1.0`` +:ref:`float` **travel_cost** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ When pathfinding moves inside this region's navigation mesh the traveled distanc .. rst-class:: classref-property -:ref:`bool` **use_edge_connections** = ``true`` +:ref:`bool` **use_edge_connections** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **bake_navigation_mesh**\ (\ on_thread\: :ref:`bool` = true\ ) +|void| **bake_navigation_mesh**\ (\ on_thread\: :ref:`bool` = true\ ) :ref:`🔗` Bakes the :ref:`NavigationMesh`. If ``on_thread`` is set to ``true`` (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new :ref:`NavigationMesh`. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as Web with threads disabled). @@ -251,7 +251,7 @@ Bakes the :ref:`NavigationMesh`. If ``on_thread`` is set t .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -263,7 +263,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the current navigation map :ref:`RID` used by this region. @@ -275,7 +275,7 @@ Returns the current navigation map :ref:`RID` used by this region. .. rst-class:: classref-method -:ref:`RID` **get_region_rid**\ (\ ) |const| +:ref:`RID` **get_region_rid**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`get_rid` instead. @@ -289,7 +289,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer3D .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this region on the :ref:`NavigationServer3D`. Combined with :ref:`NavigationServer3D.map_get_closest_point_owner` can be used to identify the **NavigationRegion3D** closest to a point on the merged navigation map. @@ -301,7 +301,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer3D .. rst-class:: classref-method -:ref:`bool` **is_baking**\ (\ ) |const| +:ref:`bool` **is_baking**\ (\ ) |const| :ref:`🔗` Returns ``true`` when the :ref:`NavigationMesh` is being baked on a background thread. @@ -313,7 +313,7 @@ Returns ``true`` when the :ref:`NavigationMesh` is being b .. rst-class:: classref-method -|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -325,7 +325,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`RID` of the navigation map this region should use. By default the region will automatically join the :ref:`World3D` default navigation map so this function is only required to override the default map. diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index 3b95c508a65..d0b2b4c41ad 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -319,7 +319,7 @@ Signals .. rst-class:: classref-signal -**map_changed**\ (\ map\: :ref:`RID`\ ) +**map_changed**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` Emitted when a navigation map is updated, when a region moves or is modified. @@ -331,7 +331,7 @@ Emitted when a navigation map is updated, when a region moves or is modified. .. rst-class:: classref-signal -**navigation_debug_changed**\ (\ ) +**navigation_debug_changed**\ (\ ) :ref:`🔗` Emitted when navigation debug settings are changed. Only available in debug builds. @@ -348,7 +348,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **agent_create**\ (\ ) +:ref:`RID` **agent_create**\ (\ ) :ref:`🔗` Creates the agent. @@ -360,7 +360,7 @@ Creates the agent. .. rst-class:: classref-method -:ref:`bool` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Return ``true`` if the specified ``agent`` uses avoidance. @@ -372,7 +372,7 @@ Return ``true`` if the specified ``agent`` uses avoidance. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`int` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_layers`` bitmask of the specified ``agent``. @@ -384,7 +384,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`int` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_mask`` bitmask of the specified ``agent``. @@ -396,7 +396,7 @@ Returns the ``avoidance_mask`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_priority`` of the specified ``agent``. @@ -408,7 +408,7 @@ Returns the ``avoidance_priority`` of the specified ``agent``. .. rst-class:: classref-method -:ref:`RID` **agent_get_map**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`RID` **agent_get_map**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``agent`` is currently assigned to. @@ -420,7 +420,7 @@ Returns the navigation map :ref:`RID` the requested ``agent`` is curr .. rst-class:: classref-method -:ref:`int` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`int` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum number of other agents the specified ``agent`` takes into account in the navigation. @@ -432,7 +432,7 @@ Returns the maximum number of other agents the specified ``agent`` takes into ac .. rst-class:: classref-method -:ref:`float` **agent_get_max_speed**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_max_speed**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum speed of the specified ``agent``. @@ -444,7 +444,7 @@ Returns the maximum speed of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum distance to other agents the specified ``agent`` takes into account in the navigation. @@ -456,7 +456,7 @@ Returns the maximum distance to other agents the specified ``agent`` takes into .. rst-class:: classref-method -:ref:`bool` **agent_get_paused**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_get_paused**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``agent`` is paused. @@ -468,7 +468,7 @@ Returns ``true`` if the specified ``agent`` is paused. .. rst-class:: classref-method -:ref:`Vector2` **agent_get_position**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`Vector2` **agent_get_position**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the position of the specified ``agent`` in world space. @@ -480,7 +480,7 @@ Returns the position of the specified ``agent`` in world space. .. rst-class:: classref-method -:ref:`float` **agent_get_radius**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_radius**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the radius of the specified ``agent``. @@ -492,7 +492,7 @@ Returns the radius of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to other agents. @@ -504,7 +504,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to static avoidance obstacles. @@ -516,7 +516,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`Vector2` **agent_get_velocity**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`Vector2` **agent_get_velocity**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the velocity of the specified ``agent``. @@ -528,7 +528,7 @@ Returns the velocity of the specified ``agent``. .. rst-class:: classref-method -:ref:`bool` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Return ``true`` if the specified ``agent`` has an avoidance callback. @@ -540,7 +540,7 @@ Return ``true`` if the specified ``agent`` has an avoidance callback. .. rst-class:: classref-method -:ref:`bool` **agent_is_map_changed**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_is_map_changed**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns true if the map got changed the previous frame. @@ -552,7 +552,7 @@ Returns true if the map got changed the previous frame. .. rst-class:: classref-method -|void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the callback :ref:`Callable` that gets called after each avoidance processing step for the ``agent``. The calculated ``safe_velocity`` will be dispatched with a signal to the object just before the physics calculations. @@ -566,7 +566,7 @@ Sets the callback :ref:`Callable` that gets called after each av .. rst-class:: classref-method -|void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the specified ``agent`` uses avoidance. @@ -578,7 +578,7 @@ If ``enabled`` is ``true``, the specified ``agent`` uses avoidance. .. rst-class:: classref-method -|void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Set the agent's ``avoidance_layers`` bitmask. @@ -590,7 +590,7 @@ Set the agent's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -|void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Set the agent's ``avoidance_mask`` bitmask. @@ -602,7 +602,7 @@ Set the agent's ``avoidance_mask`` bitmask. .. rst-class:: classref-method -|void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) +|void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) :ref:`🔗` Set the agent's ``avoidance_priority`` with a ``priority`` between 0.0 (lowest priority) to 1.0 (highest priority). @@ -616,7 +616,7 @@ The specified ``agent`` does not adjust the velocity for other agents that would .. rst-class:: classref-method -|void| **agent_set_map**\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **agent_set_map**\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Puts the agent in the map. @@ -628,7 +628,7 @@ Puts the agent in the map. .. rst-class:: classref-method -|void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) +|void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -640,7 +640,7 @@ Sets the maximum number of other agents the agent takes into account in the navi .. rst-class:: classref-method -|void| **agent_set_max_speed**\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) +|void| **agent_set_max_speed**\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) :ref:`🔗` Sets the maximum speed of the agent. Must be positive. @@ -652,7 +652,7 @@ Sets the maximum speed of the agent. Must be positive. .. rst-class:: classref-method -|void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) +|void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) :ref:`🔗` Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -664,7 +664,7 @@ Sets the maximum distance to other agents this agent takes into account in the n .. rst-class:: classref-method -|void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) +|void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` If ``paused`` is true the specified ``agent`` will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks. @@ -676,7 +676,7 @@ If ``paused`` is true the specified ``agent`` will not be processed, e.g. calcul .. rst-class:: classref-method -|void| **agent_set_position**\ (\ agent\: :ref:`RID`, position\: :ref:`Vector2`\ ) +|void| **agent_set_position**\ (\ agent\: :ref:`RID`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position of the agent in world space. @@ -688,7 +688,7 @@ Sets the position of the agent in world space. .. rst-class:: classref-method -|void| **agent_set_radius**\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **agent_set_radius**\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Sets the radius of the agent. @@ -700,7 +700,7 @@ Sets the radius of the agent. .. rst-class:: classref-method -|void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) +|void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) :ref:`🔗` The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -712,7 +712,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -|void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) +|void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) :ref:`🔗` The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -724,7 +724,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -|void| **agent_set_velocity**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) +|void| **agent_set_velocity**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) :ref:`🔗` Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position far away use :ref:`agent_set_velocity_forced` instead to reset the internal velocity state. @@ -736,7 +736,7 @@ Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The av .. rst-class:: classref-method -|void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) +|void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) :ref:`🔗` Replaces the internal velocity in the collision avoidance simulation with ``velocity`` for the specified ``agent``. When an agent is teleported to a new position far away this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -748,7 +748,7 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo .. rst-class:: classref-method -|void| **bake_from_source_geometry_data**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) +|void| **bake_from_source_geometry_data**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Bakes the provided ``navigation_polygon`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. @@ -760,7 +760,7 @@ Bakes the provided ``navigation_polygon`` with the data from the provided ``sour .. rst-class:: classref-method -|void| **bake_from_source_geometry_data_async**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) +|void| **bake_from_source_geometry_data_async**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Bakes the provided ``navigation_polygon`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called. @@ -772,7 +772,7 @@ Bakes the provided ``navigation_polygon`` with the data from the provided ``sour .. rst-class:: classref-method -|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Destroys the given RID. @@ -784,7 +784,7 @@ Destroys the given RID. .. rst-class:: classref-method -:ref:`bool` **get_debug_enabled**\ (\ ) |const| +:ref:`bool` **get_debug_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` when the NavigationServer has debug enabled. @@ -796,7 +796,7 @@ Returns ``true`` when the NavigationServer has debug enabled. .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **get_maps**\ (\ ) |const| +:ref:`Array`\[:ref:`RID`\] **get_maps**\ (\ ) |const| :ref:`🔗` Returns all created navigation map :ref:`RID`\ s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them. @@ -808,7 +808,7 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer .. rst-class:: classref-method -:ref:`bool` **is_baking_navigation_polygon**\ (\ navigation_polygon\: :ref:`NavigationPolygon`\ ) |const| +:ref:`bool` **is_baking_navigation_polygon**\ (\ navigation_polygon\: :ref:`NavigationPolygon`\ ) |const| :ref:`🔗` Returns ``true`` when the provided navigation polygon is being baked on a background thread. @@ -820,7 +820,7 @@ Returns ``true`` when the provided navigation polygon is being baked on a backgr .. rst-class:: classref-method -:ref:`RID` **link_create**\ (\ ) +:ref:`RID` **link_create**\ (\ ) :ref:`🔗` Create a new link between two positions on a map. @@ -832,7 +832,7 @@ Create a new link between two positions on a map. .. rst-class:: classref-method -:ref:`bool` **link_get_enabled**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`bool` **link_get_enabled**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``link`` is enabled. @@ -844,7 +844,7 @@ Returns ``true`` if the specified ``link`` is enabled. .. rst-class:: classref-method -:ref:`Vector2` **link_get_end_position**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`Vector2` **link_get_end_position**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ending position of this ``link``. @@ -856,7 +856,7 @@ Returns the ending position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_enter_cost**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`float` **link_get_enter_cost**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the enter cost of this ``link``. @@ -868,7 +868,7 @@ Returns the enter cost of this ``link``. .. rst-class:: classref-method -:ref:`RID` **link_get_map**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`RID` **link_get_map**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``link`` is currently assigned to. @@ -880,7 +880,7 @@ Returns the navigation map :ref:`RID` the requested ``link`` is curre .. rst-class:: classref-method -:ref:`int` **link_get_navigation_layers**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`int` **link_get_navigation_layers**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation layers for this ``link``. @@ -892,7 +892,7 @@ Returns the navigation layers for this ``link``. .. rst-class:: classref-method -:ref:`int` **link_get_owner_id**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`int` **link_get_owner_id**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` of the object which manages this link. @@ -904,7 +904,7 @@ Returns the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -:ref:`Vector2` **link_get_start_position**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`Vector2` **link_get_start_position**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the starting position of this ``link``. @@ -916,7 +916,7 @@ Returns the starting position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_travel_cost**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`float` **link_get_travel_cost**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the travel cost of this ``link``. @@ -928,7 +928,7 @@ Returns the travel cost of this ``link``. .. rst-class:: classref-method -:ref:`bool` **link_is_bidirectional**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`bool` **link_is_bidirectional**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether this ``link`` can be travelled in both directions. @@ -940,7 +940,7 @@ Returns whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -|void| **link_set_bidirectional**\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) +|void| **link_set_bidirectional**\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) :ref:`🔗` Sets whether this ``link`` can be travelled in both directions. @@ -952,7 +952,7 @@ Sets whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -|void| **link_set_enabled**\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **link_set_enabled**\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the specified ``link`` will contribute to its current navigation map. @@ -964,7 +964,7 @@ If ``enabled`` is ``true``, the specified ``link`` will contribute to its curren .. rst-class:: classref-method -|void| **link_set_end_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) +|void| **link_set_end_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the exit position for the ``link``. @@ -976,7 +976,7 @@ Sets the exit position for the ``link``. .. rst-class:: classref-method -|void| **link_set_enter_cost**\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) +|void| **link_set_enter_cost**\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``enter_cost`` for this ``link``. @@ -988,7 +988,7 @@ Sets the ``enter_cost`` for this ``link``. .. rst-class:: classref-method -|void| **link_set_map**\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **link_set_map**\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Sets the navigation map :ref:`RID` for the link. @@ -1000,7 +1000,7 @@ Sets the navigation map :ref:`RID` for the link. .. rst-class:: classref-method -|void| **link_set_navigation_layers**\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) +|void| **link_set_navigation_layers**\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) :ref:`🔗` Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path`). @@ -1012,7 +1012,7 @@ Set the links's navigation layers. This allows selecting links from a path reque .. rst-class:: classref-method -|void| **link_set_owner_id**\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) +|void| **link_set_owner_id**\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) :ref:`🔗` Set the ``ObjectID`` of the object which manages this link. @@ -1024,7 +1024,7 @@ Set the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -|void| **link_set_start_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) +|void| **link_set_start_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the entry position for this ``link``. @@ -1036,7 +1036,7 @@ Sets the entry position for this ``link``. .. rst-class:: classref-method -|void| **link_set_travel_cost**\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) +|void| **link_set_travel_cost**\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``travel_cost`` for this ``link``. @@ -1048,7 +1048,7 @@ Sets the ``travel_cost`` for this ``link``. .. rst-class:: classref-method -:ref:`RID` **map_create**\ (\ ) +:ref:`RID` **map_create**\ (\ ) :ref:`🔗` Create a new map. @@ -1060,7 +1060,7 @@ Create a new map. .. rst-class:: classref-method -|void| **map_force_update**\ (\ map\: :ref:`RID`\ ) +|void| **map_force_update**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). @@ -1078,7 +1078,7 @@ Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_agents**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_agents**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation agents :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1090,7 +1090,7 @@ Returns all navigation agents :ref:`RID`\ s that are currently assign .. rst-class:: classref-method -:ref:`float` **map_get_cell_size**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_cell_size**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the map cell size used to rasterize the navigation mesh vertices. @@ -1102,7 +1102,7 @@ Returns the map cell size used to rasterize the navigation mesh vertices. .. rst-class:: classref-method -:ref:`Vector2` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the point closest to the provided ``to_point`` on the navigation mesh surface. @@ -1114,7 +1114,7 @@ Returns the point closest to the provided ``to_point`` on the navigation mesh su .. rst-class:: classref-method -:ref:`RID` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| +:ref:`RID` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. @@ -1126,7 +1126,7 @@ Returns the owner region RID for the point returned by :ref:`map_get_closest_poi .. rst-class:: classref-method -:ref:`float` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. @@ -1138,7 +1138,7 @@ Returns the edge connection margin of the map. The edge connection margin is a d .. rst-class:: classref-method -:ref:`int` **map_get_iteration_id**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`int` **map_get_iteration_id**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized. @@ -1152,7 +1152,7 @@ Returns the current iteration id of the navigation map. Every time the navigatio .. rst-class:: classref-method -:ref:`float` **map_get_link_connection_radius**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_link_connection_radius**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. @@ -1164,7 +1164,7 @@ Returns the link connection radius of the map. This distance is the maximum rang .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_links**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_links**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation link :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1176,7 +1176,7 @@ Returns all navigation link :ref:`RID`\ s that are currently assigned .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_obstacles**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_obstacles**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation obstacle :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1188,7 +1188,7 @@ Returns all navigation obstacle :ref:`RID`\ s that are currently assi .. rst-class:: classref-method -:ref:`PackedVector2Array` **map_get_path**\ (\ map\: :ref:`RID`, origin\: :ref:`Vector2`, destination\: :ref:`Vector2`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| +:ref:`PackedVector2Array` **map_get_path**\ (\ map\: :ref:`RID`, origin\: :ref:`Vector2`, destination\: :ref:`Vector2`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| :ref:`🔗` Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region navigation layers that are allowed to be in the path. @@ -1200,7 +1200,7 @@ Returns the navigation path to reach the destination from the origin. ``navigati .. rst-class:: classref-method -:ref:`Vector2` **map_get_random_point**\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| +:ref:`Vector2` **map_get_random_point**\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| :ref:`🔗` Returns a random position picked from all map region polygons with matching ``navigation_layers``. @@ -1216,7 +1216,7 @@ If ``uniformly`` is ``false``, just a random region and a random polygon are pic .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_regions**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_regions**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation regions :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1228,7 +1228,7 @@ Returns all navigation regions :ref:`RID`\ s that are currently assig .. rst-class:: classref-method -:ref:`bool` **map_get_use_edge_connections**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`bool` **map_get_use_edge_connections**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the navigation ``map`` allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1240,7 +1240,7 @@ Returns whether the navigation ``map`` allows navigation regions to use edge con .. rst-class:: classref-method -:ref:`bool` **map_is_active**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`bool` **map_is_active**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns true if the map is active. @@ -1252,7 +1252,7 @@ Returns true if the map is active. .. rst-class:: classref-method -|void| **map_set_active**\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) +|void| **map_set_active**\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) :ref:`🔗` Sets the map active. @@ -1264,7 +1264,7 @@ Sets the map active. .. rst-class:: classref-method -|void| **map_set_cell_size**\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) +|void| **map_set_cell_size**\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) :ref:`🔗` Sets the map cell size used to rasterize the navigation mesh vertices. Must match with the cell size of the used navigation meshes. @@ -1276,7 +1276,7 @@ Sets the map cell size used to rasterize the navigation mesh vertices. Must matc .. rst-class:: classref-method -|void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) +|void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) :ref:`🔗` Set the map edge connection margin used to weld the compatible region edges. @@ -1288,7 +1288,7 @@ Set the map edge connection margin used to weld the compatible region edges. .. rst-class:: classref-method -|void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Set the map's link connection radius used to connect links to navigation polygons. @@ -1300,7 +1300,7 @@ Set the map's link connection radius used to connect links to navigation polygon .. rst-class:: classref-method -|void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1312,7 +1312,7 @@ Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the .. rst-class:: classref-method -:ref:`RID` **obstacle_create**\ (\ ) +:ref:`RID` **obstacle_create**\ (\ ) :ref:`🔗` Creates a new navigation obstacle. @@ -1324,7 +1324,7 @@ Creates a new navigation obstacle. .. rst-class:: classref-method -:ref:`bool` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`bool` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``obstacle`` has avoidance enabled. @@ -1336,7 +1336,7 @@ Returns ``true`` if the provided ``obstacle`` has avoidance enabled. .. rst-class:: classref-method -:ref:`int` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`int` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. @@ -1348,7 +1348,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. .. rst-class:: classref-method -:ref:`RID` **obstacle_get_map**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`RID` **obstacle_get_map**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``obstacle`` is currently assigned to. @@ -1360,7 +1360,7 @@ Returns the navigation map :ref:`RID` the requested ``obstacle`` is c .. rst-class:: classref-method -:ref:`bool` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`bool` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``obstacle`` is paused. @@ -1372,7 +1372,7 @@ Returns ``true`` if the specified ``obstacle`` is paused. .. rst-class:: classref-method -:ref:`Vector2` **obstacle_get_position**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`Vector2` **obstacle_get_position**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the position of the specified ``obstacle`` in world space. @@ -1384,7 +1384,7 @@ Returns the position of the specified ``obstacle`` in world space. .. rst-class:: classref-method -:ref:`float` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`float` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the radius of the specified dynamic ``obstacle``. @@ -1396,7 +1396,7 @@ Returns the radius of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`Vector2` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`Vector2` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the velocity of the specified dynamic ``obstacle``. @@ -1408,7 +1408,7 @@ Returns the velocity of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`PackedVector2Array` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`PackedVector2Array` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the outline vertices for the specified ``obstacle``. @@ -1420,7 +1420,7 @@ Returns the outline vertices for the specified ``obstacle``. .. rst-class:: classref-method -|void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using agents. @@ -1432,7 +1432,7 @@ If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using ag .. rst-class:: classref-method -|void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Set the obstacles's ``avoidance_layers`` bitmask. @@ -1444,7 +1444,7 @@ Set the obstacles's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -|void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Sets the navigation map :ref:`RID` for the obstacle. @@ -1456,7 +1456,7 @@ Sets the navigation map :ref:`RID` for the obstacle. .. rst-class:: classref-method -|void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) +|void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. affect avoidance velocities. @@ -1468,7 +1468,7 @@ If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. aff .. rst-class:: classref-method -|void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector2`\ ) +|void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position of the obstacle in world space. @@ -1480,7 +1480,7 @@ Sets the position of the obstacle in world space. .. rst-class:: classref-method -|void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Sets the radius of the dynamic obstacle. @@ -1492,7 +1492,7 @@ Sets the radius of the dynamic obstacle. .. rst-class:: classref-method -|void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) +|void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) :ref:`🔗` Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle. @@ -1504,7 +1504,7 @@ Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better pre .. rst-class:: classref-method -|void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector2Array`\ ) +|void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. @@ -1516,7 +1516,7 @@ Sets the outline vertices for the obstacle. If the vertices are winded in clockw .. rst-class:: classref-method -|void| **parse_source_geometry_data**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) +|void| **parse_source_geometry_data**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_polygon``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. @@ -1532,7 +1532,7 @@ Parses the :ref:`SceneTree` for source geometry according to th .. rst-class:: classref-method -|void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters2D`, result\: :ref:`NavigationPathQueryResult2D`\ ) |const| +|void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters2D`, result\: :ref:`NavigationPathQueryResult2D`\ ) |const| :ref:`🔗` Queries a path in a given navigation map. Start and target position and other parameters are defined through :ref:`NavigationPathQueryParameters2D`. Updates the provided :ref:`NavigationPathQueryResult2D` result object with the path among other results requested by the query. @@ -1544,7 +1544,7 @@ Queries a path in a given navigation map. Start and target position and other pa .. rst-class:: classref-method -:ref:`RID` **region_create**\ (\ ) +:ref:`RID` **region_create**\ (\ ) :ref:`🔗` Creates a new region. @@ -1556,7 +1556,7 @@ Creates a new region. .. rst-class:: classref-method -:ref:`Vector2` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| +:ref:`Vector2` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1568,7 +1568,7 @@ Returns the ending point of a connection door. ``connection`` is an index betwee .. rst-class:: classref-method -:ref:`Vector2` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| +:ref:`Vector2` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| :ref:`🔗` Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1580,7 +1580,7 @@ Returns the starting point of a connection door. ``connection`` is an index betw .. rst-class:: classref-method -:ref:`int` **region_get_connections_count**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`int` **region_get_connections_count**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns how many connections this ``region`` has with other regions in the map. @@ -1592,7 +1592,7 @@ Returns how many connections this ``region`` has with other regions in the map. .. rst-class:: classref-method -:ref:`bool` **region_get_enabled**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`bool` **region_get_enabled**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``region`` is enabled. @@ -1604,7 +1604,7 @@ Returns ``true`` if the specified ``region`` is enabled. .. rst-class:: classref-method -:ref:`float` **region_get_enter_cost**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`float` **region_get_enter_cost**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the enter cost of this ``region``. @@ -1616,7 +1616,7 @@ Returns the enter cost of this ``region``. .. rst-class:: classref-method -:ref:`RID` **region_get_map**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`RID` **region_get_map**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``region`` is currently assigned to. @@ -1628,7 +1628,7 @@ Returns the navigation map :ref:`RID` the requested ``region`` is cur .. rst-class:: classref-method -:ref:`int` **region_get_navigation_layers**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`int` **region_get_navigation_layers**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the region's navigation layers. @@ -1640,7 +1640,7 @@ Returns the region's navigation layers. .. rst-class:: classref-method -:ref:`int` **region_get_owner_id**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`int` **region_get_owner_id**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` of the object which manages this region. @@ -1652,7 +1652,7 @@ Returns the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -:ref:`Vector2` **region_get_random_point**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| +:ref:`Vector2` **region_get_random_point**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| :ref:`🔗` Returns a random position picked from all region polygons with matching ``navigation_layers``. @@ -1668,7 +1668,7 @@ If ``uniformly`` is ``false``, just a random polygon and face is picked (faster) .. rst-class:: classref-method -:ref:`Transform2D` **region_get_transform**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`Transform2D` **region_get_transform**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the global transformation of this ``region``. @@ -1680,7 +1680,7 @@ Returns the global transformation of this ``region``. .. rst-class:: classref-method -:ref:`float` **region_get_travel_cost**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`float` **region_get_travel_cost**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the travel cost of this ``region``. @@ -1692,7 +1692,7 @@ Returns the travel cost of this ``region``. .. rst-class:: classref-method -:ref:`bool` **region_get_use_edge_connections**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`bool` **region_get_use_edge_connections**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the navigation ``region`` is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1704,7 +1704,7 @@ Returns whether the navigation ``region`` is set to use edge connections to conn .. rst-class:: classref-method -:ref:`bool` **region_owns_point**\ (\ region\: :ref:`RID`, point\: :ref:`Vector2`\ ) |const| +:ref:`bool` **region_owns_point**\ (\ region\: :ref:`RID`, point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``point`` in world space is currently owned by the provided navigation ``region``. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. @@ -1720,7 +1720,7 @@ If multiple navigation meshes have positions at equal distance the navigation re .. rst-class:: classref-method -|void| **region_set_enabled**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **region_set_enabled**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true`` the specified ``region`` will contribute to its current navigation map. @@ -1732,7 +1732,7 @@ If ``enabled`` is ``true`` the specified ``region`` will contribute to its curre .. rst-class:: classref-method -|void| **region_set_enter_cost**\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) +|void| **region_set_enter_cost**\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``enter_cost`` for this ``region``. @@ -1744,7 +1744,7 @@ Sets the ``enter_cost`` for this ``region``. .. rst-class:: classref-method -|void| **region_set_map**\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **region_set_map**\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Sets the map for the region. @@ -1756,7 +1756,7 @@ Sets the map for the region. .. rst-class:: classref-method -|void| **region_set_navigation_layers**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) +|void| **region_set_navigation_layers**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) :ref:`🔗` Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path`). @@ -1768,7 +1768,7 @@ Set the region's navigation layers. This allows selecting regions from a path re .. rst-class:: classref-method -|void| **region_set_navigation_polygon**\ (\ region\: :ref:`RID`, navigation_polygon\: :ref:`NavigationPolygon`\ ) +|void| **region_set_navigation_polygon**\ (\ region\: :ref:`RID`, navigation_polygon\: :ref:`NavigationPolygon`\ ) :ref:`🔗` Sets the ``navigation_polygon`` for the region. @@ -1780,7 +1780,7 @@ Sets the ``navigation_polygon`` for the region. .. rst-class:: classref-method -|void| **region_set_owner_id**\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) +|void| **region_set_owner_id**\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) :ref:`🔗` Set the ``ObjectID`` of the object which manages this region. @@ -1792,7 +1792,7 @@ Set the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -|void| **region_set_transform**\ (\ region\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **region_set_transform**\ (\ region\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the global transformation for the region. @@ -1804,7 +1804,7 @@ Sets the global transformation for the region. .. rst-class:: classref-method -|void| **region_set_travel_cost**\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) +|void| **region_set_travel_cost**\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``travel_cost`` for this ``region``. @@ -1816,7 +1816,7 @@ Sets the ``travel_cost`` for this ``region``. .. rst-class:: classref-method -|void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the navigation ``region`` will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1828,7 +1828,7 @@ If ``enabled`` is ``true``, the navigation ``region`` will use edge connections .. rst-class:: classref-method -|void| **set_debug_enabled**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_debug_enabled**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true`` enables debug mode on the NavigationServer. @@ -1840,7 +1840,7 @@ If ``true`` enables debug mode on the NavigationServer. .. rst-class:: classref-method -:ref:`PackedVector2Array` **simplify_path**\ (\ path\: :ref:`PackedVector2Array`, epsilon\: :ref:`float`\ ) +:ref:`PackedVector2Array` **simplify_path**\ (\ path\: :ref:`PackedVector2Array`, epsilon\: :ref:`float`\ ) :ref:`🔗` Returns a simplified version of ``path`` with less critical path points removed. The simplification amount is in worlds units and controlled by ``epsilon``. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation. @@ -1854,7 +1854,7 @@ Path simplification can be helpful to mitigate various path following issues tha .. rst-class:: classref-method -:ref:`RID` **source_geometry_parser_create**\ (\ ) +:ref:`RID` **source_geometry_parser_create**\ (\ ) :ref:`🔗` Creates a new source geometry parser. If a :ref:`Callable` is set for the parser with :ref:`source_geometry_parser_set_callback` the callback will be called for every single node that gets parsed whenever :ref:`parse_source_geometry_data` is used. @@ -1866,7 +1866,7 @@ Creates a new source geometry parser. If a :ref:`Callable` is se .. rst-class:: classref-method -|void| **source_geometry_parser_set_callback**\ (\ parser\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **source_geometry_parser_set_callback**\ (\ parser\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the ``callback`` :ref:`Callable` for the specific source geometry ``parser``. The :ref:`Callable` will receive a call with the following parameters: diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 6f16a7d1ea8..370ebd0bf5e 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -357,7 +357,7 @@ Signals .. rst-class:: classref-signal -**avoidance_debug_changed**\ (\ ) +**avoidance_debug_changed**\ (\ ) :ref:`🔗` Emitted when avoidance debug settings are changed. Only available in debug builds. @@ -369,7 +369,7 @@ Emitted when avoidance debug settings are changed. Only available in debug build .. rst-class:: classref-signal -**map_changed**\ (\ map\: :ref:`RID`\ ) +**map_changed**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` Emitted when a navigation map is updated, when a region moves or is modified. @@ -381,7 +381,7 @@ Emitted when a navigation map is updated, when a region moves or is modified. .. rst-class:: classref-signal -**navigation_debug_changed**\ (\ ) +**navigation_debug_changed**\ (\ ) :ref:`🔗` Emitted when navigation debug settings are changed. Only available in debug builds. @@ -398,7 +398,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ProcessInfo**: +enum **ProcessInfo**: :ref:`🔗` .. _class_NavigationServer3D_constant_INFO_ACTIVE_MAPS: @@ -485,7 +485,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **agent_create**\ (\ ) +:ref:`RID` **agent_create**\ (\ ) :ref:`🔗` Creates the agent. @@ -497,7 +497,7 @@ Creates the agent. .. rst-class:: classref-method -:ref:`bool` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``agent`` has avoidance enabled. @@ -509,7 +509,7 @@ Returns ``true`` if the provided ``agent`` has avoidance enabled. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`int` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_layers`` bitmask of the specified ``agent``. @@ -521,7 +521,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`int` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_mask`` bitmask of the specified ``agent``. @@ -533,7 +533,7 @@ Returns the ``avoidance_mask`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_priority`` of the specified ``agent``. @@ -545,7 +545,7 @@ Returns the ``avoidance_priority`` of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_height**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_height**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``height`` of the specified ``agent``. @@ -557,7 +557,7 @@ Returns the ``height`` of the specified ``agent``. .. rst-class:: classref-method -:ref:`RID` **agent_get_map**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`RID` **agent_get_map**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``agent`` is currently assigned to. @@ -569,7 +569,7 @@ Returns the navigation map :ref:`RID` the requested ``agent`` is curr .. rst-class:: classref-method -:ref:`int` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`int` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum number of other agents the specified ``agent`` takes into account in the navigation. @@ -581,7 +581,7 @@ Returns the maximum number of other agents the specified ``agent`` takes into ac .. rst-class:: classref-method -:ref:`float` **agent_get_max_speed**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_max_speed**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum speed of the specified ``agent``. @@ -593,7 +593,7 @@ Returns the maximum speed of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum distance to other agents the specified ``agent`` takes into account in the navigation. @@ -605,7 +605,7 @@ Returns the maximum distance to other agents the specified ``agent`` takes into .. rst-class:: classref-method -:ref:`bool` **agent_get_paused**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_get_paused**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``agent`` is paused. @@ -617,7 +617,7 @@ Returns ``true`` if the specified ``agent`` is paused. .. rst-class:: classref-method -:ref:`Vector3` **agent_get_position**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`Vector3` **agent_get_position**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the position of the specified ``agent`` in world space. @@ -629,7 +629,7 @@ Returns the position of the specified ``agent`` in world space. .. rst-class:: classref-method -:ref:`float` **agent_get_radius**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_radius**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the radius of the specified ``agent``. @@ -641,7 +641,7 @@ Returns the radius of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to other agents. @@ -653,7 +653,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`float` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to static avoidance obstacles. @@ -665,7 +665,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`bool` **agent_get_use_3d_avoidance**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_get_use_3d_avoidance**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``agent`` uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). @@ -677,7 +677,7 @@ Returns ``true`` if the provided ``agent`` uses avoidance in 3D space Vector3(x, .. rst-class:: classref-method -:ref:`Vector3` **agent_get_velocity**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`Vector3` **agent_get_velocity**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the velocity of the specified ``agent``. @@ -689,7 +689,7 @@ Returns the velocity of the specified ``agent``. .. rst-class:: classref-method -:ref:`bool` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Return ``true`` if the specified ``agent`` has an avoidance callback. @@ -701,7 +701,7 @@ Return ``true`` if the specified ``agent`` has an avoidance callback. .. rst-class:: classref-method -:ref:`bool` **agent_is_map_changed**\ (\ agent\: :ref:`RID`\ ) |const| +:ref:`bool` **agent_is_map_changed**\ (\ agent\: :ref:`RID`\ ) |const| :ref:`🔗` Returns true if the map got changed the previous frame. @@ -713,7 +713,7 @@ Returns true if the map got changed the previous frame. .. rst-class:: classref-method -|void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the callback :ref:`Callable` that gets called after each avoidance processing step for the ``agent``. The calculated ``safe_velocity`` will be dispatched with a signal to the object just before the physics calculations. @@ -727,7 +727,7 @@ Sets the callback :ref:`Callable` that gets called after each av .. rst-class:: classref-method -|void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the provided ``agent`` calculates avoidance. @@ -739,7 +739,7 @@ If ``enabled`` is ``true``, the provided ``agent`` calculates avoidance. .. rst-class:: classref-method -|void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Set the agent's ``avoidance_layers`` bitmask. @@ -751,7 +751,7 @@ Set the agent's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -|void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Set the agent's ``avoidance_mask`` bitmask. @@ -763,7 +763,7 @@ Set the agent's ``avoidance_mask`` bitmask. .. rst-class:: classref-method -|void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) +|void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) :ref:`🔗` Set the agent's ``avoidance_priority`` with a ``priority`` between 0.0 (lowest priority) to 1.0 (highest priority). @@ -777,7 +777,7 @@ The specified ``agent`` does not adjust the velocity for other agents that would .. rst-class:: classref-method -|void| **agent_set_height**\ (\ agent\: :ref:`RID`, height\: :ref:`float`\ ) +|void| **agent_set_height**\ (\ agent\: :ref:`RID`, height\: :ref:`float`\ ) :ref:`🔗` Updates the provided ``agent`` ``height``. @@ -789,7 +789,7 @@ Updates the provided ``agent`` ``height``. .. rst-class:: classref-method -|void| **agent_set_map**\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **agent_set_map**\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Puts the agent in the map. @@ -801,7 +801,7 @@ Puts the agent in the map. .. rst-class:: classref-method -|void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) +|void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -813,7 +813,7 @@ Sets the maximum number of other agents the agent takes into account in the navi .. rst-class:: classref-method -|void| **agent_set_max_speed**\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) +|void| **agent_set_max_speed**\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) :ref:`🔗` Sets the maximum speed of the agent. Must be positive. @@ -825,7 +825,7 @@ Sets the maximum speed of the agent. Must be positive. .. rst-class:: classref-method -|void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) +|void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) :ref:`🔗` Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -837,7 +837,7 @@ Sets the maximum distance to other agents this agent takes into account in the n .. rst-class:: classref-method -|void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) +|void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` If ``paused`` is true the specified ``agent`` will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks. @@ -849,7 +849,7 @@ If ``paused`` is true the specified ``agent`` will not be processed, e.g. calcul .. rst-class:: classref-method -|void| **agent_set_position**\ (\ agent\: :ref:`RID`, position\: :ref:`Vector3`\ ) +|void| **agent_set_position**\ (\ agent\: :ref:`RID`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the position of the agent in world space. @@ -861,7 +861,7 @@ Sets the position of the agent in world space. .. rst-class:: classref-method -|void| **agent_set_radius**\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **agent_set_radius**\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Sets the radius of the agent. @@ -873,7 +873,7 @@ Sets the radius of the agent. .. rst-class:: classref-method -|void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) +|void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) :ref:`🔗` The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -885,7 +885,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -|void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) +|void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) :ref:`🔗` The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -897,7 +897,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -|void| **agent_set_use_3d_avoidance**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **agent_set_use_3d_avoidance**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. @@ -913,7 +913,7 @@ If ``false`` the agent calculates avoidance velocities in 2D along the xz-axis i .. rst-class:: classref-method -|void| **agent_set_velocity**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) +|void| **agent_set_velocity**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position use :ref:`agent_set_velocity_forced` as well to reset the internal simulation velocity. @@ -925,7 +925,7 @@ Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The av .. rst-class:: classref-method -|void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) +|void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) :ref:`🔗` Replaces the internal velocity in the collision avoidance simulation with ``velocity`` for the specified ``agent``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -937,7 +937,7 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo .. rst-class:: classref-method -|void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) +|void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. @@ -949,7 +949,7 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ .. rst-class:: classref-method -|void| **bake_from_source_geometry_data_async**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) +|void| **bake_from_source_geometry_data_async**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called. @@ -961,7 +961,7 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ .. rst-class:: classref-method -|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Destroys the given RID. @@ -973,7 +973,7 @@ Destroys the given RID. .. rst-class:: classref-method -:ref:`bool` **get_debug_enabled**\ (\ ) |const| +:ref:`bool` **get_debug_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` when the NavigationServer has debug enabled. @@ -985,7 +985,7 @@ Returns ``true`` when the NavigationServer has debug enabled. .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **get_maps**\ (\ ) |const| +:ref:`Array`\[:ref:`RID`\] **get_maps**\ (\ ) |const| :ref:`🔗` Returns all created navigation map :ref:`RID`\ s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them. @@ -997,7 +997,7 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer .. rst-class:: classref-method -:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| :ref:`🔗` Returns information about the current state of the NavigationServer. See :ref:`ProcessInfo` for a list of available states. @@ -1009,7 +1009,7 @@ Returns information about the current state of the NavigationServer. See :ref:`P .. rst-class:: classref-method -:ref:`bool` **is_baking_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) |const| +:ref:`bool` **is_baking_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) |const| :ref:`🔗` Returns ``true`` when the provided navigation mesh is being baked on a background thread. @@ -1021,7 +1021,7 @@ Returns ``true`` when the provided navigation mesh is being baked on a backgroun .. rst-class:: classref-method -:ref:`RID` **link_create**\ (\ ) +:ref:`RID` **link_create**\ (\ ) :ref:`🔗` Create a new link between two positions on a map. @@ -1033,7 +1033,7 @@ Create a new link between two positions on a map. .. rst-class:: classref-method -:ref:`bool` **link_get_enabled**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`bool` **link_get_enabled**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``link`` is enabled. @@ -1045,7 +1045,7 @@ Returns ``true`` if the specified ``link`` is enabled. .. rst-class:: classref-method -:ref:`Vector3` **link_get_end_position**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`Vector3` **link_get_end_position**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ending position of this ``link``. @@ -1057,7 +1057,7 @@ Returns the ending position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_enter_cost**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`float` **link_get_enter_cost**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the enter cost of this ``link``. @@ -1069,7 +1069,7 @@ Returns the enter cost of this ``link``. .. rst-class:: classref-method -:ref:`RID` **link_get_map**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`RID` **link_get_map**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``link`` is currently assigned to. @@ -1081,7 +1081,7 @@ Returns the navigation map :ref:`RID` the requested ``link`` is curre .. rst-class:: classref-method -:ref:`int` **link_get_navigation_layers**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`int` **link_get_navigation_layers**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation layers for this ``link``. @@ -1093,7 +1093,7 @@ Returns the navigation layers for this ``link``. .. rst-class:: classref-method -:ref:`int` **link_get_owner_id**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`int` **link_get_owner_id**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` of the object which manages this link. @@ -1105,7 +1105,7 @@ Returns the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -:ref:`Vector3` **link_get_start_position**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`Vector3` **link_get_start_position**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the starting position of this ``link``. @@ -1117,7 +1117,7 @@ Returns the starting position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_travel_cost**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`float` **link_get_travel_cost**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the travel cost of this ``link``. @@ -1129,7 +1129,7 @@ Returns the travel cost of this ``link``. .. rst-class:: classref-method -:ref:`bool` **link_is_bidirectional**\ (\ link\: :ref:`RID`\ ) |const| +:ref:`bool` **link_is_bidirectional**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether this ``link`` can be travelled in both directions. @@ -1141,7 +1141,7 @@ Returns whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -|void| **link_set_bidirectional**\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) +|void| **link_set_bidirectional**\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) :ref:`🔗` Sets whether this ``link`` can be travelled in both directions. @@ -1153,7 +1153,7 @@ Sets whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -|void| **link_set_enabled**\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **link_set_enabled**\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the specified ``link`` will contribute to its current navigation map. @@ -1165,7 +1165,7 @@ If ``enabled`` is ``true``, the specified ``link`` will contribute to its curren .. rst-class:: classref-method -|void| **link_set_end_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) +|void| **link_set_end_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the exit position for the ``link``. @@ -1177,7 +1177,7 @@ Sets the exit position for the ``link``. .. rst-class:: classref-method -|void| **link_set_enter_cost**\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) +|void| **link_set_enter_cost**\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``enter_cost`` for this ``link``. @@ -1189,7 +1189,7 @@ Sets the ``enter_cost`` for this ``link``. .. rst-class:: classref-method -|void| **link_set_map**\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **link_set_map**\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Sets the navigation map :ref:`RID` for the link. @@ -1201,7 +1201,7 @@ Sets the navigation map :ref:`RID` for the link. .. rst-class:: classref-method -|void| **link_set_navigation_layers**\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) +|void| **link_set_navigation_layers**\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) :ref:`🔗` Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path`). @@ -1213,7 +1213,7 @@ Set the links's navigation layers. This allows selecting links from a path reque .. rst-class:: classref-method -|void| **link_set_owner_id**\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) +|void| **link_set_owner_id**\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) :ref:`🔗` Set the ``ObjectID`` of the object which manages this link. @@ -1225,7 +1225,7 @@ Set the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -|void| **link_set_start_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) +|void| **link_set_start_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the entry position for this ``link``. @@ -1237,7 +1237,7 @@ Sets the entry position for this ``link``. .. rst-class:: classref-method -|void| **link_set_travel_cost**\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) +|void| **link_set_travel_cost**\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``travel_cost`` for this ``link``. @@ -1249,7 +1249,7 @@ Sets the ``travel_cost`` for this ``link``. .. rst-class:: classref-method -:ref:`RID` **map_create**\ (\ ) +:ref:`RID` **map_create**\ (\ ) :ref:`🔗` Create a new map. @@ -1261,7 +1261,7 @@ Create a new map. .. rst-class:: classref-method -|void| **map_force_update**\ (\ map\: :ref:`RID`\ ) +|void| **map_force_update**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). @@ -1279,7 +1279,7 @@ Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_agents**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_agents**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation agents :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1291,7 +1291,7 @@ Returns all navigation agents :ref:`RID`\ s that are currently assign .. rst-class:: classref-method -:ref:`float` **map_get_cell_height**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_cell_height**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis. @@ -1303,7 +1303,7 @@ Returns the map cell height used to rasterize the navigation mesh vertices on th .. rst-class:: classref-method -:ref:`float` **map_get_cell_size**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_cell_size**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane. @@ -1315,7 +1315,7 @@ Returns the map cell size used to rasterize the navigation mesh vertices on the .. rst-class:: classref-method -:ref:`Vector3` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the point closest to the provided ``to_point`` on the navigation mesh surface. @@ -1327,7 +1327,7 @@ Returns the point closest to the provided ``to_point`` on the navigation mesh su .. rst-class:: classref-method -:ref:`Vector3` **map_get_closest_point_normal**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **map_get_closest_point_normal**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the normal for the point returned by :ref:`map_get_closest_point`. @@ -1339,7 +1339,7 @@ Returns the normal for the point returned by :ref:`map_get_closest_point` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| +:ref:`RID` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. @@ -1351,7 +1351,7 @@ Returns the owner region RID for the point returned by :ref:`map_get_closest_poi .. rst-class:: classref-method -:ref:`Vector3` **map_get_closest_point_to_segment**\ (\ map\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| +:ref:`Vector3` **map_get_closest_point_to_segment**\ (\ map\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the closest point between the navigation surface and the segment. @@ -1363,7 +1363,7 @@ Returns the closest point between the navigation surface and the segment. .. rst-class:: classref-method -:ref:`float` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions. @@ -1375,7 +1375,7 @@ Returns the edge connection margin of the map. This distance is the minimum vert .. rst-class:: classref-method -:ref:`int` **map_get_iteration_id**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`int` **map_get_iteration_id**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized. @@ -1389,7 +1389,7 @@ Returns the current iteration id of the navigation map. Every time the navigatio .. rst-class:: classref-method -:ref:`float` **map_get_link_connection_radius**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_link_connection_radius**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. @@ -1401,7 +1401,7 @@ Returns the link connection radius of the map. This distance is the maximum rang .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_links**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_links**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation link :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1413,7 +1413,7 @@ Returns all navigation link :ref:`RID`\ s that are currently assigned .. rst-class:: classref-method -:ref:`float` **map_get_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`float` **map_get_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns map's internal merge rasterizer cell scale. @@ -1425,7 +1425,7 @@ Returns map's internal merge rasterizer cell scale. .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_obstacles**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_obstacles**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation obstacle :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1437,7 +1437,7 @@ Returns all navigation obstacle :ref:`RID`\ s that are currently assi .. rst-class:: classref-method -:ref:`PackedVector3Array` **map_get_path**\ (\ map\: :ref:`RID`, origin\: :ref:`Vector3`, destination\: :ref:`Vector3`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| +:ref:`PackedVector3Array` **map_get_path**\ (\ map\: :ref:`RID`, origin\: :ref:`Vector3`, destination\: :ref:`Vector3`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| :ref:`🔗` Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region navigation layers that are allowed to be in the path. @@ -1449,7 +1449,7 @@ Returns the navigation path to reach the destination from the origin. ``navigati .. rst-class:: classref-method -:ref:`Vector3` **map_get_random_point**\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| +:ref:`Vector3` **map_get_random_point**\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| :ref:`🔗` Returns a random position picked from all map region polygons with matching ``navigation_layers``. @@ -1465,7 +1465,7 @@ If ``uniformly`` is ``false``, just a random region and a random polygon are pic .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **map_get_regions**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`RID`\] **map_get_regions**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns all navigation regions :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1477,7 +1477,7 @@ Returns all navigation regions :ref:`RID`\ s that are currently assig .. rst-class:: classref-method -:ref:`Vector3` **map_get_up**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`Vector3` **map_get_up**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the map's up direction. @@ -1489,7 +1489,7 @@ Returns the map's up direction. .. rst-class:: classref-method -:ref:`bool` **map_get_use_edge_connections**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`bool` **map_get_use_edge_connections**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns true if the navigation ``map`` allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1501,7 +1501,7 @@ Returns true if the navigation ``map`` allows navigation regions to use edge con .. rst-class:: classref-method -:ref:`bool` **map_is_active**\ (\ map\: :ref:`RID`\ ) |const| +:ref:`bool` **map_is_active**\ (\ map\: :ref:`RID`\ ) |const| :ref:`🔗` Returns true if the map is active. @@ -1513,7 +1513,7 @@ Returns true if the map is active. .. rst-class:: classref-method -|void| **map_set_active**\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) +|void| **map_set_active**\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) :ref:`🔗` Sets the map active. @@ -1525,7 +1525,7 @@ Sets the map active. .. rst-class:: classref-method -|void| **map_set_cell_height**\ (\ map\: :ref:`RID`, cell_height\: :ref:`float`\ ) +|void| **map_set_cell_height**\ (\ map\: :ref:`RID`, cell_height\: :ref:`float`\ ) :ref:`🔗` Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes. @@ -1537,7 +1537,7 @@ Sets the map cell height used to rasterize the navigation mesh vertices on the Y .. rst-class:: classref-method -|void| **map_set_cell_size**\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) +|void| **map_set_cell_size**\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) :ref:`🔗` Sets the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size of the used navigation meshes. @@ -1549,7 +1549,7 @@ Sets the map cell size used to rasterize the navigation mesh vertices on the XZ .. rst-class:: classref-method -|void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) +|void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) :ref:`🔗` Set the map edge connection margin used to weld the compatible region edges. @@ -1561,7 +1561,7 @@ Set the map edge connection margin used to weld the compatible region edges. .. rst-class:: classref-method -|void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Set the map's link connection radius used to connect links to navigation polygons. @@ -1573,7 +1573,7 @@ Set the map's link connection radius used to connect links to navigation polygon .. rst-class:: classref-method -|void| **map_set_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`, scale\: :ref:`float`\ ) +|void| **map_set_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` Set the map's internal merge rasterizer cell scale used to control merging sensitivity. @@ -1585,7 +1585,7 @@ Set the map's internal merge rasterizer cell scale used to control merging sensi .. rst-class:: classref-method -|void| **map_set_up**\ (\ map\: :ref:`RID`, up\: :ref:`Vector3`\ ) +|void| **map_set_up**\ (\ map\: :ref:`RID`, up\: :ref:`Vector3`\ ) :ref:`🔗` Sets the map up direction. @@ -1597,7 +1597,7 @@ Sets the map up direction. .. rst-class:: classref-method -|void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1609,7 +1609,7 @@ Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the .. rst-class:: classref-method -:ref:`RID` **obstacle_create**\ (\ ) +:ref:`RID` **obstacle_create**\ (\ ) :ref:`🔗` Creates a new obstacle. @@ -1621,7 +1621,7 @@ Creates a new obstacle. .. rst-class:: classref-method -:ref:`bool` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`bool` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``obstacle`` has avoidance enabled. @@ -1633,7 +1633,7 @@ Returns ``true`` if the provided ``obstacle`` has avoidance enabled. .. rst-class:: classref-method -:ref:`int` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`int` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. @@ -1645,7 +1645,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. .. rst-class:: classref-method -:ref:`float` **obstacle_get_height**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`float` **obstacle_get_height**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``height`` of the specified ``obstacle``. @@ -1657,7 +1657,7 @@ Returns the ``height`` of the specified ``obstacle``. .. rst-class:: classref-method -:ref:`RID` **obstacle_get_map**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`RID` **obstacle_get_map**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``obstacle`` is currently assigned to. @@ -1669,7 +1669,7 @@ Returns the navigation map :ref:`RID` the requested ``obstacle`` is c .. rst-class:: classref-method -:ref:`bool` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`bool` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``obstacle`` is paused. @@ -1681,7 +1681,7 @@ Returns ``true`` if the specified ``obstacle`` is paused. .. rst-class:: classref-method -:ref:`Vector3` **obstacle_get_position**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`Vector3` **obstacle_get_position**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the position of the specified ``obstacle`` in world space. @@ -1693,7 +1693,7 @@ Returns the position of the specified ``obstacle`` in world space. .. rst-class:: classref-method -:ref:`float` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`float` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the radius of the specified dynamic ``obstacle``. @@ -1705,7 +1705,7 @@ Returns the radius of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`bool` **obstacle_get_use_3d_avoidance**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`bool` **obstacle_get_use_3d_avoidance**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``obstacle`` uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). @@ -1717,7 +1717,7 @@ Returns ``true`` if the provided ``obstacle`` uses avoidance in 3D space Vector3 .. rst-class:: classref-method -:ref:`Vector3` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`Vector3` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the velocity of the specified dynamic ``obstacle``. @@ -1729,7 +1729,7 @@ Returns the velocity of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`PackedVector3Array` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID`\ ) |const| +:ref:`PackedVector3Array` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the outline vertices for the specified ``obstacle``. @@ -1741,7 +1741,7 @@ Returns the outline vertices for the specified ``obstacle``. .. rst-class:: classref-method -|void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using agents. @@ -1753,7 +1753,7 @@ If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using ag .. rst-class:: classref-method -|void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Set the obstacles's ``avoidance_layers`` bitmask. @@ -1765,7 +1765,7 @@ Set the obstacles's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -|void| **obstacle_set_height**\ (\ obstacle\: :ref:`RID`, height\: :ref:`float`\ ) +|void| **obstacle_set_height**\ (\ obstacle\: :ref:`RID`, height\: :ref:`float`\ ) :ref:`🔗` Sets the ``height`` for the ``obstacle``. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance. @@ -1777,7 +1777,7 @@ Sets the ``height`` for the ``obstacle``. In 3D agents will ignore obstacles tha .. rst-class:: classref-method -|void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Assigns the ``obstacle`` to a navigation map. @@ -1789,7 +1789,7 @@ Assigns the ``obstacle`` to a navigation map. .. rst-class:: classref-method -|void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) +|void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) :ref:`🔗` If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. affect avoidance velocities. @@ -1801,7 +1801,7 @@ If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. aff .. rst-class:: classref-method -|void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector3`\ ) +|void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector3`\ ) :ref:`🔗` Updates the ``position`` in world space for the ``obstacle``. @@ -1813,7 +1813,7 @@ Updates the ``position`` in world space for the ``obstacle``. .. rst-class:: classref-method -|void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Sets the radius of the dynamic obstacle. @@ -1825,7 +1825,7 @@ Sets the radius of the dynamic obstacle. .. rst-class:: classref-method -|void| **obstacle_set_use_3d_avoidance**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **obstacle_set_use_3d_avoidance**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets if the ``obstacle`` uses the 2D avoidance or the 3D avoidance while avoidance is enabled. @@ -1837,7 +1837,7 @@ Sets if the ``obstacle`` uses the 2D avoidance or the 3D avoidance while avoidan .. rst-class:: classref-method -|void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) +|void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle. @@ -1849,7 +1849,7 @@ Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better pre .. rst-class:: classref-method -|void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`\ ) +|void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. @@ -1861,7 +1861,7 @@ Sets the outline vertices for the obstacle. If the vertices are winded in clockw .. rst-class:: classref-method -|void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) +|void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) :ref:`🔗` Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_mesh``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. @@ -1877,7 +1877,7 @@ Parses the :ref:`SceneTree` for source geometry according to th .. rst-class:: classref-method -|void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters3D`, result\: :ref:`NavigationPathQueryResult3D`\ ) |const| +|void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters3D`, result\: :ref:`NavigationPathQueryResult3D`\ ) |const| :ref:`🔗` Queries a path in a given navigation map. Start and target position and other parameters are defined through :ref:`NavigationPathQueryParameters3D`. Updates the provided :ref:`NavigationPathQueryResult3D` result object with the path among other results requested by the query. @@ -1889,7 +1889,7 @@ Queries a path in a given navigation map. Start and target position and other pa .. rst-class:: classref-method -|void| **region_bake_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) +|void| **region_bake_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) :ref:`🔗` **Deprecated:** This method is deprecated due to core threading changes. To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the :ref:`SceneTree` for nodes that should contribute to the navigation mesh baking. The :ref:`SceneTree` parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. @@ -1903,7 +1903,7 @@ Bakes the ``navigation_mesh`` with bake source geometry collected starting from .. rst-class:: classref-method -:ref:`RID` **region_create**\ (\ ) +:ref:`RID` **region_create**\ (\ ) :ref:`🔗` Creates a new region. @@ -1915,7 +1915,7 @@ Creates a new region. .. rst-class:: classref-method -:ref:`Vector3` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| +:ref:`Vector3` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1927,7 +1927,7 @@ Returns the ending point of a connection door. ``connection`` is an index betwee .. rst-class:: classref-method -:ref:`Vector3` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| +:ref:`Vector3` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| :ref:`🔗` Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1939,7 +1939,7 @@ Returns the starting point of a connection door. ``connection`` is an index betw .. rst-class:: classref-method -:ref:`int` **region_get_connections_count**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`int` **region_get_connections_count**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns how many connections this ``region`` has with other regions in the map. @@ -1951,7 +1951,7 @@ Returns how many connections this ``region`` has with other regions in the map. .. rst-class:: classref-method -:ref:`bool` **region_get_enabled**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`bool` **region_get_enabled**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``region`` is enabled. @@ -1963,7 +1963,7 @@ Returns ``true`` if the specified ``region`` is enabled. .. rst-class:: classref-method -:ref:`float` **region_get_enter_cost**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`float` **region_get_enter_cost**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the enter cost of this ``region``. @@ -1975,7 +1975,7 @@ Returns the enter cost of this ``region``. .. rst-class:: classref-method -:ref:`RID` **region_get_map**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`RID` **region_get_map**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the navigation map :ref:`RID` the requested ``region`` is currently assigned to. @@ -1987,7 +1987,7 @@ Returns the navigation map :ref:`RID` the requested ``region`` is cur .. rst-class:: classref-method -:ref:`int` **region_get_navigation_layers**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`int` **region_get_navigation_layers**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the region's navigation layers. @@ -1999,7 +1999,7 @@ Returns the region's navigation layers. .. rst-class:: classref-method -:ref:`int` **region_get_owner_id**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`int` **region_get_owner_id**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` of the object which manages this region. @@ -2011,7 +2011,7 @@ Returns the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -:ref:`Vector3` **region_get_random_point**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| +:ref:`Vector3` **region_get_random_point**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| :ref:`🔗` Returns a random position picked from all region polygons with matching ``navigation_layers``. @@ -2027,7 +2027,7 @@ If ``uniformly`` is ``false``, just a random polygon and face is picked (faster) .. rst-class:: classref-method -:ref:`Transform3D` **region_get_transform**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`Transform3D` **region_get_transform**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the global transformation of this ``region``. @@ -2039,7 +2039,7 @@ Returns the global transformation of this ``region``. .. rst-class:: classref-method -:ref:`float` **region_get_travel_cost**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`float` **region_get_travel_cost**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the travel cost of this ``region``. @@ -2051,7 +2051,7 @@ Returns the travel cost of this ``region``. .. rst-class:: classref-method -:ref:`bool` **region_get_use_edge_connections**\ (\ region\: :ref:`RID`\ ) |const| +:ref:`bool` **region_get_use_edge_connections**\ (\ region\: :ref:`RID`\ ) |const| :ref:`🔗` Returns true if the navigation ``region`` is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -2063,7 +2063,7 @@ Returns true if the navigation ``region`` is set to use edge connections to conn .. rst-class:: classref-method -:ref:`bool` **region_owns_point**\ (\ region\: :ref:`RID`, point\: :ref:`Vector3`\ ) |const| +:ref:`bool` **region_owns_point**\ (\ region\: :ref:`RID`, point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if the provided ``point`` in world space is currently owned by the provided navigation ``region``. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. @@ -2079,7 +2079,7 @@ If multiple navigation meshes have positions at equal distance the navigation re .. rst-class:: classref-method -|void| **region_set_enabled**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **region_set_enabled**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the specified ``region`` will contribute to its current navigation map. @@ -2091,7 +2091,7 @@ If ``enabled`` is ``true``, the specified ``region`` will contribute to its curr .. rst-class:: classref-method -|void| **region_set_enter_cost**\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) +|void| **region_set_enter_cost**\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``enter_cost`` for this ``region``. @@ -2103,7 +2103,7 @@ Sets the ``enter_cost`` for this ``region``. .. rst-class:: classref-method -|void| **region_set_map**\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) +|void| **region_set_map**\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) :ref:`🔗` Sets the map for the region. @@ -2115,7 +2115,7 @@ Sets the map for the region. .. rst-class:: classref-method -|void| **region_set_navigation_layers**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) +|void| **region_set_navigation_layers**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) :ref:`🔗` Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path`). @@ -2127,7 +2127,7 @@ Set the region's navigation layers. This allows selecting regions from a path re .. rst-class:: classref-method -|void| **region_set_navigation_mesh**\ (\ region\: :ref:`RID`, navigation_mesh\: :ref:`NavigationMesh`\ ) +|void| **region_set_navigation_mesh**\ (\ region\: :ref:`RID`, navigation_mesh\: :ref:`NavigationMesh`\ ) :ref:`🔗` Sets the navigation mesh for the region. @@ -2139,7 +2139,7 @@ Sets the navigation mesh for the region. .. rst-class:: classref-method -|void| **region_set_owner_id**\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) +|void| **region_set_owner_id**\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) :ref:`🔗` Set the ``ObjectID`` of the object which manages this region. @@ -2151,7 +2151,7 @@ Set the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -|void| **region_set_transform**\ (\ region\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) +|void| **region_set_transform**\ (\ region\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the global transformation for the region. @@ -2163,7 +2163,7 @@ Sets the global transformation for the region. .. rst-class:: classref-method -|void| **region_set_travel_cost**\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) +|void| **region_set_travel_cost**\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) :ref:`🔗` Sets the ``travel_cost`` for this ``region``. @@ -2175,7 +2175,7 @@ Sets the ``travel_cost`` for this ``region``. .. rst-class:: classref-method -|void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the navigation ``region`` will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -2187,7 +2187,7 @@ If ``enabled`` is ``true``, the navigation ``region`` will use edge connections .. rst-class:: classref-method -|void| **set_active**\ (\ active\: :ref:`bool`\ ) +|void| **set_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` Control activation of this server. @@ -2199,7 +2199,7 @@ Control activation of this server. .. rst-class:: classref-method -|void| **set_debug_enabled**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_debug_enabled**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true`` enables debug mode on the NavigationServer. @@ -2211,7 +2211,7 @@ If ``true`` enables debug mode on the NavigationServer. .. rst-class:: classref-method -:ref:`PackedVector3Array` **simplify_path**\ (\ path\: :ref:`PackedVector3Array`, epsilon\: :ref:`float`\ ) +:ref:`PackedVector3Array` **simplify_path**\ (\ path\: :ref:`PackedVector3Array`, epsilon\: :ref:`float`\ ) :ref:`🔗` Returns a simplified version of ``path`` with less critical path points removed. The simplification amount is in worlds units and controlled by ``epsilon``. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation. @@ -2225,7 +2225,7 @@ Path simplification can be helpful to mitigate various path following issues tha .. rst-class:: classref-method -:ref:`RID` **source_geometry_parser_create**\ (\ ) +:ref:`RID` **source_geometry_parser_create**\ (\ ) :ref:`🔗` Creates a new source geometry parser. If a :ref:`Callable` is set for the parser with :ref:`source_geometry_parser_set_callback` the callback will be called for every single node that gets parsed whenever :ref:`parse_source_geometry_data` is used. @@ -2237,7 +2237,7 @@ Creates a new source geometry parser. If a :ref:`Callable` is se .. rst-class:: classref-method -|void| **source_geometry_parser_set_callback**\ (\ parser\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **source_geometry_parser_set_callback**\ (\ parser\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the ``callback`` :ref:`Callable` for the specific source geometry ``parser``. The :ref:`Callable` will receive a call with the following parameters: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index c1afe222b83..7b12a95868d 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -78,7 +78,7 @@ Signals .. rst-class:: classref-signal -**texture_changed**\ (\ ) +**texture_changed**\ (\ ) :ref:`🔗` Emitted when the node's texture changes. @@ -95,7 +95,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AxisStretchMode**: +enum **AxisStretchMode**: :ref:`🔗` .. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_STRETCH: @@ -134,7 +134,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AxisStretchMode` **axis_stretch_horizontal** = ``0`` +:ref:`AxisStretchMode` **axis_stretch_horizontal** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ The stretch mode to use for horizontal stretching/tiling. See :ref:`AxisStretchM .. rst-class:: classref-property -:ref:`AxisStretchMode` **axis_stretch_vertical** = ``0`` +:ref:`AxisStretchMode` **axis_stretch_vertical** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ The stretch mode to use for vertical stretching/tiling. See :ref:`AxisStretchMod .. rst-class:: classref-property -:ref:`bool` **draw_center** = ``true`` +:ref:`bool` **draw_center** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. .. rst-class:: classref-property -:ref:`int` **patch_margin_bottom** = ``0`` +:ref:`int` **patch_margin_bottom** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto .. rst-class:: classref-property -:ref:`int` **patch_margin_left** = ``0`` +:ref:`int` **patch_margin_left** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ The width of the 9-slice's left column. A margin of 16 means the 9-slice's left .. rst-class:: classref-property -:ref:`int` **patch_margin_right** = ``0`` +:ref:`int` **patch_margin_right** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ The width of the 9-slice's right column. A margin of 16 means the 9-slice's righ .. rst-class:: classref-property -:ref:`int` **patch_margin_top** = ``0`` +:ref:`int` **patch_margin_top** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -253,7 +253,7 @@ The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corn .. rst-class:: classref-property -:ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -270,7 +270,7 @@ Rectangular region of the texture to sample from. If you're working with an atla .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the size of the margin on the specified :ref:`Side`. @@ -304,7 +304,7 @@ Returns the size of the margin on the specified :ref:`Side`, value\: :ref:`int`\ ) +|void| **set_patch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) :ref:`🔗` Sets the size of the margin on the specified :ref:`Side` to ``value`` pixels. diff --git a/classes/class_node.rst b/classes/class_node.rst index e7e5b9338bc..e6c2af5e0eb 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -311,7 +311,7 @@ Signals .. rst-class:: classref-signal -**child_entered_tree**\ (\ node\: :ref:`Node`\ ) +**child_entered_tree**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the child ``node`` enters the :ref:`SceneTree`, usually because this node entered the tree (see :ref:`tree_entered`), or :ref:`add_child` has been called. @@ -325,7 +325,7 @@ This signal is emitted *after* the child node's own :ref:`NOTIFICATION_ENTER_TRE .. rst-class:: classref-signal -**child_exiting_tree**\ (\ node\: :ref:`Node`\ ) +**child_exiting_tree**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the child ``node`` is about to exit the :ref:`SceneTree`, usually because this node is exiting the tree (see :ref:`tree_exiting`), or because the child ``node`` is being removed or freed. @@ -339,7 +339,7 @@ When this signal is received, the child ``node`` is still accessible inside the .. rst-class:: classref-signal -**child_order_changed**\ (\ ) +**child_order_changed**\ (\ ) :ref:`🔗` Emitted when the list of children is changed. This happens when child nodes are added, moved or removed. @@ -351,7 +351,7 @@ Emitted when the list of children is changed. This happens when child nodes are .. rst-class:: classref-signal -**editor_description_changed**\ (\ node\: :ref:`Node`\ ) +**editor_description_changed**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the node's editor description field changed. @@ -363,7 +363,7 @@ Emitted when the node's editor description field changed. .. rst-class:: classref-signal -**ready**\ (\ ) +**ready**\ (\ ) :ref:`🔗` Emitted when the node is considered ready, after :ref:`_ready` is called. @@ -375,7 +375,7 @@ Emitted when the node is considered ready, after :ref:`_ready` Emitted when the node's :ref:`name` is changed, if the node is inside the tree. @@ -387,7 +387,7 @@ Emitted when the node's :ref:`name` is changed, if the .. rst-class:: classref-signal -**replacing_by**\ (\ node\: :ref:`Node`\ ) +**replacing_by**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when this node is being replaced by the ``node``, see :ref:`replace_by`. @@ -401,7 +401,7 @@ This signal is emitted *after* ``node`` has been added as a child of the origina .. rst-class:: classref-signal -**tree_entered**\ (\ ) +**tree_entered**\ (\ ) :ref:`🔗` Emitted when the node enters the tree. @@ -415,7 +415,7 @@ This signal is emitted *after* the related :ref:`NOTIFICATION_ENTER_TREE` Emitted after the node exits the tree and is no longer active. @@ -429,7 +429,7 @@ This signal is emitted *after* the related :ref:`NOTIFICATION_EXIT_TREE` Emitted when the node is just about to exit the tree. The node is still valid. As such, this is the right place for de-initialization (or a "destructor", if you will). @@ -448,7 +448,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ProcessMode**: +enum **ProcessMode**: :ref:`🔗` .. _class_Node_constant_PROCESS_MODE_INHERIT: @@ -498,7 +498,7 @@ Never process. Completely disables processing, ignoring :ref:`SceneTree.paused` .. _class_Node_constant_PROCESS_THREAD_GROUP_INHERIT: @@ -532,7 +532,7 @@ Process this node (and child nodes set to inherit) on a sub-thread. See :ref:`pr .. rst-class:: classref-enumeration -flags **ProcessThreadMessages**: +flags **ProcessThreadMessages**: :ref:`🔗` .. _class_Node_constant_FLAG_PROCESS_THREAD_MESSAGES: @@ -566,7 +566,7 @@ Allows this node to process threaded messages created with :ref:`call_deferred_t .. rst-class:: classref-enumeration -enum **PhysicsInterpolationMode**: +enum **PhysicsInterpolationMode**: :ref:`🔗` .. _class_Node_constant_PHYSICS_INTERPOLATION_MODE_INHERIT: @@ -600,7 +600,7 @@ Disables physics interpolation for this node and for children set to :ref:`PHYSI .. rst-class:: classref-enumeration -enum **DuplicateFlags**: +enum **DuplicateFlags**: :ref:`🔗` .. _class_Node_constant_DUPLICATE_SIGNALS: @@ -642,7 +642,7 @@ Duplicate using :ref:`PackedScene.instantiate` .. _class_Node_constant_INTERNAL_MODE_DISABLED: @@ -676,7 +676,7 @@ The node will be placed at the end of the parent's children, after any non-inter .. rst-class:: classref-enumeration -enum **AutoTranslateMode**: +enum **AutoTranslateMode**: :ref:`🔗` .. _class_Node_constant_AUTO_TRANSLATE_MODE_INHERIT: @@ -717,7 +717,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_ENTER_TREE** = ``10`` +**NOTIFICATION_ENTER_TREE** = ``10`` :ref:`🔗` Notification received when the node enters a :ref:`SceneTree`. See :ref:`_enter_tree`. @@ -727,7 +727,7 @@ This notification is received *before* the related :ref:`tree_entered` Notification received when the node is about to exit a :ref:`SceneTree`. See :ref:`_exit_tree`. @@ -737,7 +737,7 @@ This notification is received *after* the related :ref:`tree_exiting` **Deprecated:** This notification is no longer sent by the engine. Use :ref:`NOTIFICATION_CHILD_ORDER_CHANGED` instead. @@ -747,7 +747,7 @@ This notification is received *after* the related :ref:`tree_exiting` Notification received when the node is ready. See :ref:`_ready`. @@ -755,7 +755,7 @@ Notification received when the node is ready. See :ref:`_ready` Notification received when the node is paused. See :ref:`process_mode`. @@ -763,7 +763,7 @@ Notification received when the node is paused. See :ref:`process_mode` Notification received when the node is unpaused. See :ref:`process_mode`. @@ -771,7 +771,7 @@ Notification received when the node is unpaused. See :ref:`process_mode` Notification received from the tree every physics frame when :ref:`is_physics_processing` returns ``true``. See :ref:`_physics_process`. @@ -779,7 +779,7 @@ Notification received from the tree every physics frame when :ref:`is_physics_pr .. rst-class:: classref-constant -**NOTIFICATION_PROCESS** = ``17`` +**NOTIFICATION_PROCESS** = ``17`` :ref:`🔗` Notification received from the tree every rendered frame when :ref:`is_processing` returns ``true``. See :ref:`_process`. @@ -787,7 +787,7 @@ Notification received from the tree every rendered frame when :ref:`is_processin .. rst-class:: classref-constant -**NOTIFICATION_PARENTED** = ``18`` +**NOTIFICATION_PARENTED** = ``18`` :ref:`🔗` Notification received when the node is set as a child of another node (see :ref:`add_child` and :ref:`add_sibling`). @@ -797,7 +797,7 @@ Notification received when the node is set as a child of another node (see :ref: .. rst-class:: classref-constant -**NOTIFICATION_UNPARENTED** = ``19`` +**NOTIFICATION_UNPARENTED** = ``19`` :ref:`🔗` Notification received when the parent node calls :ref:`remove_child` on this node. @@ -807,7 +807,7 @@ Notification received when the parent node calls :ref:`remove_child` Notification received *only* by the newly instantiated scene root node, when :ref:`PackedScene.instantiate` is completed. @@ -815,7 +815,7 @@ Notification received *only* by the newly instantiated scene root node, when :re .. rst-class:: classref-constant -**NOTIFICATION_DRAG_BEGIN** = ``21`` +**NOTIFICATION_DRAG_BEGIN** = ``21`` :ref:`🔗` Notification received when a drag operation begins. All nodes receive this notification, not only the dragged one. @@ -827,7 +827,7 @@ Use :ref:`Viewport.gui_get_drag_data` t .. rst-class:: classref-constant -**NOTIFICATION_DRAG_END** = ``22`` +**NOTIFICATION_DRAG_END** = ``22`` :ref:`🔗` Notification received when a drag operation ends. @@ -837,7 +837,7 @@ Use :ref:`Viewport.gui_is_drag_successful` Notification received when the node's :ref:`name` or one of its ancestors' :ref:`name` is changed. This notification is *not* received when the node is removed from the :ref:`SceneTree`. @@ -845,7 +845,7 @@ Notification received when the node's :ref:`name` or o .. rst-class:: classref-constant -**NOTIFICATION_CHILD_ORDER_CHANGED** = ``24`` +**NOTIFICATION_CHILD_ORDER_CHANGED** = ``24`` :ref:`🔗` Notification received when the list of children is changed. This happens when child nodes are added, moved or removed. @@ -853,7 +853,7 @@ Notification received when the list of children is changed. This happens when ch .. rst-class:: classref-constant -**NOTIFICATION_INTERNAL_PROCESS** = ``25`` +**NOTIFICATION_INTERNAL_PROCESS** = ``25`` :ref:`🔗` Notification received from the tree every rendered frame when :ref:`is_processing_internal` returns ``true``. @@ -861,7 +861,7 @@ Notification received from the tree every rendered frame when :ref:`is_processin .. rst-class:: classref-constant -**NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = ``26`` +**NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = ``26`` :ref:`🔗` Notification received from the tree every physics frame when :ref:`is_physics_processing_internal` returns ``true``. @@ -869,7 +869,7 @@ Notification received from the tree every physics frame when :ref:`is_physics_pr .. rst-class:: classref-constant -**NOTIFICATION_POST_ENTER_TREE** = ``27`` +**NOTIFICATION_POST_ENTER_TREE** = ``27`` :ref:`🔗` Notification received when the node enters the tree, just before :ref:`NOTIFICATION_READY` may be received. Unlike the latter, it is sent every time the node enters tree, not just once. @@ -877,7 +877,7 @@ Notification received when the node enters the tree, just before :ref:`NOTIFICAT .. rst-class:: classref-constant -**NOTIFICATION_DISABLED** = ``28`` +**NOTIFICATION_DISABLED** = ``28`` :ref:`🔗` Notification received when the node is disabled. See :ref:`PROCESS_MODE_DISABLED`. @@ -885,7 +885,7 @@ Notification received when the node is disabled. See :ref:`PROCESS_MODE_DISABLED .. rst-class:: classref-constant -**NOTIFICATION_ENABLED** = ``29`` +**NOTIFICATION_ENABLED** = ``29`` :ref:`🔗` Notification received when the node is enabled again after being disabled. See :ref:`PROCESS_MODE_DISABLED`. @@ -893,7 +893,7 @@ Notification received when the node is enabled again after being disabled. See : .. rst-class:: classref-constant -**NOTIFICATION_RESET_PHYSICS_INTERPOLATION** = ``2001`` +**NOTIFICATION_RESET_PHYSICS_INTERPOLATION** = ``2001`` :ref:`🔗` Notification received when :ref:`reset_physics_interpolation` is called on the node or its ancestors. @@ -901,7 +901,7 @@ Notification received when :ref:`reset_physics_interpolation` Notification received right before the scene with the node is saved in the editor. This notification is only sent in the Godot editor and will not occur in exported projects. @@ -909,7 +909,7 @@ Notification received right before the scene with the node is saved in the edito .. rst-class:: classref-constant -**NOTIFICATION_EDITOR_POST_SAVE** = ``9002`` +**NOTIFICATION_EDITOR_POST_SAVE** = ``9002`` :ref:`🔗` Notification received right after the scene with the node is saved in the editor. This notification is only sent in the Godot editor and will not occur in exported projects. @@ -917,7 +917,7 @@ Notification received right after the scene with the node is saved in the editor .. rst-class:: classref-constant -**NOTIFICATION_WM_MOUSE_ENTER** = ``1002`` +**NOTIFICATION_WM_MOUSE_ENTER** = ``1002`` :ref:`🔗` Notification received when the mouse enters the window. @@ -927,7 +927,7 @@ Implemented for embedded windows and on desktop and web platforms. .. rst-class:: classref-constant -**NOTIFICATION_WM_MOUSE_EXIT** = ``1003`` +**NOTIFICATION_WM_MOUSE_EXIT** = ``1003`` :ref:`🔗` Notification received when the mouse leaves the window. @@ -937,7 +937,7 @@ Implemented for embedded windows and on desktop and web platforms. .. rst-class:: classref-constant -**NOTIFICATION_WM_WINDOW_FOCUS_IN** = ``1004`` +**NOTIFICATION_WM_WINDOW_FOCUS_IN** = ``1004`` :ref:`🔗` Notification received from the OS when the node's :ref:`Window` ancestor is focused. This may be a change of focus between two windows of the same engine instance, or from the OS desktop or a third-party application to a window of the game (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_IN` is also received). @@ -947,7 +947,7 @@ A :ref:`Window` node receives this notification when it is focused .. rst-class:: classref-constant -**NOTIFICATION_WM_WINDOW_FOCUS_OUT** = ``1005`` +**NOTIFICATION_WM_WINDOW_FOCUS_OUT** = ``1005`` :ref:`🔗` Notification received from the OS when the node's :ref:`Window` ancestor is defocused. This may be a change of focus between two windows of the same engine instance, or from a window of the game to the OS desktop or a third-party application (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_OUT` is also received). @@ -957,7 +957,7 @@ A :ref:`Window` node receives this notification when it is defocus .. rst-class:: classref-constant -**NOTIFICATION_WM_CLOSE_REQUEST** = ``1006`` +**NOTIFICATION_WM_CLOSE_REQUEST** = ``1006`` :ref:`🔗` Notification received from the OS when a close request is sent (e.g. closing the window with a "Close" button or :kbd:`Alt + F4`). @@ -967,7 +967,7 @@ Implemented on desktop platforms. .. rst-class:: classref-constant -**NOTIFICATION_WM_GO_BACK_REQUEST** = ``1007`` +**NOTIFICATION_WM_GO_BACK_REQUEST** = ``1007`` :ref:`🔗` Notification received from the OS when a go back request is sent (e.g. pressing the "Back" button on Android). @@ -977,7 +977,7 @@ Implemented only on iOS. .. rst-class:: classref-constant -**NOTIFICATION_WM_SIZE_CHANGED** = ``1008`` +**NOTIFICATION_WM_SIZE_CHANGED** = ``1008`` :ref:`🔗` Notification received when the window is resized. @@ -987,7 +987,7 @@ Notification received when the window is resized. .. rst-class:: classref-constant -**NOTIFICATION_WM_DPI_CHANGE** = ``1009`` +**NOTIFICATION_WM_DPI_CHANGE** = ``1009`` :ref:`🔗` Notification received from the OS when the screen's dots per inch (DPI) scale is changed. Only implemented on macOS. @@ -995,7 +995,7 @@ Notification received from the OS when the screen's dots per inch (DPI) scale is .. rst-class:: classref-constant -**NOTIFICATION_VP_MOUSE_ENTER** = ``1010`` +**NOTIFICATION_VP_MOUSE_ENTER** = ``1010`` :ref:`🔗` Notification received when the mouse cursor enters the :ref:`Viewport`'s visible area, that is not occluded behind other :ref:`Control`\ s or :ref:`Window`\ s, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. @@ -1003,7 +1003,7 @@ Notification received when the mouse cursor enters the :ref:`Viewport` Notification received when the mouse cursor leaves the :ref:`Viewport`'s visible area, that is not occluded behind other :ref:`Control`\ s or :ref:`Window`\ s, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. @@ -1011,7 +1011,7 @@ Notification received when the mouse cursor leaves the :ref:`Viewport` Notification received from the OS when the application is exceeding its allocated memory. @@ -1021,7 +1021,7 @@ Implemented only on iOS. .. rst-class:: classref-constant -**NOTIFICATION_TRANSLATION_CHANGED** = ``2010`` +**NOTIFICATION_TRANSLATION_CHANGED** = ``2010`` :ref:`🔗` Notification received when translations may have changed. Can be triggered by the user changing the locale, changing :ref:`auto_translate_mode` or when the node enters the scene tree. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. @@ -1039,7 +1039,7 @@ Notification received when translations may have changed. Can be triggered by th .. rst-class:: classref-constant -**NOTIFICATION_WM_ABOUT** = ``2011`` +**NOTIFICATION_WM_ABOUT** = ``2011`` :ref:`🔗` Notification received from the OS when a request for "About" information is sent. @@ -1049,7 +1049,7 @@ Implemented only on macOS. .. rst-class:: classref-constant -**NOTIFICATION_CRASH** = ``2012`` +**NOTIFICATION_CRASH** = ``2012`` :ref:`🔗` Notification received from Godot's crash handler when the engine is about to crash. @@ -1059,7 +1059,7 @@ Implemented on desktop platforms, if the crash handler is enabled. .. rst-class:: classref-constant -**NOTIFICATION_OS_IME_UPDATE** = ``2013`` +**NOTIFICATION_OS_IME_UPDATE** = ``2013`` :ref:`🔗` Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). @@ -1069,7 +1069,7 @@ Implemented only on macOS. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_RESUMED** = ``2014`` +**NOTIFICATION_APPLICATION_RESUMED** = ``2014`` :ref:`🔗` Notification received from the OS when the application is resumed. @@ -1079,7 +1079,7 @@ Specific to the Android and iOS platforms. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_PAUSED** = ``2015`` +**NOTIFICATION_APPLICATION_PAUSED** = ``2015`` :ref:`🔗` Notification received from the OS when the application is paused. @@ -1091,7 +1091,7 @@ Specific to the Android and iOS platforms. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_FOCUS_IN** = ``2016`` +**NOTIFICATION_APPLICATION_FOCUS_IN** = ``2016`` :ref:`🔗` Notification received from the OS when the application is focused, i.e. when changing the focus from the OS desktop or a thirdparty application to any open window of the Godot instance. @@ -1101,7 +1101,7 @@ Implemented on desktop and mobile platforms. .. rst-class:: classref-constant -**NOTIFICATION_APPLICATION_FOCUS_OUT** = ``2017`` +**NOTIFICATION_APPLICATION_FOCUS_OUT** = ``2017`` :ref:`🔗` Notification received from the OS when the application is defocused, i.e. when changing the focus from any open window of the Godot instance to the OS desktop or a thirdparty application. @@ -1111,7 +1111,7 @@ Implemented on desktop and mobile platforms. .. rst-class:: classref-constant -**NOTIFICATION_TEXT_SERVER_CHANGED** = ``2018`` +**NOTIFICATION_TEXT_SERVER_CHANGED** = ``2018`` :ref:`🔗` Notification received when the :ref:`TextServer` is changed. @@ -1128,7 +1128,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AutoTranslateMode` **auto_translate_mode** = ``0`` +:ref:`AutoTranslateMode` **auto_translate_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1147,7 +1147,7 @@ Defines if any text should automatically change to its translated version depend .. rst-class:: classref-property -:ref:`String` **editor_description** = ``""`` +:ref:`String` **editor_description** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1164,7 +1164,7 @@ An optional description to the node. It will be displayed as a tooltip when hove .. rst-class:: classref-property -:ref:`MultiplayerAPI` **multiplayer** +:ref:`MultiplayerAPI` **multiplayer** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1182,7 +1182,7 @@ The :ref:`MultiplayerAPI` instance associated with this no .. rst-class:: classref-property -:ref:`StringName` **name** +:ref:`StringName` **name** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1201,7 +1201,7 @@ The name of the node. This name must be unique among the siblings (other child n .. rst-class:: classref-property -:ref:`Node` **owner** +:ref:`Node` **owner** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1220,7 +1220,7 @@ The owner of this node. The owner must be an ancestor of this node. When packing .. rst-class:: classref-property -:ref:`PhysicsInterpolationMode` **physics_interpolation_mode** = ``0`` +:ref:`PhysicsInterpolationMode` **physics_interpolation_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1239,7 +1239,7 @@ Allows enabling or disabling physics interpolation per node, offering a finer gr .. rst-class:: classref-property -:ref:`ProcessMode` **process_mode** = ``0`` +:ref:`ProcessMode` **process_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1256,7 +1256,7 @@ The node's processing behavior (see :ref:`ProcessMode`). .. rst-class:: classref-property -:ref:`int` **process_physics_priority** = ``0`` +:ref:`int` **process_physics_priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1273,7 +1273,7 @@ Similar to :ref:`process_priority` but for .. rst-class:: classref-property -:ref:`int` **process_priority** = ``0`` +:ref:`int` **process_priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1290,7 +1290,7 @@ The node's execution order of the process callbacks (:ref:`_process` **process_thread_group** = ``0`` +:ref:`ProcessThreadGroup` **process_thread_group** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1313,7 +1313,7 @@ To better understand process thread groups, the idea is that any node set to any .. rst-class:: classref-property -:ref:`int` **process_thread_group_order** +:ref:`int` **process_thread_group_order** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1330,14 +1330,14 @@ Change the process thread group order. Groups with a lesser order will process b .. rst-class:: classref-property -|bitfield|\[:ref:`ProcessThreadMessages`\] **process_thread_messages** +|bitfield|\[:ref:`ProcessThreadMessages`\] **process_thread_messages** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_process_thread_messages**\ (\ value\: |bitfield|\[:ref:`ProcessThreadMessages`\]\ ) - |bitfield|\[:ref:`ProcessThreadMessages`\] **get_process_thread_messages**\ (\ ) -Set whether the current thread group will process messages (calls to :ref:`call_deferred_thread_group` on threads, and whether it wants to receive them during regular process or physics process callbacks. +Set whether the current thread group will process messages (calls to :ref:`call_deferred_thread_group` on threads), and whether it wants to receive them during regular process or physics process callbacks. .. rst-class:: classref-item-separator @@ -1347,7 +1347,7 @@ Set whether the current thread group will process messages (calls to :ref:`call_ .. rst-class:: classref-property -:ref:`String` **scene_file_path** +:ref:`String` **scene_file_path** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1364,7 +1364,7 @@ The original scene's file path, if the node has been instantiated from a :ref:`P .. rst-class:: classref-property -:ref:`bool` **unique_name_in_owner** = ``false`` +:ref:`bool` **unique_name_in_owner** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1388,7 +1388,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_enter_tree**\ (\ ) |virtual| +|void| **_enter_tree**\ (\ ) |virtual| :ref:`🔗` Called when the node enters the :ref:`SceneTree` (e.g. upon instantiating, scene changing, or after calling :ref:`add_child` in a script). If the node has children, its :ref:`_enter_tree` callback will be called first, and then that of the children. @@ -1402,7 +1402,7 @@ Corresponds to the :ref:`NOTIFICATION_ENTER_TREE` Called when the node is about to leave the :ref:`SceneTree` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child` in a script). If the node has children, its :ref:`_exit_tree` callback will be called last, after all its children have left the tree. @@ -1416,7 +1416,7 @@ Corresponds to the :ref:`NOTIFICATION_EXIT_TREE` **_get_configuration_warnings**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_configuration_warnings**\ (\ ) |virtual| |const| :ref:`🔗` The elements in the array returned from this method are displayed as warnings in the Scene dock if the script that overrides it is a ``tool`` script. @@ -1445,7 +1445,7 @@ Call :ref:`update_configuration_warnings`\ ) |virtual| +|void| **_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Called when there is an input event. The input event propagates up through the node tree until a node consumes it. @@ -1465,7 +1465,7 @@ For gameplay input, :ref:`_unhandled_input`\ ) |virtual| +|void| **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the ``delta`` variable should be constant. ``delta`` is in seconds. @@ -1483,7 +1483,7 @@ Corresponds to the :ref:`NOTIFICATION_PHYSICS_PROCESS`\ ) |virtual| +|void| **_process**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the ``delta`` time since the previous frame is not constant. ``delta`` is in seconds. @@ -1501,7 +1501,7 @@ Corresponds to the :ref:`NOTIFICATION_PROCESS` Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their :ref:`_ready` callbacks get triggered first, and the parent node will receive the ready notification afterwards. @@ -1519,7 +1519,7 @@ Usually used for initialization. For even earlier initialization, :ref:`Object._ .. rst-class:: classref-method -|void| **_shortcut_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| +|void| **_shortcut_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Called when an :ref:`InputEventKey`, :ref:`InputEventShortcut`, or :ref:`InputEventJoypadButton` hasn't been consumed by :ref:`_input` or any GUI :ref:`Control` item. It is called before :ref:`_unhandled_key_input` and :ref:`_unhandled_input`. The input event propagates up through the node tree until a node consumes it. @@ -1539,7 +1539,7 @@ This method can be used to handle shortcuts. For generic GUI events, use :ref:`_ .. rst-class:: classref-method -|void| **_unhandled_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| +|void| **_unhandled_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Called when an :ref:`InputEvent` hasn't been consumed by :ref:`_input` or any GUI :ref:`Control` item. It is called after :ref:`_shortcut_input` and after :ref:`_unhandled_key_input`. The input event propagates up through the node tree until a node consumes it. @@ -1559,7 +1559,7 @@ For gameplay input, this method is usually a better fit than :ref:`_input`\ ) |virtual| +|void| **_unhandled_key_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| :ref:`🔗` Called when an :ref:`InputEventKey` hasn't been consumed by :ref:`_input` or any GUI :ref:`Control` item. It is called after :ref:`_shortcut_input` but before :ref:`_unhandled_input`. The input event propagates up through the node tree until a node consumes it. @@ -1581,7 +1581,7 @@ For gameplay input, this and :ref:`_unhandled_input`, force_readable_name\: :ref:`bool` = false, internal\: :ref:`InternalMode` = 0\ ) +|void| **add_child**\ (\ node\: :ref:`Node`, force_readable_name\: :ref:`bool` = false, internal\: :ref:`InternalMode` = 0\ ) :ref:`🔗` Adds a child ``node``. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. @@ -1624,7 +1624,7 @@ If you need the child node to be added below a specific node in the list of chil .. rst-class:: classref-method -|void| **add_sibling**\ (\ sibling\: :ref:`Node`, force_readable_name\: :ref:`bool` = false\ ) +|void| **add_sibling**\ (\ sibling\: :ref:`Node`, force_readable_name\: :ref:`bool` = false\ ) :ref:`🔗` Adds a ``sibling`` node to this node's parent, and moves the added sibling right below this node. @@ -1642,7 +1642,7 @@ Use :ref:`add_child` instead of this method if you .. rst-class:: classref-method -|void| **add_to_group**\ (\ group\: :ref:`StringName`, persistent\: :ref:`bool` = false\ ) +|void| **add_to_group**\ (\ group\: :ref:`StringName`, persistent\: :ref:`bool` = false\ ) :ref:`🔗` Adds the node to the ``group``. Groups can be helpful to organize a subset of nodes, for example ``"enemies"`` or ``"collectables"``. See notes in the description, and the group methods in :ref:`SceneTree`. @@ -1660,7 +1660,7 @@ If ``persistent`` is ``true``, the group will be stored when saved inside a :ref .. rst-class:: classref-method -:ref:`String` **atr**\ (\ message\: :ref:`String`, context\: :ref:`StringName` = ""\ ) |const| +:ref:`String` **atr**\ (\ message\: :ref:`String`, context\: :ref:`StringName` = ""\ ) |const| :ref:`🔗` Translates a ``message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. Note that most :ref:`Control` nodes automatically translate their strings, so this method is mostly useful for formatted strings or custom drawn text. @@ -1678,7 +1678,7 @@ For detailed examples, see :doc:`Internationalizing games <../tutorials/i18n/int .. rst-class:: classref-method -:ref:`String` **atr_n**\ (\ message\: :ref:`String`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = ""\ ) |const| +:ref:`String` **atr_n**\ (\ message\: :ref:`String`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = ""\ ) |const| :ref:`🔗` Translates a ``message`` or ``plural_message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. @@ -1700,7 +1700,7 @@ For detailed examples, see :doc:`Localization using gettext <../tutorials/i18n/l .. rst-class:: classref-method -:ref:`Variant` **call_deferred_thread_group**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Variant` **call_deferred_thread_group**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` This function is similar to :ref:`Object.call_deferred` except that the call will take place when the node thread group is processed. If the node thread group processes in sub-threads, then the call will be done on that thread, right before :ref:`NOTIFICATION_PROCESS` or :ref:`NOTIFICATION_PHYSICS_PROCESS`, the :ref:`_process` or :ref:`_physics_process` or their internal versions are called. @@ -1712,7 +1712,7 @@ This function is similar to :ref:`Object.call_deferred` **call_thread_safe**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Variant` **call_thread_safe**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` This function ensures that the calling of this function will succeed, no matter whether it's being done from a thread or not. If called from a thread that is not allowed to call the function, the call will become deferred. Otherwise, the call will go through directly. @@ -1724,7 +1724,7 @@ This function ensures that the calling of this function will succeed, no matter .. rst-class:: classref-method -:ref:`bool` **can_process**\ (\ ) |const| +:ref:`bool` **can_process**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node can receive processing notifications and input callbacks (:ref:`NOTIFICATION_PROCESS`, :ref:`_input`, etc.) from the :ref:`SceneTree` and :ref:`Viewport`. The returned value depends on :ref:`process_mode`: @@ -1748,7 +1748,7 @@ If the node is not inside the tree, returns ``false`` no matter the value of :re .. rst-class:: classref-method -:ref:`Tween` **create_tween**\ (\ ) +:ref:`Tween` **create_tween**\ (\ ) :ref:`🔗` Creates a new :ref:`Tween` and binds it to this node. @@ -1779,7 +1779,7 @@ The Tween will start automatically on the next process frame or physics frame (d .. rst-class:: classref-method -:ref:`Node` **duplicate**\ (\ flags\: :ref:`int` = 15\ ) |const| +:ref:`Node` **duplicate**\ (\ flags\: :ref:`int` = 15\ ) |const| :ref:`🔗` Duplicates the node, returning a new node with all of its properties, signals and groups copied from the original. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags`). @@ -1793,7 +1793,7 @@ Duplicates the node, returning a new node with all of its properties, signals an .. rst-class:: classref-method -:ref:`Node` **find_child**\ (\ pattern\: :ref:`String`, recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| +:ref:`Node` **find_child**\ (\ pattern\: :ref:`String`, recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| :ref:`🔗` Finds the first descendant of this node whose :ref:`name` matches ``pattern``, returning ``null`` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. @@ -1813,7 +1813,7 @@ If ``owned`` is ``true``, only descendants with a valid :ref:`owner`\[:ref:`Node`\] **find_children**\ (\ pattern\: :ref:`String`, type\: :ref:`String` = "", recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| +:ref:`Array`\[:ref:`Node`\] **find_children**\ (\ pattern\: :ref:`String`, type\: :ref:`String` = "", recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| :ref:`🔗` Finds all descendants of this node whose names match ``pattern``, returning an empty :ref:`Array` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. @@ -1835,7 +1835,7 @@ If ``owned`` is ``true``, only descendants with a valid :ref:`owner` **find_parent**\ (\ pattern\: :ref:`String`\ ) |const| +:ref:`Node` **find_parent**\ (\ pattern\: :ref:`String`\ ) |const| :ref:`🔗` Finds the first ancestor of this node whose :ref:`name` matches ``pattern``, returning ``null`` if no match is found. The matching is done through :ref:`String.match`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. See also :ref:`find_child` and :ref:`find_children`. @@ -1849,7 +1849,7 @@ Finds the first ancestor of this node whose :ref:`name .. rst-class:: classref-method -:ref:`Node` **get_child**\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| +:ref:`Node` **get_child**\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| :ref:`🔗` Fetches a child node by its index. Each child node has an index relative its siblings (see :ref:`get_index`). The first child is at index 0. Negative values can also be used to start from the end of the list. This method can be used in combination with :ref:`get_child_count` to iterate over this node's children. If no child exists at the given index, this method returns ``null`` and an error is generated. @@ -1875,7 +1875,7 @@ If ``include_internal`` is ``false``, internal children are ignored (see :ref:`a .. rst-class:: classref-method -:ref:`int` **get_child_count**\ (\ include_internal\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_child_count**\ (\ include_internal\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the number of children of this node. @@ -1889,7 +1889,7 @@ If ``include_internal`` is ``false``, internal children are not counted (see :re .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node`\] **get_children**\ (\ include_internal\: :ref:`bool` = false\ ) |const| +:ref:`Array`\[:ref:`Node`\] **get_children**\ (\ include_internal\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns all children of this node inside an :ref:`Array`. @@ -1903,7 +1903,7 @@ If ``include_internal`` is ``false``, excludes internal children from the return .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_groups**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **get_groups**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` of group names that the node has been added to. @@ -1942,7 +1942,7 @@ Returns an :ref:`Array` of group names that the node has been added .. rst-class:: classref-method -:ref:`int` **get_index**\ (\ include_internal\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_index**\ (\ include_internal\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns this node's order among its siblings. The first node's index is ``0``. See also :ref:`get_child`. @@ -1956,7 +1956,7 @@ If ``include_internal`` is ``false``, returns the index ignoring internal childr .. rst-class:: classref-method -:ref:`Window` **get_last_exclusive_window**\ (\ ) |const| +:ref:`Window` **get_last_exclusive_window**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Window` that contains this node, or the last exclusive child in a chain of windows starting with the one that contains this node. @@ -1968,7 +1968,7 @@ Returns the :ref:`Window` that contains this node, or the last exc .. rst-class:: classref-method -:ref:`int` **get_multiplayer_authority**\ (\ ) |const| +:ref:`int` **get_multiplayer_authority**\ (\ ) |const| :ref:`🔗` Returns the peer ID of the multiplayer authority for this node. See :ref:`set_multiplayer_authority`. @@ -1980,7 +1980,7 @@ Returns the peer ID of the multiplayer authority for this node. See :ref:`set_mu .. rst-class:: classref-method -:ref:`Node` **get_node**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`Node` **get_node**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Fetches a node. The :ref:`NodePath` can either be a relative path (from this node), or an absolute path (from the :ref:`SceneTree.root`) to a node. If ``path`` does not point to a valid node, generates an error and returns ``null``. Attempts to access methods on the return value will result in an *"Attempt to call on a null instance."* error. @@ -2030,7 +2030,7 @@ The following calls will return a valid node: .. rst-class:: classref-method -:ref:`Array` **get_node_and_resource**\ (\ path\: :ref:`NodePath`\ ) +:ref:`Array` **get_node_and_resource**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` Fetches a node and its most nested resource as specified by the :ref:`NodePath`'s subname. Returns an :ref:`Array` of size ``3`` where: @@ -2089,7 +2089,7 @@ Fetches a node and its most nested resource as specified by the :ref:`NodePath` **get_node_or_null**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`Node` **get_node_or_null**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Fetches a node by :ref:`NodePath`. Similar to :ref:`get_node`, but does not generate an error if ``path`` does not point to a valid node. @@ -2101,7 +2101,7 @@ Fetches a node by :ref:`NodePath`. Similar to :ref:`get_node` **get_parent**\ (\ ) |const| +:ref:`Node` **get_parent**\ (\ ) |const| :ref:`🔗` Returns this node's parent node, or ``null`` if the node doesn't have a parent. @@ -2113,7 +2113,7 @@ Returns this node's parent node, or ``null`` if the node doesn't have a parent. .. rst-class:: classref-method -:ref:`NodePath` **get_path**\ (\ ) |const| +:ref:`NodePath` **get_path**\ (\ ) |const| :ref:`🔗` Returns the node's absolute path, relative to the :ref:`SceneTree.root`. If the node is not inside the scene tree, this method fails and returns an empty :ref:`NodePath`. @@ -2125,7 +2125,7 @@ Returns the node's absolute path, relative to the :ref:`SceneTree.root` **get_path_to**\ (\ node\: :ref:`Node`, use_unique_path\: :ref:`bool` = false\ ) |const| +:ref:`NodePath` **get_path_to**\ (\ node\: :ref:`Node`, use_unique_path\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the relative :ref:`NodePath` from this node to the specified ``node``. Both nodes must be in the same :ref:`SceneTree` or scene hierarchy, otherwise this method fails and returns an empty :ref:`NodePath`. @@ -2141,7 +2141,7 @@ If ``use_unique_path`` is ``true``, returns the shortest path accounting for thi .. rst-class:: classref-method -:ref:`float` **get_physics_process_delta_time**\ (\ ) |const| +:ref:`float` **get_physics_process_delta_time**\ (\ ) |const| :ref:`🔗` Returns the time elapsed (in seconds) since the last physics callback. This value is identical to :ref:`_physics_process`'s ``delta`` parameter, and is often consistent at run-time, unless :ref:`Engine.physics_ticks_per_second` is changed. See also :ref:`NOTIFICATION_PHYSICS_PROCESS`. @@ -2153,7 +2153,7 @@ Returns the time elapsed (in seconds) since the last physics callback. This valu .. rst-class:: classref-method -:ref:`float` **get_process_delta_time**\ (\ ) |const| +:ref:`float` **get_process_delta_time**\ (\ ) |const| :ref:`🔗` Returns the time elapsed (in seconds) since the last process callback. This value is identical to :ref:`_process`'s ``delta`` parameter, and may vary from frame to frame. See also :ref:`NOTIFICATION_PROCESS`. @@ -2165,7 +2165,7 @@ Returns the time elapsed (in seconds) since the last process callback. This valu .. rst-class:: classref-method -:ref:`bool` **get_scene_instance_load_placeholder**\ (\ ) |const| +:ref:`bool` **get_scene_instance_load_placeholder**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this node is an instance load placeholder. See :ref:`InstancePlaceholder` and :ref:`set_scene_instance_load_placeholder`. @@ -2177,7 +2177,7 @@ Returns ``true`` if this node is an instance load placeholder. See :ref:`Instanc .. rst-class:: classref-method -:ref:`SceneTree` **get_tree**\ (\ ) |const| +:ref:`SceneTree` **get_tree**\ (\ ) |const| :ref:`🔗` Returns the :ref:`SceneTree` that contains this node. If this node is not inside the tree, generates an error and returns ``null``. See also :ref:`is_inside_tree`. @@ -2189,7 +2189,7 @@ Returns the :ref:`SceneTree` that contains this node. If this n .. rst-class:: classref-method -:ref:`String` **get_tree_string**\ (\ ) +:ref:`String` **get_tree_string**\ (\ ) :ref:`🔗` Returns the tree as a :ref:`String`. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the :ref:`get_node` function. It also can be used in game UI/UX. @@ -2212,7 +2212,7 @@ May print, for example: .. rst-class:: classref-method -:ref:`String` **get_tree_string_pretty**\ (\ ) +:ref:`String` **get_tree_string_pretty**\ (\ ) :ref:`🔗` Similar to :ref:`get_tree_string`, this returns the tree as a :ref:`String`. This version displays a more graphical representation similar to what is displayed in the Scene Dock. It is useful for inspecting larger trees. @@ -2235,7 +2235,7 @@ May print, for example: .. rst-class:: classref-method -:ref:`Viewport` **get_viewport**\ (\ ) |const| +:ref:`Viewport` **get_viewport**\ (\ ) |const| :ref:`🔗` Returns the node's closest :ref:`Viewport` ancestor, if the node is inside the tree. Otherwise, returns ``null``. @@ -2247,7 +2247,7 @@ Returns the node's closest :ref:`Viewport` ancestor, if the node .. rst-class:: classref-method -:ref:`Window` **get_window**\ (\ ) |const| +:ref:`Window` **get_window**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Window` that contains this node. If the node is in the main window, this is equivalent to getting the root node (``get_tree().get_root()``). @@ -2259,7 +2259,7 @@ Returns the :ref:`Window` that contains this node. If the node is .. rst-class:: classref-method -:ref:`bool` **has_node**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`bool` **has_node**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Returns ``true`` if the ``path`` points to a valid node. See also :ref:`get_node`. @@ -2271,7 +2271,7 @@ Returns ``true`` if the ``path`` points to a valid node. See also :ref:`get_node .. rst-class:: classref-method -:ref:`bool` **has_node_and_resource**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`bool` **has_node_and_resource**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Returns ``true`` if ``path`` points to a valid node and its subnames point to a valid :ref:`Resource`, e.g. ``Area2D/CollisionShape2D:shape``. Properties that are not :ref:`Resource` types (such as nodes or other :ref:`Variant` types) are not considered. See also :ref:`get_node_and_resource`. @@ -2283,7 +2283,7 @@ Returns ``true`` if ``path`` points to a valid node and its subnames point to a .. rst-class:: classref-method -:ref:`bool` **is_ancestor_of**\ (\ node\: :ref:`Node`\ ) |const| +:ref:`bool` **is_ancestor_of**\ (\ node\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``node`` is a direct or indirect child of this node. @@ -2295,7 +2295,7 @@ Returns ``true`` if the given ``node`` is a direct or indirect child of this nod .. rst-class:: classref-method -:ref:`bool` **is_displayed_folded**\ (\ ) |const| +:ref:`bool` **is_displayed_folded**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is folded (collapsed) in the Scene dock. This method is intended to be used in editor plugins and tools. See also :ref:`set_display_folded`. @@ -2307,7 +2307,7 @@ Returns ``true`` if the node is folded (collapsed) in the Scene dock. This metho .. rst-class:: classref-method -:ref:`bool` **is_editable_instance**\ (\ node\: :ref:`Node`\ ) |const| +:ref:`bool` **is_editable_instance**\ (\ node\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if ``node`` has editable children enabled relative to this node. This method is intended to be used in editor plugins and tools. See also :ref:`set_editable_instance`. @@ -2319,7 +2319,7 @@ Returns ``true`` if ``node`` has editable children enabled relative to this node .. rst-class:: classref-method -:ref:`bool` **is_greater_than**\ (\ node\: :ref:`Node`\ ) |const| +:ref:`bool` **is_greater_than**\ (\ node\: :ref:`Node`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``node`` occurs later in the scene hierarchy than this node. A node occurring later is usually processed last. @@ -2331,7 +2331,7 @@ Returns ``true`` if the given ``node`` occurs later in the scene hierarchy than .. rst-class:: classref-method -:ref:`bool` **is_in_group**\ (\ group\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_in_group**\ (\ group\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if this node has been added to the given ``group``. See :ref:`add_to_group` and :ref:`remove_from_group`. See also notes in the description, and the :ref:`SceneTree`'s group methods. @@ -2343,7 +2343,7 @@ Returns ``true`` if this node has been added to the given ``group``. See :ref:`a .. rst-class:: classref-method -:ref:`bool` **is_inside_tree**\ (\ ) |const| +:ref:`bool` **is_inside_tree**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this node is currently inside a :ref:`SceneTree`. See also :ref:`get_tree`. @@ -2355,7 +2355,7 @@ Returns ``true`` if this node is currently inside a :ref:`SceneTree` **is_multiplayer_authority**\ (\ ) |const| +:ref:`bool` **is_multiplayer_authority**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the local system is the multiplayer authority of this node. @@ -2367,7 +2367,7 @@ Returns ``true`` if the local system is the multiplayer authority of this node. .. rst-class:: classref-method -:ref:`bool` **is_node_ready**\ (\ ) |const| +:ref:`bool` **is_node_ready**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is ready, i.e. it's inside scene tree and all its children are initialized. @@ -2381,7 +2381,7 @@ Returns ``true`` if the node is ready, i.e. it's inside scene tree and all its c .. rst-class:: classref-method -:ref:`bool` **is_part_of_edited_scene**\ (\ ) |const| +:ref:`bool` **is_part_of_edited_scene**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is part of the scene currently opened in the editor. @@ -2393,7 +2393,7 @@ Returns ``true`` if the node is part of the scene currently opened in the editor .. rst-class:: classref-method -:ref:`bool` **is_physics_interpolated**\ (\ ) |const| +:ref:`bool` **is_physics_interpolated**\ (\ ) |const| :ref:`🔗` Returns ``true`` if physics interpolation is enabled for this node (see :ref:`physics_interpolation_mode`). @@ -2407,7 +2407,7 @@ Returns ``true`` if physics interpolation is enabled for this node (see :ref:`ph .. rst-class:: classref-method -:ref:`bool` **is_physics_interpolated_and_enabled**\ (\ ) |const| +:ref:`bool` **is_physics_interpolated_and_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if physics interpolation is enabled (see :ref:`physics_interpolation_mode`) **and** enabled in the :ref:`SceneTree`. @@ -2423,7 +2423,7 @@ See :ref:`SceneTree.physics_interpolation` **is_physics_processing**\ (\ ) |const| +:ref:`bool` **is_physics_processing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). @@ -2435,7 +2435,7 @@ Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process .. rst-class:: classref-method -:ref:`bool` **is_physics_processing_internal**\ (\ ) |const| +:ref:`bool` **is_physics_processing_internal**\ (\ ) |const| :ref:`🔗` Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). @@ -2447,7 +2447,7 @@ Returns ``true`` if internal physics processing is enabled (see :ref:`set_physic .. rst-class:: classref-method -:ref:`bool` **is_processing**\ (\ ) |const| +:ref:`bool` **is_processing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if processing is enabled (see :ref:`set_process`). @@ -2459,7 +2459,7 @@ Returns ``true`` if processing is enabled (see :ref:`set_process` **is_processing_input**\ (\ ) |const| +:ref:`bool` **is_processing_input**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is processing input (see :ref:`set_process_input`). @@ -2471,7 +2471,7 @@ Returns ``true`` if the node is processing input (see :ref:`set_process_input` **is_processing_internal**\ (\ ) |const| +:ref:`bool` **is_processing_internal**\ (\ ) |const| :ref:`🔗` Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). @@ -2483,7 +2483,7 @@ Returns ``true`` if internal processing is enabled (see :ref:`set_process_intern .. rst-class:: classref-method -:ref:`bool` **is_processing_shortcut_input**\ (\ ) |const| +:ref:`bool` **is_processing_shortcut_input**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is processing shortcuts (see :ref:`set_process_shortcut_input`). @@ -2495,7 +2495,7 @@ Returns ``true`` if the node is processing shortcuts (see :ref:`set_process_shor .. rst-class:: classref-method -:ref:`bool` **is_processing_unhandled_input**\ (\ ) |const| +:ref:`bool` **is_processing_unhandled_input**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). @@ -2507,7 +2507,7 @@ Returns ``true`` if the node is processing unhandled input (see :ref:`set_proces .. rst-class:: classref-method -:ref:`bool` **is_processing_unhandled_key_input**\ (\ ) |const| +:ref:`bool` **is_processing_unhandled_key_input**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input`). @@ -2519,7 +2519,7 @@ Returns ``true`` if the node is processing unhandled key input (see :ref:`set_pr .. rst-class:: classref-method -|void| **move_child**\ (\ child_node\: :ref:`Node`, to_index\: :ref:`int`\ ) +|void| **move_child**\ (\ child_node\: :ref:`Node`, to_index\: :ref:`int`\ ) :ref:`🔗` Moves ``child_node`` to the given index. A node's index is the order among its siblings. If ``to_index`` is negative, the index is counted from the end of the list. See also :ref:`get_child` and :ref:`get_index`. @@ -2533,7 +2533,7 @@ Moves ``child_node`` to the given index. A node's index is the order among its s .. rst-class:: classref-method -|void| **notify_deferred_thread_group**\ (\ what\: :ref:`int`\ ) +|void| **notify_deferred_thread_group**\ (\ what\: :ref:`int`\ ) :ref:`🔗` Similar to :ref:`call_deferred_thread_group`, but for notifications. @@ -2545,7 +2545,7 @@ Similar to :ref:`call_deferred_thread_group`\ ) +|void| **notify_thread_safe**\ (\ what\: :ref:`int`\ ) :ref:`🔗` Similar to :ref:`call_thread_safe`, but for notifications. @@ -2557,7 +2557,7 @@ Similar to :ref:`call_thread_safe`, but for .. rst-class:: classref-method -|void| **print_orphan_nodes**\ (\ ) |static| +|void| **print_orphan_nodes**\ (\ ) |static| :ref:`🔗` Prints all orphan nodes (nodes outside the :ref:`SceneTree`). Useful for debugging. @@ -2571,7 +2571,7 @@ Prints all orphan nodes (nodes outside the :ref:`SceneTree`). U .. rst-class:: classref-method -|void| **print_tree**\ (\ ) +|void| **print_tree**\ (\ ) :ref:`🔗` Prints the node and its children to the console, recursively. The node does not have to be inside the tree. This method outputs :ref:`NodePath`\ s relative to this node, and is good for copy/pasting into :ref:`get_node`. See also :ref:`print_tree_pretty`. @@ -2594,7 +2594,7 @@ May print, for example: .. rst-class:: classref-method -|void| **print_tree_pretty**\ (\ ) +|void| **print_tree_pretty**\ (\ ) :ref:`🔗` Prints the node and its children to the console, recursively. The node does not have to be inside the tree. Similar to :ref:`print_tree`, but the graphical representation looks like what is displayed in the editor's Scene dock. It is useful for inspecting larger trees. @@ -2617,7 +2617,7 @@ May print, for example: .. rst-class:: classref-method -|void| **propagate_call**\ (\ method\: :ref:`StringName`, args\: :ref:`Array` = [], parent_first\: :ref:`bool` = false\ ) +|void| **propagate_call**\ (\ method\: :ref:`StringName`, args\: :ref:`Array` = [], parent_first\: :ref:`bool` = false\ ) :ref:`🔗` Calls the given ``method`` name, passing ``args`` as arguments, on this node and all of its children, recursively. @@ -2631,7 +2631,7 @@ If ``parent_first`` is ``true``, the method is called on this node first, then o .. rst-class:: classref-method -|void| **propagate_notification**\ (\ what\: :ref:`int`\ ) +|void| **propagate_notification**\ (\ what\: :ref:`int`\ ) :ref:`🔗` Calls :ref:`Object.notification` with ``what`` on this node and all of its children, recursively. @@ -2643,7 +2643,7 @@ Calls :ref:`Object.notification` with ``what`` .. rst-class:: classref-method -|void| **queue_free**\ (\ ) +|void| **queue_free**\ (\ ) :ref:`🔗` Queues this node to be deleted at the end of the current frame. When deleted, all of its children are deleted as well, and all references to the node and its children become invalid. @@ -2659,7 +2659,7 @@ Unlike with :ref:`Object.free`, the node is not delete .. rst-class:: classref-method -|void| **remove_child**\ (\ node\: :ref:`Node`\ ) +|void| **remove_child**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Removes a child ``node``. The ``node``, along with its children, are **not** deleted. To delete a node, see :ref:`queue_free`. @@ -2673,7 +2673,7 @@ Removes a child ``node``. The ``node``, along with its children, are **not** del .. rst-class:: classref-method -|void| **remove_from_group**\ (\ group\: :ref:`StringName`\ ) +|void| **remove_from_group**\ (\ group\: :ref:`StringName`\ ) :ref:`🔗` Removes the node from the given ``group``. Does nothing if the node is not in the ``group``. See also notes in the description, and the :ref:`SceneTree`'s group methods. @@ -2685,7 +2685,7 @@ Removes the node from the given ``group``. Does nothing if the node is not in th .. rst-class:: classref-method -|void| **reparent**\ (\ new_parent\: :ref:`Node`, keep_global_transform\: :ref:`bool` = true\ ) +|void| **reparent**\ (\ new_parent\: :ref:`Node`, keep_global_transform\: :ref:`bool` = true\ ) :ref:`🔗` Changes the parent of this **Node** to the ``new_parent``. The node needs to already have a parent. The node's :ref:`owner` is preserved if its owner is still reachable from the new location (i.e., the node is still a descendant of the new parent after the operation). @@ -2699,7 +2699,7 @@ If ``keep_global_transform`` is ``true``, the node's global transform will be pr .. rst-class:: classref-method -|void| **replace_by**\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false\ ) +|void| **replace_by**\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false\ ) :ref:`🔗` Replaces this node by the given ``node``. All children of this node are moved to ``node``. @@ -2715,7 +2715,7 @@ If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that th .. rst-class:: classref-method -|void| **request_ready**\ (\ ) +|void| **request_ready**\ (\ ) :ref:`🔗` Requests :ref:`_ready` to be called again the next time the node enters the tree. Does **not** immediately call :ref:`_ready`. @@ -2729,7 +2729,7 @@ Requests :ref:`_ready` to be called again the .. rst-class:: classref-method -|void| **reset_physics_interpolation**\ (\ ) +|void| **reset_physics_interpolation**\ (\ ) :ref:`🔗` When physics interpolation is active, moving a node to a radically different transform (such as placement within a level) can result in a visible glitch as the object is rendered moving from the old to new position over the physics tick. @@ -2747,7 +2747,7 @@ The notification :ref:`NOTIFICATION_RESET_PHYSICS_INTERPOLATION` **rpc**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Error` **rpc**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), sending additional arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath`, including the exact same :ref:`name`. Behavior depends on the RPC configuration for the given ``method`` (see :ref:`rpc_config` and :ref:`@GDScript.@rpc`). By default, methods are not exposed to RPCs. @@ -2763,7 +2763,7 @@ May return :ref:`@GlobalScope.OK` if the call is .. rst-class:: classref-method -|void| **rpc_config**\ (\ method\: :ref:`StringName`, config\: :ref:`Variant`\ ) +|void| **rpc_config**\ (\ method\: :ref:`StringName`, config\: :ref:`Variant`\ ) :ref:`🔗` Changes the RPC configuration for the given ``method``. ``config`` should either be ``null`` to disable the feature (as by default), or a :ref:`Dictionary` containing the following entries: @@ -2785,7 +2785,7 @@ Changes the RPC configuration for the given ``method``. ``config`` should either .. rst-class:: classref-method -:ref:`Error` **rpc_id**\ (\ peer_id\: :ref:`int`, method\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Error` **rpc_id**\ (\ peer_id\: :ref:`int`, method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`MultiplayerPeer.set_target_peer`). @@ -2799,7 +2799,7 @@ May return :ref:`@GlobalScope.OK` if the call is .. rst-class:: classref-method -|void| **set_deferred_thread_group**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_deferred_thread_group**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Similar to :ref:`call_deferred_thread_group`, but for setting properties. @@ -2811,7 +2811,7 @@ Similar to :ref:`call_deferred_thread_group`\ ) +|void| **set_display_folded**\ (\ fold\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, the node appears folded in the Scene dock. As a result, all of its children are hidden. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also :ref:`is_displayed_folded`. @@ -2823,7 +2823,7 @@ If set to ``true``, the node appears folded in the Scene dock. As a result, all .. rst-class:: classref-method -|void| **set_editable_instance**\ (\ node\: :ref:`Node`, is_editable\: :ref:`bool`\ ) +|void| **set_editable_instance**\ (\ node\: :ref:`Node`, is_editable\: :ref:`bool`\ ) :ref:`🔗` Set to ``true`` to allow all nodes owned by ``node`` to be available, and editable, in the Scene dock, even if their :ref:`owner` is not the scene root. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also :ref:`is_editable_instance`. @@ -2835,7 +2835,7 @@ Set to ``true`` to allow all nodes owned by ``node`` to be available, and editab .. rst-class:: classref-method -|void| **set_multiplayer_authority**\ (\ id\: :ref:`int`, recursive\: :ref:`bool` = true\ ) +|void| **set_multiplayer_authority**\ (\ id\: :ref:`int`, recursive\: :ref:`bool` = true\ ) :ref:`🔗` Sets the node's multiplayer authority to the peer with the given peer ``id``. The multiplayer authority is the peer that has authority over the node on the network. Defaults to peer ID 1 (the server). Useful in conjunction with :ref:`rpc_config` and the :ref:`MultiplayerAPI`. @@ -2851,7 +2851,7 @@ If ``recursive`` is ``true``, the given peer is recursively set as the authority .. rst-class:: classref-method -|void| **set_physics_process**\ (\ enable\: :ref:`bool`\ ) +|void| **set_physics_process**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables physics (fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS` at a fixed (usually 60 FPS, see :ref:`Engine.physics_ticks_per_second` to change) interval (and the :ref:`_physics_process` callback will be called if it exists). @@ -2865,7 +2865,7 @@ If set to ``true``, enables physics (fixed framerate) processing. When a node is .. rst-class:: classref-method -|void| **set_physics_process_internal**\ (\ enable\: :ref:`bool`\ ) +|void| **set_physics_process_internal**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process`). @@ -2879,7 +2879,7 @@ If set to ``true``, enables internal physics for this node. Internal physics pro .. rst-class:: classref-method -|void| **set_process**\ (\ enable\: :ref:`bool`\ ) +|void| **set_process**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PROCESS` on every drawn frame (and the :ref:`_process` callback will be called if it exists). @@ -2895,7 +2895,7 @@ If set to ``true``, enables processing. When a node is being processed, it will .. rst-class:: classref-method -|void| **set_process_input**\ (\ enable\: :ref:`bool`\ ) +|void| **set_process_input**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables input processing. @@ -2909,7 +2909,7 @@ If set to ``true``, enables input processing. .. rst-class:: classref-method -|void| **set_process_internal**\ (\ enable\: :ref:`bool`\ ) +|void| **set_process_internal**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). @@ -2923,7 +2923,7 @@ If set to ``true``, enables internal processing for this node. Internal processi .. rst-class:: classref-method -|void| **set_process_shortcut_input**\ (\ enable\: :ref:`bool`\ ) +|void| **set_process_shortcut_input**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables shortcut processing for this node. @@ -2937,7 +2937,7 @@ If set to ``true``, enables shortcut processing for this node. .. rst-class:: classref-method -|void| **set_process_unhandled_input**\ (\ enable\: :ref:`bool`\ ) +|void| **set_process_unhandled_input**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables unhandled input processing. It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). @@ -2951,7 +2951,7 @@ If set to ``true``, enables unhandled input processing. It enables the node to r .. rst-class:: classref-method -|void| **set_process_unhandled_key_input**\ (\ enable\: :ref:`bool`\ ) +|void| **set_process_unhandled_key_input**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, enables unhandled key input processing. @@ -2965,7 +2965,7 @@ If set to ``true``, enables unhandled key input processing. .. rst-class:: classref-method -|void| **set_scene_instance_load_placeholder**\ (\ load_placeholder\: :ref:`bool`\ ) +|void| **set_scene_instance_load_placeholder**\ (\ load_placeholder\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, the node becomes a :ref:`InstancePlaceholder` when packed and instantiated from a :ref:`PackedScene`. See also :ref:`get_scene_instance_load_placeholder`. @@ -2977,7 +2977,7 @@ If set to ``true``, the node becomes a :ref:`InstancePlaceholder`, value\: :ref:`Variant`\ ) +|void| **set_thread_safe**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Similar to :ref:`call_thread_safe`, but for setting properties. @@ -2989,7 +2989,7 @@ Similar to :ref:`call_thread_safe`, but for .. rst-class:: classref-method -|void| **update_configuration_warnings**\ (\ ) +|void| **update_configuration_warnings**\ (\ ) :ref:`🔗` Refreshes the warnings displayed for this node in the Scene dock. Use :ref:`_get_configuration_warnings` to customize the warning messages to display. diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 66b4bf38061..a48128eb7cc 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -111,7 +111,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **global_position** +:ref:`Vector2` **global_position** :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ Global position. .. rst-class:: classref-property -:ref:`float` **global_rotation** +:ref:`float` **global_rotation** :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ Global rotation in radians. .. rst-class:: classref-property -:ref:`float` **global_rotation_degrees** +:ref:`float` **global_rotation_degrees** :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ Helper property to access :ref:`global_rotation` **global_scale** +:ref:`Vector2` **global_scale** :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ Global scale. .. rst-class:: classref-property -:ref:`float` **global_skew** +:ref:`float` **global_skew** :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ Global skew in radians. .. rst-class:: classref-property -:ref:`Transform2D` **global_transform** +:ref:`Transform2D` **global_transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ Global :ref:`Transform2D`. .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ Position, relative to the node's parent. .. rst-class:: classref-property -:ref:`float` **rotation** = ``0.0`` +:ref:`float` **rotation** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -249,7 +249,7 @@ Rotation in radians, relative to the node's parent. .. rst-class:: classref-property -:ref:`float` **rotation_degrees** +:ref:`float` **rotation_degrees** :ref:`🔗` .. rst-class:: classref-property-setget @@ -266,7 +266,7 @@ Helper property to access :ref:`rotation` in deg .. rst-class:: classref-property -:ref:`Vector2` **scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -285,7 +285,7 @@ The node's scale. Unscaled value: ``(1, 1)``. .. rst-class:: classref-property -:ref:`float` **skew** = ``0.0`` +:ref:`float` **skew** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ Slants the node. .. rst-class:: classref-property -:ref:`Transform2D` **transform** +:ref:`Transform2D` **transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -326,7 +326,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **apply_scale**\ (\ ratio\: :ref:`Vector2`\ ) +|void| **apply_scale**\ (\ ratio\: :ref:`Vector2`\ ) :ref:`🔗` Multiplies the current scale by the ``ratio`` vector. @@ -338,7 +338,7 @@ Multiplies the current scale by the ``ratio`` vector. .. rst-class:: classref-method -:ref:`float` **get_angle_to**\ (\ point\: :ref:`Vector2`\ ) |const| +:ref:`float` **get_angle_to**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the angle between the node and the ``point`` in radians. @@ -352,7 +352,7 @@ Returns the angle between the node and the ``point`` in radians. .. rst-class:: classref-method -:ref:`Transform2D` **get_relative_transform_to_parent**\ (\ parent\: :ref:`Node`\ ) |const| +:ref:`Transform2D` **get_relative_transform_to_parent**\ (\ parent\: :ref:`Node`\ ) |const| :ref:`🔗` Returns the :ref:`Transform2D` relative to this node's parent. @@ -364,7 +364,7 @@ Returns the :ref:`Transform2D` relative to this node's parent .. rst-class:: classref-method -|void| **global_translate**\ (\ offset\: :ref:`Vector2`\ ) +|void| **global_translate**\ (\ offset\: :ref:`Vector2`\ ) :ref:`🔗` Adds the ``offset`` vector to the node's global position. @@ -376,7 +376,7 @@ Adds the ``offset`` vector to the node's global position. .. rst-class:: classref-method -|void| **look_at**\ (\ point\: :ref:`Vector2`\ ) +|void| **look_at**\ (\ point\: :ref:`Vector2`\ ) :ref:`🔗` Rotates the node so that its local +X axis points towards the ``point``, which is expected to use global coordinates. @@ -390,7 +390,7 @@ Rotates the node so that its local +X axis points towards the ``point``, which i .. rst-class:: classref-method -|void| **move_local_x**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) +|void| **move_local_x**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) :ref:`🔗` Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. @@ -402,7 +402,7 @@ Applies a local translation on the node's X axis based on the :ref:`Node._proces .. rst-class:: classref-method -|void| **move_local_y**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) +|void| **move_local_y**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) :ref:`🔗` Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. @@ -414,7 +414,7 @@ Applies a local translation on the node's Y axis based on the :ref:`Node._proces .. rst-class:: classref-method -|void| **rotate**\ (\ radians\: :ref:`float`\ ) +|void| **rotate**\ (\ radians\: :ref:`float`\ ) :ref:`🔗` Applies a rotation to the node, in radians, starting from its current rotation. @@ -426,7 +426,7 @@ Applies a rotation to the node, in radians, starting from its current rotation. .. rst-class:: classref-method -:ref:`Vector2` **to_global**\ (\ local_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **to_global**\ (\ local_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the **Node2D** it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position. @@ -438,7 +438,7 @@ Transforms the provided local position into a position in global coordinate spac .. rst-class:: classref-method -:ref:`Vector2` **to_local**\ (\ global_point\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **to_local**\ (\ global_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Transforms the provided global position into a position in local coordinate space. The output will be local relative to the **Node2D** it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent. @@ -450,7 +450,7 @@ Transforms the provided global position into a position in local coordinate spac .. rst-class:: classref-method -|void| **translate**\ (\ offset\: :ref:`Vector2`\ ) +|void| **translate**\ (\ offset\: :ref:`Vector2`\ ) :ref:`🔗` Translates the node by the given ``offset`` in local coordinates. diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index c8c77228b32..8721fcb3051 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -177,7 +177,7 @@ Signals .. rst-class:: classref-signal -**visibility_changed**\ (\ ) +**visibility_changed**\ (\ ) :ref:`🔗` Emitted when node visibility changes. @@ -194,7 +194,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **RotationEditMode**: +enum **RotationEditMode**: :ref:`🔗` .. _class_Node3D_constant_ROTATION_EDIT_MODE_EULER: @@ -233,7 +233,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` +**NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗` **Node3D** nodes receive this notification when their global transform changes. This means that either the current or a parent node changed its transform. @@ -243,7 +243,7 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` **Node3D** nodes receive this notification when they are registered to new :ref:`World3D` resource. @@ -251,7 +251,7 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` **Node3D** nodes receive this notification when they are unregistered from current :ref:`World3D` resource. @@ -259,7 +259,7 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` **Node3D** nodes receive this notification when their visibility changes. @@ -267,7 +267,7 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` **Node3D** nodes receive this notification when their local transform changes. This is not received when the transform of a parent node is changed. @@ -286,7 +286,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Basis` **basis** +:ref:`Basis` **basis** :ref:`🔗` .. rst-class:: classref-property-setget @@ -303,7 +303,7 @@ Basis of the :ref:`transform` property. Represe .. rst-class:: classref-property -:ref:`Basis` **global_basis** +:ref:`Basis` **global_basis** :ref:`🔗` .. rst-class:: classref-property-setget @@ -320,7 +320,7 @@ Global basis of this node. This is equivalent to ``global_transform.basis``. .. rst-class:: classref-property -:ref:`Vector3` **global_position** +:ref:`Vector3` **global_position** :ref:`🔗` .. rst-class:: classref-property-setget @@ -337,7 +337,7 @@ Global position of this node. This is equivalent to ``global_transform.origin``. .. rst-class:: classref-property -:ref:`Vector3` **global_rotation** +:ref:`Vector3` **global_rotation** :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +356,7 @@ Rotation part of the global transformation in radians, specified in terms of YXZ .. rst-class:: classref-property -:ref:`Vector3` **global_rotation_degrees** +:ref:`Vector3` **global_rotation_degrees** :ref:`🔗` .. rst-class:: classref-property-setget @@ -373,7 +373,7 @@ Helper property to access :ref:`global_rotation` **global_transform** +:ref:`Transform3D` **global_transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -390,7 +390,7 @@ World3D space (global) :ref:`Transform3D` of this node. .. rst-class:: classref-property -:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -407,7 +407,7 @@ Local position or translation of this node relative to the parent. This is equiv .. rst-class:: classref-property -:ref:`Quaternion` **quaternion** +:ref:`Quaternion` **quaternion** :ref:`🔗` .. rst-class:: classref-property-setget @@ -424,7 +424,7 @@ Access to the node rotation as a :ref:`Quaternion`. This prope .. rst-class:: classref-property -:ref:`Vector3` **rotation** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **rotation** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -445,7 +445,7 @@ Rotation part of the local transformation in radians, specified in terms of Eule .. rst-class:: classref-property -:ref:`Vector3` **rotation_degrees** +:ref:`Vector3` **rotation_degrees** :ref:`🔗` .. rst-class:: classref-property-setget @@ -462,7 +462,7 @@ Helper property to access :ref:`rotation` in deg .. rst-class:: classref-property -:ref:`RotationEditMode` **rotation_edit_mode** = ``0`` +:ref:`RotationEditMode` **rotation_edit_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -479,7 +479,7 @@ Specify how rotation (and scale) will be presented in the editor. .. rst-class:: classref-property -:ref:`EulerOrder` **rotation_order** = ``2`` +:ref:`EulerOrder` **rotation_order** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -496,7 +496,7 @@ Specify the axis rotation order of the :ref:`rotation` **scale** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **scale** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -517,7 +517,7 @@ Scale part of the local transformation. .. rst-class:: classref-property -:ref:`bool` **top_level** = ``false`` +:ref:`bool` **top_level** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -534,7 +534,7 @@ If ``true``, the node will not inherit its transformations from its parent. Node .. rst-class:: classref-property -:ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -551,7 +551,7 @@ Local space :ref:`Transform3D` of this node, with respect to .. rst-class:: classref-property -:ref:`NodePath` **visibility_parent** = ``NodePath("")`` +:ref:`NodePath` **visibility_parent** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -568,7 +568,7 @@ Defines the visibility range parent for this node and its subtree. The visibilit .. rst-class:: classref-property -:ref:`bool` **visible** = ``true`` +:ref:`bool` **visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -590,7 +590,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_gizmo**\ (\ gizmo\: :ref:`Node3DGizmo`\ ) +|void| **add_gizmo**\ (\ gizmo\: :ref:`Node3DGizmo`\ ) :ref:`🔗` Attach an editor gizmo to this **Node3D**. @@ -604,7 +604,7 @@ Attach an editor gizmo to this **Node3D**. .. rst-class:: classref-method -|void| **clear_gizmos**\ (\ ) +|void| **clear_gizmos**\ (\ ) :ref:`🔗` Clear all gizmos attached to this **Node3D**. @@ -616,7 +616,7 @@ Clear all gizmos attached to this **Node3D**. .. rst-class:: classref-method -|void| **clear_subgizmo_selection**\ (\ ) +|void| **clear_subgizmo_selection**\ (\ ) :ref:`🔗` Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs become invalid after a property change. @@ -628,7 +628,7 @@ Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs .. rst-class:: classref-method -|void| **force_update_transform**\ (\ ) +|void| **force_update_transform**\ (\ ) :ref:`🔗` Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. @@ -640,7 +640,7 @@ Forces the transform to update. Transform changes in physics are not instant for .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node3DGizmo`\] **get_gizmos**\ (\ ) |const| +:ref:`Array`\[:ref:`Node3DGizmo`\] **get_gizmos**\ (\ ) |const| :ref:`🔗` Returns all the gizmos attached to this **Node3D**. @@ -652,7 +652,7 @@ Returns all the gizmos attached to this **Node3D**. .. rst-class:: classref-method -:ref:`Node3D` **get_parent_node_3d**\ (\ ) |const| +:ref:`Node3D` **get_parent_node_3d**\ (\ ) |const| :ref:`🔗` Returns the parent **Node3D**, or ``null`` if no parent exists, the parent is not of type **Node3D**, or :ref:`top_level` is ``true``. @@ -666,7 +666,7 @@ Returns the parent **Node3D**, or ``null`` if no parent exists, the parent is no .. rst-class:: classref-method -:ref:`World3D` **get_world_3d**\ (\ ) |const| +:ref:`World3D` **get_world_3d**\ (\ ) |const| :ref:`🔗` Returns the current :ref:`World3D` resource this **Node3D** node is registered to. @@ -678,7 +678,7 @@ Returns the current :ref:`World3D` resource this **Node3D** node .. rst-class:: classref-method -|void| **global_rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) +|void| **global_rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. @@ -690,7 +690,7 @@ Rotates the global (world) transformation around axis, a unit :ref:`Vector3`\ ) +|void| **global_scale**\ (\ scale\: :ref:`Vector3`\ ) :ref:`🔗` Scales the global (world) transformation by the given :ref:`Vector3` scale factors. @@ -702,7 +702,7 @@ Scales the global (world) transformation by the given :ref:`Vector3`\ ) +|void| **global_translate**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. @@ -714,7 +714,7 @@ Moves the global (world) transformation by :ref:`Vector3` offset. .. rst-class:: classref-method -|void| **hide**\ (\ ) +|void| **hide**\ (\ ) :ref:`🔗` Disables rendering of this node. Changes :ref:`visible` to ``false``. @@ -726,7 +726,7 @@ Disables rendering of this node. Changes :ref:`visible` **is_local_transform_notification_enabled**\ (\ ) |const| +:ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` Returns whether node notifies about its local transformation changes. **Node3D** will not propagate this by default. @@ -738,7 +738,7 @@ Returns whether node notifies about its local transformation changes. **Node3D** .. rst-class:: classref-method -:ref:`bool` **is_scale_disabled**\ (\ ) |const| +:ref:`bool` **is_scale_disabled**\ (\ ) |const| :ref:`🔗` Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformation scale. @@ -750,7 +750,7 @@ Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformat .. rst-class:: classref-method -:ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| +:ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` Returns whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default. @@ -762,7 +762,7 @@ Returns whether the node notifies about its global and local transformation chan .. rst-class:: classref-method -:ref:`bool` **is_visible_in_tree**\ (\ ) |const| +:ref:`bool` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree. @@ -774,7 +774,7 @@ Returns ``true`` if the node is present in the :ref:`SceneTree` .. rst-class:: classref-method -|void| **look_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) +|void| **look_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) :ref:`🔗` Rotates the node so that the local forward axis (-Z, :ref:`Vector3.FORWARD`) points toward the ``target`` position. @@ -794,7 +794,7 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw .. rst-class:: classref-method -|void| **look_at_from_position**\ (\ position\: :ref:`Vector3`, target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) +|void| **look_at_from_position**\ (\ position\: :ref:`Vector3`, target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) :ref:`🔗` Moves the node to the specified ``position``, and then rotates the node to point toward the ``target`` as per :ref:`look_at`. Operations take place in global space. @@ -806,7 +806,7 @@ Moves the node to the specified ``position``, and then rotates the node to point .. rst-class:: classref-method -|void| **orthonormalize**\ (\ ) +|void| **orthonormalize**\ (\ ) :ref:`🔗` Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's :ref:`Transform3D`. @@ -818,7 +818,7 @@ Resets this node's transformations (like scale, skew and taper) preserving its r .. rst-class:: classref-method -|void| **rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) +|void| **rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. @@ -830,7 +830,7 @@ Rotates the local transformation around axis, a unit :ref:`Vector3`, angle\: :ref:`float`\ ) +|void| **rotate_object_local**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. @@ -842,7 +842,7 @@ Rotates the local transformation around axis, a unit :ref:`Vector3`\ ) +|void| **rotate_x**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` Rotates the local transformation around the X axis by angle in radians. @@ -854,7 +854,7 @@ Rotates the local transformation around the X axis by angle in radians. .. rst-class:: classref-method -|void| **rotate_y**\ (\ angle\: :ref:`float`\ ) +|void| **rotate_y**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` Rotates the local transformation around the Y axis by angle in radians. @@ -866,7 +866,7 @@ Rotates the local transformation around the Y axis by angle in radians. .. rst-class:: classref-method -|void| **rotate_z**\ (\ angle\: :ref:`float`\ ) +|void| **rotate_z**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` Rotates the local transformation around the Z axis by angle in radians. @@ -878,7 +878,7 @@ Rotates the local transformation around the Z axis by angle in radians. .. rst-class:: classref-method -|void| **scale_object_local**\ (\ scale\: :ref:`Vector3`\ ) +|void| **scale_object_local**\ (\ scale\: :ref:`Vector3`\ ) :ref:`🔗` Scales the local transformation by given 3D scale factors in object-local coordinate system. @@ -890,7 +890,7 @@ Scales the local transformation by given 3D scale factors in object-local coordi .. rst-class:: classref-method -|void| **set_disable_scale**\ (\ disable\: :ref:`bool`\ ) +|void| **set_disable_scale**\ (\ disable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation scale. Changes to the local transformation scale are preserved. @@ -902,7 +902,7 @@ Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation .. rst-class:: classref-method -|void| **set_identity**\ (\ ) +|void| **set_identity**\ (\ ) :ref:`🔗` Reset all transformations for this node (sets its :ref:`Transform3D` to the identity matrix). @@ -914,7 +914,7 @@ Reset all transformations for this node (sets its :ref:`Transform3D`\ ) +|void| **set_ignore_transform_notification**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` Sets whether the node ignores notification that its transformation (global or local) changed. @@ -926,7 +926,7 @@ Sets whether the node ignores notification that its transformation (global or lo .. rst-class:: classref-method -|void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) +|void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the node notifies about its local transformation changes. **Node3D** will not propagate this by default. @@ -938,7 +938,7 @@ Sets whether the node notifies about its local transformation changes. **Node3D* .. rst-class:: classref-method -|void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) +|void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default, unless it is in the editor context and it has a valid gizmo. @@ -950,7 +950,7 @@ Sets whether the node notifies about its global and local transformation changes .. rst-class:: classref-method -|void| **set_subgizmo_selection**\ (\ gizmo\: :ref:`Node3DGizmo`, id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **set_subgizmo_selection**\ (\ gizmo\: :ref:`Node3DGizmo`, id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Set subgizmo selection for this node in the editor. @@ -964,7 +964,7 @@ Set subgizmo selection for this node in the editor. .. rst-class:: classref-method -|void| **show**\ (\ ) +|void| **show**\ (\ ) :ref:`🔗` Enables rendering of this node. Changes :ref:`visible` to ``true``. @@ -976,7 +976,7 @@ Enables rendering of this node. Changes :ref:`visible` **to_global**\ (\ local_point\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **to_global**\ (\ local_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Transforms ``local_point`` from this node's local space to world space. @@ -988,7 +988,7 @@ Transforms ``local_point`` from this node's local space to world space. .. rst-class:: classref-method -:ref:`Vector3` **to_local**\ (\ global_point\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **to_local**\ (\ global_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Transforms ``global_point`` from world space to this node's local space. @@ -1000,7 +1000,7 @@ Transforms ``global_point`` from world space to this node's local space. .. rst-class:: classref-method -|void| **translate**\ (\ offset\: :ref:`Vector3`\ ) +|void| **translate**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` Changes the node's position by the given offset :ref:`Vector3`. @@ -1014,7 +1014,7 @@ Note that the translation ``offset`` is affected by the node's scale, so if scal .. rst-class:: classref-method -|void| **translate_object_local**\ (\ offset\: :ref:`Vector3`\ ) +|void| **translate_object_local**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` Changes the node's position by the given offset :ref:`Vector3` in local space. @@ -1026,7 +1026,7 @@ Changes the node's position by the given offset :ref:`Vector3` in .. rst-class:: classref-method -|void| **update_gizmos**\ (\ ) +|void| **update_gizmos**\ (\ ) :ref:`🔗` Updates all the **Node3D** gizmos attached to this node. diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 5835a8f0689..842dd3e8a9c 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -143,7 +143,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`NodePath` **NodePath**\ (\ ) +:ref:`NodePath` **NodePath**\ (\ ) :ref:`🔗` Constructs an empty **NodePath**. @@ -205,7 +205,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_as_property_path**\ (\ ) |const| +:ref:`NodePath` **get_as_property_path**\ (\ ) |const| :ref:`🔗` Returns a copy of this node path with a colon character (``:``) prefixed, transforming it to a pure property path with no node names (relative to the current node). @@ -240,7 +240,7 @@ Returns a copy of this node path with a colon character (``:``) prefixed, transf .. rst-class:: classref-method -:ref:`StringName` **get_concatenated_names**\ (\ ) |const| +:ref:`StringName` **get_concatenated_names**\ (\ ) |const| :ref:`🔗` Returns all node names concatenated with a slash character (``/``) as a single :ref:`StringName`. @@ -252,7 +252,7 @@ Returns all node names concatenated with a slash character (``/``) as a single : .. rst-class:: classref-method -:ref:`StringName` **get_concatenated_subnames**\ (\ ) |const| +:ref:`StringName` **get_concatenated_subnames**\ (\ ) |const| :ref:`🔗` Returns all property subnames concatenated with a colon character (``:``) as a single :ref:`StringName`. @@ -279,7 +279,7 @@ Returns all property subnames concatenated with a colon character (``:``) as a s .. rst-class:: classref-method -:ref:`StringName` **get_name**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_name**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the node name indicated by ``idx``, starting from 0. If ``idx`` is out of bounds, an error is generated. See also :ref:`get_subname_count` and :ref:`get_name_count`. @@ -310,7 +310,7 @@ Returns the node name indicated by ``idx``, starting from 0. If ``idx`` is out o .. rst-class:: classref-method -:ref:`int` **get_name_count**\ (\ ) |const| +:ref:`int` **get_name_count**\ (\ ) |const| :ref:`🔗` Returns the number of node names in the path. Property subnames are not included. @@ -324,7 +324,7 @@ For example, ``"../RigidBody2D/Sprite2D:texture"`` contains 3 node names. .. rst-class:: classref-method -:ref:`StringName` **get_subname**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_subname**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the property name indicated by ``idx``, starting from 0. If ``idx`` is out of bounds, an error is generated. See also :ref:`get_subname_count`. @@ -353,7 +353,7 @@ Returns the property name indicated by ``idx``, starting from 0. If ``idx`` is o .. rst-class:: classref-method -:ref:`int` **get_subname_count**\ (\ ) |const| +:ref:`int` **get_subname_count**\ (\ ) |const| :ref:`🔗` Returns the number of property names ("subnames") in the path. Each subname in the node path is listed after a colon character (``:``). @@ -367,7 +367,7 @@ For example, ``"Level/RigidBody2D/Sprite2D:texture:resource_name"`` contains 2 s .. rst-class:: classref-method -:ref:`int` **hash**\ (\ ) |const| +:ref:`int` **hash**\ (\ ) |const| :ref:`🔗` Returns the 32-bit hash value representing the node path's contents. @@ -381,7 +381,7 @@ Returns the 32-bit hash value representing the node path's contents. .. rst-class:: classref-method -:ref:`bool` **is_absolute**\ (\ ) |const| +:ref:`bool` **is_absolute**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node path is absolute. Unlike a relative path, an absolute path is represented by a leading slash character (``/``) and always begins from the :ref:`SceneTree`. It can be used to reliably access nodes from the root node (e.g. ``"/root/Global"`` if an autoload named "Global" exists). @@ -393,7 +393,7 @@ Returns ``true`` if the node path is absolute. Unlike a relative path, an absolu .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the node path has been constructed from an empty :ref:`String` (``""``). @@ -405,7 +405,7 @@ Returns ``true`` if the node path has been constructed from an empty :ref:`Strin .. rst-class:: classref-method -:ref:`NodePath` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`NodePath` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **NodePath**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **NodePath**. @@ -426,7 +426,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`NodePath`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`NodePath`\ ) :ref:`🔗` Returns ``true`` if two node paths are not equal. @@ -438,7 +438,7 @@ Returns ``true`` if two node paths are not equal. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`NodePath`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`NodePath`\ ) :ref:`🔗` Returns ``true`` if two node paths are equal, that is, they are composed of the same node names and subnames in the same order. diff --git a/classes/class_noise.rst b/classes/class_noise.rst index 4c47cb45651..fad4510dcde 100644 --- a/classes/class_noise.rst +++ b/classes/class_noise.rst @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Image` **get_image**\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| +:ref:`Image` **get_image**\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns an :ref:`Image` containing 2D noise values. @@ -82,7 +82,7 @@ Returns an :ref:`Image` containing 2D noise values. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Image`\] **get_image_3d**\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| +:ref:`Array`\[:ref:`Image`\] **get_image_3d**\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns an :ref:`Array` of :ref:`Image`\ s containing 3D noise values for use with :ref:`ImageTexture3D.create`. @@ -96,7 +96,7 @@ Returns an :ref:`Array` of :ref:`Image`\ s containing .. rst-class:: classref-method -:ref:`float` **get_noise_1d**\ (\ x\: :ref:`float`\ ) |const| +:ref:`float` **get_noise_1d**\ (\ x\: :ref:`float`\ ) |const| :ref:`🔗` Returns the 1D noise value at the given (x) coordinate. @@ -108,7 +108,7 @@ Returns the 1D noise value at the given (x) coordinate. .. rst-class:: classref-method -:ref:`float` **get_noise_2d**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) |const| +:ref:`float` **get_noise_2d**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) |const| :ref:`🔗` Returns the 2D noise value at the given position. @@ -120,7 +120,7 @@ Returns the 2D noise value at the given position. .. rst-class:: classref-method -:ref:`float` **get_noise_2dv**\ (\ v\: :ref:`Vector2`\ ) |const| +:ref:`float` **get_noise_2dv**\ (\ v\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the 2D noise value at the given position. @@ -132,7 +132,7 @@ Returns the 2D noise value at the given position. .. rst-class:: classref-method -:ref:`float` **get_noise_3d**\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`\ ) |const| +:ref:`float` **get_noise_3d**\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`\ ) |const| :ref:`🔗` Returns the 3D noise value at the given position. @@ -144,7 +144,7 @@ Returns the 3D noise value at the given position. .. rst-class:: classref-method -:ref:`float` **get_noise_3dv**\ (\ v\: :ref:`Vector3`\ ) |const| +:ref:`float` **get_noise_3dv**\ (\ v\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the 3D noise value at the given position. @@ -156,7 +156,7 @@ Returns the 3D noise value at the given position. .. rst-class:: classref-method -:ref:`Image` **get_seamless_image**\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| +:ref:`Image` **get_seamless_image**\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns an :ref:`Image` containing seamless 2D noise values. @@ -170,7 +170,7 @@ Returns an :ref:`Image` containing seamless 2D noise values. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Image`\] **get_seamless_image_3d**\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| +:ref:`Array`\[:ref:`Image`\] **get_seamless_image_3d**\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns an :ref:`Array` of :ref:`Image`\ s containing seamless 3D noise values for use with :ref:`ImageTexture3D.create`. diff --git a/classes/class_noisetexture2d.rst b/classes/class_noisetexture2d.rst index c9445f591b1..87439723364 100644 --- a/classes/class_noisetexture2d.rst +++ b/classes/class_noisetexture2d.rst @@ -80,7 +80,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **as_normal_map** = ``false`` +:ref:`bool` **as_normal_map** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ If ``true``, the resulting texture contains a normal map created from the origin .. rst-class:: classref-property -:ref:`float` **bump_strength** = ``8.0`` +:ref:`float` **bump_strength** = ``8.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ Strength of the bump maps used in this texture. A higher value will make the bum .. rst-class:: classref-property -:ref:`Gradient` **color_ramp** +:ref:`Gradient` **color_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ A :ref:`Gradient` which is used to map the luminance of each pix .. rst-class:: classref-property -:ref:`bool` **generate_mipmaps** = ``true`` +:ref:`bool` **generate_mipmaps** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ Determines whether mipmaps are generated for this texture. Enabling this results .. rst-class:: classref-property -:ref:`int` **height** = ``512`` +:ref:`int` **height** = ``512`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ Height of the generated texture (in pixels). .. rst-class:: classref-property -:ref:`bool` **in_3d_space** = ``false`` +:ref:`bool` **in_3d_space** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ Determines whether the noise image is calculated in 3D space. May result in redu .. rst-class:: classref-property -:ref:`bool` **invert** = ``false`` +:ref:`bool` **invert** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ If ``true``, inverts the noise texture. White becomes black, black becomes white .. rst-class:: classref-property -:ref:`Noise` **noise** +:ref:`Noise` **noise** :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ The instance of the :ref:`Noise` object. .. rst-class:: classref-property -:ref:`bool` **normalize** = ``true`` +:ref:`bool` **normalize** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ Turning normalization off can affect the contrast and allows you to generate non .. rst-class:: classref-property -:ref:`bool` **seamless** = ``false`` +:ref:`bool` **seamless** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ If ``true``, a seamless texture is requested from the :ref:`Noise` .. rst-class:: classref-property -:ref:`float` **seamless_blend_skirt** = ``0.1`` +:ref:`float` **seamless_blend_skirt** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ Used for the default/fallback implementation of the seamless texture generation. .. rst-class:: classref-property -:ref:`int` **width** = ``512`` +:ref:`int` **width** = ``512`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_noisetexture3d.rst b/classes/class_noisetexture3d.rst index 8e326be3707..29d82b62deb 100644 --- a/classes/class_noisetexture3d.rst +++ b/classes/class_noisetexture3d.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Gradient` **color_ramp** +:ref:`Gradient` **color_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ A :ref:`Gradient` which is used to map the luminance of each pix .. rst-class:: classref-property -:ref:`int` **depth** = ``64`` +:ref:`int` **depth** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ Depth of the generated texture (in pixels). .. rst-class:: classref-property -:ref:`int` **height** = ``64`` +:ref:`int` **height** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Height of the generated texture (in pixels). .. rst-class:: classref-property -:ref:`bool` **invert** = ``false`` +:ref:`bool` **invert** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ If ``true``, inverts the noise texture. White becomes black, black becomes white .. rst-class:: classref-property -:ref:`Noise` **noise** +:ref:`Noise` **noise** :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The instance of the :ref:`Noise` object. .. rst-class:: classref-property -:ref:`bool` **normalize** = ``true`` +:ref:`bool` **normalize** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -175,7 +175,7 @@ Turning normalization off can affect the contrast and allows you to generate non .. rst-class:: classref-property -:ref:`bool` **seamless** = ``false`` +:ref:`bool` **seamless** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ If ``true``, a seamless texture is requested from the :ref:`Noise` .. rst-class:: classref-property -:ref:`float` **seamless_blend_skirt** = ``0.1`` +:ref:`float` **seamless_blend_skirt** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ Used for the default/fallback implementation of the seamless texture generation. .. rst-class:: classref-property -:ref:`int` **width** = ``64`` +:ref:`int` **width** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_object.rst b/classes/class_object.rst index bcafbc2760a..a95ce41bb5b 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` Base class for all other classes in the engine. @@ -195,7 +195,7 @@ Signals .. rst-class:: classref-signal -**property_list_changed**\ (\ ) +**property_list_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`notify_property_list_changed` is called. @@ -207,7 +207,7 @@ Emitted when :ref:`notify_property_list_changed` Emitted when the object's script is changed. @@ -226,7 +226,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ConnectFlags**: +enum **ConnectFlags**: :ref:`🔗` .. _class_Object_constant_CONNECT_DEFERRED: @@ -273,7 +273,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_POSTINITIALIZE** = ``0`` +**NOTIFICATION_POSTINITIALIZE** = ``0`` :ref:`🔗` Notification received when the object is initialized, before its script is attached. Used internally. @@ -281,7 +281,7 @@ Notification received when the object is initialized, before its script is attac .. rst-class:: classref-constant -**NOTIFICATION_PREDELETE** = ``1`` +**NOTIFICATION_PREDELETE** = ``1`` :ref:`🔗` Notification received when the object is about to be deleted. Can act as the deconstructor of some programming languages. @@ -289,7 +289,7 @@ Notification received when the object is about to be deleted. Can act as the dec .. rst-class:: classref-constant -**NOTIFICATION_EXTENSION_RELOADED** = ``2`` +**NOTIFICATION_EXTENSION_RELOADED** = ``2`` :ref:`🔗` Notification received when the object finishes hot reloading. This notification is only sent for extensions classes and derived. @@ -306,7 +306,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get**\ (\ property\: :ref:`StringName`\ ) |virtual| +:ref:`Variant` **_get**\ (\ property\: :ref:`StringName`\ ) |virtual| :ref:`🔗` Override this method to customize the behavior of :ref:`get`. Should return the given ``property``'s value, or ``null`` if the ``property`` should be handled normally. @@ -361,7 +361,7 @@ Combined with :ref:`_set` and :ref:`_get_prope .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_property_list**\ (\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_property_list**\ (\ ) |virtual| :ref:`🔗` Override this method to provide a custom list of additional properties to handle by the engine. @@ -489,7 +489,7 @@ The example below displays a list of numbers shown as words going from ``ZERO`` .. rst-class:: classref-method -|void| **_init**\ (\ ) |virtual| +|void| **_init**\ (\ ) |virtual| :ref:`🔗` Called when the object's script is instantiated, oftentimes after the object is initialized in memory (through ``Object.new()`` in GDScript, or ``new GodotObject`` in C#). It can be also defined to take in parameters. This method is similar to a constructor in most programming languages. @@ -503,7 +503,7 @@ Called when the object's script is instantiated, oftentimes after the object is .. rst-class:: classref-method -|void| **_notification**\ (\ what\: :ref:`int`\ ) |virtual| +|void| **_notification**\ (\ what\: :ref:`int`\ ) |virtual| :ref:`🔗` Called when the object receives a notification, which can be identified in ``what`` by comparing it with a constant. See also :ref:`notification`. @@ -538,7 +538,7 @@ Called when the object receives a notification, which can be identified in ``wha .. rst-class:: classref-method -:ref:`bool` **_property_can_revert**\ (\ property\: :ref:`StringName`\ ) |virtual| +:ref:`bool` **_property_can_revert**\ (\ property\: :ref:`StringName`\ ) |virtual| :ref:`🔗` Override this method to customize the given ``property``'s revert behavior. Should return ``true`` if the ``property`` has a custom default value and is revertible in the Inspector dock. Use :ref:`_property_get_revert` to specify the ``property``'s default value. @@ -552,7 +552,7 @@ Override this method to customize the given ``property``'s revert behavior. Shou .. rst-class:: classref-method -:ref:`Variant` **_property_get_revert**\ (\ property\: :ref:`StringName`\ ) |virtual| +:ref:`Variant` **_property_get_revert**\ (\ property\: :ref:`StringName`\ ) |virtual| :ref:`🔗` Override this method to customize the given ``property``'s revert behavior. Should return the default value for the ``property``. If the default value differs from the ``property``'s current value, a revert icon is displayed in the Inspector dock. @@ -566,7 +566,7 @@ Override this method to customize the given ``property``'s revert behavior. Shou .. rst-class:: classref-method -:ref:`bool` **_set**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| +:ref:`bool` **_set**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Override this method to customize the behavior of :ref:`set`. Should set the ``property`` to ``value`` and return ``true``, or ``false`` if the ``property`` should be handled normally. The *exact* way to set the ``property`` is up to this method's implementation. @@ -629,7 +629,7 @@ Combined with :ref:`_get` and :ref:`_get_prope .. rst-class:: classref-method -:ref:`String` **_to_string**\ (\ ) |virtual| +:ref:`String` **_to_string**\ (\ ) |virtual| :ref:`🔗` Override this method to customize the return value of :ref:`to_string`, and therefore the object's representation as a :ref:`String`. @@ -650,7 +650,7 @@ Override this method to customize the return value of :ref:`to_string`\ ) |virtual| +|void| **_validate_property**\ (\ property\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` Override this method to customize existing properties. Every property info goes through this method, except properties added with :ref:`_get_property_list`. The dictionary contents is the same as in :ref:`_get_property_list`. @@ -713,7 +713,7 @@ Override this method to customize existing properties. Every property info goes .. rst-class:: classref-method -|void| **add_user_signal**\ (\ signal\: :ref:`String`, arguments\: :ref:`Array` = []\ ) +|void| **add_user_signal**\ (\ signal\: :ref:`String`, arguments\: :ref:`Array` = []\ ) :ref:`🔗` Adds a user-defined ``signal``. Optional arguments for the signal can be added as an :ref:`Array` of dictionaries, each defining a ``name`` :ref:`String` and a ``type`` :ref:`int` (see :ref:`Variant.Type`). See also :ref:`has_user_signal` and :ref:`remove_user_signal`. @@ -753,7 +753,7 @@ Adds a user-defined ``signal``. Optional arguments for the signal can be added a .. rst-class:: classref-method -:ref:`Variant` **call**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Variant` **call**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Calls the ``method`` on the object and returns the result. This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -782,7 +782,7 @@ Calls the ``method`` on the object and returns the result. This method supports .. rst-class:: classref-method -:ref:`Variant` **call_deferred**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Variant` **call_deferred**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Calls the ``method`` on the object during idle time. Always returns null, **not** the method's result. @@ -828,7 +828,7 @@ See also :ref:`Callable.call_deferred`. .. rst-class:: classref-method -:ref:`Variant` **callv**\ (\ method\: :ref:`StringName`, arg_array\: :ref:`Array`\ ) +:ref:`Variant` **callv**\ (\ method\: :ref:`StringName`, arg_array\: :ref:`Array`\ ) :ref:`🔗` Calls the ``method`` on the object and returns the result. Unlike :ref:`call`, this method expects all parameters to be contained inside ``arg_array``. @@ -857,7 +857,7 @@ Calls the ``method`` on the object and returns the result. Unlike :ref:`call` **can_translate_messages**\ (\ ) |const| +:ref:`bool` **can_translate_messages**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the object is allowed to translate messages with :ref:`tr` and :ref:`tr_n`. See also :ref:`set_message_translation`. @@ -869,7 +869,7 @@ Returns ``true`` if the object is allowed to translate messages with :ref:`tr` If this method is called during :ref:`NOTIFICATION_PREDELETE`, this object will reject being freed and will remain allocated. This is mostly an internal function used for error handling to avoid the user from freeing objects when they are not intended to. @@ -881,7 +881,7 @@ If this method is called during :ref:`NOTIFICATION_PREDELETE` **connect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) +:ref:`Error` **connect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) :ref:`🔗` Connects a ``signal`` by name to a ``callable``. Optional ``flags`` can be also added to configure the connection's behavior (see :ref:`ConnectFlags` constants). @@ -1043,7 +1043,7 @@ When calling :ref:`emit_signal` or :ref:`Signal .. rst-class:: classref-method -|void| **disconnect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) +|void| **disconnect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) :ref:`🔗` Disconnects a ``signal`` by name from a given ``callable``. If the connection does not exist, generates an error. Use :ref:`is_connected` to make sure that the connection exists. @@ -1055,7 +1055,7 @@ Disconnects a ``signal`` by name from a given ``callable``. If the connection do .. rst-class:: classref-method -:ref:`Error` **emit_signal**\ (\ signal\: :ref:`StringName`, ...\ ) |vararg| +:ref:`Error` **emit_signal**\ (\ signal\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Emits the given ``signal`` by name. The signal must exist, so it should be a built-in signal of this class or one of its inherited classes, or a user-defined signal (see :ref:`add_user_signal`). This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -1086,7 +1086,7 @@ Returns :ref:`@GlobalScope.ERR_UNAVAILABLE` Deletes the object from memory. Pre-existing references to the object become invalid, and any attempt to access them will result in a run-time error. Checking the references with :ref:`@GlobalScope.is_instance_valid` will return ``false``. @@ -1098,7 +1098,7 @@ Deletes the object from memory. Pre-existing references to the object become inv .. rst-class:: classref-method -:ref:`Variant` **get**\ (\ property\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`Variant` value of the given ``property``. If the ``property`` does not exist, this method returns ``null``. @@ -1129,7 +1129,7 @@ Returns the :ref:`Variant` value of the given ``property``. If th .. rst-class:: classref-method -:ref:`String` **get_class**\ (\ ) |const| +:ref:`String` **get_class**\ (\ ) |const| :ref:`🔗` Returns the object's built-in class name, as a :ref:`String`. See also :ref:`is_class`. @@ -1143,7 +1143,7 @@ Returns the object's built-in class name, as a :ref:`String`. See .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_incoming_connections**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_incoming_connections**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` of signal connections received by this object. Each connection is represented as a :ref:`Dictionary` that contains three entries: @@ -1161,7 +1161,7 @@ Returns an :ref:`Array` of signal connections received by this obje .. rst-class:: classref-method -:ref:`Variant` **get_indexed**\ (\ property_path\: :ref:`NodePath`\ ) |const| +:ref:`Variant` **get_indexed**\ (\ property_path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Gets the object's property indexed by the given ``property_path``. The path should be a :ref:`NodePath` relative to the current object and can use the colon character (``:``) to access nested properties. @@ -1198,7 +1198,7 @@ Gets the object's property indexed by the given ``property_path``. The path shou .. rst-class:: classref-method -:ref:`int` **get_instance_id**\ (\ ) |const| +:ref:`int` **get_instance_id**\ (\ ) |const| :ref:`🔗` Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedObjectAsID`, and can be used to retrieve this object instance with :ref:`@GlobalScope.instance_from_id`. @@ -1210,7 +1210,7 @@ Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedOb .. rst-class:: classref-method -:ref:`Variant` **get_meta**\ (\ name\: :ref:`StringName`, default\: :ref:`Variant` = null\ ) |const| +:ref:`Variant` **get_meta**\ (\ name\: :ref:`StringName`, default\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Returns the object's metadata value for the given entry ``name``. If the entry does not exist, returns ``default``. If ``default`` is ``null``, an error is also generated. @@ -1226,7 +1226,7 @@ Returns the object's metadata value for the given entry ``name``. If the entry d .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_meta_list**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **get_meta_list**\ (\ ) |const| :ref:`🔗` Returns the object's metadata entry names as a :ref:`PackedStringArray`. @@ -1238,7 +1238,7 @@ Returns the object's metadata entry names as a :ref:`PackedStringArray` **get_method_argument_count**\ (\ method\: :ref:`StringName`\ ) |const| +:ref:`int` **get_method_argument_count**\ (\ method\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the number of arguments of the given ``method`` by name. @@ -1252,7 +1252,7 @@ Returns the number of arguments of the given ``method`` by name. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_method_list**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_method_list**\ (\ ) |const| :ref:`🔗` Returns this object's methods and their signatures as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: @@ -1278,7 +1278,7 @@ Returns this object's methods and their signatures as an :ref:`Array`\[:ref:`Dictionary`\] **get_property_list**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_property_list**\ (\ ) |const| :ref:`🔗` Returns the object's property list as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: @@ -1304,7 +1304,7 @@ Returns the object's property list as an :ref:`Array` of dictionari .. rst-class:: classref-method -:ref:`Variant` **get_script**\ (\ ) |const| +:ref:`Variant` **get_script**\ (\ ) |const| :ref:`🔗` Returns the object's :ref:`Script` instance, or ``null`` if no script is attached. @@ -1316,7 +1316,7 @@ Returns the object's :ref:`Script` instance, or ``null`` if no scr .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_signal_connection_list**\ (\ signal\: :ref:`StringName`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_signal_connection_list**\ (\ signal\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns an :ref:`Array` of connections for the given ``signal`` name. Each connection is represented as a :ref:`Dictionary` that contains three entries: @@ -1334,7 +1334,7 @@ Returns an :ref:`Array` of connections for the given ``signal`` nam .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_signal_list**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_signal_list**\ (\ ) |const| :ref:`🔗` Returns the list of existing signals as an :ref:`Array` of dictionaries. @@ -1348,7 +1348,7 @@ Returns the list of existing signals as an :ref:`Array` of dictiona .. rst-class:: classref-method -:ref:`bool` **has_meta**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_meta**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a metadata entry is found with the given ``name``. See also :ref:`get_meta`, :ref:`set_meta` and :ref:`remove_meta`. @@ -1364,7 +1364,7 @@ Returns ``true`` if a metadata entry is found with the given ``name``. See also .. rst-class:: classref-method -:ref:`bool` **has_method**\ (\ method\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_method**\ (\ method\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``method`` name exists in the object. @@ -1378,7 +1378,7 @@ Returns ``true`` if the given ``method`` name exists in the object. .. rst-class:: classref-method -:ref:`bool` **has_signal**\ (\ signal\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_signal**\ (\ signal\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``signal`` name exists in the object. @@ -1392,7 +1392,7 @@ Returns ``true`` if the given ``signal`` name exists in the object. .. rst-class:: classref-method -:ref:`bool` **has_user_signal**\ (\ signal\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_user_signal**\ (\ signal\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the given user-defined ``signal`` name exists. Only signals added with :ref:`add_user_signal` are included. See also :ref:`remove_user_signal`. @@ -1404,7 +1404,7 @@ Returns ``true`` if the given user-defined ``signal`` name exists. Only signals .. rst-class:: classref-method -:ref:`bool` **is_blocking_signals**\ (\ ) |const| +:ref:`bool` **is_blocking_signals**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the object is blocking its signals from being emitted. See :ref:`set_block_signals`. @@ -1416,7 +1416,7 @@ Returns ``true`` if the object is blocking its signals from being emitted. See : .. rst-class:: classref-method -:ref:`bool` **is_class**\ (\ class\: :ref:`String`\ ) |const| +:ref:`bool` **is_class**\ (\ class\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the object inherits from the given ``class``. See also :ref:`get_class`. @@ -1449,7 +1449,7 @@ Returns ``true`` if the object inherits from the given ``class``. See also :ref: .. rst-class:: classref-method -:ref:`bool` **is_connected**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) |const| +:ref:`bool` **is_connected**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) |const| :ref:`🔗` Returns ``true`` if a connection exists between the given ``signal`` name and ``callable``. @@ -1463,7 +1463,7 @@ Returns ``true`` if a connection exists between the given ``signal`` name and `` .. rst-class:: classref-method -:ref:`bool` **is_queued_for_deletion**\ (\ ) |const| +:ref:`bool` **is_queued_for_deletion**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`Node.queue_free` method was called for the object. @@ -1475,7 +1475,7 @@ Returns ``true`` if the :ref:`Node.queue_free` met .. rst-class:: classref-method -|void| **notification**\ (\ what\: :ref:`int`, reversed\: :ref:`bool` = false\ ) +|void| **notification**\ (\ what\: :ref:`int`, reversed\: :ref:`bool` = false\ ) :ref:`🔗` Sends the given ``what`` notification to all classes inherited by the object, triggering calls to :ref:`_notification`, starting from the highest ancestor (the **Object** class) and going down to the object's script. @@ -1516,7 +1516,7 @@ If ``reversed`` is ``true``, the call order is reversed. .. rst-class:: classref-method -|void| **notify_property_list_changed**\ (\ ) +|void| **notify_property_list_changed**\ (\ ) :ref:`🔗` Emits the :ref:`property_list_changed` signal. This is mainly used to refresh the editor, so that the Inspector and editor plugins are properly updated. @@ -1528,7 +1528,7 @@ Emits the :ref:`property_list_changed .. rst-class:: classref-method -:ref:`bool` **property_can_revert**\ (\ property\: :ref:`StringName`\ ) |const| +:ref:`bool` **property_can_revert**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``property`` has a custom default value. Use :ref:`property_get_revert` to get the ``property``'s default value. @@ -1542,7 +1542,7 @@ Returns ``true`` if the given ``property`` has a custom default value. Use :ref: .. rst-class:: classref-method -:ref:`Variant` **property_get_revert**\ (\ property\: :ref:`StringName`\ ) |const| +:ref:`Variant` **property_get_revert**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the custom default value of the given ``property``. Use :ref:`property_can_revert` to check if the ``property`` has a custom default value. @@ -1556,7 +1556,7 @@ Returns the custom default value of the given ``property``. Use :ref:`property_c .. rst-class:: classref-method -|void| **remove_meta**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_meta**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the given entry ``name`` from the object's metadata. See also :ref:`has_meta`, :ref:`get_meta` and :ref:`set_meta`. @@ -1572,7 +1572,7 @@ Removes the given entry ``name`` from the object's metadata. See also :ref:`has_ .. rst-class:: classref-method -|void| **remove_user_signal**\ (\ signal\: :ref:`StringName`\ ) +|void| **remove_user_signal**\ (\ signal\: :ref:`StringName`\ ) :ref:`🔗` Removes the given user signal ``signal`` from the object. See also :ref:`add_user_signal` and :ref:`has_user_signal`. @@ -1584,7 +1584,7 @@ Removes the given user signal ``signal`` from the object. See also :ref:`add_use .. rst-class:: classref-method -|void| **set**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Assigns ``value`` to the given ``property``. If the property does not exist or the given ``value``'s type doesn't match, nothing happens. @@ -1615,7 +1615,7 @@ Assigns ``value`` to the given ``property``. If the property does not exist or t .. rst-class:: classref-method -|void| **set_block_signals**\ (\ enable\: :ref:`bool`\ ) +|void| **set_block_signals**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, the object becomes unable to emit signals. As such, :ref:`emit_signal` and signal connections will not work, until it is set to ``false``. @@ -1627,7 +1627,7 @@ If set to ``true``, the object becomes unable to emit signals. As such, :ref:`em .. rst-class:: classref-method -|void| **set_deferred**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_deferred**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Assigns ``value`` to the given ``property``, at the end of the current frame. This is equivalent to calling :ref:`set` through :ref:`call_deferred`. @@ -1668,7 +1668,7 @@ Assigns ``value`` to the given ``property``, at the end of the current frame. Th .. rst-class:: classref-method -|void| **set_indexed**\ (\ property_path\: :ref:`NodePath`, value\: :ref:`Variant`\ ) +|void| **set_indexed**\ (\ property_path\: :ref:`NodePath`, value\: :ref:`Variant`\ ) :ref:`🔗` Assigns a new ``value`` to the property identified by the ``property_path``. The path should be a :ref:`NodePath` relative to this object, and can use the colon character (``:``) to access nested properties. @@ -1701,7 +1701,7 @@ Assigns a new ``value`` to the property identified by the ``property_path``. The .. rst-class:: classref-method -|void| **set_message_translation**\ (\ enable\: :ref:`bool`\ ) +|void| **set_message_translation**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, allows the object to translate messages with :ref:`tr` and :ref:`tr_n`. Enabled by default. See also :ref:`can_translate_messages`. @@ -1713,7 +1713,7 @@ If set to ``true``, allows the object to translate messages with :ref:`tr`, value\: :ref:`Variant`\ ) +|void| **set_meta**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Adds or changes the entry ``name`` inside the object's metadata. The metadata ``value`` can be any :ref:`Variant`, although some types cannot be serialized correctly. @@ -1731,7 +1731,7 @@ If ``value`` is ``null``, the entry is removed. This is the equivalent of using .. rst-class:: classref-method -|void| **set_script**\ (\ script\: :ref:`Variant`\ ) +|void| **set_script**\ (\ script\: :ref:`Variant`\ ) :ref:`🔗` Attaches ``script`` to the object, and instantiates it. As a result, the script's :ref:`_init` is called. A :ref:`Script` is used to extend the object's functionality. @@ -1745,7 +1745,7 @@ If a script already exists, its instance is detached, and its property values an .. rst-class:: classref-method -:ref:`String` **to_string**\ (\ ) +:ref:`String` **to_string**\ (\ ) :ref:`🔗` Returns a :ref:`String` representing the object. Defaults to ``""``. Override :ref:`_to_string` to customize the string representation of the object. @@ -1757,7 +1757,7 @@ Returns a :ref:`String` representing the object. Defaults to ``"` **tr**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| +:ref:`String` **tr**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Translates a ``message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. Note that most :ref:`Control` nodes automatically translate their strings, so this method is mostly useful for formatted strings or custom drawn text. @@ -1775,7 +1775,7 @@ For detailed examples, see :doc:`Internationalizing games <../tutorials/i18n/int .. rst-class:: classref-method -:ref:`String` **tr_n**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| +:ref:`String` **tr_n**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Translates a ``message`` or ``plural_message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. diff --git a/classes/class_occluder3d.rst b/classes/class_occluder3d.rst index 26e36199c6f..3adc96f721b 100644 --- a/classes/class_occluder3d.rst +++ b/classes/class_occluder3d.rst @@ -59,7 +59,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_indices**\ (\ ) |const| +:ref:`PackedInt32Array` **get_indices**\ (\ ) |const| :ref:`🔗` Returns the occluder shape's vertex indices. @@ -71,7 +71,7 @@ Returns the occluder shape's vertex indices. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_vertices**\ (\ ) |const| +:ref:`PackedVector3Array` **get_vertices**\ (\ ) |const| :ref:`🔗` Returns the occluder shape's vertex positions. diff --git a/classes/class_occluderinstance3d.rst b/classes/class_occluderinstance3d.rst index b1380983f45..cec65f8afbf 100644 --- a/classes/class_occluderinstance3d.rst +++ b/classes/class_occluderinstance3d.rst @@ -81,7 +81,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bake_mask** = ``4294967295`` +:ref:`int` **bake_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -100,7 +100,7 @@ To improve performance and avoid artifacts, it is recommended to exclude dynamic .. rst-class:: classref-property -:ref:`float` **bake_simplification_distance** = ``0.1`` +:ref:`float` **bake_simplification_distance** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Setting this to ``0.0`` disables simplification entirely, but vertices in the ex .. rst-class:: classref-property -:ref:`Occluder3D` **occluder** +:ref:`Occluder3D` **occluder** :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_bake_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_bake_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`bake_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -161,7 +161,7 @@ Returns whether or not the specified layer of the :ref:`bake_mask`, value\: :ref:`bool`\ ) +|void| **set_bake_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`bake_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 526c0d6ed93..896ac20c74c 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CullMode**: +enum **CullMode**: :ref:`🔗` .. _class_OccluderPolygon2D_constant_CULL_DISABLED: @@ -89,7 +89,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **closed** = ``true`` +:ref:`bool` **closed** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -106,7 +106,7 @@ If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light c .. rst-class:: classref-property -:ref:`CullMode` **cull_mode** = ``0`` +:ref:`CullMode` **cull_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ The culling mode to use. .. rst-class:: classref-property -:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_oggpacketsequence.rst b/classes/class_oggpacketsequence.rst index 66230031eb5..e4b1928438b 100644 --- a/classes/class_oggpacketsequence.rst +++ b/classes/class_oggpacketsequence.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt64Array` **granule_positions** = ``PackedInt64Array()`` +:ref:`PackedInt64Array` **granule_positions** = ``PackedInt64Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -81,7 +81,7 @@ Contains the granule positions for each page in this packet sequence. .. rst-class:: classref-property -:ref:`Array`\[:ref:`Array`\] **packet_data** = ``[]`` +:ref:`Array`\[:ref:`Array`\] **packet_data** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -98,7 +98,7 @@ Contains the raw packets that make up this OggPacketSequence. .. rst-class:: classref-property -:ref:`float` **sampling_rate** = ``0.0`` +:ref:`float` **sampling_rate** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_length**\ (\ ) |const| +:ref:`float` **get_length**\ (\ ) |const| :ref:`🔗` The length of this stream, in seconds. diff --git a/classes/class_omnilight3d.rst b/classes/class_omnilight3d.rst index 080c50489a5..87e076b3605 100644 --- a/classes/class_omnilight3d.rst +++ b/classes/class_omnilight3d.rst @@ -68,7 +68,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ShadowMode**: +enum **ShadowMode**: :ref:`🔗` .. _class_OmniLight3D_constant_SHADOW_DUAL_PARABOLOID: @@ -99,7 +99,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **omni_attenuation** = ``1.0`` +:ref:`float` **omni_attenuation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ A value of ``0.0`` smoothly attenuates light at the edge of the range. A value o .. rst-class:: classref-property -:ref:`float` **omni_range** = ``5.0`` +:ref:`float` **omni_range** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ The light's radius. Note that the effectively lit area may appear to be smaller .. rst-class:: classref-property -:ref:`ShadowMode` **omni_shadow_mode** = ``1`` +:ref:`ShadowMode` **omni_shadow_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_openxraction.rst b/classes/class_openxraction.rst index 23da5b6e0e2..bf367a74145 100644 --- a/classes/class_openxraction.rst +++ b/classes/class_openxraction.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ActionType**: +enum **ActionType**: :ref:`🔗` .. _class_OpenXRAction_constant_OPENXR_ACTION_BOOL: @@ -107,7 +107,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ActionType` **action_type** = ``1`` +:ref:`ActionType` **action_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ The type of action. .. rst-class:: classref-property -:ref:`String` **localized_name** = ``""`` +:ref:`String` **localized_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ The localized description of this action. .. rst-class:: classref-property -:ref:`PackedStringArray` **toplevel_paths** = ``PackedStringArray()`` +:ref:`PackedStringArray` **toplevel_paths** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_openxractionmap.rst b/classes/class_openxractionmap.rst index 26e6827243a..7265681d325 100644 --- a/classes/class_openxractionmap.rst +++ b/classes/class_openxractionmap.rst @@ -84,7 +84,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array` **action_sets** = ``[]`` +:ref:`Array` **action_sets** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ Collection of :ref:`OpenXRActionSet`\ s that are part of .. rst-class:: classref-property -:ref:`Array` **interaction_profiles** = ``[]`` +:ref:`Array` **interaction_profiles** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_action_set**\ (\ action_set\: :ref:`OpenXRActionSet`\ ) +|void| **add_action_set**\ (\ action_set\: :ref:`OpenXRActionSet`\ ) :ref:`🔗` Add an action set. @@ -135,7 +135,7 @@ Add an action set. .. rst-class:: classref-method -|void| **add_interaction_profile**\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) +|void| **add_interaction_profile**\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) :ref:`🔗` Add an interaction profile. @@ -147,7 +147,7 @@ Add an interaction profile. .. rst-class:: classref-method -|void| **create_default_action_sets**\ (\ ) +|void| **create_default_action_sets**\ (\ ) :ref:`🔗` Setup this action set with our default actions. @@ -159,7 +159,7 @@ Setup this action set with our default actions. .. rst-class:: classref-method -:ref:`OpenXRActionSet` **find_action_set**\ (\ name\: :ref:`String`\ ) |const| +:ref:`OpenXRActionSet` **find_action_set**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Retrieve an action set by name. @@ -171,7 +171,7 @@ Retrieve an action set by name. .. rst-class:: classref-method -:ref:`OpenXRInteractionProfile` **find_interaction_profile**\ (\ name\: :ref:`String`\ ) |const| +:ref:`OpenXRInteractionProfile` **find_interaction_profile**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Find an interaction profile by its name (path). @@ -183,7 +183,7 @@ Find an interaction profile by its name (path). .. rst-class:: classref-method -:ref:`OpenXRActionSet` **get_action_set**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`OpenXRActionSet` **get_action_set**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Retrieve the action set at this index. @@ -195,7 +195,7 @@ Retrieve the action set at this index. .. rst-class:: classref-method -:ref:`int` **get_action_set_count**\ (\ ) |const| +:ref:`int` **get_action_set_count**\ (\ ) |const| :ref:`🔗` Retrieve the number of actions sets in our action map. @@ -207,7 +207,7 @@ Retrieve the number of actions sets in our action map. .. rst-class:: classref-method -:ref:`OpenXRInteractionProfile` **get_interaction_profile**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`OpenXRInteractionProfile` **get_interaction_profile**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Get the interaction profile at this index. @@ -219,7 +219,7 @@ Get the interaction profile at this index. .. rst-class:: classref-method -:ref:`int` **get_interaction_profile_count**\ (\ ) |const| +:ref:`int` **get_interaction_profile_count**\ (\ ) |const| :ref:`🔗` Retrieve the number of interaction profiles in our action map. @@ -231,7 +231,7 @@ Retrieve the number of interaction profiles in our action map. .. rst-class:: classref-method -|void| **remove_action_set**\ (\ action_set\: :ref:`OpenXRActionSet`\ ) +|void| **remove_action_set**\ (\ action_set\: :ref:`OpenXRActionSet`\ ) :ref:`🔗` Remove an action set. @@ -243,7 +243,7 @@ Remove an action set. .. rst-class:: classref-method -|void| **remove_interaction_profile**\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) +|void| **remove_interaction_profile**\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) :ref:`🔗` Remove an interaction profile. diff --git a/classes/class_openxractionset.rst b/classes/class_openxractionset.rst index 9c2e2791bac..7647dd15cff 100644 --- a/classes/class_openxractionset.rst +++ b/classes/class_openxractionset.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array` **actions** = ``[]`` +:ref:`Array` **actions** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,7 +85,7 @@ Collection of actions for this action set. .. rst-class:: classref-property -:ref:`String` **localized_name** = ``""`` +:ref:`String` **localized_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ The localized name of this action set. .. rst-class:: classref-property -:ref:`int` **priority** = ``0`` +:ref:`int` **priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_action**\ (\ action\: :ref:`OpenXRAction`\ ) +|void| **add_action**\ (\ action\: :ref:`OpenXRAction`\ ) :ref:`🔗` Add an action to this action set. @@ -136,7 +136,7 @@ Add an action to this action set. .. rst-class:: classref-method -:ref:`int` **get_action_count**\ (\ ) |const| +:ref:`int` **get_action_count**\ (\ ) |const| :ref:`🔗` Retrieve the number of actions in our action set. @@ -148,7 +148,7 @@ Retrieve the number of actions in our action set. .. rst-class:: classref-method -|void| **remove_action**\ (\ action\: :ref:`OpenXRAction`\ ) +|void| **remove_action**\ (\ action\: :ref:`OpenXRAction`\ ) :ref:`🔗` Remove an action from this action set. diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index 03390fcbef7..60781adebea 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -105,7 +105,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpenXRAlphaBlendModeSupport**: +enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗` .. _class_OpenXRAPIExtension_constant_OPENXR_ALPHA_BLEND_MODE_SUPPORT_NONE: @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_render**\ (\ ) +:ref:`bool` **can_render**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR is initialized for rendering with an XR viewport. @@ -156,7 +156,7 @@ Returns ``true`` if OpenXR is initialized for rendering with an XR viewport. .. rst-class:: classref-method -:ref:`String` **get_error_string**\ (\ result\: :ref:`int`\ ) +:ref:`String` **get_error_string**\ (\ result\: :ref:`int`\ ) :ref:`🔗` Returns an error string for the given `XrResult `__. @@ -168,7 +168,7 @@ Returns an error string for the given `XrResult ` **get_hand_tracker**\ (\ hand_index\: :ref:`int`\ ) +:ref:`int` **get_hand_tracker**\ (\ hand_index\: :ref:`int`\ ) :ref:`🔗` Returns the corresponding ``XRHandTrackerEXT`` handle for the given hand index value. @@ -180,7 +180,7 @@ Returns the corresponding ``XRHandTrackerEXT`` handle for the given hand index v .. rst-class:: classref-method -:ref:`int` **get_instance**\ (\ ) +:ref:`int` **get_instance**\ (\ ) :ref:`🔗` Returns the `XrInstance `__ created during the initialization of the OpenXR API. @@ -192,7 +192,7 @@ Returns the `XrInstance ` **get_instance_proc_addr**\ (\ name\: :ref:`String`\ ) +:ref:`int` **get_instance_proc_addr**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Returns the function pointer of the OpenXR function with the specified name, cast to an integer. If the function with the given name does not exist, the method returns ``0``. @@ -206,7 +206,7 @@ Returns the function pointer of the OpenXR function with the specified name, cas .. rst-class:: classref-method -:ref:`int` **get_next_frame_time**\ (\ ) +:ref:`int` **get_next_frame_time**\ (\ ) :ref:`🔗` Returns the predicted display timing for the next frame. @@ -218,7 +218,7 @@ Returns the predicted display timing for the next frame. .. rst-class:: classref-method -:ref:`int` **get_play_space**\ (\ ) +:ref:`int` **get_play_space**\ (\ ) :ref:`🔗` Returns the play space, which is an `XrSpace `__ cast to an integer. @@ -230,7 +230,7 @@ Returns the play space, which is an `XrSpace ` **get_predicted_display_time**\ (\ ) +:ref:`int` **get_predicted_display_time**\ (\ ) :ref:`🔗` Returns the predicted display timing for the current frame. @@ -242,7 +242,7 @@ Returns the predicted display timing for the current frame. .. rst-class:: classref-method -:ref:`int` **get_session**\ (\ ) +:ref:`int` **get_session**\ (\ ) :ref:`🔗` Returns the OpenXR session, which is an `XrSession `__ cast to an integer. @@ -254,7 +254,7 @@ Returns the OpenXR session, which is an `XrSession ` **get_swapchain_format_name**\ (\ swapchain_format\: :ref:`int`\ ) +:ref:`String` **get_swapchain_format_name**\ (\ swapchain_format\: :ref:`int`\ ) :ref:`🔗` Returns the name of the specified swapchain format. @@ -266,7 +266,7 @@ Returns the name of the specified swapchain format. .. rst-class:: classref-method -:ref:`int` **get_system_id**\ (\ ) +:ref:`int` **get_system_id**\ (\ ) :ref:`🔗` Returns the id of the system, which is a `XrSystemId `__ cast to an integer. @@ -278,7 +278,7 @@ Returns the id of the system, which is a `XrSystemId ` **is_environment_blend_mode_alpha_supported**\ (\ ) +:ref:`OpenXRAlphaBlendModeSupport` **is_environment_blend_mode_alpha_supported**\ (\ ) :ref:`🔗` Returns :ref:`OpenXRAlphaBlendModeSupport` denoting if :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` is really supported, emulated or not supported at all. @@ -290,7 +290,7 @@ Returns :ref:`OpenXRAlphaBlendModeSupport` **is_initialized**\ (\ ) +:ref:`bool` **is_initialized**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR is initialized. @@ -302,7 +302,7 @@ Returns ``true`` if OpenXR is initialized. .. rst-class:: classref-method -:ref:`bool` **is_running**\ (\ ) +:ref:`bool` **is_running**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR is running (`xrBeginSession `__ was successfully called and the swapchains were created). @@ -314,7 +314,7 @@ Returns ``true`` if OpenXR is running (`xrBeginSession ` **openxr_is_enabled**\ (\ check_run_in_editor\: :ref:`bool`\ ) |static| +:ref:`bool` **openxr_is_enabled**\ (\ check_run_in_editor\: :ref:`bool`\ ) |static| :ref:`🔗` Returns ``true`` if OpenXR is enabled. @@ -326,7 +326,7 @@ Returns ``true`` if OpenXR is enabled. .. rst-class:: classref-method -|void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) +|void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` Registers the given extension as a composition layer provider. @@ -338,7 +338,7 @@ Registers the given extension as a composition layer provider. .. rst-class:: classref-method -|void| **set_emulate_environment_blend_mode_alpha_blend**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_emulate_environment_blend_mode_alpha_blend**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, an OpenXR extension is loaded which is capable of emulating the :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` blend mode. @@ -350,7 +350,7 @@ If set to ``true``, an OpenXR extension is loaded which is capable of emulating .. rst-class:: classref-method -:ref:`Transform3D` **transform_from_pose**\ (\ pose\: ``const void*``\ ) +:ref:`Transform3D` **transform_from_pose**\ (\ pose\: ``const void*``\ ) :ref:`🔗` Creates a :ref:`Transform3D` from an `XrPosef `__. @@ -362,7 +362,7 @@ Creates a :ref:`Transform3D` from an `XrPosef `\ ) +|void| **unregister_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` Unregisters the given extension as a composition layer provider. @@ -374,7 +374,7 @@ Unregisters the given extension as a composition layer provider. .. rst-class:: classref-method -:ref:`bool` **xr_result**\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) +:ref:`bool` **xr_result**\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) :ref:`🔗` Returns ``true`` if the provided `XrResult `__ (cast to an integer) is successful. Otherwise returns ``false`` and prints the `XrResult `__ converted to a string, with the specified additional information. diff --git a/classes/class_openxrcompositionlayer.rst b/classes/class_openxrcompositionlayer.rst index 84a3575784a..751e86fabe5 100644 --- a/classes/class_openxrcompositionlayer.rst +++ b/classes/class_openxrcompositionlayer.rst @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **alpha_blend** = ``false`` +:ref:`bool` **alpha_blend** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -91,7 +91,7 @@ Can be combined with :ref:`Viewport.transparent_bg` **enable_hole_punch** = ``false`` +:ref:`bool` **enable_hole_punch** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ This can be used to create the illusion that the composition layer exists in the .. rst-class:: classref-property -:ref:`SubViewport` **layer_viewport** +:ref:`SubViewport` **layer_viewport** :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ The :ref:`SubViewport` to render on the composition layer. .. rst-class:: classref-property -:ref:`int` **sort_order** = ``1`` +:ref:`int` **sort_order** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **intersects_ray**\ (\ origin\: :ref:`Vector3`, direction\: :ref:`Vector3`\ ) |const| +:ref:`Vector2` **intersects_ray**\ (\ origin\: :ref:`Vector3`, direction\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns UV coordinates where the given ray intersects with the composition layer. ``origin`` and ``direction`` must be in global space. @@ -165,7 +165,7 @@ Returns ``Vector2(-1.0, -1.0)`` if the ray doesn't intersect. .. rst-class:: classref-method -:ref:`bool` **is_natively_supported**\ (\ ) |const| +:ref:`bool` **is_natively_supported**\ (\ ) |const| :ref:`🔗` Returns true if the OpenXR runtime natively supports this composition layer type. diff --git a/classes/class_openxrcompositionlayercylinder.rst b/classes/class_openxrcompositionlayercylinder.rst index a3298511349..05e44866d6a 100644 --- a/classes/class_openxrcompositionlayercylinder.rst +++ b/classes/class_openxrcompositionlayercylinder.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **aspect_ratio** = ``1.0`` +:ref:`float` **aspect_ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ The aspect ratio of the slice. Used to set the height relative to the width. .. rst-class:: classref-property -:ref:`float` **central_angle** = ``1.5708`` +:ref:`float` **central_angle** = ``1.5708`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ The central angle of the cylinder. Used to set the width. .. rst-class:: classref-property -:ref:`int` **fallback_segments** = ``10`` +:ref:`int` **fallback_segments** = ``10`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The number of segments to use in the fallback mesh. .. rst-class:: classref-property -:ref:`float` **radius** = ``1.0`` +:ref:`float` **radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_openxrcompositionlayerequirect.rst b/classes/class_openxrcompositionlayerequirect.rst index 09cd36d8565..2992d3e1331 100644 --- a/classes/class_openxrcompositionlayerequirect.rst +++ b/classes/class_openxrcompositionlayerequirect.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **central_horizontal_angle** = ``1.5708`` +:ref:`float` **central_horizontal_angle** = ``1.5708`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ The central horizontal angle of the sphere. Used to set the width. .. rst-class:: classref-property -:ref:`int` **fallback_segments** = ``10`` +:ref:`int` **fallback_segments** = ``10`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The number of segments to use in the fallback mesh. .. rst-class:: classref-property -:ref:`float` **lower_vertical_angle** = ``0.785398`` +:ref:`float` **lower_vertical_angle** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The lower vertical angle of the sphere. Used (together with :ref:`upper_vertical .. rst-class:: classref-property -:ref:`float` **radius** = ``1.0`` +:ref:`float` **radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ The radius of the sphere. .. rst-class:: classref-property -:ref:`float` **upper_vertical_angle** = ``0.785398`` +:ref:`float` **upper_vertical_angle** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_openxrcompositionlayerquad.rst b/classes/class_openxrcompositionlayerquad.rst index 98e8ce83ce0..42a5dac104c 100644 --- a/classes/class_openxrcompositionlayerquad.rst +++ b/classes/class_openxrcompositionlayerquad.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **quad_size** = ``Vector2(1, 1)`` +:ref:`Vector2` **quad_size** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_openxrextensionwrapperextension.rst b/classes/class_openxrextensionwrapperextension.rst index a56a5d86fb9..672d1ab4b43 100644 --- a/classes/class_openxrextensionwrapperextension.rst +++ b/classes/class_openxrextensionwrapperextension.rst @@ -52,6 +52,8 @@ Methods +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_main_swapchains_created`\ (\ ) |virtual| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_on_process`\ (\ ) |virtual| | @@ -110,7 +112,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| +:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` Returns a pointer to an ``XrCompositionLayerBaseHeader`` struct to provide the given composition layer. @@ -124,7 +126,7 @@ This will only be called if the extension previously registered itself with :ref .. rst-class:: classref-method -:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| +:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| :ref:`🔗` Returns the number of composition layers this extension wrapper provides via :ref:`_get_composition_layer`. @@ -138,7 +140,7 @@ This will only be called if the extension previously registered itself with :ref .. rst-class:: classref-method -:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| +:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` Returns an integer that will be used to sort the given composition layer provided via :ref:`_get_composition_layer`. Lower numbers will move the layer to the front of the list, and higher numbers to the end. The default projection layer has an order of ``0``, so layers provided by this method should probably be above or below (but not exactly) ``0``. @@ -152,7 +154,7 @@ This will only be called if the extension previously registered itself with :ref .. rst-class:: classref-method -:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |virtual| +:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |virtual| :ref:`🔗` Returns a :ref:`Dictionary` of OpenXR extensions related to this extension. The :ref:`Dictionary` should contain the name of the extension, mapped to a ``bool *`` cast to an integer: @@ -168,7 +170,7 @@ Returns a :ref:`Dictionary` of OpenXR extensions related to th .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| +:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| :ref:`🔗` Returns a :ref:`PackedStringArray` of positional tracker names that are used within the extension wrapper. @@ -180,7 +182,7 @@ Returns a :ref:`PackedStringArray` of positional tracke .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_viewport_composition_layer_extension_properties**\ (\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_viewport_composition_layer_extension_properties**\ (\ ) |virtual| :ref:`🔗` Gets an array of :ref:`Dictionary`\ s that represent properties, just like :ref:`Object._get_property_list`, that will be added to :ref:`OpenXRCompositionLayer` nodes. @@ -192,7 +194,7 @@ Gets an array of :ref:`Dictionary`\ s that represent propertie .. rst-class:: classref-method -:ref:`Dictionary` **_get_viewport_composition_layer_extension_property_defaults**\ (\ ) |virtual| +:ref:`Dictionary` **_get_viewport_composition_layer_extension_property_defaults**\ (\ ) |virtual| :ref:`🔗` Gets a :ref:`Dictionary` containing the default values for the properties returned by :ref:`_get_viewport_composition_layer_extension_properties`. @@ -204,7 +206,7 @@ Gets a :ref:`Dictionary` containing the default values for the .. rst-class:: classref-method -|void| **_on_before_instance_created**\ (\ ) |virtual| +|void| **_on_before_instance_created**\ (\ ) |virtual| :ref:`🔗` Called before the OpenXR instance is created. @@ -216,7 +218,7 @@ Called before the OpenXR instance is created. .. rst-class:: classref-method -:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| +:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| :ref:`🔗` Called when there is an OpenXR event to process. When implementing, return ``true`` if the event was handled, return ``false`` otherwise. @@ -228,7 +230,7 @@ Called when there is an OpenXR event to process. When implementing, return ``tru .. rst-class:: classref-method -|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| +|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| :ref:`🔗` Called right after the OpenXR instance is created. @@ -240,7 +242,7 @@ Called right after the OpenXR instance is created. .. rst-class:: classref-method -|void| **_on_instance_destroyed**\ (\ ) |virtual| +|void| **_on_instance_destroyed**\ (\ ) |virtual| :ref:`🔗` Called right before the OpenXR instance is destroyed. @@ -248,11 +250,23 @@ Called right before the OpenXR instance is destroyed. ---- +.. _class_OpenXRExtensionWrapperExtension_private_method__on_main_swapchains_created: + +.. rst-class:: classref-method + +|void| **_on_main_swapchains_created**\ (\ ) |virtual| :ref:`🔗` + +Called right after the main swapchains are (re)created. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRExtensionWrapperExtension_private_method__on_pre_render: .. rst-class:: classref-method -|void| **_on_pre_render**\ (\ ) |virtual| +|void| **_on_pre_render**\ (\ ) |virtual| :ref:`🔗` Called right before the XR viewports begin their rendering step. @@ -264,7 +278,7 @@ Called right before the XR viewports begin their rendering step. .. rst-class:: classref-method -|void| **_on_process**\ (\ ) |virtual| +|void| **_on_process**\ (\ ) |virtual| :ref:`🔗` Called as part of the OpenXR process handling. This happens right before general and physics processing steps of the main loop. During this step controller data is queried and made available to game logic. @@ -276,7 +290,7 @@ Called as part of the OpenXR process handling. This happens right before general .. rst-class:: classref-method -|void| **_on_register_metadata**\ (\ ) |virtual| +|void| **_on_register_metadata**\ (\ ) |virtual| :ref:`🔗` Allows extensions to register additional controller metadata. This function is called even when the OpenXR API is not constructed as the metadata needs to be available to the editor. @@ -290,7 +304,7 @@ Extensions should also provide metadata regardless of whether they are supported .. rst-class:: classref-method -|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| +|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| :ref:`🔗` Called right after the OpenXR session is created. @@ -302,7 +316,7 @@ Called right after the OpenXR session is created. .. rst-class:: classref-method -|void| **_on_session_destroyed**\ (\ ) |virtual| +|void| **_on_session_destroyed**\ (\ ) |virtual| :ref:`🔗` Called right before the OpenXR session is destroyed. @@ -314,7 +328,7 @@ Called right before the OpenXR session is destroyed. .. rst-class:: classref-method -|void| **_on_state_exiting**\ (\ ) |virtual| +|void| **_on_state_exiting**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to exiting. @@ -326,7 +340,7 @@ Called when the OpenXR session state is changed to exiting. .. rst-class:: classref-method -|void| **_on_state_focused**\ (\ ) |virtual| +|void| **_on_state_focused**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to focused. This state is the active state when the game runs. @@ -338,7 +352,7 @@ Called when the OpenXR session state is changed to focused. This state is the ac .. rst-class:: classref-method -|void| **_on_state_idle**\ (\ ) |virtual| +|void| **_on_state_idle**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to idle. @@ -350,7 +364,7 @@ Called when the OpenXR session state is changed to idle. .. rst-class:: classref-method -|void| **_on_state_loss_pending**\ (\ ) |virtual| +|void| **_on_state_loss_pending**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to loss pending. @@ -362,7 +376,7 @@ Called when the OpenXR session state is changed to loss pending. .. rst-class:: classref-method -|void| **_on_state_ready**\ (\ ) |virtual| +|void| **_on_state_ready**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to ready. This means OpenXR is ready to set up the session. @@ -374,7 +388,7 @@ Called when the OpenXR session state is changed to ready. This means OpenXR is r .. rst-class:: classref-method -|void| **_on_state_stopping**\ (\ ) |virtual| +|void| **_on_state_stopping**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to stopping. @@ -386,7 +400,7 @@ Called when the OpenXR session state is changed to stopping. .. rst-class:: classref-method -|void| **_on_state_synchronized**\ (\ ) |virtual| +|void| **_on_state_synchronized**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to synchronized. OpenXR also returns to this state when the application loses focus. @@ -398,7 +412,7 @@ Called when the OpenXR session state is changed to synchronized. OpenXR also ret .. rst-class:: classref-method -|void| **_on_state_visible**\ (\ ) |virtual| +|void| **_on_state_visible**\ (\ ) |virtual| :ref:`🔗` Called when the OpenXR session state is changed to visible. This means OpenXR is now ready to receive frames. @@ -410,7 +424,7 @@ Called when the OpenXR session state is changed to visible. This means OpenXR is .. rst-class:: classref-method -|void| **_on_viewport_composition_layer_destroyed**\ (\ layer\: ``const void*``\ ) |virtual| +|void| **_on_viewport_composition_layer_destroyed**\ (\ layer\: ``const void*``\ ) |virtual| :ref:`🔗` Called when a composition layer created via :ref:`OpenXRCompositionLayer` is destroyed. @@ -424,7 +438,7 @@ Called when a composition layer created via :ref:`OpenXRCompositionLayer` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| +:ref:`int` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` Adds additional data structures when each hand tracker is created. @@ -436,7 +450,7 @@ Adds additional data structures when each hand tracker is created. .. rst-class:: classref-method -:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| +:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` Adds additional data structures when the OpenXR instance is created. @@ -448,7 +462,7 @@ Adds additional data structures when the OpenXR instance is created. .. rst-class:: classref-method -:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| +:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` Adds additional data structures when the OpenXR session is created. @@ -460,7 +474,7 @@ Adds additional data structures when the OpenXR session is created. .. rst-class:: classref-method -:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| +:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` Adds additional data structures when creating OpenXR swapchains. @@ -472,7 +486,7 @@ Adds additional data structures when creating OpenXR swapchains. .. rst-class:: classref-method -:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| +:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` Adds additional data structures when interogating OpenXR system abilities. @@ -484,7 +498,7 @@ Adds additional data structures when interogating OpenXR system abilities. .. rst-class:: classref-method -:ref:`int` **_set_viewport_composition_layer_and_get_next_pointer**\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| +:ref:`int` **_set_viewport_composition_layer_and_get_next_pointer**\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` Adds additional data structures to composition layers created by :ref:`OpenXRCompositionLayer`. @@ -500,7 +514,7 @@ Adds additional data structures to composition layers created by :ref:`OpenXRCom .. rst-class:: classref-method -:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) +:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) :ref:`🔗` Returns the created :ref:`OpenXRAPIExtension`, which can be used to access the OpenXR API. @@ -512,7 +526,7 @@ Returns the created :ref:`OpenXRAPIExtension`, which c .. rst-class:: classref-method -|void| **register_extension_wrapper**\ (\ ) +|void| **register_extension_wrapper**\ (\ ) :ref:`🔗` Registers the extension. This should happen at core module initialization level. diff --git a/classes/class_openxrhand.rst b/classes/class_openxrhand.rst index af4ef5e29cd..bbad64f1aa2 100644 --- a/classes/class_openxrhand.rst +++ b/classes/class_openxrhand.rst @@ -62,7 +62,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Hands**: +enum **Hands**: :ref:`🔗` .. _class_OpenXRHand_constant_HAND_LEFT: @@ -96,7 +96,7 @@ Maximum supported hands. .. rst-class:: classref-enumeration -enum **MotionRange**: +enum **MotionRange**: :ref:`🔗` .. _class_OpenXRHand_constant_MOTION_RANGE_UNOBSTRUCTED: @@ -130,7 +130,7 @@ Maximum supported motion ranges. .. rst-class:: classref-enumeration -enum **SkeletonRig**: +enum **SkeletonRig**: :ref:`🔗` .. _class_OpenXRHand_constant_SKELETON_RIG_OPENXR: @@ -164,7 +164,7 @@ Maximum supported hands. .. rst-class:: classref-enumeration -enum **BoneUpdate**: +enum **BoneUpdate**: :ref:`🔗` .. _class_OpenXRHand_constant_BONE_UPDATE_FULL: @@ -203,7 +203,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BoneUpdate` **bone_update** = ``0`` +:ref:`BoneUpdate` **bone_update** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ Specify the type of updates to perform on the bone. .. rst-class:: classref-property -:ref:`Hands` **hand** = ``0`` +:ref:`Hands` **hand** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ Specifies whether this node tracks the left or right hand of the player. .. rst-class:: classref-property -:ref:`NodePath` **hand_skeleton** = ``NodePath("")`` +:ref:`NodePath` **hand_skeleton** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ Set a :ref:`Skeleton3D` node for which the pose positions will .. rst-class:: classref-property -:ref:`MotionRange` **motion_range** = ``0`` +:ref:`MotionRange` **motion_range** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ Set the motion range (if supported) limiting the hand motion. .. rst-class:: classref-property -:ref:`SkeletonRig` **skeleton_rig** = ``0`` +:ref:`SkeletonRig` **skeleton_rig** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_openxrinteractionprofile.rst b/classes/class_openxrinteractionprofile.rst index 5dced35e5d6..24ad57e75bd 100644 --- a/classes/class_openxrinteractionprofile.rst +++ b/classes/class_openxrinteractionprofile.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array` **bindings** = ``[]`` +:ref:`Array` **bindings** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -81,7 +81,7 @@ Action bindings for this interaction profile. .. rst-class:: classref-property -:ref:`String` **interaction_profile_path** = ``""`` +:ref:`String` **interaction_profile_path** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`OpenXRIPBinding` **get_binding**\ (\ index\: :ref:`int`\ ) |const| +:ref:`OpenXRIPBinding` **get_binding**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Retrieve the binding at this index. @@ -115,7 +115,7 @@ Retrieve the binding at this index. .. rst-class:: classref-method -:ref:`int` **get_binding_count**\ (\ ) |const| +:ref:`int` **get_binding_count**\ (\ ) |const| :ref:`🔗` Get the number of bindings in this interaction profile. diff --git a/classes/class_openxrinteractionprofilemetadata.rst b/classes/class_openxrinteractionprofilemetadata.rst index 92634d89de2..675464241f7 100644 --- a/classes/class_openxrinteractionprofilemetadata.rst +++ b/classes/class_openxrinteractionprofilemetadata.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **register_interaction_profile**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) +|void| **register_interaction_profile**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) :ref:`🔗` Registers an interaction profile using its OpenXR designation (e.g. ``/interaction_profiles/khr/simple_controller`` is the profile for OpenXR's simple controller profile). @@ -66,7 +66,7 @@ Registers an interaction profile using its OpenXR designation (e.g. ``/interacti .. rst-class:: classref-method -|void| **register_io_path**\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`, action_type\: :ref:`ActionType`\ ) +|void| **register_io_path**\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`, action_type\: :ref:`ActionType`\ ) :ref:`🔗` Registers an input/output path for the given ``interaction_profile``. The profile should previously have been registered using :ref:`register_interaction_profile`. ``display_name`` is the description shown to the user. ``toplevel_path`` specifies the bind path this input/output can be bound to (e.g. ``/user/hand/left`` or ``/user/hand/right``). ``openxr_path`` is the action input/output being registered (e.g. ``/user/hand/left/input/aim/pose``). ``openxr_extension_name`` restricts this input/output to an enabled/available extension, this doesn't need to repeat the extension on the profile but relates to overlapping extension (e.g. ``XR_EXT_palm_pose`` that introduces ``…/input/palm_ext/pose`` input paths). ``action_type`` defines the type of input or output provided by OpenXR. @@ -78,7 +78,7 @@ Registers an input/output path for the given ``interaction_profile``. The profil .. rst-class:: classref-method -|void| **register_profile_rename**\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) +|void| **register_profile_rename**\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) :ref:`🔗` Allows for renaming old interaction profile paths to new paths to maintain backwards compatibility with older action maps. @@ -90,7 +90,7 @@ Allows for renaming old interaction profile paths to new paths to maintain backw .. rst-class:: classref-method -|void| **register_top_level_path**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) +|void| **register_top_level_path**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) :ref:`🔗` Registers a top level path to which profiles can be bound. For instance ``/user/hand/left`` refers to the bind point for the player's left hand. Extensions can register additional top level paths, for instance a haptic vest extension might register ``/user/body/vest``. diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index 42fa94e6281..56f5cb446cd 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -109,7 +109,7 @@ Signals .. rst-class:: classref-signal -**instance_exiting**\ (\ ) +**instance_exiting**\ (\ ) :ref:`🔗` Informs our OpenXR instance is exiting. @@ -121,7 +121,7 @@ Informs our OpenXR instance is exiting. .. rst-class:: classref-signal -**pose_recentered**\ (\ ) +**pose_recentered**\ (\ ) :ref:`🔗` Informs the user queued a recenter of the player position. @@ -133,7 +133,7 @@ Informs the user queued a recenter of the player position. .. rst-class:: classref-signal -**refresh_rate_changed**\ (\ refresh_rate\: :ref:`float`\ ) +**refresh_rate_changed**\ (\ refresh_rate\: :ref:`float`\ ) :ref:`🔗` Informs the user the HMD refresh rate has changed. @@ -147,7 +147,7 @@ Informs the user the HMD refresh rate has changed. .. rst-class:: classref-signal -**session_begun**\ (\ ) +**session_begun**\ (\ ) :ref:`🔗` Informs our OpenXR session has been started. @@ -159,7 +159,7 @@ Informs our OpenXR session has been started. .. rst-class:: classref-signal -**session_focussed**\ (\ ) +**session_focussed**\ (\ ) :ref:`🔗` Informs our OpenXR session now has focus. @@ -171,7 +171,7 @@ Informs our OpenXR session now has focus. .. rst-class:: classref-signal -**session_loss_pending**\ (\ ) +**session_loss_pending**\ (\ ) :ref:`🔗` Informs our OpenXR session is in the process of being lost. @@ -183,7 +183,7 @@ Informs our OpenXR session is in the process of being lost. .. rst-class:: classref-signal -**session_stopping**\ (\ ) +**session_stopping**\ (\ ) :ref:`🔗` Informs our OpenXR session is stopping. @@ -195,7 +195,7 @@ Informs our OpenXR session is stopping. .. rst-class:: classref-signal -**session_visible**\ (\ ) +**session_visible**\ (\ ) :ref:`🔗` Informs our OpenXR session is now visible (output is being sent to the HMD). @@ -212,7 +212,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Hand**: +enum **Hand**: :ref:`🔗` .. _class_OpenXRInterface_constant_HAND_LEFT: @@ -246,7 +246,7 @@ Maximum value for the hand enum. .. rst-class:: classref-enumeration -enum **HandMotionRange**: +enum **HandMotionRange**: :ref:`🔗` .. _class_OpenXRInterface_constant_HAND_MOTION_RANGE_UNOBSTRUCTED: @@ -280,7 +280,7 @@ Maximum value for the motion range enum. .. rst-class:: classref-enumeration -enum **HandTrackedSource**: +enum **HandTrackedSource**: :ref:`🔗` .. _class_OpenXRInterface_constant_HAND_TRACKED_SOURCE_UNKNOWN: @@ -322,7 +322,7 @@ Maximum value for the hand tracked source enum. .. rst-class:: classref-enumeration -enum **HandJoints**: +enum **HandJoints**: :ref:`🔗` .. _class_OpenXRInterface_constant_HAND_JOINT_PALM: @@ -548,7 +548,7 @@ Maximum value for the hand joint enum. .. rst-class:: classref-enumeration -flags **HandJointFlags**: +flags **HandJointFlags**: :ref:`🔗` .. _class_OpenXRInterface_constant_HAND_JOINT_NONE: @@ -619,7 +619,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **display_refresh_rate** = ``0.0`` +:ref:`float` **display_refresh_rate** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -636,7 +636,7 @@ The display refresh rate for the current HMD. Only functional if this feature is .. rst-class:: classref-property -:ref:`bool` **foveation_dynamic** = ``false`` +:ref:`bool` **foveation_dynamic** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -655,7 +655,7 @@ Enable dynamic foveation adjustment, the interface must be initialized before th .. rst-class:: classref-property -:ref:`int` **foveation_level** = ``0`` +:ref:`int` **foveation_level** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -674,7 +674,7 @@ Set foveation level from 0 (off) to 3 (high), the interface must be initialized .. rst-class:: classref-property -:ref:`float` **render_target_size_multiplier** = ``1.0`` +:ref:`float` **render_target_size_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -691,7 +691,7 @@ The render size multiplier for the current HMD. Must be set before the interface .. rst-class:: classref-property -:ref:`float` **vrs_min_radius** = ``20.0`` +:ref:`float` **vrs_min_radius** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -710,7 +710,7 @@ The minimum radius around the focal point where full quality is guaranteed if VR .. rst-class:: classref-property -:ref:`float` **vrs_strength** = ``1.0`` +:ref:`float` **vrs_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -734,7 +734,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **get_action_sets**\ (\ ) |const| +:ref:`Array` **get_action_sets**\ (\ ) |const| :ref:`🔗` Returns a list of action sets registered with Godot (loaded from the action map at runtime). @@ -746,7 +746,7 @@ Returns a list of action sets registered with Godot (loaded from the action map .. rst-class:: classref-method -:ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| +:ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| :ref:`🔗` Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized. @@ -758,7 +758,7 @@ Returns display refresh rates supported by the current HMD. Only returned if thi .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_angular_velocity**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| +:ref:`Vector3` **get_hand_joint_angular_velocity**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_angular_velocity` obtained from :ref:`XRServer.get_tracker` instead. @@ -772,7 +772,7 @@ If handtracking is enabled, returns the angular velocity of a joint (``joint``) .. rst-class:: classref-method -|bitfield|\[:ref:`HandJointFlags`\] **get_hand_joint_flags**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| +|bitfield|\[:ref:`HandJointFlags`\] **get_hand_joint_flags**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_flags` obtained from :ref:`XRServer.get_tracker` instead. @@ -786,7 +786,7 @@ If handtracking is enabled, returns flags that inform us of the validity of the .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_linear_velocity**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| +:ref:`Vector3` **get_hand_joint_linear_velocity**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_linear_velocity` obtained from :ref:`XRServer.get_tracker` instead. @@ -800,7 +800,7 @@ If handtracking is enabled, returns the linear velocity of a joint (``joint``) o .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_position**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| +:ref:`Vector3` **get_hand_joint_position**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_transform` obtained from :ref:`XRServer.get_tracker` instead. @@ -814,7 +814,7 @@ If handtracking is enabled, returns the position of a joint (``joint``) of a han .. rst-class:: classref-method -:ref:`float` **get_hand_joint_radius**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| +:ref:`float` **get_hand_joint_radius**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_radius` obtained from :ref:`XRServer.get_tracker` instead. @@ -828,7 +828,7 @@ If handtracking is enabled, returns the radius of a joint (``joint``) of a hand .. rst-class:: classref-method -:ref:`Quaternion` **get_hand_joint_rotation**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| +:ref:`Quaternion` **get_hand_joint_rotation**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_transform` obtained from :ref:`XRServer.get_tracker` instead. @@ -842,7 +842,7 @@ If handtracking is enabled, returns the rotation of a joint (``joint``) of a han .. rst-class:: classref-method -:ref:`HandTrackedSource` **get_hand_tracking_source**\ (\ hand\: :ref:`Hand`\ ) |const| +:ref:`HandTrackedSource` **get_hand_tracking_source**\ (\ hand\: :ref:`Hand`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`XRHandTracker.hand_tracking_source` obtained from :ref:`XRServer.get_tracker` instead. @@ -856,7 +856,7 @@ If handtracking is enabled and hand tracking source is supported, gets the sourc .. rst-class:: classref-method -:ref:`HandMotionRange` **get_motion_range**\ (\ hand\: :ref:`Hand`\ ) |const| +:ref:`HandMotionRange` **get_motion_range**\ (\ hand\: :ref:`Hand`\ ) |const| :ref:`🔗` If handtracking is enabled and motion range is supported, gets the currently configured motion range for ``hand``. @@ -868,7 +868,7 @@ If handtracking is enabled and motion range is supported, gets the currently con .. rst-class:: classref-method -:ref:`bool` **is_action_set_active**\ (\ name\: :ref:`String`\ ) |const| +:ref:`bool` **is_action_set_active**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the given action set is active. @@ -880,7 +880,7 @@ Returns ``true`` if the given action set is active. .. rst-class:: classref-method -:ref:`bool` **is_eye_gaze_interaction_supported**\ (\ ) +:ref:`bool` **is_eye_gaze_interaction_supported**\ (\ ) :ref:`🔗` Returns the capabilities of the eye gaze interaction extension. @@ -894,7 +894,7 @@ Returns the capabilities of the eye gaze interaction extension. .. rst-class:: classref-method -:ref:`bool` **is_foveation_supported**\ (\ ) |const| +:ref:`bool` **is_foveation_supported**\ (\ ) |const| :ref:`🔗` Returns ``true`` if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value. @@ -908,7 +908,7 @@ Returns ``true`` if OpenXR's foveation extension is supported, the interface mus .. rst-class:: classref-method -:ref:`bool` **is_hand_interaction_supported**\ (\ ) |const| +:ref:`bool` **is_hand_interaction_supported**\ (\ ) |const| :ref:`🔗` Returns ``true`` if OpenXR's hand interaction profile is supported and enabled. @@ -922,7 +922,7 @@ Returns ``true`` if OpenXR's hand interaction profile is supported and enabled. .. rst-class:: classref-method -:ref:`bool` **is_hand_tracking_supported**\ (\ ) +:ref:`bool` **is_hand_tracking_supported**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR's hand tracking is supported and enabled. @@ -936,7 +936,7 @@ Returns ``true`` if OpenXR's hand tracking is supported and enabled. .. rst-class:: classref-method -|void| **set_action_set_active**\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) +|void| **set_action_set_active**\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) :ref:`🔗` Sets the given action set as active or inactive. @@ -948,7 +948,7 @@ Sets the given action set as active or inactive. .. rst-class:: classref-method -|void| **set_motion_range**\ (\ hand\: :ref:`Hand`, motion_range\: :ref:`HandMotionRange`\ ) +|void| **set_motion_range**\ (\ hand\: :ref:`Hand`, motion_range\: :ref:`HandMotionRange`\ ) :ref:`🔗` If handtracking is enabled and motion range is supported, sets the currently configured motion range for ``hand`` to ``motion_range``. diff --git a/classes/class_openxripbinding.rst b/classes/class_openxripbinding.rst index aa1500651d0..8f0534e8534 100644 --- a/classes/class_openxripbinding.rst +++ b/classes/class_openxripbinding.rst @@ -66,7 +66,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpenXRAction` **action** +:ref:`OpenXRAction` **action** :ref:`🔗` .. rst-class:: classref-property-setget @@ -83,7 +83,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedStringArray` **paths** = ``PackedStringArray()`` +:ref:`PackedStringArray` **paths** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_path**\ (\ path\: :ref:`String`\ ) +|void| **add_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Add an input/output path to this binding. @@ -119,7 +119,7 @@ Add an input/output path to this binding. .. rst-class:: classref-method -:ref:`int` **get_path_count**\ (\ ) |const| +:ref:`int` **get_path_count**\ (\ ) |const| :ref:`🔗` Get the number of input/output paths in this binding. @@ -131,7 +131,7 @@ Get the number of input/output paths in this binding. .. rst-class:: classref-method -:ref:`bool` **has_path**\ (\ path\: :ref:`String`\ ) |const| +:ref:`bool` **has_path**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if this input/output path is part of this binding. @@ -143,7 +143,7 @@ Returns ``true`` if this input/output path is part of this binding. .. rst-class:: classref-method -|void| **remove_path**\ (\ path\: :ref:`String`\ ) +|void| **remove_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Removes this input/output path from this binding. diff --git a/classes/class_optimizedtranslation.rst b/classes/class_optimizedtranslation.rst index d30e0ed31ee..baa1e451239 100644 --- a/classes/class_optimizedtranslation.rst +++ b/classes/class_optimizedtranslation.rst @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **generate**\ (\ from\: :ref:`Translation`\ ) +|void| **generate**\ (\ from\: :ref:`Translation`\ ) :ref:`🔗` Generates and sets an optimized translation from the given :ref:`Translation` resource. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index ab477e78e33..199d36b5d08 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -147,7 +147,7 @@ Signals .. rst-class:: classref-signal -**item_focused**\ (\ index\: :ref:`int`\ ) +**item_focused**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Emitted when the user navigates to an item using the :ref:`ProjectSettings.input/ui_up` or :ref:`ProjectSettings.input/ui_down` input actions. The index of the item selected is passed as argument. @@ -159,7 +159,7 @@ Emitted when the user navigates to an item using the :ref:`ProjectSettings.input .. rst-class:: classref-signal -**item_selected**\ (\ index\: :ref:`int`\ ) +**item_selected**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. @@ -178,7 +178,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_reselect** = ``false`` +:ref:`bool` **allow_reselect** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ If ``true``, the currently selected item can be selected again. .. rst-class:: classref-property -:ref:`bool` **fit_to_longest_item** = ``true`` +:ref:`bool` **fit_to_longest_item** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,7 +214,7 @@ If ``true``, minimum size will be determined by the longest item's text, instead .. rst-class:: classref-property -:ref:`int` **item_count** = ``0`` +:ref:`int` **item_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ The number of items to select from. .. rst-class:: classref-property -:ref:`int` **selected** = ``-1`` +:ref:`int` **selected** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -252,7 +252,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_icon_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) +|void| **add_icon_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) :ref:`🔗` Adds an item, with a ``texture`` icon, text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end. @@ -264,7 +264,7 @@ Adds an item, with a ``texture`` icon, text ``label`` and (optionally) ``id``. I .. rst-class:: classref-method -|void| **add_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) +|void| **add_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) :ref:`🔗` Adds an item, with text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end. @@ -276,7 +276,7 @@ Adds an item, with text ``label`` and (optionally) ``id``. If no ``id`` is passe .. rst-class:: classref-method -|void| **add_separator**\ (\ text\: :ref:`String` = ""\ ) +|void| **add_separator**\ (\ text\: :ref:`String` = ""\ ) :ref:`🔗` Adds a separator to the list of items. Separators help to group items, and can optionally be given a ``text`` header. A separator also gets an index assigned, and is appended at the end of the item list. @@ -288,7 +288,7 @@ Adds a separator to the list of items. Separators help to group items, and can o .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears all the items in the **OptionButton**. @@ -300,7 +300,7 @@ Clears all the items in the **OptionButton**. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_item_icon**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon of the item at index ``idx``. @@ -312,7 +312,7 @@ Returns the icon of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_id**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`int` **get_item_id**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ID of the item at index ``idx``. @@ -324,7 +324,7 @@ Returns the ID of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_index**\ (\ id\: :ref:`int`\ ) |const| +:ref:`int` **get_item_index**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the index of the item with the given ``id``. @@ -336,7 +336,7 @@ Returns the index of the item with the given ``id``. .. rst-class:: classref-method -:ref:`Variant` **get_item_metadata**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_item_metadata**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID. @@ -348,7 +348,7 @@ Retrieves the metadata of an item. Metadata may be any type and can be used to s .. rst-class:: classref-method -:ref:`String` **get_item_text**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_text**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text of the item at index ``idx``. @@ -360,7 +360,7 @@ Returns the text of the item at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_item_tooltip**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip of the item at index ``idx``. @@ -372,7 +372,7 @@ Returns the tooltip of the item at index ``idx``. .. rst-class:: classref-method -:ref:`PopupMenu` **get_popup**\ (\ ) |const| +:ref:`PopupMenu` **get_popup**\ (\ ) |const| :ref:`🔗` Returns the :ref:`PopupMenu` contained in this button. @@ -386,7 +386,7 @@ Returns the :ref:`PopupMenu` contained in this button. .. rst-class:: classref-method -:ref:`int` **get_selectable_item**\ (\ from_last\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_selectable_item**\ (\ from_last\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the index of the first item which is not disabled, or marked as a separator. If ``from_last`` is ``true``, the items will be searched in reverse order. @@ -400,7 +400,7 @@ Returns ``-1`` if no item is found. .. rst-class:: classref-method -:ref:`int` **get_selected_id**\ (\ ) |const| +:ref:`int` **get_selected_id**\ (\ ) |const| :ref:`🔗` Returns the ID of the selected item, or ``-1`` if no item is selected. @@ -412,7 +412,7 @@ Returns the ID of the selected item, or ``-1`` if no item is selected. .. rst-class:: classref-method -:ref:`Variant` **get_selected_metadata**\ (\ ) |const| +:ref:`Variant` **get_selected_metadata**\ (\ ) |const| :ref:`🔗` Gets the metadata of the selected item. Metadata for items can be set using :ref:`set_item_metadata`. @@ -424,7 +424,7 @@ Gets the metadata of the selected item. Metadata for items can be set using :ref .. rst-class:: classref-method -:ref:`bool` **has_selectable_items**\ (\ ) |const| +:ref:`bool` **has_selectable_items**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this button contains at least one item which is not disabled, or marked as a separator. @@ -436,7 +436,7 @@ Returns ``true`` if this button contains at least one item which is not disabled .. rst-class:: classref-method -:ref:`bool` **is_item_disabled**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_disabled**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` is disabled. @@ -448,7 +448,7 @@ Returns ``true`` if the item at index ``idx`` is disabled. .. rst-class:: classref-method -:ref:`bool` **is_item_separator**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_separator**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at index ``idx`` is marked as a separator. @@ -460,7 +460,7 @@ Returns ``true`` if the item at index ``idx`` is marked as a separator. .. rst-class:: classref-method -|void| **remove_item**\ (\ idx\: :ref:`int`\ ) +|void| **remove_item**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Removes the item at index ``idx``. @@ -472,7 +472,7 @@ Removes the item at index ``idx``. .. rst-class:: classref-method -|void| **select**\ (\ idx\: :ref:`int`\ ) +|void| **select**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Selects an item by index and makes it the current item. This will work even if the item is disabled. @@ -486,7 +486,7 @@ Passing ``-1`` as the index deselects any currently selected item. .. rst-class:: classref-method -|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) +|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, shortcuts are disabled and cannot be used to trigger the button. @@ -498,7 +498,7 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. .. rst-class:: classref-method -|void| **set_item_disabled**\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_item_disabled**\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Sets whether the item at index ``idx`` is disabled. @@ -512,7 +512,7 @@ Disabled items are drawn differently in the dropdown and are not selectable by t .. rst-class:: classref-method -|void| **set_item_icon**\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) +|void| **set_item_icon**\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the icon of the item at index ``idx``. @@ -524,7 +524,7 @@ Sets the icon of the item at index ``idx``. .. rst-class:: classref-method -|void| **set_item_id**\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) +|void| **set_item_id**\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) :ref:`🔗` Sets the ID of the item at index ``idx``. @@ -536,7 +536,7 @@ Sets the ID of the item at index ``idx``. .. rst-class:: classref-method -|void| **set_item_metadata**\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) +|void| **set_item_metadata**\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID. @@ -548,7 +548,7 @@ Sets the metadata of an item. Metadata may be of any type and can be used to sto .. rst-class:: classref-method -|void| **set_item_text**\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_item_text**\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets the text of the item at index ``idx``. @@ -560,7 +560,7 @@ Sets the text of the item at index ``idx``. .. rst-class:: classref-method -|void| **set_item_tooltip**\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_item_tooltip**\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the tooltip of the item at index ``idx``. @@ -572,7 +572,7 @@ Sets the tooltip of the item at index ``idx``. .. rst-class:: classref-method -|void| **show_popup**\ (\ ) +|void| **show_popup**\ (\ ) :ref:`🔗` Adjusts popup position and sizing for the **OptionButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. @@ -589,7 +589,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **arrow_margin** = ``4`` +:ref:`int` **arrow_margin** = ``4`` :ref:`🔗` The horizontal space between the arrow icon and the right edge of the button. @@ -601,7 +601,7 @@ The horizontal space between the arrow icon and the right edge of the button. .. rst-class:: classref-themeproperty -:ref:`int` **modulate_arrow** = ``0`` +:ref:`int` **modulate_arrow** = ``0`` :ref:`🔗` If different than ``0``, the arrow icon will be modulated to the font color. @@ -613,7 +613,7 @@ If different than ``0``, the arrow icon will be modulated to the font color. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **arrow** +:ref:`Texture2D` **arrow** :ref:`🔗` The arrow icon to be drawn on the right end of the button. diff --git a/classes/class_os.rst b/classes/class_os.rst index 227fd0eada2..2e3a023b748 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -201,7 +201,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **RenderingDriver**: +enum **RenderingDriver**: :ref:`🔗` .. _class_OS_constant_RENDERING_DRIVER_VULKAN: @@ -235,7 +235,7 @@ The Direct3D 12 rendering driver. .. rst-class:: classref-enumeration -enum **SystemDir**: +enum **SystemDir**: :ref:`🔗` .. _class_OS_constant_SYSTEM_DIR_DESKTOP: @@ -314,7 +314,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **delta_smoothing** = ``true`` +:ref:`bool` **delta_smoothing** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -333,7 +333,7 @@ If ``true``, the engine filters the time delta measured between each frame, and .. rst-class:: classref-property -:ref:`bool` **low_processor_usage_mode** = ``false`` +:ref:`bool` **low_processor_usage_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -352,7 +352,7 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the .. rst-class:: classref-property -:ref:`int` **low_processor_usage_mode_sleep_usec** = ``6900`` +:ref:`int` **low_processor_usage_mode_sleep_usec** = ``6900`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -376,7 +376,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **alert**\ (\ text\: :ref:`String`, title\: :ref:`String` = "Alert!"\ ) +|void| **alert**\ (\ text\: :ref:`String`, title\: :ref:`String` = "Alert!"\ ) :ref:`🔗` Displays a modal dialog box using the host platform's implementation. The engine execution is blocked until the dialog is closed. @@ -388,7 +388,7 @@ Displays a modal dialog box using the host platform's implementation. The engine .. rst-class:: classref-method -|void| **close_midi_inputs**\ (\ ) +|void| **close_midi_inputs**\ (\ ) :ref:`🔗` Shuts down the system MIDI driver. Godot will no longer receive :ref:`InputEventMIDI`. See also :ref:`open_midi_inputs` and :ref:`get_connected_midi_inputs`. @@ -402,7 +402,7 @@ Shuts down the system MIDI driver. Godot will no longer receive :ref:`InputEvent .. rst-class:: classref-method -|void| **crash**\ (\ message\: :ref:`String`\ ) +|void| **crash**\ (\ message\: :ref:`String`\ ) :ref:`🔗` Crashes the engine (or the editor if called within a ``@tool`` script). See also :ref:`kill`. @@ -416,7 +416,7 @@ Crashes the engine (or the editor if called within a ``@tool`` script). See also .. rst-class:: classref-method -:ref:`int` **create_instance**\ (\ arguments\: :ref:`PackedStringArray`\ ) +:ref:`int` **create_instance**\ (\ arguments\: :ref:`PackedStringArray`\ ) :ref:`🔗` Creates a new instance of Godot that runs independently. The ``arguments`` are used in the given order and separated by a space. @@ -434,7 +434,7 @@ See :ref:`create_process` if you wish to run a d .. rst-class:: classref-method -:ref:`int` **create_process**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, open_console\: :ref:`bool` = false\ ) +:ref:`int` **create_process**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, open_console\: :ref:`bool` = false\ ) :ref:`🔗` Creates a new process that runs independently of Godot. It will not terminate when Godot terminates. The path specified in ``path`` must exist and be an executable file or macOS ``.app`` bundle. The path is resolved based on the current platform. The ``arguments`` are used in the given order and separated by a space. @@ -471,7 +471,7 @@ See :ref:`execute` if you wish to run an external comma .. rst-class:: classref-method -|void| **delay_msec**\ (\ msec\: :ref:`int`\ ) |const| +|void| **delay_msec**\ (\ msec\: :ref:`int`\ ) |const| :ref:`🔗` Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_msec` does nothing and prints an error message. @@ -487,7 +487,7 @@ Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must b .. rst-class:: classref-method -|void| **delay_usec**\ (\ usec\: :ref:`int`\ ) |const| +|void| **delay_usec**\ (\ usec\: :ref:`int`\ ) |const| :ref:`🔗` Delays execution of the current thread by ``usec`` microseconds. ``usec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_usec` does nothing and prints an error message. @@ -503,7 +503,7 @@ Delays execution of the current thread by ``usec`` microseconds. ``usec`` must b .. rst-class:: classref-method -:ref:`int` **execute**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, output\: :ref:`Array` = [], read_stderr\: :ref:`bool` = false, open_console\: :ref:`bool` = false\ ) +:ref:`int` **execute**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, output\: :ref:`Array` = [], read_stderr\: :ref:`bool` = false, open_console\: :ref:`bool` = false\ ) :ref:`🔗` Executes the given process in a *blocking* way. The file specified in ``path`` must exist and be executable. The system path resolution will be used. The ``arguments`` are used in the given order, separated by spaces, and wrapped in quotes. @@ -569,7 +569,7 @@ If you wish to access a shell built-in or execute a composite command, a platfor .. rst-class:: classref-method -:ref:`Dictionary` **execute_with_pipe**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`\ ) +:ref:`Dictionary` **execute_with_pipe**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`\ ) :ref:`🔗` Creates a new process that runs independently of Godot with redirected IO. It will not terminate when Godot terminates. The path specified in ``path`` must exist and be an executable file or macOS ``.app`` bundle. The path is resolved based on the current platform. The ``arguments`` are used in the given order and separated by a space. @@ -599,7 +599,7 @@ If the process cannot be created, this method returns an empty :ref:`Dictionary< .. rst-class:: classref-method -:ref:`Key` **find_keycode_from_string**\ (\ string\: :ref:`String`\ ) |const| +:ref:`Key` **find_keycode_from_string**\ (\ string\: :ref:`String`\ ) |const| :ref:`🔗` Finds the keycode for the given string. The returned values are equivalent to the :ref:`Key` constants. @@ -632,7 +632,7 @@ See also :ref:`get_keycode_string`. .. rst-class:: classref-method -:ref:`String` **get_cache_dir**\ (\ ) |const| +:ref:`String` **get_cache_dir**\ (\ ) |const| :ref:`🔗` Returns the *global* cache data directory according to the operating system's standards. @@ -648,7 +648,7 @@ Not to be confused with :ref:`get_user_data_dir` **get_cmdline_args**\ (\ ) +:ref:`PackedStringArray` **get_cmdline_args**\ (\ ) :ref:`🔗` Returns the command-line arguments passed to the engine. @@ -705,7 +705,7 @@ Here's a minimal example on how to parse command-line arguments into a :ref:`Dic .. rst-class:: classref-method -:ref:`PackedStringArray` **get_cmdline_user_args**\ (\ ) +:ref:`PackedStringArray` **get_cmdline_user_args**\ (\ ) :ref:`🔗` Returns the command-line user arguments passed to the engine. User arguments are ignored by the engine and reserved for the user. They are passed after the double dash ``--`` argument. ``++`` may be used when ``--`` is intercepted by another program (such as ``startx``). @@ -727,7 +727,7 @@ To get all passed arguments, use :ref:`get_cmdline_args` **get_config_dir**\ (\ ) |const| +:ref:`String` **get_config_dir**\ (\ ) |const| :ref:`🔗` Returns the *global* user configuration directory according to the operating system's standards. @@ -743,7 +743,7 @@ Not to be confused with :ref:`get_user_data_dir` **get_connected_midi_inputs**\ (\ ) +:ref:`PackedStringArray` **get_connected_midi_inputs**\ (\ ) :ref:`🔗` Returns an array of connected MIDI device names, if they exist. Returns an empty array if the system MIDI driver has not previously been initialized with :ref:`open_midi_inputs`. See also :ref:`close_midi_inputs`. @@ -757,7 +757,7 @@ Returns an array of connected MIDI device names, if they exist. Returns an empty .. rst-class:: classref-method -:ref:`String` **get_data_dir**\ (\ ) |const| +:ref:`String` **get_data_dir**\ (\ ) |const| :ref:`🔗` Returns the *global* user data directory according to the operating system's standards. @@ -773,7 +773,7 @@ Not to be confused with :ref:`get_user_data_dir` **get_distribution_name**\ (\ ) |const| +:ref:`String` **get_distribution_name**\ (\ ) |const| :ref:`🔗` Returns the name of the distribution for Linux and BSD platforms (e.g. "Ubuntu", "Manjaro", "OpenBSD", etc.). @@ -791,7 +791,7 @@ Returns the same value as :ref:`get_name` for other pl .. rst-class:: classref-method -:ref:`String` **get_environment**\ (\ variable\: :ref:`String`\ ) |const| +:ref:`String` **get_environment**\ (\ variable\: :ref:`String`\ ) |const| :ref:`🔗` Returns the value of the given environment variable, or an empty string if ``variable`` doesn't exist. @@ -807,7 +807,7 @@ Returns the value of the given environment variable, or an empty string if ``var .. rst-class:: classref-method -:ref:`String` **get_executable_path**\ (\ ) |const| +:ref:`String` **get_executable_path**\ (\ ) |const| :ref:`🔗` Returns the file path to the current engine executable. @@ -821,7 +821,7 @@ Returns the file path to the current engine executable. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_granted_permissions**\ (\ ) |const| +:ref:`PackedStringArray` **get_granted_permissions**\ (\ ) |const| :ref:`🔗` On Android devices: Returns the list of dangerous permissions that have been granted. @@ -835,7 +835,7 @@ On macOS: Returns the list of user selected folders accessible to the applicatio .. rst-class:: classref-method -:ref:`String` **get_keycode_string**\ (\ code\: :ref:`Key`\ ) |const| +:ref:`String` **get_keycode_string**\ (\ code\: :ref:`Key`\ ) |const| :ref:`🔗` Returns the given keycode as a :ref:`String`. @@ -866,7 +866,7 @@ See also :ref:`find_keycode_from_string` **get_locale**\ (\ ) |const| +:ref:`String` **get_locale**\ (\ ) |const| :ref:`🔗` Returns the host OS locale as a :ref:`String` of the form ``language_Script_COUNTRY_VARIANT@extra``. Every substring after ``language`` is optional and may not exist. @@ -890,7 +890,7 @@ If you want only the language code and not the fully specified locale from the O .. rst-class:: classref-method -:ref:`String` **get_locale_language**\ (\ ) |const| +:ref:`String` **get_locale_language**\ (\ ) |const| :ref:`🔗` Returns the host OS locale's 2 or 3-letter `language code `__ as a string which should be consistent on all platforms. This is equivalent to extracting the ``language`` part of the :ref:`get_locale` string. @@ -904,7 +904,7 @@ This can be used to narrow down fully specified locale strings to only the "comm .. rst-class:: classref-method -:ref:`int` **get_main_thread_id**\ (\ ) |const| +:ref:`int` **get_main_thread_id**\ (\ ) |const| :ref:`🔗` Returns the ID of the main thread. See :ref:`get_thread_caller_id`. @@ -918,7 +918,7 @@ Returns the ID of the main thread. See :ref:`get_thread_caller_id` **get_memory_info**\ (\ ) |const| +:ref:`Dictionary` **get_memory_info**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` containing information about the current memory with the following entries: @@ -940,7 +940,7 @@ Returns a :ref:`Dictionary` containing information about the c .. rst-class:: classref-method -:ref:`String` **get_model_name**\ (\ ) |const| +:ref:`String` **get_model_name**\ (\ ) |const| :ref:`🔗` Returns the model name of the current device. @@ -954,7 +954,7 @@ Returns the model name of the current device. .. rst-class:: classref-method -:ref:`String` **get_name**\ (\ ) |const| +:ref:`String` **get_name**\ (\ ) |const| :ref:`🔗` Returns the name of the host platform. @@ -1033,7 +1033,7 @@ Returns the name of the host platform. .. rst-class:: classref-method -:ref:`int` **get_process_exit_code**\ (\ pid\: :ref:`int`\ ) |const| +:ref:`int` **get_process_exit_code**\ (\ pid\: :ref:`int`\ ) |const| :ref:`🔗` Returns the exit code of a spawned process once it has finished running (see :ref:`is_process_running`). @@ -1049,7 +1049,7 @@ Returns ``-1`` if the ``pid`` is not a PID of a spawned child process, the proce .. rst-class:: classref-method -:ref:`int` **get_process_id**\ (\ ) |const| +:ref:`int` **get_process_id**\ (\ ) |const| :ref:`🔗` Returns the number used by the host machine to uniquely identify this application. @@ -1063,7 +1063,7 @@ Returns the number used by the host machine to uniquely identify this applicatio .. rst-class:: classref-method -:ref:`int` **get_processor_count**\ (\ ) |const| +:ref:`int` **get_processor_count**\ (\ ) |const| :ref:`🔗` Returns the number of *logical* CPU cores available on the host machine. On CPUs with HyperThreading enabled, this number will be greater than the number of *physical* CPU cores. @@ -1075,7 +1075,7 @@ Returns the number of *logical* CPU cores available on the host machine. On CPUs .. rst-class:: classref-method -:ref:`String` **get_processor_name**\ (\ ) |const| +:ref:`String` **get_processor_name**\ (\ ) |const| :ref:`🔗` Returns the full name of the CPU model on the host machine (e.g. ``"Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz"``). @@ -1089,7 +1089,7 @@ Returns the full name of the CPU model on the host machine (e.g. ``"Intel(R) Cor .. rst-class:: classref-method -:ref:`PackedStringArray` **get_restart_on_exit_arguments**\ (\ ) |const| +:ref:`PackedStringArray` **get_restart_on_exit_arguments**\ (\ ) |const| :ref:`🔗` Returns the list of command line arguments that will be used when the project automatically restarts using :ref:`set_restart_on_exit`. See also :ref:`is_restart_on_exit_set`. @@ -1101,7 +1101,7 @@ Returns the list of command line arguments that will be used when the project au .. rst-class:: classref-method -:ref:`int` **get_static_memory_peak_usage**\ (\ ) |const| +:ref:`int` **get_static_memory_peak_usage**\ (\ ) |const| :ref:`🔗` Returns the maximum amount of static memory used. Only works in debug builds. @@ -1113,7 +1113,7 @@ Returns the maximum amount of static memory used. Only works in debug builds. .. rst-class:: classref-method -:ref:`int` **get_static_memory_usage**\ (\ ) |const| +:ref:`int` **get_static_memory_usage**\ (\ ) |const| :ref:`🔗` Returns the amount of static memory being used by the program in bytes. Only works in debug builds. @@ -1125,7 +1125,7 @@ Returns the amount of static memory being used by the program in bytes. Only wor .. rst-class:: classref-method -:ref:`String` **get_system_dir**\ (\ dir\: :ref:`SystemDir`, shared_storage\: :ref:`bool` = true\ ) |const| +:ref:`String` **get_system_dir**\ (\ dir\: :ref:`SystemDir`, shared_storage\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns the path to commonly used folders across different platforms, as defined by ``dir``. See the :ref:`SystemDir` constants for available locations. @@ -1141,7 +1141,7 @@ Returns the path to commonly used folders across different platforms, as defined .. rst-class:: classref-method -:ref:`String` **get_system_font_path**\ (\ font_name\: :ref:`String`, weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| +:ref:`String` **get_system_font_path**\ (\ font_name\: :ref:`String`, weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the path to the system font file with ``font_name`` and style. Returns an empty string if no matching fonts found. @@ -1159,7 +1159,7 @@ The following aliases can be used to request default fonts: "sans-serif", "serif .. rst-class:: classref-method -:ref:`PackedStringArray` **get_system_font_path_for_text**\ (\ font_name\: :ref:`String`, text\: :ref:`String`, locale\: :ref:`String` = "", script\: :ref:`String` = "", weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| +:ref:`PackedStringArray` **get_system_font_path_for_text**\ (\ font_name\: :ref:`String`, text\: :ref:`String`, locale\: :ref:`String` = "", script\: :ref:`String` = "", weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns an array of the system substitute font file paths, which are similar to the font with ``font_name`` and style for the specified text, locale, and script. Returns an empty array if no matching fonts found. @@ -1179,7 +1179,7 @@ The following aliases can be used to request default fonts: "sans-serif", "serif .. rst-class:: classref-method -:ref:`PackedStringArray` **get_system_fonts**\ (\ ) |const| +:ref:`PackedStringArray` **get_system_fonts**\ (\ ) |const| :ref:`🔗` Returns the list of font family names available. @@ -1193,7 +1193,7 @@ Returns the list of font family names available. .. rst-class:: classref-method -:ref:`int` **get_thread_caller_id**\ (\ ) |const| +:ref:`int` **get_thread_caller_id**\ (\ ) |const| :ref:`🔗` Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications. @@ -1207,7 +1207,7 @@ Returns the ID of the current thread. This can be used in logs to ease debugging .. rst-class:: classref-method -:ref:`String` **get_unique_id**\ (\ ) |const| +:ref:`String` **get_unique_id**\ (\ ) |const| :ref:`🔗` Returns a string that is unique to the device. @@ -1223,7 +1223,7 @@ Returns a string that is unique to the device. .. rst-class:: classref-method -:ref:`String` **get_user_data_dir**\ (\ ) |const| +:ref:`String` **get_user_data_dir**\ (\ ) |const| :ref:`🔗` Returns the absolute directory path where user data is written (the ``user://`` directory in Godot). The path depends on the project name and :ref:`ProjectSettings.application/config/use_custom_user_dir`. @@ -1249,7 +1249,7 @@ Not to be confused with :ref:`get_data_dir`, which .. rst-class:: classref-method -:ref:`String` **get_version**\ (\ ) |const| +:ref:`String` **get_version**\ (\ ) |const| :ref:`🔗` Returns the exact production and build version of the operating system. This is different from the branded version used in marketing. This helps to distinguish between different releases of operating systems, including minor versions, and insider and custom builds. @@ -1271,7 +1271,7 @@ Returns the exact production and build version of the operating system. This is .. rst-class:: classref-method -:ref:`PackedStringArray` **get_video_adapter_driver_info**\ (\ ) |const| +:ref:`PackedStringArray` **get_video_adapter_driver_info**\ (\ ) |const| :ref:`🔗` Returns the video adapter driver name and version for the user's currently active graphics card, as a :ref:`PackedStringArray`. See also :ref:`RenderingServer.get_video_adapter_api_version`. @@ -1289,7 +1289,7 @@ The second element holds the driver version. For example, on the ``nvidia`` driv .. rst-class:: classref-method -:ref:`bool` **has_environment**\ (\ variable\: :ref:`String`\ ) |const| +:ref:`bool` **has_environment**\ (\ variable\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the environment variable with the name ``variable`` exists. @@ -1303,7 +1303,7 @@ Returns ``true`` if the environment variable with the name ``variable`` exists. .. rst-class:: classref-method -:ref:`bool` **has_feature**\ (\ tag_name\: :ref:`String`\ ) |const| +:ref:`bool` **has_feature**\ (\ tag_name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the :doc:`Feature Tags <../tutorials/export/feature_tags>` documentation for more details. @@ -1319,7 +1319,7 @@ Returns ``true`` if the feature for the given feature tag is supported in the cu .. rst-class:: classref-method -:ref:`bool` **is_debug_build**\ (\ ) |const| +:ref:`bool` **is_debug_build**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the Godot binary used to run the project is a *debug* export template, or when running in the editor. @@ -1335,7 +1335,7 @@ Returns ``false`` if the Godot binary used to run the project is a *release* exp .. rst-class:: classref-method -:ref:`bool` **is_keycode_unicode**\ (\ code\: :ref:`int`\ ) |const| +:ref:`bool` **is_keycode_unicode**\ (\ code\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the input keycode corresponds to a Unicode character. For a list of codes, see the :ref:`Key` constants. @@ -1366,7 +1366,7 @@ Returns ``true`` if the input keycode corresponds to a Unicode character. For a .. rst-class:: classref-method -:ref:`bool` **is_process_running**\ (\ pid\: :ref:`int`\ ) |const| +:ref:`bool` **is_process_running**\ (\ pid\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the child process ID (``pid``) is still running or ``false`` if it has terminated. ``pid`` must be a valid ID generated from :ref:`create_process`. @@ -1380,7 +1380,7 @@ Returns ``true`` if the child process ID (``pid``) is still running or ``false`` .. rst-class:: classref-method -:ref:`bool` **is_restart_on_exit_set**\ (\ ) |const| +:ref:`bool` **is_restart_on_exit_set**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the project will automatically restart when it exits for any reason, ``false`` otherwise. See also :ref:`set_restart_on_exit` and :ref:`get_restart_on_exit_arguments`. @@ -1392,7 +1392,7 @@ Returns ``true`` if the project will automatically restart when it exits for any .. rst-class:: classref-method -:ref:`bool` **is_sandboxed**\ (\ ) |const| +:ref:`bool` **is_sandboxed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the application is running in the sandbox. @@ -1406,7 +1406,7 @@ Returns ``true`` if the application is running in the sandbox. .. rst-class:: classref-method -:ref:`bool` **is_stdout_verbose**\ (\ ) |const| +:ref:`bool` **is_stdout_verbose**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the engine was executed with the ``--verbose`` or ``-v`` command line argument, or if :ref:`ProjectSettings.debug/settings/stdout/verbose_stdout` is ``true``. See also :ref:`@GlobalScope.print_verbose`. @@ -1418,7 +1418,7 @@ Returns ``true`` if the engine was executed with the ``--verbose`` or ``-v`` com .. rst-class:: classref-method -:ref:`bool` **is_userfs_persistent**\ (\ ) |const| +:ref:`bool` **is_userfs_persistent**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the ``user://`` file system is persistent, that is, its state is the same after a player quits and starts the game again. Relevant to the Web platform, where this persistence may be unavailable. @@ -1430,7 +1430,7 @@ Returns ``true`` if the ``user://`` file system is persistent, that is, its stat .. rst-class:: classref-method -:ref:`Error` **kill**\ (\ pid\: :ref:`int`\ ) +:ref:`Error` **kill**\ (\ pid\: :ref:`int`\ ) :ref:`🔗` Kill (terminate) the process identified by the given process ID (``pid``), such as the ID returned by :ref:`execute` in non-blocking mode. See also :ref:`crash`. @@ -1446,7 +1446,7 @@ Kill (terminate) the process identified by the given process ID (``pid``), such .. rst-class:: classref-method -:ref:`Error` **move_to_trash**\ (\ path\: :ref:`String`\ ) |const| +:ref:`Error` **move_to_trash**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Moves the file or directory at the given ``path`` to the system's recycle bin. See also :ref:`DirAccess.remove`. @@ -1481,7 +1481,7 @@ Returns :ref:`@GlobalScope.FAILED` if the fi .. rst-class:: classref-method -|void| **open_midi_inputs**\ (\ ) +|void| **open_midi_inputs**\ (\ ) :ref:`🔗` Initializes the singleton for the system MIDI driver, allowing Godot to receive :ref:`InputEventMIDI`. See also :ref:`get_connected_midi_inputs` and :ref:`close_midi_inputs`. @@ -1495,7 +1495,7 @@ Initializes the singleton for the system MIDI driver, allowing Godot to receive .. rst-class:: classref-method -:ref:`String` **read_string_from_stdin**\ (\ ) +:ref:`String` **read_string_from_stdin**\ (\ ) :ref:`🔗` Reads a user input string from the standard input (usually the terminal). This operation is *blocking*, which causes the window to freeze if :ref:`read_string_from_stdin` is called on the main thread. The thread calling :ref:`read_string_from_stdin` will block until the program receives a line break in standard input (usually by the user pressing :kbd:`Enter`). @@ -1511,7 +1511,7 @@ Reads a user input string from the standard input (usually the terminal). This o .. rst-class:: classref-method -:ref:`bool` **request_permission**\ (\ name\: :ref:`String`\ ) +:ref:`bool` **request_permission**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Requests permission from the OS for the given ``name``. Returns ``true`` if the permission has been successfully granted. @@ -1525,7 +1525,7 @@ Requests permission from the OS for the given ``name``. Returns ``true`` if the .. rst-class:: classref-method -:ref:`bool` **request_permissions**\ (\ ) +:ref:`bool` **request_permissions**\ (\ ) :ref:`🔗` Requests *dangerous* permissions from the OS. Returns ``true`` if permissions have been successfully granted. @@ -1539,7 +1539,7 @@ Requests *dangerous* permissions from the OS. Returns ``true`` if permissions ha .. rst-class:: classref-method -|void| **revoke_granted_permissions**\ (\ ) +|void| **revoke_granted_permissions**\ (\ ) :ref:`🔗` On macOS (sandboxed applications only), this function clears list of user selected folders accessible to the application. @@ -1551,7 +1551,7 @@ On macOS (sandboxed applications only), this function clears list of user select .. rst-class:: classref-method -|void| **set_environment**\ (\ variable\: :ref:`String`, value\: :ref:`String`\ ) |const| +|void| **set_environment**\ (\ variable\: :ref:`String`, value\: :ref:`String`\ ) |const| :ref:`🔗` Sets the value of the environment variable ``variable`` to ``value``. The environment variable will be set for the Godot process and any process executed with :ref:`execute` after running :ref:`set_environment`. The environment variable will *not* persist to processes run after the Godot process was terminated. @@ -1565,7 +1565,7 @@ Sets the value of the environment variable ``variable`` to ``value``. The enviro .. rst-class:: classref-method -|void| **set_restart_on_exit**\ (\ restart\: :ref:`bool`, arguments\: :ref:`PackedStringArray` = PackedStringArray()\ ) +|void| **set_restart_on_exit**\ (\ restart\: :ref:`bool`, arguments\: :ref:`PackedStringArray` = PackedStringArray()\ ) :ref:`🔗` If ``restart`` is ``true``, restarts the project automatically when it is exited with :ref:`SceneTree.quit` or :ref:`Node.NOTIFICATION_WM_CLOSE_REQUEST`. Command-line ``arguments`` can be supplied. To restart the project with the same command line arguments as originally used to run the project, pass :ref:`get_cmdline_args` as the value for ``arguments``. @@ -1583,7 +1583,7 @@ This method can be used to apply setting changes that require a restart. See als .. rst-class:: classref-method -:ref:`Error` **set_thread_name**\ (\ name\: :ref:`String`\ ) +:ref:`Error` **set_thread_name**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Assigns the given name to the current thread. Returns :ref:`@GlobalScope.ERR_UNAVAILABLE` if unavailable on the current platform. @@ -1595,7 +1595,7 @@ Assigns the given name to the current thread. Returns :ref:`@GlobalScope.ERR_UNA .. rst-class:: classref-method -|void| **set_use_file_access_save_and_swap**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_use_file_access_save_and_swap**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, when opening a file for writing, a temporary file is used in its place. When closed, it is automatically applied to the target file. @@ -1609,7 +1609,7 @@ This can useful when files may be opened by other applications, such as antiviru .. rst-class:: classref-method -:ref:`Error` **shell_open**\ (\ uri\: :ref:`String`\ ) +:ref:`Error` **shell_open**\ (\ uri\: :ref:`String`\ ) :ref:`🔗` Requests the OS to open a resource identified by ``uri`` with the most appropriate program. For example: @@ -1633,7 +1633,7 @@ Use :ref:`ProjectSettings.globalize_path` **shell_show_in_file_manager**\ (\ file_or_dir_path\: :ref:`String`, open_folder\: :ref:`bool` = true\ ) +:ref:`Error` **shell_show_in_file_manager**\ (\ file_or_dir_path\: :ref:`String`, open_folder\: :ref:`bool` = true\ ) :ref:`🔗` Requests the OS to open the file manager, navigate to the given ``file_or_dir_path`` and select the target file or folder. @@ -1651,7 +1651,7 @@ Use :ref:`ProjectSettings.globalize_path`\ ) |const| +|void| **unset_environment**\ (\ variable\: :ref:`String`\ ) |const| :ref:`🔗` Removes the given environment variable from the current environment, if it exists. The ``variable`` name cannot be empty or include the ``=`` character. The environment variable will be removed for the Godot process and any process executed with :ref:`execute` after running :ref:`unset_environment`. The removal of the environment variable will *not* persist to processes run after the Godot process was terminated. diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index c5450db1bbf..4cd742c92e8 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -202,7 +202,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedByteArray` **PackedByteArray**\ (\ ) +:ref:`PackedByteArray` **PackedByteArray**\ (\ ) :ref:`🔗` Constructs an empty **PackedByteArray**. @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -251,7 +251,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedByteArray`\ ) :ref:`🔗` Appends a **PackedByteArray** at the end of this array. @@ -263,7 +263,7 @@ Appends a **PackedByteArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -277,7 +277,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -289,7 +289,7 @@ Clears the array. This is equivalent to using :ref:`resize` **compress**\ (\ compression_mode\: :ref:`int` = 0\ ) |const| +:ref:`PackedByteArray` **compress**\ (\ compression_mode\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns a new **PackedByteArray** with the data compressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. @@ -301,7 +301,7 @@ Returns a new **PackedByteArray** with the data compressed. Set the compression .. rst-class:: classref-method -:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -313,7 +313,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`float` **decode_double**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`float` **decode_double**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 64-bit floating-point number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0.0`` if a valid number can't be decoded. @@ -325,7 +325,7 @@ Decodes a 64-bit floating-point number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`float` **decode_float**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`float` **decode_float**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 32-bit floating-point number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0.0`` if a valid number can't be decoded. @@ -337,7 +337,7 @@ Decodes a 32-bit floating-point number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`float` **decode_half**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`float` **decode_half**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 16-bit floating-point number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0.0`` if a valid number can't be decoded. @@ -349,7 +349,7 @@ Decodes a 16-bit floating-point number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_s8**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_s8**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 8-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -361,7 +361,7 @@ Decodes a 8-bit signed integer number from the bytes starting at ``byte_offset`` .. rst-class:: classref-method -:ref:`int` **decode_s16**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_s16**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 16-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -373,7 +373,7 @@ Decodes a 16-bit signed integer number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_s32**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_s32**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 32-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -385,7 +385,7 @@ Decodes a 32-bit signed integer number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_s64**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_s64**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 64-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -397,7 +397,7 @@ Decodes a 64-bit signed integer number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_u8**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_u8**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 8-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -409,7 +409,7 @@ Decodes a 8-bit unsigned integer number from the bytes starting at ``byte_offset .. rst-class:: classref-method -:ref:`int` **decode_u16**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_u16**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 16-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -421,7 +421,7 @@ Decodes a 16-bit unsigned integer number from the bytes starting at ``byte_offse .. rst-class:: classref-method -:ref:`int` **decode_u32**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_u32**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 32-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -433,7 +433,7 @@ Decodes a 32-bit unsigned integer number from the bytes starting at ``byte_offse .. rst-class:: classref-method -:ref:`int` **decode_u64**\ (\ byte_offset\: :ref:`int`\ ) |const| +:ref:`int` **decode_u64**\ (\ byte_offset\: :ref:`int`\ ) |const| :ref:`🔗` Decodes a 64-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -445,7 +445,7 @@ Decodes a 64-bit unsigned integer number from the bytes starting at ``byte_offse .. rst-class:: classref-method -:ref:`Variant` **decode_var**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| +:ref:`Variant` **decode_var**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| :ref:`🔗` Decodes a :ref:`Variant` from the bytes starting at ``byte_offset``. Returns ``null`` if a valid variant can't be decoded or the value is :ref:`Object`-derived and ``allow_objects`` is ``false``. @@ -457,7 +457,7 @@ Decodes a :ref:`Variant` from the bytes starting at ``byte_offset .. rst-class:: classref-method -:ref:`int` **decode_var_size**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| +:ref:`int` **decode_var_size**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| :ref:`🔗` Decodes a size of a :ref:`Variant` from the bytes starting at ``byte_offset``. Requires at least 4 bytes of data starting at the offset, otherwise fails. @@ -469,7 +469,7 @@ Decodes a size of a :ref:`Variant` from the bytes starting at ``b .. rst-class:: classref-method -:ref:`PackedByteArray` **decompress**\ (\ buffer_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| +:ref:`PackedByteArray` **decompress**\ (\ buffer_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns a new **PackedByteArray** with the data decompressed. Set ``buffer_size`` to the size of the uncompressed data. Set the compression mode using one of :ref:`CompressionMode`'s constants. @@ -483,7 +483,7 @@ Returns a new **PackedByteArray** with the data decompressed. Set ``buffer_size` .. rst-class:: classref-method -:ref:`PackedByteArray` **decompress_dynamic**\ (\ max_output_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| +:ref:`PackedByteArray` **decompress_dynamic**\ (\ max_output_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns a new **PackedByteArray** with the data decompressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. **This method only accepts brotli, gzip, and deflate compression modes.**\ @@ -501,7 +501,7 @@ GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a .. rst-class:: classref-method -:ref:`PackedByteArray` **duplicate**\ (\ ) +:ref:`PackedByteArray` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -513,7 +513,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **encode_double**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) +|void| **encode_double**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Encodes a 64-bit floating-point number as bytes at the index of ``byte_offset`` bytes. The array must have at least 8 bytes of allocated space, starting at the offset. @@ -525,7 +525,7 @@ Encodes a 64-bit floating-point number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -|void| **encode_float**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) +|void| **encode_float**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Encodes a 32-bit floating-point number as bytes at the index of ``byte_offset`` bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -537,7 +537,7 @@ Encodes a 32-bit floating-point number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -|void| **encode_half**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) +|void| **encode_half**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Encodes a 16-bit floating-point number as bytes at the index of ``byte_offset`` bytes. The array must have at least 2 bytes of space, starting at the offset. @@ -549,7 +549,7 @@ Encodes a 16-bit floating-point number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -|void| **encode_s8**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_s8**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 8-bit signed integer number (signed byte) at the index of ``byte_offset`` bytes. The array must have at least 1 byte of space, starting at the offset. @@ -561,7 +561,7 @@ Encodes a 8-bit signed integer number (signed byte) at the index of ``byte_offse .. rst-class:: classref-method -|void| **encode_s16**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_s16**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 16-bit signed integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 2 bytes of space, starting at the offset. @@ -573,7 +573,7 @@ Encodes a 16-bit signed integer number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -|void| **encode_s32**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_s32**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 32-bit signed integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -585,7 +585,7 @@ Encodes a 32-bit signed integer number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -|void| **encode_s64**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_s64**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 64-bit signed integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 8 bytes of space, starting at the offset. @@ -597,7 +597,7 @@ Encodes a 64-bit signed integer number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -|void| **encode_u8**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_u8**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 8-bit unsigned integer number (byte) at the index of ``byte_offset`` bytes. The array must have at least 1 byte of space, starting at the offset. @@ -609,7 +609,7 @@ Encodes a 8-bit unsigned integer number (byte) at the index of ``byte_offset`` b .. rst-class:: classref-method -|void| **encode_u16**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_u16**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 16-bit unsigned integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 2 bytes of space, starting at the offset. @@ -621,7 +621,7 @@ Encodes a 16-bit unsigned integer number as bytes at the index of ``byte_offset` .. rst-class:: classref-method -|void| **encode_u32**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_u32**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 32-bit unsigned integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -633,7 +633,7 @@ Encodes a 32-bit unsigned integer number as bytes at the index of ``byte_offset` .. rst-class:: classref-method -|void| **encode_u64**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) +|void| **encode_u64**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Encodes a 64-bit unsigned integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 8 bytes of space, starting at the offset. @@ -645,7 +645,7 @@ Encodes a 64-bit unsigned integer number as bytes at the index of ``byte_offset` .. rst-class:: classref-method -:ref:`int` **encode_var**\ (\ byte_offset\: :ref:`int`, value\: :ref:`Variant`, allow_objects\: :ref:`bool` = false\ ) +:ref:`int` **encode_var**\ (\ byte_offset\: :ref:`int`, value\: :ref:`Variant`, allow_objects\: :ref:`bool` = false\ ) :ref:`🔗` Encodes a :ref:`Variant` at the index of ``byte_offset`` bytes. A sufficient space must be allocated, depending on the encoded variant's size. If ``allow_objects`` is ``false``, :ref:`Object`-derived values are not permitted and will instead be serialized as ID-only. @@ -657,7 +657,7 @@ Encodes a :ref:`Variant` at the index of ``byte_offset`` bytes. A .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`int`\ ) +|void| **fill**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -669,7 +669,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -681,7 +681,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`String` **get_string_from_ascii**\ (\ ) |const| +:ref:`String` **get_string_from_ascii**\ (\ ) |const| :ref:`🔗` Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. This is the inverse of :ref:`String.to_ascii_buffer`. @@ -693,7 +693,7 @@ Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast altern .. rst-class:: classref-method -:ref:`String` **get_string_from_utf8**\ (\ ) |const| +:ref:`String` **get_string_from_utf8**\ (\ ) |const| :ref:`🔗` Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. This is the inverse of :ref:`String.to_utf8_buffer`. @@ -705,7 +705,7 @@ Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`g .. rst-class:: classref-method -:ref:`String` **get_string_from_utf16**\ (\ ) |const| +:ref:`String` **get_string_from_utf16**\ (\ ) |const| :ref:`🔗` Converts UTF-16 encoded array to :ref:`String`. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of :ref:`String.to_utf16_buffer`. @@ -717,7 +717,7 @@ Converts UTF-16 encoded array to :ref:`String`. If the BOM is miss .. rst-class:: classref-method -:ref:`String` **get_string_from_utf32**\ (\ ) |const| +:ref:`String` **get_string_from_utf32**\ (\ ) |const| :ref:`🔗` Converts UTF-32 encoded array to :ref:`String`. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string. This is the inverse of :ref:`String.to_utf32_buffer`. @@ -729,7 +729,7 @@ Converts UTF-32 encoded array to :ref:`String`. System endianness .. rst-class:: classref-method -:ref:`String` **get_string_from_wchar**\ (\ ) |const| +:ref:`String` **get_string_from_wchar**\ (\ ) |const| :ref:`🔗` Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded array to :ref:`String`. Returns empty string if source array is not valid wide string. This is the inverse of :ref:`String.to_wchar_buffer`. @@ -741,7 +741,7 @@ Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platfor .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -753,7 +753,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`bool` **has_encoded_var**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| +:ref:`bool` **has_encoded_var**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if a valid :ref:`Variant` value can be decoded at the ``byte_offset``. Returns ``false`` otherwise or when the value is :ref:`Object`-derived and ``allow_objects`` is ``false``. @@ -765,7 +765,7 @@ Returns ``true`` if a valid :ref:`Variant` value can be decoded a .. rst-class:: classref-method -:ref:`String` **hex_encode**\ (\ ) |const| +:ref:`String` **hex_encode**\ (\ ) |const| :ref:`🔗` Returns a hexadecimal representation of this array as a :ref:`String`. @@ -792,7 +792,7 @@ Returns a hexadecimal representation of this array as a :ref:`String` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -804,7 +804,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -816,7 +816,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Appends an element at the end of the array. @@ -828,7 +828,7 @@ Appends an element at the end of the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -840,7 +840,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -852,7 +852,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -864,7 +864,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -876,7 +876,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Changes the byte at the given index. @@ -888,7 +888,7 @@ Changes the byte at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -900,7 +900,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedByteArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedByteArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedByteArray**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedByteArray**. @@ -916,7 +916,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -928,7 +928,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **to_float32_array**\ (\ ) |const| +:ref:`PackedFloat32Array` **to_float32_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedFloat32Array`, where each block of 4 bytes has been converted to a 32-bit float (C++ ``float``). @@ -944,7 +944,7 @@ If the original data can't be converted to 32-bit floats, the resulting data is .. rst-class:: classref-method -:ref:`PackedFloat64Array` **to_float64_array**\ (\ ) |const| +:ref:`PackedFloat64Array` **to_float64_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedFloat64Array`, where each block of 8 bytes has been converted to a 64-bit float (C++ ``double``, Godot :ref:`float`). @@ -960,7 +960,7 @@ If the original data can't be converted to 64-bit floats, the resulting data is .. rst-class:: classref-method -:ref:`PackedInt32Array` **to_int32_array**\ (\ ) |const| +:ref:`PackedInt32Array` **to_int32_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedInt32Array`, where each block of 4 bytes has been converted to a signed 32-bit integer (C++ ``int32_t``). @@ -976,7 +976,7 @@ If the original data can't be converted to signed 32-bit integers, the resulting .. rst-class:: classref-method -:ref:`PackedInt64Array` **to_int64_array**\ (\ ) |const| +:ref:`PackedInt64Array` **to_int64_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedInt64Array`, where each block of 8 bytes has been converted to a signed 64-bit integer (C++ ``int64_t``, Godot :ref:`int`). @@ -997,7 +997,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedByteArray`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedByteArray`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -1009,7 +1009,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedByteArray` **operator +**\ (\ right\: :ref:`PackedByteArray`\ ) +:ref:`PackedByteArray` **operator +**\ (\ right\: :ref:`PackedByteArray`\ ) :ref:`🔗` Returns a new **PackedByteArray** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -1021,7 +1021,7 @@ Returns a new **PackedByteArray** with contents of ``right`` added at the end of .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedByteArray`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedByteArray`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal bytes at the corresponding indices. @@ -1033,7 +1033,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the byte at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index 0f9530ad837..7b3775ce4ea 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -126,7 +126,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedColorArray` **PackedColorArray**\ (\ ) +:ref:`PackedColorArray` **PackedColorArray**\ (\ ) :ref:`🔗` Constructs an empty **PackedColorArray**. @@ -169,7 +169,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`Color`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`Color`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -181,7 +181,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedColorArray`\ ) :ref:`🔗` Appends a **PackedColorArray** at the end of this array. @@ -193,7 +193,7 @@ Appends a **PackedColorArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -207,7 +207,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -219,7 +219,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`Color`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`Color`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -231,7 +231,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedColorArray` **duplicate**\ (\ ) +:ref:`PackedColorArray` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -243,7 +243,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`Color`\ ) +|void| **fill**\ (\ value\: :ref:`Color`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -255,7 +255,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -267,7 +267,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`Color`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`Color`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -279,7 +279,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Color`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Color`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -291,7 +291,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -303,7 +303,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`Color`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`Color`\ ) :ref:`🔗` Appends a value to the array. @@ -315,7 +315,7 @@ Appends a value to the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -327,7 +327,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -339,7 +339,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -351,7 +351,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`Color`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Color`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -363,7 +363,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Color`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Color`\ ) :ref:`🔗` Changes the :ref:`Color` at the given index. @@ -375,7 +375,7 @@ Changes the :ref:`Color` at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -387,7 +387,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedColorArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedColorArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedColorArray**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedColorArray**. @@ -403,7 +403,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -415,7 +415,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedByteArray` with each color encoded as bytes. @@ -432,7 +432,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedColorArray`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedColorArray`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -444,7 +444,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedColorArray` **operator +**\ (\ right\: :ref:`PackedColorArray`\ ) +:ref:`PackedColorArray` **operator +**\ (\ right\: :ref:`PackedColorArray`\ ) :ref:`🔗` Returns a new **PackedColorArray** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -456,7 +456,7 @@ Returns a new **PackedColorArray** with contents of ``right`` added at the end o .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedColorArray`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedColorArray`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Color`\ s at the corresponding indices. @@ -468,7 +468,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Color` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Color` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Color` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 150848cd731..d62329be378 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **pack**\ (\ value\: :ref:`Variant`\ ) +:ref:`Error` **pack**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Packs the given container into a binary representation. The ``value`` must be either :ref:`Array` or :ref:`Dictionary`, any other type will result in invalid data error. @@ -84,7 +84,7 @@ Packs the given container into a binary representation. The ``value`` must be ei .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the size of the packed container (see :ref:`Array.size` and :ref:`Dictionary.size`). diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index eacdab73d38..7d86c5ad767 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the size of the packed container (see :ref:`Array.size` and :ref:`Dictionary.size`). diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst index 791c171d8da..d06bec47b6d 100644 --- a/classes/class_packedfloat32array.rst +++ b/classes/class_packedfloat32array.rst @@ -126,7 +126,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedFloat32Array` **PackedFloat32Array**\ (\ ) +:ref:`PackedFloat32Array` **PackedFloat32Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedFloat32Array**. @@ -163,7 +163,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`float`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -175,7 +175,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Appends a **PackedFloat32Array** at the end of this array. @@ -187,7 +187,7 @@ Appends a **PackedFloat32Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -203,7 +203,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -215,7 +215,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`float`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`float`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -229,7 +229,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **duplicate**\ (\ ) +:ref:`PackedFloat32Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -241,7 +241,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`float`\ ) +|void| **fill**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -253,7 +253,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -267,7 +267,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`float`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`float`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -281,7 +281,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -293,7 +293,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -305,7 +305,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`float`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Appends an element at the end of the array. @@ -317,7 +317,7 @@ Appends an element at the end of the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -329,7 +329,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -341,7 +341,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -353,7 +353,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -367,7 +367,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Changes the float at the given index. @@ -379,7 +379,7 @@ Changes the float at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -391,7 +391,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedFloat32Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedFloat32Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat32Array**. @@ -407,7 +407,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -421,7 +421,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 4 bytes. @@ -440,7 +440,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedFloat32Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -452,7 +452,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedFloat32Array` **operator +**\ (\ right\: :ref:`PackedFloat32Array`\ ) +:ref:`PackedFloat32Array` **operator +**\ (\ right\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Returns a new **PackedFloat32Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -464,7 +464,7 @@ Returns a new **PackedFloat32Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedFloat32Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal floats at the corresponding indices. @@ -476,7 +476,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`float` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index c47d8a9916a..c77ec3e8124 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -128,7 +128,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedFloat64Array` **PackedFloat64Array**\ (\ ) +:ref:`PackedFloat64Array` **PackedFloat64Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedFloat64Array**. @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`float`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -177,7 +177,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedFloat64Array`\ ) :ref:`🔗` Appends a **PackedFloat64Array** at the end of this array. @@ -189,7 +189,7 @@ Appends a **PackedFloat64Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -205,7 +205,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -217,7 +217,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`float`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`float`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -231,7 +231,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedFloat64Array` **duplicate**\ (\ ) +:ref:`PackedFloat64Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -243,7 +243,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`float`\ ) +|void| **fill**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -255,7 +255,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -269,7 +269,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`float`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`float`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -283,7 +283,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -295,7 +295,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -307,7 +307,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`float`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Appends an element at the end of the array. @@ -319,7 +319,7 @@ Appends an element at the end of the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -331,7 +331,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -343,7 +343,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -355,7 +355,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -369,7 +369,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Changes the float at the given index. @@ -381,7 +381,7 @@ Changes the float at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -393,7 +393,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedFloat64Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedFloat64Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedFloat64Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat64Array**. @@ -409,7 +409,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -423,7 +423,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 8 bytes. @@ -442,7 +442,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedFloat64Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedFloat64Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -454,7 +454,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedFloat64Array` **operator +**\ (\ right\: :ref:`PackedFloat64Array`\ ) +:ref:`PackedFloat64Array` **operator +**\ (\ right\: :ref:`PackedFloat64Array`\ ) :ref:`🔗` Returns a new **PackedFloat64Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -466,7 +466,7 @@ Returns a new **PackedFloat64Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedFloat64Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedFloat64Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal doubles at the corresponding indices. @@ -478,7 +478,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`float` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index 3799759f6ea..66bb53c8e28 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -126,7 +126,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedInt32Array` **PackedInt32Array**\ (\ ) +:ref:`PackedInt32Array` **PackedInt32Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedInt32Array**. @@ -163,7 +163,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -175,7 +175,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Appends a **PackedInt32Array** at the end of this array. @@ -187,7 +187,7 @@ Appends a **PackedInt32Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -201,7 +201,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -213,7 +213,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`int`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -225,7 +225,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedInt32Array` **duplicate**\ (\ ) +:ref:`PackedInt32Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -237,7 +237,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`int`\ ) +|void| **fill**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -249,7 +249,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -261,7 +261,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -273,7 +273,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -285,7 +285,7 @@ Inserts a new integer at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -297,7 +297,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Appends a value to the array. @@ -309,7 +309,7 @@ Appends a value to the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -321,7 +321,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -333,7 +333,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -345,7 +345,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -357,7 +357,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Changes the integer at the given index. @@ -369,7 +369,7 @@ Changes the integer at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -381,7 +381,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedInt32Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedInt32Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedInt32Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedInt32Array**. @@ -397,7 +397,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -409,7 +409,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 4 bytes. @@ -428,7 +428,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedInt32Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -440,7 +440,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedInt32Array` **operator +**\ (\ right\: :ref:`PackedInt32Array`\ ) +:ref:`PackedInt32Array` **operator +**\ (\ right\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Returns a new **PackedInt32Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -452,7 +452,7 @@ Returns a new **PackedInt32Array** with contents of ``right`` added at the end o .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedInt32Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal ints at the corresponding indices. @@ -464,7 +464,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`int` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index 8291b5ea7a5..4a7ea79463b 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -128,7 +128,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedInt64Array` **PackedInt64Array**\ (\ ) +:ref:`PackedInt64Array` **PackedInt64Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedInt64Array**. @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -177,7 +177,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedInt64Array`\ ) :ref:`🔗` Appends a **PackedInt64Array** at the end of this array. @@ -189,7 +189,7 @@ Appends a **PackedInt64Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -203,7 +203,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -215,7 +215,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`int`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -227,7 +227,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedInt64Array` **duplicate**\ (\ ) +:ref:`PackedInt64Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -239,7 +239,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`int`\ ) +|void| **fill**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -251,7 +251,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -263,7 +263,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -275,7 +275,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -287,7 +287,7 @@ Inserts a new integer at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -299,7 +299,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Appends a value to the array. @@ -311,7 +311,7 @@ Appends a value to the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -323,7 +323,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -335,7 +335,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -347,7 +347,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -359,7 +359,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) :ref:`🔗` Changes the integer at the given index. @@ -371,7 +371,7 @@ Changes the integer at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -383,7 +383,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedInt64Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedInt64Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedInt64Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedInt64Array**. @@ -399,7 +399,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -411,7 +411,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 8 bytes. @@ -430,7 +430,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedInt64Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedInt64Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -442,7 +442,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedInt64Array` **operator +**\ (\ right\: :ref:`PackedInt64Array`\ ) +:ref:`PackedInt64Array` **operator +**\ (\ right\: :ref:`PackedInt64Array`\ ) :ref:`🔗` Returns a new **PackedInt64Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -454,7 +454,7 @@ Returns a new **PackedInt64Array** with contents of ``right`` added at the end o .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedInt64Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedInt64Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal ints at the corresponding indices. @@ -466,7 +466,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`int` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index fb01afb453c..497d46b6eb9 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -151,7 +151,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **GenEditState**: +enum **GenEditState**: :ref:`🔗` .. _class_PackedScene_constant_GEN_EDIT_STATE_DISABLED: @@ -204,7 +204,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Dictionary` **_bundled** = ``{ "conn_count": 0, "conns": PackedInt32Array(), "editable_instances": [], "names": PackedStringArray(), "node_count": 0, "node_paths": [], "nodes": PackedInt32Array(), "variants": [], "version": 3 }`` +:ref:`Dictionary` **_bundled** = ``{ "conn_count": 0, "conns": PackedInt32Array(), "editable_instances": [], "names": PackedStringArray(), "node_count": 0, "node_paths": [], "nodes": PackedInt32Array(), "variants": [], "version": 3 }`` :ref:`🔗` A dictionary representation of the scene contents. @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_instantiate**\ (\ ) |const| +:ref:`bool` **can_instantiate**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the scene file has nodes. @@ -235,7 +235,7 @@ Returns ``true`` if the scene file has nodes. .. rst-class:: classref-method -:ref:`SceneState` **get_state**\ (\ ) |const| +:ref:`SceneState` **get_state**\ (\ ) |const| :ref:`🔗` Returns the :ref:`SceneState` representing the scene file contents. @@ -247,7 +247,7 @@ Returns the :ref:`SceneState` representing the scene file cont .. rst-class:: classref-method -:ref:`Node` **instantiate**\ (\ edit_state\: :ref:`GenEditState` = 0\ ) |const| +:ref:`Node` **instantiate**\ (\ edit_state\: :ref:`GenEditState` = 0\ ) |const| :ref:`🔗` Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a :ref:`Node.NOTIFICATION_SCENE_INSTANTIATED` notification on the root node. @@ -259,7 +259,7 @@ Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). .. rst-class:: classref-method -:ref:`Error` **pack**\ (\ path\: :ref:`Node`\ ) +:ref:`Error` **pack**\ (\ path\: :ref:`Node`\ ) :ref:`🔗` Packs the ``path`` node, and all owned sub-nodes, into this **PackedScene**. Any existing data will be cleared. See :ref:`Node.owner`. diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst index f91f6aa38c3..76fca07c585 100644 --- a/classes/class_packedstringarray.rst +++ b/classes/class_packedstringarray.rst @@ -141,7 +141,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedStringArray` **PackedStringArray**\ (\ ) +:ref:`PackedStringArray` **PackedStringArray**\ (\ ) :ref:`🔗` Constructs an empty **PackedStringArray**. @@ -178,7 +178,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`String`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`String`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -190,7 +190,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedStringArray`\ ) :ref:`🔗` Appends a **PackedStringArray** at the end of this array. @@ -202,7 +202,7 @@ Appends a **PackedStringArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -216,7 +216,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -228,7 +228,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`String`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`String`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -240,7 +240,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedStringArray` **duplicate**\ (\ ) +:ref:`PackedStringArray` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -252,7 +252,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`String`\ ) +|void| **fill**\ (\ value\: :ref:`String`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -264,7 +264,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -276,7 +276,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`String`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -288,7 +288,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`String`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`String`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -300,7 +300,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -312,7 +312,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`String`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`String`\ ) :ref:`🔗` Appends a string element at end of the array. @@ -324,7 +324,7 @@ Appends a string element at end of the array. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -336,7 +336,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -348,7 +348,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -360,7 +360,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -372,7 +372,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`String`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`String`\ ) :ref:`🔗` Changes the :ref:`String` at the given index. @@ -384,7 +384,7 @@ Changes the :ref:`String` at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -396,7 +396,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedStringArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedStringArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedStringArray**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedStringArray**. @@ -412,7 +412,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -424,7 +424,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedByteArray` with each string encoded as bytes. @@ -441,7 +441,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedStringArray`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedStringArray`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -453,7 +453,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedStringArray` **operator +**\ (\ right\: :ref:`PackedStringArray`\ ) +:ref:`PackedStringArray` **operator +**\ (\ right\: :ref:`PackedStringArray`\ ) :ref:`🔗` Returns a new **PackedStringArray** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -465,7 +465,7 @@ Returns a new **PackedStringArray** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedStringArray`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedStringArray`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`String`\ s at the corresponding indices. @@ -477,7 +477,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`String` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`String` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`String` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index 8c5b3741b98..33783faf019 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -135,7 +135,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedVector2Array` **PackedVector2Array**\ (\ ) +:ref:`PackedVector2Array` **PackedVector2Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedVector2Array**. @@ -178,7 +178,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`Vector2`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`Vector2`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -190,7 +190,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Appends a **PackedVector2Array** at the end of this array. @@ -202,7 +202,7 @@ Appends a **PackedVector2Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -218,7 +218,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -230,7 +230,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`Vector2`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -244,7 +244,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedVector2Array` **duplicate**\ (\ ) +:ref:`PackedVector2Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -256,7 +256,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`Vector2`\ ) +|void| **fill**\ (\ value\: :ref:`Vector2`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -268,7 +268,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -282,7 +282,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`Vector2`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -296,7 +296,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector2`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector2`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -308,7 +308,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -320,7 +320,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`Vector2`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`Vector2`\ ) :ref:`🔗` Inserts a :ref:`Vector2` at the end. @@ -332,7 +332,7 @@ Inserts a :ref:`Vector2` at the end. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -344,7 +344,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -356,7 +356,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -368,7 +368,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -382,7 +382,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector2`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector2`\ ) :ref:`🔗` Changes the :ref:`Vector2` at the given index. @@ -394,7 +394,7 @@ Changes the :ref:`Vector2` at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -406,7 +406,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedVector2Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedVector2Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedVector2Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector2Array**. @@ -422,7 +422,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -436,7 +436,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedByteArray` with each vector encoded as bytes. @@ -453,7 +453,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector2Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -465,7 +465,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedVector2Array` **operator ***\ (\ right\: :ref:`Transform2D`\ ) +:ref:`PackedVector2Array` **operator ***\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Returns a new **PackedVector2Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -481,7 +481,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`PackedVector2Array` **operator +**\ (\ right\: :ref:`PackedVector2Array`\ ) +:ref:`PackedVector2Array` **operator +**\ (\ right\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Returns a new **PackedVector2Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -493,7 +493,7 @@ Returns a new **PackedVector2Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector2Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector2`\ s at the corresponding indices. @@ -505,7 +505,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Vector2` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Vector2` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Vector2` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index bd4d0b4da83..9b667b549ed 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -128,7 +128,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedVector3Array` **PackedVector3Array**\ (\ ) +:ref:`PackedVector3Array` **PackedVector3Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedVector3Array**. @@ -171,7 +171,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`Vector3`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -183,7 +183,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Appends a **PackedVector3Array** at the end of this array. @@ -195,7 +195,7 @@ Appends a **PackedVector3Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -211,7 +211,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -223,7 +223,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`Vector3`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -237,7 +237,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedVector3Array` **duplicate**\ (\ ) +:ref:`PackedVector3Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -249,7 +249,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`Vector3`\ ) +|void| **fill**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -261,7 +261,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -275,7 +275,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`Vector3`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -289,7 +289,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector3`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector3`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -301,7 +301,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -313,7 +313,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`Vector3`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` Inserts a :ref:`Vector3` at the end. @@ -325,7 +325,7 @@ Inserts a :ref:`Vector3` at the end. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -337,7 +337,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. @@ -349,7 +349,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -361,7 +361,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -375,7 +375,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector3`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector3`\ ) :ref:`🔗` Changes the :ref:`Vector3` at the given index. @@ -387,7 +387,7 @@ Changes the :ref:`Vector3` at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -399,7 +399,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedVector3Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedVector3Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedVector3Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector3Array**. @@ -415,7 +415,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -429,7 +429,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedByteArray` with each vector encoded as bytes. @@ -446,7 +446,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector3Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -458,7 +458,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedVector3Array` **operator ***\ (\ right\: :ref:`Transform3D`\ ) +:ref:`PackedVector3Array` **operator ***\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Returns a new **PackedVector3Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform3D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -474,7 +474,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`PackedVector3Array` **operator +**\ (\ right\: :ref:`PackedVector3Array`\ ) +:ref:`PackedVector3Array` **operator +**\ (\ right\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Returns a new **PackedVector3Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -486,7 +486,7 @@ Returns a new **PackedVector3Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector3Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector3`\ s at the corresponding indices. @@ -498,7 +498,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Vector3` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Vector3` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Vector3` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packedvector4array.rst b/classes/class_packedvector4array.rst index 8c5afb1c78a..1ddf1682fac 100644 --- a/classes/class_packedvector4array.rst +++ b/classes/class_packedvector4array.rst @@ -124,7 +124,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedVector4Array` **PackedVector4Array**\ (\ ) +:ref:`PackedVector4Array` **PackedVector4Array**\ (\ ) :ref:`🔗` Constructs an empty **PackedVector4Array**. @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append**\ (\ value\: :ref:`Vector4`\ ) +:ref:`bool` **append**\ (\ value\: :ref:`Vector4`\ ) :ref:`🔗` Appends an element at the end of the array (alias of :ref:`push_back`). @@ -179,7 +179,7 @@ Appends an element at the end of the array (alias of :ref:`push_back`\ ) +|void| **append_array**\ (\ array\: :ref:`PackedVector4Array`\ ) :ref:`🔗` Appends a **PackedVector4Array** at the end of this array. @@ -191,7 +191,7 @@ Appends a **PackedVector4Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Vector4`, before\: :ref:`bool` = true\ ) +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector4`, before\: :ref:`bool` = true\ ) :ref:`🔗` Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -207,7 +207,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -219,7 +219,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count**\ (\ value\: :ref:`Vector4`\ ) |const| +:ref:`int` **count**\ (\ value\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the number of times an element is in the array. @@ -233,7 +233,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedVector4Array` **duplicate**\ (\ ) +:ref:`PackedVector4Array` **duplicate**\ (\ ) :ref:`🔗` Creates a copy of the array, and returns it. @@ -245,7 +245,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -|void| **fill**\ (\ value\: :ref:`Vector4`\ ) +|void| **fill**\ (\ value\: :ref:`Vector4`\ ) :ref:`🔗` Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -257,7 +257,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find**\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -271,7 +271,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has**\ (\ value\: :ref:`Vector4`\ ) |const| +:ref:`bool` **has**\ (\ value\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns ``true`` if the array contains ``value``. @@ -285,7 +285,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector4`\ ) +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector4`\ ) :ref:`🔗` Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -297,7 +297,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the array is empty. @@ -309,7 +309,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back**\ (\ value\: :ref:`Vector4`\ ) +:ref:`bool` **push_back**\ (\ value\: :ref:`Vector4`\ ) :ref:`🔗` Inserts a :ref:`Vector4` at the end. @@ -321,7 +321,7 @@ Inserts a :ref:`Vector4` at the end. .. rst-class:: classref-method -|void| **remove_at**\ (\ index\: :ref:`int`\ ) +|void| **remove_at**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes an element from the array by index. @@ -333,7 +333,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. @@ -345,7 +345,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -|void| **reverse**\ (\ ) +|void| **reverse**\ (\ ) :ref:`🔗` Reverses the order of the elements in the array. @@ -357,7 +357,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -371,7 +371,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector4`\ ) +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector4`\ ) :ref:`🔗` Changes the :ref:`Vector4` at the given index. @@ -383,7 +383,7 @@ Changes the :ref:`Vector4` at the given index. .. rst-class:: classref-method -:ref:`int` **size**\ (\ ) |const| +:ref:`int` **size**\ (\ ) |const| :ref:`🔗` Returns the number of elements in the array. @@ -395,7 +395,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedVector4Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| +:ref:`PackedVector4Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| :ref:`🔗` Returns the slice of the **PackedVector4Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector4Array**. @@ -411,7 +411,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -|void| **sort**\ (\ ) +|void| **sort**\ (\ ) :ref:`🔗` Sorts the elements of the array in ascending order. @@ -425,7 +425,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| :ref:`🔗` Returns a :ref:`PackedByteArray` with each vector encoded as bytes. @@ -442,7 +442,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector4Array`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector4Array`\ ) :ref:`🔗` Returns ``true`` if contents of the arrays differ. @@ -454,7 +454,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedVector4Array` **operator +**\ (\ right\: :ref:`PackedVector4Array`\ ) +:ref:`PackedVector4Array` **operator +**\ (\ right\: :ref:`PackedVector4Array`\ ) :ref:`🔗` Returns a new **PackedVector4Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -466,7 +466,7 @@ Returns a new **PackedVector4Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector4Array`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector4Array`\ ) :ref:`🔗` Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector4`\ s at the corresponding indices. @@ -478,7 +478,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Vector4` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Vector4` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`Vector4` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index e82251d7b00..88180b22ac2 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **encode_buffer_max_size** = ``8388608`` +:ref:`int` **encode_buffer_max_size** = ``8388608`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_available_packet_count**\ (\ ) |const| +:ref:`int` **get_available_packet_count**\ (\ ) |const| :ref:`🔗` Returns the number of packets currently available in the ring-buffer. @@ -108,7 +108,7 @@ Returns the number of packets currently available in the ring-buffer. .. rst-class:: classref-method -:ref:`PackedByteArray` **get_packet**\ (\ ) +:ref:`PackedByteArray` **get_packet**\ (\ ) :ref:`🔗` Gets a raw packet. @@ -120,7 +120,7 @@ Gets a raw packet. .. rst-class:: classref-method -:ref:`Error` **get_packet_error**\ (\ ) |const| +:ref:`Error` **get_packet_error**\ (\ ) |const| :ref:`🔗` Returns the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). @@ -132,7 +132,7 @@ Returns the error state of the last packet received (via :ref:`get_packet` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) +:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) :ref:`🔗` Gets a Variant. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -148,7 +148,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -:ref:`Error` **put_packet**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **put_packet**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sends a raw packet. @@ -160,7 +160,7 @@ Sends a raw packet. .. rst-class:: classref-method -:ref:`Error` **put_var**\ (\ var\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) +:ref:`Error` **put_var**\ (\ var\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) :ref:`🔗` Sends a :ref:`Variant` as a packet. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index 36833923807..8d5775e604e 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Status**: +enum **Status**: :ref:`🔗` .. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED: @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **connect_to_peer**\ (\ packet_peer\: :ref:`PacketPeerUDP`, hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **connect_to_peer**\ (\ packet_peer\: :ref:`PacketPeerUDP`, hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :ref:`PacketPeerUDP` which must be connected (see :ref:`PacketPeerUDP.connect_to_host`). You can optionally specify the ``client_options`` to be used while verifying the TLS connections. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -123,7 +123,7 @@ Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :re .. rst-class:: classref-method -|void| **disconnect_from_peer**\ (\ ) +|void| **disconnect_from_peer**\ (\ ) :ref:`🔗` Disconnects this peer, terminating the DTLS session. @@ -135,7 +135,7 @@ Disconnects this peer, terminating the DTLS session. .. rst-class:: classref-method -:ref:`Status` **get_status**\ (\ ) |const| +:ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` Returns the status of the connection. See :ref:`Status` for values. @@ -147,7 +147,7 @@ Returns the status of the connection. See :ref:`Status` Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working. diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index 4c50efdd6b7..d50c2bfef06 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -47,7 +47,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -89,7 +89,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| +:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index d5da79923f3..3b7d62d1742 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **input_buffer_max_size** = ``65532`` +:ref:`int` **input_buffer_max_size** = ``65532`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **output_buffer_max_size** = ``65532`` +:ref:`int` **output_buffer_max_size** = ``65532`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StreamPeer` **stream_peer** +:ref:`StreamPeer` **stream_peer** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 34084f298ec..745ea55799b 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **bind**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", recv_buf_size\: :ref:`int` = 65536\ ) +:ref:`Error` **bind**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", recv_buf_size\: :ref:`int` = 65536\ ) :ref:`🔗` Binds this **PacketPeerUDP** to the specified ``port`` and ``bind_address`` with a buffer size ``recv_buf_size``, allowing it to receive incoming packets. @@ -90,7 +90,7 @@ If ``bind_address`` is set to any valid address (e.g. ``"192.168.1.101"``, ``":: .. rst-class:: classref-method -|void| **close**\ (\ ) +|void| **close**\ (\ ) :ref:`🔗` Closes the **PacketPeerUDP**'s underlying UDP socket. @@ -102,7 +102,7 @@ Closes the **PacketPeerUDP**'s underlying UDP socket. .. rst-class:: classref-method -:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Calling this method connects this UDP peer to the given ``host``/``port`` pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to :ref:`set_dest_address` are not allowed). This method does not send any data to the remote peer, to do that, use :ref:`PacketPeer.put_var` or :ref:`PacketPeer.put_packet` as usual. See also :ref:`UDPServer`. @@ -116,7 +116,7 @@ Calling this method connects this UDP peer to the given ``host``/``port`` pair. .. rst-class:: classref-method -:ref:`int` **get_local_port**\ (\ ) |const| +:ref:`int` **get_local_port**\ (\ ) |const| :ref:`🔗` Returns the local port to which this peer is bound. @@ -128,7 +128,7 @@ Returns the local port to which this peer is bound. .. rst-class:: classref-method -:ref:`String` **get_packet_ip**\ (\ ) |const| +:ref:`String` **get_packet_ip**\ (\ ) |const| :ref:`🔗` Returns the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -140,7 +140,7 @@ Returns the IP of the remote peer that sent the last packet(that was received wi .. rst-class:: classref-method -:ref:`int` **get_packet_port**\ (\ ) |const| +:ref:`int` **get_packet_port**\ (\ ) |const| :ref:`🔗` Returns the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -152,7 +152,7 @@ Returns the port of the remote peer that sent the last packet(that was received .. rst-class:: classref-method -:ref:`bool` **is_bound**\ (\ ) |const| +:ref:`bool` **is_bound**\ (\ ) |const| :ref:`🔗` Returns whether this **PacketPeerUDP** is bound to an address and can receive packets. @@ -164,7 +164,7 @@ Returns whether this **PacketPeerUDP** is bound to an address and can receive pa .. rst-class:: classref-method -:ref:`bool` **is_socket_connected**\ (\ ) |const| +:ref:`bool` **is_socket_connected**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the UDP socket is open and has been connected to a remote address. See :ref:`connect_to_host`. @@ -176,7 +176,7 @@ Returns ``true`` if the UDP socket is open and has been connected to a remote ad .. rst-class:: classref-method -:ref:`Error` **join_multicast_group**\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) +:ref:`Error` **join_multicast_group**\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) :ref:`🔗` Joins the multicast group specified by ``multicast_address`` using the interface identified by ``interface_name``. @@ -192,7 +192,7 @@ You can join the same multicast group with multiple interfaces. Use :ref:`IP.get .. rst-class:: classref-method -:ref:`Error` **leave_multicast_group**\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) +:ref:`Error` **leave_multicast_group**\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) :ref:`🔗` Removes the interface identified by ``interface_name`` from the multicast group specified by ``multicast_address``. @@ -204,7 +204,7 @@ Removes the interface identified by ``interface_name`` from the multicast group .. rst-class:: classref-method -|void| **set_broadcast_enabled**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_broadcast_enabled**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` Enable or disable sending of broadcast packets (e.g. ``set_dest_address("255.255.255.255", 4343)``. This option is disabled by default. @@ -218,7 +218,7 @@ Enable or disable sending of broadcast packets (e.g. ``set_dest_address("255.255 .. rst-class:: classref-method -:ref:`Error` **set_dest_address**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +:ref:`Error` **set_dest_address**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. @@ -232,7 +232,7 @@ Sets the destination address and port for sending packets and variables. A hostn .. rst-class:: classref-method -:ref:`Error` **wait**\ (\ ) +:ref:`Error` **wait**\ (\ ) :ref:`🔗` Waits for a packet to arrive on the bound address. See :ref:`bind`. diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 90948fc509a..c5ec36b1f2e 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -55,7 +55,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The :ref:`StyleBox` of this control. diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index 04de2f1c978..8505ed8780a 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -69,7 +69,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The style of **PanelContainer**'s background. diff --git a/classes/class_panoramaskymaterial.rst b/classes/class_panoramaskymaterial.rst index b719114b091..0759e569aa0 100644 --- a/classes/class_panoramaskymaterial.rst +++ b/classes/class_panoramaskymaterial.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **energy_multiplier** = ``1.0`` +:ref:`float` **energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-property -:ref:`bool` **filter** = ``true`` +:ref:`bool` **filter** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ A boolean value to determine if the background texture should be filtered or not .. rst-class:: classref-property -:ref:`Texture2D` **panorama** +:ref:`Texture2D` **panorama** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_parallax2d.rst b/classes/class_parallax2d.rst index decfec93b58..a8d7337406c 100644 --- a/classes/class_parallax2d.rst +++ b/classes/class_parallax2d.rst @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **autoscroll** = ``Vector2(0, 0)`` +:ref:`Vector2` **autoscroll** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -87,7 +87,7 @@ Velocity at which the offset scrolls automatically, in pixels per second. .. rst-class:: classref-property -:ref:`bool` **follow_viewport** = ``true`` +:ref:`bool` **follow_viewport** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ If ``true``, this **Parallax2D** is offset by the current camera's position. If .. rst-class:: classref-property -:ref:`bool` **ignore_camera_scroll** = ``false`` +:ref:`bool` **ignore_camera_scroll** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ If ``true``, **Parallax2D**'s position is not affected by the position of the ca .. rst-class:: classref-property -:ref:`Vector2` **limit_begin** = ``Vector2(-1e+07, -1e+07)`` +:ref:`Vector2` **limit_begin** = ``Vector2(-1e+07, -1e+07)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ Top-left limits for scrolling to begin. If the camera is outside of this limit, .. rst-class:: classref-property -:ref:`Vector2` **limit_end** = ``Vector2(1e+07, 1e+07)`` +:ref:`Vector2` **limit_end** = ``Vector2(1e+07, 1e+07)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ Bottom-right limits for scrolling to end. If the camera is outside of this limit .. rst-class:: classref-property -:ref:`Vector2` **repeat_size** = ``Vector2(0, 0)`` +:ref:`Vector2` **repeat_size** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ Repeats the :ref:`Texture2D` of each of this node's children an .. rst-class:: classref-property -:ref:`int` **repeat_times** = ``1`` +:ref:`int` **repeat_times** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ Overrides the amount of times the texture repeats. Each texture copy spreads eve .. rst-class:: classref-property -:ref:`Vector2` **screen_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **screen_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ Offset used to scroll this **Parallax2D**. This value is updated automatically u .. rst-class:: classref-property -:ref:`Vector2` **scroll_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **scroll_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ The **Parallax2D**'s offset. Similar to :ref:`screen_offset` **scroll_scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **scroll_scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 175ea0f5581..a7c2621c574 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **scroll_base_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **scroll_base_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -77,7 +77,7 @@ The base position offset for all :ref:`ParallaxLayer` child .. rst-class:: classref-property -:ref:`Vector2` **scroll_base_scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **scroll_base_scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ The base motion scale for all :ref:`ParallaxLayer` children .. rst-class:: classref-property -:ref:`bool` **scroll_ignore_camera_zoom** = ``false`` +:ref:`bool` **scroll_ignore_camera_zoom** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ If ``true``, elements in :ref:`ParallaxLayer` child aren't .. rst-class:: classref-property -:ref:`Vector2` **scroll_limit_begin** = ``Vector2(0, 0)`` +:ref:`Vector2` **scroll_limit_begin** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ Top-left limits for scrolling to begin. If the camera is outside of this limit, .. rst-class:: classref-property -:ref:`Vector2` **scroll_limit_end** = ``Vector2(0, 0)`` +:ref:`Vector2` **scroll_limit_end** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ Bottom-right limits for scrolling to end. If the camera is outside of this limit .. rst-class:: classref-property -:ref:`Vector2` **scroll_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **scroll_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 2eec41cf81f..7dc0f710a2c 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **motion_mirroring** = ``Vector2(0, 0)`` +:ref:`Vector2` **motion_mirroring** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ The interval, in pixels, at which the **ParallaxLayer** is drawn repeatedly. Use .. rst-class:: classref-property -:ref:`Vector2` **motion_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **motion_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`Par .. rst-class:: classref-property -:ref:`Vector2` **motion_scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **motion_scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index db537243e88..0ea83a1e990 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -262,7 +262,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Parameter**: +enum **Parameter**: :ref:`🔗` .. _class_ParticleProcessMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY: @@ -424,7 +424,7 @@ Use with :ref:`set_param_texture` .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY: @@ -478,7 +478,7 @@ Represents the size of the :ref:`ParticleFlags` .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINT: @@ -552,7 +552,7 @@ Represents the size of the :ref:`EmissionShape` .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_DISABLED: @@ -618,7 +618,7 @@ Represents the size of the :ref:`SubEmitterMode` .. _class_ParticleProcessMaterial_constant_COLLISION_DISABLED: @@ -665,7 +665,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture2D` **alpha_curve** +:ref:`Texture2D` **alpha_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -682,7 +682,7 @@ The alpha value of each particle's color will be multiplied by this :ref:`CurveT .. rst-class:: classref-property -:ref:`Texture2D` **angle_curve** +:ref:`Texture2D` **angle_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -699,7 +699,7 @@ Each particle's rotation will be animated along this :ref:`CurveTexture` **angle_max** = ``0.0`` +:ref:`float` **angle_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -718,7 +718,7 @@ Only applied when :ref:`particle_flag_disable_z` **angle_min** = ``0.0`` +:ref:`float` **angle_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -735,7 +735,7 @@ Minimum equivalent of :ref:`angle_max` **angular_velocity_curve** +:ref:`Texture2D` **angular_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -752,7 +752,7 @@ Each particle's angular velocity (rotation speed) will vary along this :ref:`Cur .. rst-class:: classref-property -:ref:`float` **angular_velocity_max** = ``0.0`` +:ref:`float` **angular_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -771,7 +771,7 @@ Only applied when :ref:`particle_flag_disable_z` **angular_velocity_min** = ``0.0`` +:ref:`float` **angular_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -788,7 +788,7 @@ Minimum equivalent of :ref:`angular_velocity_max` **anim_offset_curve** +:ref:`Texture2D` **anim_offset_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -805,7 +805,7 @@ Each particle's animation offset will vary along this :ref:`CurveTexture` **anim_offset_max** = ``0.0`` +:ref:`float` **anim_offset_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -822,7 +822,7 @@ Maximum animation offset that corresponds to frame index in the texture. ``0`` i .. rst-class:: classref-property -:ref:`float` **anim_offset_min** = ``0.0`` +:ref:`float` **anim_offset_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -839,7 +839,7 @@ Minimum equivalent of :ref:`anim_offset_max` **anim_speed_curve** +:ref:`Texture2D` **anim_speed_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -856,7 +856,7 @@ Each particle's animation speed will vary along this :ref:`CurveTexture` **anim_speed_max** = ``0.0`` +:ref:`float` **anim_speed_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -875,7 +875,7 @@ With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMate .. rst-class:: classref-property -:ref:`float` **anim_speed_min** = ``0.0`` +:ref:`float` **anim_speed_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -892,7 +892,7 @@ Minimum equivalent of :ref:`anim_speed_max` **attractor_interaction_enabled** = ``true`` +:ref:`bool` **attractor_interaction_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -909,7 +909,7 @@ If ``true``, interaction with particle attractors is enabled. In 3D, attraction .. rst-class:: classref-property -:ref:`float` **collision_bounce** +:ref:`float` **collision_bounce** :ref:`🔗` .. rst-class:: classref-property-setget @@ -926,7 +926,7 @@ The particles' bounciness. Values range from ``0`` (no bounce) to ``1`` (full bo .. rst-class:: classref-property -:ref:`float` **collision_friction** +:ref:`float` **collision_friction** :ref:`🔗` .. rst-class:: classref-property-setget @@ -943,7 +943,7 @@ The particles' friction. Values range from ``0`` (frictionless) to ``1`` (maximu .. rst-class:: classref-property -:ref:`CollisionMode` **collision_mode** = ``0`` +:ref:`CollisionMode` **collision_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -964,7 +964,7 @@ The particles' collision mode. .. rst-class:: classref-property -:ref:`bool` **collision_use_scale** = ``false`` +:ref:`bool` **collision_use_scale** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -981,7 +981,7 @@ If ``true``, :ref:`GPUParticles3D.collision_base_size` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1000,7 +1000,7 @@ Each particle's initial color. If the :ref:`GPUParticles2D .. rst-class:: classref-property -:ref:`Texture2D` **color_initial_ramp** +:ref:`Texture2D` **color_initial_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1019,7 +1019,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D` **color_ramp** +:ref:`Texture2D` **color_ramp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1038,7 +1038,7 @@ Each particle's color will vary along this :ref:`GradientTexture1D` **damping_curve** +:ref:`Texture2D` **damping_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1055,7 +1055,7 @@ Damping will vary along this :ref:`CurveTexture`. .. rst-class:: classref-property -:ref:`float` **damping_max** = ``0.0`` +:ref:`float` **damping_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1072,7 +1072,7 @@ The maximum rate at which particles lose velocity. For example value of ``100`` .. rst-class:: classref-property -:ref:`float` **damping_min** = ``0.0`` +:ref:`float` **damping_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1089,7 +1089,7 @@ Minimum equivalent of :ref:`damping_max` **direction** = ``Vector3(1, 0, 0)`` +:ref:`Vector3` **direction** = ``Vector3(1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1106,7 +1106,7 @@ Unit vector specifying the particles' emission direction. .. rst-class:: classref-property -:ref:`Texture2D` **directional_velocity_curve** +:ref:`Texture2D` **directional_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1125,7 +1125,7 @@ A curve that specifies the velocity along each of the axes of the particle syste .. rst-class:: classref-property -:ref:`float` **directional_velocity_max** +:ref:`float` **directional_velocity_max** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1144,7 +1144,7 @@ Maximum directional velocity value, which is multiplied by :ref:`directional_vel .. rst-class:: classref-property -:ref:`float` **directional_velocity_min** +:ref:`float` **directional_velocity_min** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1163,7 +1163,7 @@ Minimum directional velocity value, which is multiplied by :ref:`directional_vel .. rst-class:: classref-property -:ref:`Vector3` **emission_box_extents** +:ref:`Vector3` **emission_box_extents** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1182,7 +1182,7 @@ The box's extents if :ref:`emission_shape` **emission_color_texture** +:ref:`Texture2D` **emission_color_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1201,7 +1201,7 @@ Particle color will be modulated by color determined by sampling this texture at .. rst-class:: classref-property -:ref:`Texture2D` **emission_curve** +:ref:`Texture2D` **emission_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1220,7 +1220,7 @@ Each particle's color will be multiplied by this :ref:`CurveTexture` **emission_normal_texture** +:ref:`Texture2D` **emission_normal_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1237,7 +1237,7 @@ Particle velocity and rotation will be set by sampling this texture at the same .. rst-class:: classref-property -:ref:`int` **emission_point_count** +:ref:`int` **emission_point_count** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1254,7 +1254,7 @@ The number of emission points if :ref:`emission_shape` **emission_point_texture** +:ref:`Texture2D` **emission_point_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1271,7 +1271,7 @@ Particles will be emitted at positions determined by sampling this texture at a .. rst-class:: classref-property -:ref:`Vector3` **emission_ring_axis** +:ref:`Vector3` **emission_ring_axis** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1288,7 +1288,7 @@ The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_ring_height** +:ref:`float` **emission_ring_height** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1305,7 +1305,7 @@ The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_ring_inner_radius** +:ref:`float` **emission_ring_inner_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1322,7 +1322,7 @@ The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_ring_radius** +:ref:`float` **emission_ring_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1339,7 +1339,7 @@ The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` **emission_shape** = ``0`` +:ref:`EmissionShape` **emission_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1356,7 +1356,7 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape` **emission_shape_offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **emission_shape_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1373,7 +1373,7 @@ The offset for the :ref:`emission_shape` **emission_shape_scale** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **emission_shape_scale** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1390,7 +1390,7 @@ The scale of the :ref:`emission_shape` **emission_sphere_radius** +:ref:`float` **emission_sphere_radius** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1407,7 +1407,7 @@ The sphere's radius if :ref:`emission_shape` **flatness** = ``0.0`` +:ref:`float` **flatness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1424,7 +1424,7 @@ Amount of :ref:`spread` along the .. rst-class:: classref-property -:ref:`Vector3` **gravity** = ``Vector3(0, -9.8, 0)`` +:ref:`Vector3` **gravity** = ``Vector3(0, -9.8, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1441,7 +1441,7 @@ Gravity applied to every particle. .. rst-class:: classref-property -:ref:`Texture2D` **hue_variation_curve** +:ref:`Texture2D` **hue_variation_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1458,7 +1458,7 @@ Each particle's hue will vary along this :ref:`CurveTexture` .. rst-class:: classref-property -:ref:`float` **hue_variation_max** = ``0.0`` +:ref:`float` **hue_variation_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1475,7 +1475,7 @@ Maximum initial hue variation applied to each particle. It will shift the partic .. rst-class:: classref-property -:ref:`float` **hue_variation_min** = ``0.0`` +:ref:`float` **hue_variation_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1492,7 +1492,7 @@ Minimum equivalent of :ref:`hue_variation_max` **inherit_velocity_ratio** = ``0.0`` +:ref:`float` **inherit_velocity_ratio** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1509,7 +1509,7 @@ Percentage of the velocity of the respective :ref:`GPUParticles2D` **initial_velocity_max** = ``0.0`` +:ref:`float` **initial_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1526,7 +1526,7 @@ Maximum initial velocity magnitude for each particle. Direction comes from :ref: .. rst-class:: classref-property -:ref:`float` **initial_velocity_min** = ``0.0`` +:ref:`float` **initial_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1543,7 +1543,7 @@ Minimum equivalent of :ref:`initial_velocity_max` **lifetime_randomness** = ``0.0`` +:ref:`float` **lifetime_randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1560,7 +1560,7 @@ Particle lifetime randomness ratio. The equation for the lifetime of a particle .. rst-class:: classref-property -:ref:`Texture2D` **linear_accel_curve** +:ref:`Texture2D` **linear_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1577,7 +1577,7 @@ Each particle's linear acceleration will vary along this :ref:`CurveTexture` **linear_accel_max** = ``0.0`` +:ref:`float` **linear_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1594,7 +1594,7 @@ Maximum linear acceleration applied to each particle in the direction of motion. .. rst-class:: classref-property -:ref:`float` **linear_accel_min** = ``0.0`` +:ref:`float` **linear_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1611,7 +1611,7 @@ Minimum equivalent of :ref:`linear_accel_max` **orbit_velocity_curve** +:ref:`Texture2D` **orbit_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1632,7 +1632,7 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` **orbit_velocity_max** = ``0.0`` +:ref:`float` **orbit_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1651,7 +1651,7 @@ Maximum orbital velocity applied to each particle. Makes the particles circle ar .. rst-class:: classref-property -:ref:`float` **orbit_velocity_min** = ``0.0`` +:ref:`float` **orbit_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1670,7 +1670,7 @@ Minimum equivalent of :ref:`orbit_velocity_max` **particle_flag_align_y** = ``false`` +:ref:`bool` **particle_flag_align_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1687,7 +1687,7 @@ Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-property -:ref:`bool` **particle_flag_damping_as_friction** = ``false`` +:ref:`bool` **particle_flag_damping_as_friction** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1704,7 +1704,7 @@ Changes the behavior of the damping properties from a linear deceleration to a d .. rst-class:: classref-property -:ref:`bool` **particle_flag_disable_z** = ``false`` +:ref:`bool` **particle_flag_disable_z** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1721,7 +1721,7 @@ If ``true``, particles will not move on the z axis. .. rst-class:: classref-property -:ref:`bool` **particle_flag_rotate_y** = ``false`` +:ref:`bool` **particle_flag_rotate_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1738,7 +1738,7 @@ If ``true``, particles rotate around Y axis by :ref:`angle_min` **radial_accel_curve** +:ref:`Texture2D` **radial_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1755,7 +1755,7 @@ Each particle's radial acceleration will vary along this :ref:`CurveTexture` **radial_accel_max** = ``0.0`` +:ref:`float` **radial_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1772,7 +1772,7 @@ Maximum radial acceleration applied to each particle. Makes particle accelerate .. rst-class:: classref-property -:ref:`float` **radial_accel_min** = ``0.0`` +:ref:`float` **radial_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1789,7 +1789,7 @@ Minimum equivalent of :ref:`radial_accel_max` **radial_velocity_curve** +:ref:`Texture2D` **radial_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1808,7 +1808,7 @@ A :ref:`CurveTexture` that defines the velocity over the par .. rst-class:: classref-property -:ref:`float` **radial_velocity_max** = ``0.0`` +:ref:`float` **radial_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1827,7 +1827,7 @@ Maximum radial velocity applied to each particle. Makes particles move away from .. rst-class:: classref-property -:ref:`float` **radial_velocity_min** = ``0.0`` +:ref:`float` **radial_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1846,7 +1846,7 @@ Minimum radial velocity applied to each particle. Makes particles move away from .. rst-class:: classref-property -:ref:`Texture2D` **scale_curve** +:ref:`Texture2D` **scale_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1863,7 +1863,7 @@ Each particle's scale will vary along this :ref:`CurveTexture` **scale_max** = ``1.0`` +:ref:`float` **scale_max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1880,7 +1880,7 @@ Maximum initial scale applied to each particle. .. rst-class:: classref-property -:ref:`float` **scale_min** = ``1.0`` +:ref:`float` **scale_min** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1897,7 +1897,7 @@ Minimum equivalent of :ref:`scale_max` **scale_over_velocity_curve** +:ref:`Texture2D` **scale_over_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1914,7 +1914,7 @@ Either a :ref:`CurveTexture` or a :ref:`CurveXYZTexture` **scale_over_velocity_max** = ``0.0`` +:ref:`float` **scale_over_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1933,7 +1933,7 @@ Maximum velocity value reference for :ref:`scale_over_velocity_curve` **scale_over_velocity_min** = ``0.0`` +:ref:`float` **scale_over_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1952,7 +1952,7 @@ Minimum velocity value reference for :ref:`scale_over_velocity_curve` **spread** = ``45.0`` +:ref:`float` **spread** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1969,7 +1969,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-property -:ref:`int` **sub_emitter_amount_at_collision** +:ref:`int` **sub_emitter_amount_at_collision** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1988,7 +1988,7 @@ The amount of particles to spawn from the subemitter node when a collision occur .. rst-class:: classref-property -:ref:`int` **sub_emitter_amount_at_end** +:ref:`int` **sub_emitter_amount_at_end** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2007,7 +2007,7 @@ The amount of particles to spawn from the subemitter node when the particle expi .. rst-class:: classref-property -:ref:`float` **sub_emitter_frequency** +:ref:`float` **sub_emitter_frequency** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2026,7 +2026,7 @@ The frequency at which particles should be emitted from the subemitter node. One .. rst-class:: classref-property -:ref:`bool` **sub_emitter_keep_velocity** = ``false`` +:ref:`bool` **sub_emitter_keep_velocity** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2043,7 +2043,7 @@ If ``true``, the subemitter inherits the parent particle's velocity when it spaw .. rst-class:: classref-property -:ref:`SubEmitterMode` **sub_emitter_mode** = ``0`` +:ref:`SubEmitterMode` **sub_emitter_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2060,7 +2060,7 @@ The particle subemitter mode (see :ref:`GPUParticles2D.sub_emitter` **tangential_accel_curve** +:ref:`Texture2D` **tangential_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2077,7 +2077,7 @@ Each particle's tangential acceleration will vary along this :ref:`CurveTexture< .. rst-class:: classref-property -:ref:`float` **tangential_accel_max** = ``0.0`` +:ref:`float` **tangential_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2094,7 +2094,7 @@ Maximum tangential acceleration applied to each particle. Tangential acceleratio .. rst-class:: classref-property -:ref:`float` **tangential_accel_min** = ``0.0`` +:ref:`float` **tangential_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2111,7 +2111,7 @@ Minimum equivalent of :ref:`tangential_accel_max` **turbulence_enabled** = ``false`` +:ref:`bool` **turbulence_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2130,7 +2130,7 @@ If ``true``, enables turbulence for the particle system. Turbulence can be used .. rst-class:: classref-property -:ref:`float` **turbulence_influence_max** = ``0.1`` +:ref:`float` **turbulence_influence_max** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2149,7 +2149,7 @@ The actual amount of turbulence influence on each particle is calculated as a ra .. rst-class:: classref-property -:ref:`float` **turbulence_influence_min** = ``0.1`` +:ref:`float` **turbulence_influence_min** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2168,7 +2168,7 @@ The actual amount of turbulence influence on each particle is calculated as a ra .. rst-class:: classref-property -:ref:`Texture2D` **turbulence_influence_over_life** +:ref:`Texture2D` **turbulence_influence_over_life** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2185,7 +2185,7 @@ Each particle's amount of turbulence will be influenced along this :ref:`CurveTe .. rst-class:: classref-property -:ref:`float` **turbulence_initial_displacement_max** = ``0.0`` +:ref:`float` **turbulence_initial_displacement_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2204,7 +2204,7 @@ The actual amount of displacement will be a factor of the underlying turbulence .. rst-class:: classref-property -:ref:`float` **turbulence_initial_displacement_min** = ``0.0`` +:ref:`float` **turbulence_initial_displacement_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2223,7 +2223,7 @@ The actual amount of displacement will be a factor of the underlying turbulence .. rst-class:: classref-property -:ref:`float` **turbulence_noise_scale** = ``9.0`` +:ref:`float` **turbulence_noise_scale** = ``9.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2242,7 +2242,7 @@ A small scale will result in smaller features with more detail while a high scal .. rst-class:: classref-property -:ref:`Vector3` **turbulence_noise_speed** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **turbulence_noise_speed** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2261,7 +2261,7 @@ The default value of ``Vector3(0, 0, 0)`` turns off the scrolling. .. rst-class:: classref-property -:ref:`float` **turbulence_noise_speed_random** = ``0.2`` +:ref:`float` **turbulence_noise_speed_random** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2280,7 +2280,7 @@ A value of 0.0 will result in a fixed pattern. .. rst-class:: classref-property -:ref:`float` **turbulence_noise_strength** = ``1.0`` +:ref:`float` **turbulence_noise_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2297,7 +2297,7 @@ The turbulence noise strength. Increasing this will result in a stronger, more c .. rst-class:: classref-property -:ref:`Texture2D` **velocity_limit_curve** +:ref:`Texture2D` **velocity_limit_curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -2314,7 +2314,7 @@ A :ref:`CurveTexture` that defines the maximum velocity of a .. rst-class:: classref-property -:ref:`Vector3` **velocity_pivot** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **velocity_pivot** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -2336,7 +2336,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_param**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`Vector2` **get_param**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the minimum and maximum values of the given ``param`` as a vector. @@ -2350,7 +2350,7 @@ The ``x`` component of the returned vector corresponds to minimum and the ``y`` .. rst-class:: classref-method -:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the maximum value range for the given parameter. @@ -2362,7 +2362,7 @@ Returns the maximum value range for the given parameter. .. rst-class:: classref-method -:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the minimum value range for the given parameter. @@ -2374,7 +2374,7 @@ Returns the minimum value range for the given parameter. .. rst-class:: classref-method -:ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| +:ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the :ref:`Texture2D` used by the specified parameter. @@ -2386,7 +2386,7 @@ Returns the :ref:`Texture2D` used by the specified parameter. .. rst-class:: classref-method -:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| +:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFlags` for options. @@ -2398,7 +2398,7 @@ Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFl .. rst-class:: classref-method -|void| **set_param**\ (\ param\: :ref:`Parameter`, value\: :ref:`Vector2`\ ) +|void| **set_param**\ (\ param\: :ref:`Parameter`, value\: :ref:`Vector2`\ ) :ref:`🔗` Sets the minimum and maximum values of the given ``param``. @@ -2412,7 +2412,7 @@ The ``x`` component of the argument vector corresponds to minimum and the ``y`` .. rst-class:: classref-method -|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the maximum value range for the given parameter. @@ -2424,7 +2424,7 @@ Sets the maximum value range for the given parameter. .. rst-class:: classref-method -|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the minimum value range for the given parameter. @@ -2436,7 +2436,7 @@ Sets the minimum value range for the given parameter. .. rst-class:: classref-method -|void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +|void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the :ref:`Texture2D` for the specified :ref:`Parameter`. @@ -2448,7 +2448,7 @@ Sets the :ref:`Texture2D` for the specified :ref:`Parameter`, enable\: :ref:`bool`\ ) +|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables the specified particle flag. See :ref:`ParticleFlags` for options. diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index cb8b288856d..058f946639b 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Curve2D` **curve** +:ref:`Curve2D` **curve** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_path3d.rst b/classes/class_path3d.rst index e0865f08bee..500c6ba958e 100644 --- a/classes/class_path3d.rst +++ b/classes/class_path3d.rst @@ -48,7 +48,7 @@ Signals .. rst-class:: classref-signal -**curve_changed**\ (\ ) +**curve_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`curve` changes. @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Curve3D` **curve** +:ref:`Curve3D` **curve** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index ade30c030f0..16ecfbdfd0f 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **cubic_interp** = ``true`` +:ref:`bool` **cubic_interp** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -81,7 +81,7 @@ There are two answers to this problem: either increase the number of cached poin .. rst-class:: classref-property -:ref:`float` **h_offset** = ``0.0`` +:ref:`float` **h_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -98,7 +98,7 @@ The node's offset along the curve. .. rst-class:: classref-property -:ref:`bool` **loop** = ``true`` +:ref:`bool` **loop** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s .. rst-class:: classref-property -:ref:`float` **progress** = ``0.0`` +:ref:`float` **progress** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ The distance along the path, in pixels. Changing this value sets this node's pos .. rst-class:: classref-property -:ref:`float` **progress_ratio** = ``0.0`` +:ref:`float` **progress_ratio** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ The distance along the path as a number in the range 0.0 (for the first vertex) .. rst-class:: classref-property -:ref:`bool` **rotates** = ``true`` +:ref:`bool` **rotates** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ If ``true``, this node rotates to follow the path, with the +X direction facing .. rst-class:: classref-property -:ref:`float` **v_offset** = ``0.0`` +:ref:`float` **v_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_pathfollow3d.rst b/classes/class_pathfollow3d.rst index 37222b21b8b..1323bd70faf 100644 --- a/classes/class_pathfollow3d.rst +++ b/classes/class_pathfollow3d.rst @@ -76,7 +76,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **RotationMode**: +enum **RotationMode**: :ref:`🔗` .. _class_PathFollow3D_constant_ROTATION_NONE: @@ -131,7 +131,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **cubic_interp** = ``true`` +:ref:`bool` **cubic_interp** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ There are two answers to this problem: either increase the number of cached poin .. rst-class:: classref-property -:ref:`float` **h_offset** = ``0.0`` +:ref:`float` **h_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ The node's offset along the curve. .. rst-class:: classref-property -:ref:`bool` **loop** = ``true`` +:ref:`bool` **loop** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -186,7 +186,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s .. rst-class:: classref-property -:ref:`float` **progress** = ``0.0`` +:ref:`float` **progress** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -203,7 +203,7 @@ The distance from the first vertex, measured in 3D units along the path. Changin .. rst-class:: classref-property -:ref:`float` **progress_ratio** = ``0.0`` +:ref:`float` **progress_ratio** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ The distance from the first vertex, considering 0.0 as the first vertex and 1.0 .. rst-class:: classref-property -:ref:`RotationMode` **rotation_mode** = ``3`` +:ref:`RotationMode` **rotation_mode** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ Allows or forbids rotation on one or more axes, depending on the :ref:`RotationM .. rst-class:: classref-property -:ref:`bool` **tilt_enabled** = ``true`` +:ref:`bool` **tilt_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ If ``true``, the tilt property of :ref:`Curve3D` takes effect. .. rst-class:: classref-property -:ref:`bool` **use_model_front** = ``false`` +:ref:`bool` **use_model_front** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ If ``true``, the node moves on the travel path with orienting the +Z axis as for .. rst-class:: classref-property -:ref:`float` **v_offset** = ``0.0`` +:ref:`float` **v_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -293,7 +293,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **correct_posture**\ (\ transform\: :ref:`Transform3D`, rotation_mode\: :ref:`RotationMode`\ ) |static| +:ref:`Transform3D` **correct_posture**\ (\ transform\: :ref:`Transform3D`, rotation_mode\: :ref:`RotationMode`\ ) |static| :ref:`🔗` Correct the ``transform``. ``rotation_mode`` implicitly specifies how posture (forward, up and sideway direction) is calculated. diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 674ccaa616d..019f889c9d8 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -71,7 +71,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_file**\ (\ pck_path\: :ref:`String`, source_path\: :ref:`String`, encrypt\: :ref:`bool` = false\ ) +:ref:`Error` **add_file**\ (\ pck_path\: :ref:`String`, source_path\: :ref:`String`, encrypt\: :ref:`bool` = false\ ) :ref:`🔗` Adds the ``source_path`` file to the current PCK package at the ``pck_path`` internal path (should start with ``res://``). @@ -83,7 +83,7 @@ Adds the ``source_path`` file to the current PCK package at the ``pck_path`` int .. rst-class:: classref-method -:ref:`Error` **flush**\ (\ verbose\: :ref:`bool` = false\ ) +:ref:`Error` **flush**\ (\ verbose\: :ref:`bool` = false\ ) :ref:`🔗` Writes the files specified using all :ref:`add_file` calls since the last flush. If ``verbose`` is ``true``, a list of files added will be printed to the console for easier debugging. @@ -95,7 +95,7 @@ Writes the files specified using all :ref:`add_file` **pck_start**\ (\ pck_name\: :ref:`String`, alignment\: :ref:`int` = 32, key\: :ref:`String` = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory\: :ref:`bool` = false\ ) +:ref:`Error` **pck_start**\ (\ pck_name\: :ref:`String`, alignment\: :ref:`int` = 32, key\: :ref:`String` = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory\: :ref:`bool` = false\ ) :ref:`🔗` Creates a new PCK file with the name ``pck_name``. The ``.pck`` file extension isn't added automatically, so it should be part of ``pck_name`` (even though it's not required). diff --git a/classes/class_performance.rst b/classes/class_performance.rst index d0db64cf46c..8928c4e8237 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -66,7 +66,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Monitor**: +enum **Monitor**: :ref:`🔗` .. _class_Performance_constant_TIME_FPS: @@ -353,7 +353,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_custom_monitor**\ (\ id\: :ref:`StringName`, callable\: :ref:`Callable`, arguments\: :ref:`Array` = []\ ) +|void| **add_custom_monitor**\ (\ id\: :ref:`StringName`, callable\: :ref:`Callable`, arguments\: :ref:`Array` = []\ ) :ref:`🔗` Adds a custom monitor with the name ``id``. You can specify the category of the monitor using slash delimiters in ``id`` (for example: ``"Game/NumberOfNPCs"``). If there is more than one slash delimiter, then the default category is used. The default category is ``"Custom"``. Prints an error if given ``id`` is already present. @@ -421,7 +421,7 @@ Callables are called with arguments supplied in argument array. .. rst-class:: classref-method -:ref:`Variant` **get_custom_monitor**\ (\ id\: :ref:`StringName`\ ) +:ref:`Variant` **get_custom_monitor**\ (\ id\: :ref:`StringName`\ ) :ref:`🔗` Returns the value of custom monitor with given ``id``. The callable is called to get the value of custom monitor. See also :ref:`has_custom_monitor`. Prints an error if the given ``id`` is absent. @@ -433,7 +433,7 @@ Returns the value of custom monitor with given ``id``. The callable is called to .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_custom_monitor_names**\ (\ ) +:ref:`Array`\[:ref:`StringName`\] **get_custom_monitor_names**\ (\ ) :ref:`🔗` Returns the names of active custom monitors in an :ref:`Array`. @@ -445,7 +445,7 @@ Returns the names of active custom monitors in an :ref:`Array`. .. rst-class:: classref-method -:ref:`float` **get_monitor**\ (\ monitor\: :ref:`Monitor`\ ) |const| +:ref:`float` **get_monitor**\ (\ monitor\: :ref:`Monitor`\ ) |const| :ref:`🔗` Returns the value of one of the available built-in monitors. You should provide one of the :ref:`Monitor` constants as the argument, like this: @@ -472,7 +472,7 @@ See :ref:`get_custom_monitor` to qu .. rst-class:: classref-method -:ref:`int` **get_monitor_modification_time**\ (\ ) +:ref:`int` **get_monitor_modification_time**\ (\ ) :ref:`🔗` Returns the last tick in which custom monitor was added/removed (in microseconds since the engine started). This is set to :ref:`Time.get_ticks_usec` when the monitor is updated. @@ -484,7 +484,7 @@ Returns the last tick in which custom monitor was added/removed (in microseconds .. rst-class:: classref-method -:ref:`bool` **has_custom_monitor**\ (\ id\: :ref:`StringName`\ ) +:ref:`bool` **has_custom_monitor**\ (\ id\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if custom monitor with the given ``id`` is present, ``false`` otherwise. @@ -496,7 +496,7 @@ Returns ``true`` if custom monitor with the given ``id`` is present, ``false`` o .. rst-class:: classref-method -|void| **remove_custom_monitor**\ (\ id\: :ref:`StringName`\ ) +|void| **remove_custom_monitor**\ (\ id\: :ref:`StringName`\ ) :ref:`🔗` Removes the custom monitor with given ``id``. Prints an error if the given ``id`` is already absent. diff --git a/classes/class_physicalbone2d.rst b/classes/class_physicalbone2d.rst index 73230e89704..9f663ff57b0 100644 --- a/classes/class_physicalbone2d.rst +++ b/classes/class_physicalbone2d.rst @@ -75,7 +75,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **auto_configure_joint** = ``true`` +:ref:`bool` **auto_configure_joint** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -92,7 +92,7 @@ If ``true``, the **PhysicalBone2D** will automatically configure the first :ref: .. rst-class:: classref-property -:ref:`int` **bone2d_index** = ``-1`` +:ref:`int` **bone2d_index** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -109,7 +109,7 @@ The index of the :ref:`Bone2D` that this **PhysicalBone2D** should .. rst-class:: classref-property -:ref:`NodePath` **bone2d_nodepath** = ``NodePath("")`` +:ref:`NodePath` **bone2d_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -126,7 +126,7 @@ The :ref:`NodePath` to the :ref:`Bone2D` that this .. rst-class:: classref-property -:ref:`bool` **follow_bone_when_simulating** = ``false`` +:ref:`bool` **follow_bone_when_simulating** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -143,7 +143,7 @@ If ``true``, the **PhysicalBone2D** will keep the transform of the bone it is bo .. rst-class:: classref-property -:ref:`bool` **simulate_physics** = ``false`` +:ref:`bool` **simulate_physics** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Joint2D` **get_joint**\ (\ ) |const| +:ref:`Joint2D` **get_joint**\ (\ ) |const| :ref:`🔗` Returns the first :ref:`Joint2D` child node, if one exists. This is mainly a helper function to make it easier to get the :ref:`Joint2D` that the **PhysicalBone2D** is autoconfiguring. @@ -179,7 +179,7 @@ Returns the first :ref:`Joint2D` child node, if one exists. This .. rst-class:: classref-method -:ref:`bool` **is_simulating_physics**\ (\ ) |const| +:ref:`bool` **is_simulating_physics**\ (\ ) |const| :ref:`🔗` Returns a boolean that indicates whether the **PhysicalBone2D** is running and simulating using the Godot 2D physics engine. When ``true``, the PhysicalBone2D node is using physics. diff --git a/classes/class_physicalbone3d.rst b/classes/class_physicalbone3d.rst index da5c4eea495..c830b8a7952 100644 --- a/classes/class_physicalbone3d.rst +++ b/classes/class_physicalbone3d.rst @@ -101,7 +101,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DampMode**: +enum **DampMode**: :ref:`🔗` .. _class_PhysicalBone3D_constant_DAMP_MODE_COMBINE: @@ -127,7 +127,7 @@ In this mode, the body's damping value replaces any value set in areas or the de .. rst-class:: classref-enumeration -enum **JointType**: +enum **JointType**: :ref:`🔗` .. _class_PhysicalBone3D_constant_JOINT_TYPE_NONE: @@ -214,7 +214,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_damp** = ``0.0`` +:ref:`float` **angular_damp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -233,7 +233,7 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` **angular_damp_mode** = ``0`` +:ref:`DampMode` **angular_damp_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -250,7 +250,7 @@ Defines how :ref:`angular_damp` is a .. rst-class:: classref-property -:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -267,7 +267,7 @@ The PhysicalBone3D's rotational velocity in *radians* per second. .. rst-class:: classref-property -:ref:`Transform3D` **body_offset** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **body_offset** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -284,7 +284,7 @@ Sets the body's transform. .. rst-class:: classref-property -:ref:`float` **bounce** = ``0.0`` +:ref:`float` **bounce** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -303,7 +303,7 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci .. rst-class:: classref-property -:ref:`bool` **can_sleep** = ``true`` +:ref:`bool` **can_sleep** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -320,7 +320,7 @@ If ``true``, the body is deactivated when there is no movement, so it will not t .. rst-class:: classref-property -:ref:`bool` **custom_integrator** = ``false`` +:ref:`bool` **custom_integrator** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -339,7 +339,7 @@ Setting this property will call the method :ref:`PhysicsServer3D.body_set_omit_f .. rst-class:: classref-property -:ref:`float` **friction** = ``1.0`` +:ref:`float` **friction** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +356,7 @@ The body's friction, from ``0`` (frictionless) to ``1`` (max friction). .. rst-class:: classref-property -:ref:`float` **gravity_scale** = ``1.0`` +:ref:`float` **gravity_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -373,7 +373,7 @@ This is multiplied by the global 3D gravity setting found in **Project > Project .. rst-class:: classref-property -:ref:`Transform3D` **joint_offset** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **joint_offset** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -390,7 +390,7 @@ Sets the joint's transform. .. rst-class:: classref-property -:ref:`Vector3` **joint_rotation** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **joint_rotation** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -407,7 +407,7 @@ Sets the joint's rotation in radians. .. rst-class:: classref-property -:ref:`JointType` **joint_type** = ``0`` +:ref:`JointType` **joint_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -424,7 +424,7 @@ Sets the joint type. See :ref:`JointType` for pos .. rst-class:: classref-property -:ref:`float` **linear_damp** = ``0.0`` +:ref:`float` **linear_damp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -443,7 +443,7 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` **linear_damp_mode** = ``0`` +:ref:`DampMode` **linear_damp_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -460,7 +460,7 @@ Defines how :ref:`linear_damp` is app .. rst-class:: classref-property -:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -477,7 +477,7 @@ The body's linear velocity in units per second. Can be used sporadically, but ** .. rst-class:: classref-property -:ref:`float` **mass** = ``1.0`` +:ref:`float` **mass** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -499,7 +499,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| +|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| :ref:`🔗` Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it is called before the standard force integration, but the :ref:`custom_integrator` property allows you to disable the standard force integration and do fully custom force integration for a body. @@ -511,7 +511,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) :ref:`🔗` .. container:: contribute @@ -525,7 +525,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` .. container:: contribute @@ -539,7 +539,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -:ref:`int` **get_bone_id**\ (\ ) |const| +:ref:`int` **get_bone_id**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -553,7 +553,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -:ref:`bool` **get_simulate_physics**\ (\ ) +:ref:`bool` **get_simulate_physics**\ (\ ) :ref:`🔗` .. container:: contribute @@ -567,7 +567,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -:ref:`bool` **is_simulating_physics**\ (\ ) +:ref:`bool` **is_simulating_physics**\ (\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_physicalbonesimulator3d.rst b/classes/class_physicalbonesimulator3d.rst index b23f74b6c55..33817f8a26c 100644 --- a/classes/class_physicalbonesimulator3d.rst +++ b/classes/class_physicalbonesimulator3d.rst @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_simulating_physics**\ (\ ) |const| +:ref:`bool` **is_simulating_physics**\ (\ ) |const| :ref:`🔗` Returns a boolean that indicates whether the **PhysicalBoneSimulator3D** is running and simulating. @@ -66,7 +66,7 @@ Returns a boolean that indicates whether the **PhysicalBoneSimulator3D** is runn .. rst-class:: classref-method -|void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) +|void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) :ref:`🔗` Adds a collision exception to the physical bone. @@ -80,7 +80,7 @@ Works just like the :ref:`RigidBody3D` node. .. rst-class:: classref-method -|void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) +|void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) :ref:`🔗` Removes a collision exception to the physical bone. @@ -94,7 +94,7 @@ Works just like the :ref:`RigidBody3D` node. .. rst-class:: classref-method -|void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) +|void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to start simulating and reacting to the physics world. @@ -108,7 +108,7 @@ Optionally, a list of bone names can be passed-in, allowing only the passed-in b .. rst-class:: classref-method -|void| **physical_bones_stop_simulation**\ (\ ) +|void| **physical_bones_stop_simulation**\ (\ ) :ref:`🔗` Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to stop simulating. diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index 33fbb719da5..09c7e0e97bf 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **energy_multiplier** = ``1.0`` +:ref:`float` **energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -87,7 +87,7 @@ The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-property -:ref:`Color` **ground_color** = ``Color(0.1, 0.07, 0.034, 1)`` +:ref:`Color` **ground_color** = ``Color(0.1, 0.07, 0.034, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ Modulates the :ref:`Color` on the bottom half of the sky to represe .. rst-class:: classref-property -:ref:`float` **mie_coefficient** = ``0.005`` +:ref:`float` **mie_coefficient** = ``0.005`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ Controls the strength of `Mie scattering ` **mie_color** = ``Color(0.69, 0.729, 0.812, 1)`` +:ref:`Color` **mie_color** = ``Color(0.69, 0.729, 0.812, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ Controls the :ref:`Color` of the `Mie scattering ` **mie_eccentricity** = ``0.8`` +:ref:`float` **mie_eccentricity** = ``0.8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ Controls the direction of the `Mie scattering ` **night_sky** +:ref:`Texture2D` **night_sky** :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ Controls the direction of the `Mie scattering ` **rayleigh_coefficient** = ``2.0`` +:ref:`float` **rayleigh_coefficient** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ Controls the strength of the `Rayleigh scattering ` **rayleigh_color** = ``Color(0.3, 0.405, 0.6, 1)`` +:ref:`Color` **rayleigh_color** = ``Color(0.3, 0.405, 0.6, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ Controls the :ref:`Color` of the `Rayleigh scattering ` **sun_disk_scale** = ``1.0`` +:ref:`float` **sun_disk_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ Sets the size of the sun disk. Default value is based on Sol's perceived size fr .. rst-class:: classref-property -:ref:`float` **turbidity** = ``10.0`` +:ref:`float` **turbidity** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ Sets the thickness of the atmosphere. High turbidity creates a foggy-looking atm .. rst-class:: classref-property -:ref:`bool` **use_debanding** = ``true`` +:ref:`bool` **use_debanding** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index d705de7b256..b9eaef04a76 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -77,7 +77,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) +|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Adds a body to the list of bodies that this body can't collide with. @@ -89,7 +89,7 @@ Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`Array`\[:ref:`PhysicsBody2D`\] **get_collision_exceptions**\ (\ ) +:ref:`Array`\[:ref:`PhysicsBody2D`\] **get_collision_exceptions**\ (\ ) :ref:`🔗` Returns an array of nodes that were added as collision exceptions for this body. @@ -101,7 +101,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-method -:ref:`Vector2` **get_gravity**\ (\ ) |const| +:ref:`Vector2` **get_gravity**\ (\ ) |const| :ref:`🔗` Returns the gravity vector computed from all sources that can affect the body, including all gravity overrides from :ref:`Area2D` nodes and the global world gravity. @@ -113,7 +113,7 @@ Returns the gravity vector computed from all sources that can affect the body, i .. rst-class:: classref-method -:ref:`KinematicCollision2D` **move_and_collide**\ (\ motion\: :ref:`Vector2`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) +:ref:`KinematicCollision2D` **move_and_collide**\ (\ motion\: :ref:`Vector2`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) :ref:`🔗` Moves the body along the vector ``motion``. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. @@ -133,7 +133,7 @@ If ``recovery_as_collision`` is ``true``, any depenetration from the recovery ph .. rst-class:: classref-method -|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) +|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Removes a body from the list of bodies that this body can't collide with. @@ -145,7 +145,7 @@ Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`bool` **test_move**\ (\ from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, collision\: :ref:`KinematicCollision2D` = null, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) +:ref:`bool` **test_move**\ (\ from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, collision\: :ref:`KinematicCollision2D` = null, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) :ref:`🔗` Checks for collisions without moving the body. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. diff --git a/classes/class_physicsbody3d.rst b/classes/class_physicsbody3d.rst index f9cb293abdf..ba70d009166 100644 --- a/classes/class_physicsbody3d.rst +++ b/classes/class_physicsbody3d.rst @@ -93,7 +93,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **axis_lock_angular_x** = ``false`` +:ref:`bool` **axis_lock_angular_x** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ Lock the body's rotation in the X axis. .. rst-class:: classref-property -:ref:`bool` **axis_lock_angular_y** = ``false`` +:ref:`bool` **axis_lock_angular_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ Lock the body's rotation in the Y axis. .. rst-class:: classref-property -:ref:`bool` **axis_lock_angular_z** = ``false`` +:ref:`bool` **axis_lock_angular_z** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ Lock the body's rotation in the Z axis. .. rst-class:: classref-property -:ref:`bool` **axis_lock_linear_x** = ``false`` +:ref:`bool` **axis_lock_linear_x** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ Lock the body's linear movement in the X axis. .. rst-class:: classref-property -:ref:`bool` **axis_lock_linear_y** = ``false`` +:ref:`bool` **axis_lock_linear_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ Lock the body's linear movement in the Y axis. .. rst-class:: classref-property -:ref:`bool` **axis_lock_linear_z** = ``false`` +:ref:`bool` **axis_lock_linear_z** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) +|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Adds a body to the list of bodies that this body can't collide with. @@ -212,7 +212,7 @@ Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| +:ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| :ref:`🔗` Returns ``true`` if the specified linear or rotational ``axis`` is locked. @@ -224,7 +224,7 @@ Returns ``true`` if the specified linear or rotational ``axis`` is locked. .. rst-class:: classref-method -:ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) +:ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) :ref:`🔗` Returns an array of nodes that were added as collision exceptions for this body. @@ -236,7 +236,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-method -:ref:`Vector3` **get_gravity**\ (\ ) |const| +:ref:`Vector3` **get_gravity**\ (\ ) |const| :ref:`🔗` Returns the gravity vector computed from all sources that can affect the body, including all gravity overrides from :ref:`Area3D` nodes and the global world gravity. @@ -248,7 +248,7 @@ Returns the gravity vector computed from all sources that can affect the body, i .. rst-class:: classref-method -:ref:`KinematicCollision3D` **move_and_collide**\ (\ motion\: :ref:`Vector3`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) +:ref:`KinematicCollision3D` **move_and_collide**\ (\ motion\: :ref:`Vector3`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) :ref:`🔗` Moves the body along the vector ``motion``. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. @@ -270,7 +270,7 @@ If ``recovery_as_collision`` is ``true``, any depenetration from the recovery ph .. rst-class:: classref-method -|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) +|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Removes a body from the list of bodies that this body can't collide with. @@ -282,7 +282,7 @@ Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-method -|void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +|void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) :ref:`🔗` Locks or unlocks the specified linear or rotational ``axis`` depending on the value of ``lock``. @@ -294,7 +294,7 @@ Locks or unlocks the specified linear or rotational ``axis`` depending on the va .. rst-class:: classref-method -:ref:`bool` **test_move**\ (\ from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, collision\: :ref:`KinematicCollision3D` = null, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) +:ref:`bool` **test_move**\ (\ from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, collision\: :ref:`KinematicCollision3D` = null, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) :ref:`🔗` Checks for collisions without moving the body. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 3e6349fb359..c41b3638adf 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -145,7 +145,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_velocity** +:ref:`float` **angular_velocity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ The body's rotational velocity in *radians* per second. .. rst-class:: classref-property -:ref:`Vector2` **center_of_mass** +:ref:`Vector2` **center_of_mass** :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ The body's center of mass position relative to the body's center in the global c .. rst-class:: classref-property -:ref:`Vector2` **center_of_mass_local** +:ref:`Vector2` **center_of_mass_local** :ref:`🔗` .. rst-class:: classref-property-setget @@ -194,7 +194,7 @@ The body's center of mass position in the body's local coordinate system. .. rst-class:: classref-property -:ref:`float` **inverse_inertia** +:ref:`float` **inverse_inertia** :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ The inverse of the inertia of the body. .. rst-class:: classref-property -:ref:`float` **inverse_mass** +:ref:`float` **inverse_mass** :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ The inverse of the mass of the body. .. rst-class:: classref-property -:ref:`Vector2` **linear_velocity** +:ref:`Vector2` **linear_velocity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -243,7 +243,7 @@ The body's linear velocity in pixels per second. .. rst-class:: classref-property -:ref:`bool` **sleeping** +:ref:`bool` **sleeping** :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ If ``true``, this body is currently sleeping (not active). .. rst-class:: classref-property -:ref:`float` **step** +:ref:`float` **step** :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ The timestep (delta) used for the simulation. .. rst-class:: classref-property -:ref:`float` **total_angular_damp** +:ref:`float` **total_angular_damp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ The rate at which the body stops rotating, if there are not any other forces mov .. rst-class:: classref-property -:ref:`Vector2` **total_gravity** +:ref:`Vector2` **total_gravity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -308,7 +308,7 @@ The total gravity vector being currently applied to this body. .. rst-class:: classref-property -:ref:`float` **total_linear_damp** +:ref:`float` **total_linear_damp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ The rate at which the body stops moving, if there are not any other forces movin .. rst-class:: classref-property -:ref:`Transform2D` **transform** +:ref:`Transform2D` **transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -346,7 +346,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_constant_central_force**\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -360,7 +360,7 @@ This is equivalent to using :ref:`add_constant_force`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -374,7 +374,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -|void| **add_constant_torque**\ (\ torque\: :ref:`float`\ ) +|void| **add_constant_torque**\ (\ torque\: :ref:`float`\ ) :ref:`🔗` Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = 0``. @@ -386,7 +386,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -|void| **apply_central_force**\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **apply_central_force**\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -400,7 +400,7 @@ This is equivalent to using :ref:`apply_force`\ ) +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector2`\ ) :ref:`🔗` Applies a directional impulse without affecting rotation. @@ -416,7 +416,7 @@ This is equivalent to using :ref:`apply_impulse`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -430,7 +430,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -|void| **apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a positioned impulse to the body. @@ -446,7 +446,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **apply_torque**\ (\ torque\: :ref:`float`\ ) +|void| **apply_torque**\ (\ torque\: :ref:`float`\ ) :ref:`🔗` Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -460,7 +460,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -|void| **apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) +|void| **apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) :ref:`🔗` Applies a rotational impulse to the body without affecting the position. @@ -476,7 +476,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Vector2` **get_constant_force**\ (\ ) |const| +:ref:`Vector2` **get_constant_force**\ (\ ) |const| :ref:`🔗` Returns the body's total constant positional forces applied during each physics update. @@ -490,7 +490,7 @@ See :ref:`add_constant_force` **get_constant_torque**\ (\ ) |const| +:ref:`float` **get_constant_torque**\ (\ ) |const| :ref:`🔗` Returns the body's total constant rotational forces applied during each physics update. @@ -504,7 +504,7 @@ See :ref:`add_constant_torque` **get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`RID` **get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider's :ref:`RID`. @@ -516,7 +516,7 @@ Returns the collider's :ref:`RID`. .. rst-class:: classref-method -:ref:`int` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider's object id. @@ -528,7 +528,7 @@ Returns the collider's object id. .. rst-class:: classref-method -:ref:`Object` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Object` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). @@ -540,7 +540,7 @@ Returns the collider object. This depends on how it was created (will return a s .. rst-class:: classref-method -:ref:`Vector2` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the contact point on the collider in the global coordinate system. @@ -552,7 +552,7 @@ Returns the position of the contact point on the collider in the global coordina .. rst-class:: classref-method -:ref:`int` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider's shape index. @@ -564,7 +564,7 @@ Returns the collider's shape index. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the velocity vector at the collider's contact point. @@ -576,7 +576,7 @@ Returns the velocity vector at the collider's contact point. .. rst-class:: classref-method -:ref:`int` **get_contact_count**\ (\ ) |const| +:ref:`int` **get_contact_count**\ (\ ) |const| :ref:`🔗` Returns the number of contacts this body has with other bodies. @@ -590,7 +590,7 @@ Returns the number of contacts this body has with other bodies. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the impulse created by the contact. @@ -602,7 +602,7 @@ Returns the impulse created by the contact. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local normal at the contact point. @@ -614,7 +614,7 @@ Returns the local normal at the contact point. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the contact point on the body in the global coordinate system. @@ -626,7 +626,7 @@ Returns the position of the contact point on the body in the global coordinate s .. rst-class:: classref-method -:ref:`int` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local shape index of the collision. @@ -638,7 +638,7 @@ Returns the local shape index of the collision. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the velocity vector at the body's contact point. @@ -650,7 +650,7 @@ Returns the velocity vector at the body's contact point. .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **get_space_state**\ (\ ) +:ref:`PhysicsDirectSpaceState2D` **get_space_state**\ (\ ) :ref:`🔗` Returns the current state of the space, useful for queries. @@ -662,7 +662,7 @@ Returns the current state of the space, useful for queries. .. rst-class:: classref-method -:ref:`Vector2` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the body's velocity at the given relative position, including both translation and rotation. @@ -674,7 +674,7 @@ Returns the body's velocity at the given relative position, including both trans .. rst-class:: classref-method -|void| **integrate_forces**\ (\ ) +|void| **integrate_forces**\ (\ ) :ref:`🔗` Updates the body's linear and angular velocity by applying gravity and damping for the equivalent of one physics tick. @@ -686,7 +686,7 @@ Updates the body's linear and angular velocity by applying gravity and damping f .. rst-class:: classref-method -|void| **set_constant_force**\ (\ force\: :ref:`Vector2`\ ) +|void| **set_constant_force**\ (\ force\: :ref:`Vector2`\ ) :ref:`🔗` Sets the body's total constant positional forces applied during each physics update. @@ -700,7 +700,7 @@ See :ref:`add_constant_force`\ ) +|void| **set_constant_torque**\ (\ torque\: :ref:`float`\ ) :ref:`🔗` Sets the body's total constant rotational forces applied during each physics update. diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst index 27909ea6c3a..51e5668d1f0 100644 --- a/classes/class_physicsdirectbodystate2dextension.rst +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -134,7 +134,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| +|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_central_force`. @@ -146,7 +146,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_central_force .. rst-class:: classref-method -|void| **_add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| +|void| **_add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_force`. @@ -158,7 +158,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_force`\ ) |virtual| +|void| **_add_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_torque`. @@ -170,7 +170,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_torque`\ ) |virtual| +|void| **_apply_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.apply_central_force`. @@ -182,7 +182,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.apply_central_force`\ ) |virtual| +|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.apply_central_impulse`. @@ -194,7 +194,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.apply_central_impulse`, position\: :ref:`Vector2`\ ) |virtual| +|void| **_apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.apply_force`. @@ -206,7 +206,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.apply_force`, position\: :ref:`Vector2`\ ) |virtual| +|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.apply_impulse`. @@ -218,7 +218,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.apply_impulse`\ ) |virtual| +|void| **_apply_torque**\ (\ torque\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.apply_torque`. @@ -230,7 +230,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.apply_torque`\ ) |virtual| +|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.apply_torque_impulse`. @@ -242,7 +242,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.apply_torque_impulse` **_get_angular_velocity**\ (\ ) |virtual| |const| +:ref:`float` **_get_angular_velocity**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_velocity` and its respective getter. @@ -254,7 +254,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_vel .. rst-class:: classref-method -:ref:`Vector2` **_get_center_of_mass**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_center_of_mass**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_mass` and its respective getter. @@ -266,7 +266,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_m .. rst-class:: classref-method -:ref:`Vector2` **_get_center_of_mass_local**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_center_of_mass_local**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_mass_local` and its respective getter. @@ -278,7 +278,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_m .. rst-class:: classref-method -:ref:`Vector2` **_get_constant_force**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_constant_force**\ (\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_constant_force`. @@ -290,7 +290,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_constant_force` **_get_constant_torque**\ (\ ) |virtual| |const| +:ref:`float` **_get_constant_torque**\ (\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_constant_torque`. @@ -302,7 +302,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_constant_torque` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider`. @@ -314,7 +314,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_id`. @@ -326,7 +326,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_id` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_object`. @@ -338,7 +338,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_objec .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_position`. @@ -350,7 +350,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_posit .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_shape`. @@ -362,7 +362,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_shape .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_velocity_at_position`. @@ -374,7 +374,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_veloc .. rst-class:: classref-method -:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_count`. @@ -386,7 +386,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_count` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_impulse`. @@ -398,7 +398,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_impulse` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_normal`. @@ -410,7 +410,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_normal` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_position`. @@ -422,7 +422,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_position .. rst-class:: classref-method -:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_shape`. @@ -434,7 +434,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_shape` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_velocity_at_position`. @@ -446,7 +446,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_velocity .. rst-class:: classref-method -:ref:`float` **_get_inverse_inertia**\ (\ ) |virtual| |const| +:ref:`float` **_get_inverse_inertia**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.inverse_inertia` and its respective getter. @@ -458,7 +458,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.inverse_ine .. rst-class:: classref-method -:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| +:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.inverse_mass` and its respective getter. @@ -470,7 +470,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.inverse_mas .. rst-class:: classref-method -:ref:`Vector2` **_get_linear_velocity**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_linear_velocity**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.linear_velocity` and its respective getter. @@ -482,7 +482,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.linear_velo .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **_get_space_state**\ (\ ) |virtual| +:ref:`PhysicsDirectSpaceState2D` **_get_space_state**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_space_state`. @@ -494,7 +494,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_space_state` **_get_step**\ (\ ) |virtual| |const| +:ref:`float` **_get_step**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.step` and its respective getter. @@ -506,7 +506,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.step` **_get_total_angular_damp**\ (\ ) |virtual| |const| +:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_angular_damp` and its respective getter. @@ -518,7 +518,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_angul .. rst-class:: classref-method -:ref:`Vector2` **_get_total_gravity**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_total_gravity**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_gravity` and its respective getter. @@ -530,7 +530,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_gravi .. rst-class:: classref-method -:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| +:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_linear_damp` and its respective getter. @@ -542,7 +542,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_linea .. rst-class:: classref-method -:ref:`Transform2D` **_get_transform**\ (\ ) |virtual| |const| +:ref:`Transform2D` **_get_transform**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.transform` and its respective getter. @@ -554,7 +554,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.transform` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |const| +:ref:`Vector2` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.get_velocity_at_local_position`. @@ -566,7 +566,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.get_velocity_at_local_posi .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ ) |virtual| +|void| **_integrate_forces**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.integrate_forces`. @@ -578,7 +578,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.integrate_forces` **_is_sleeping**\ (\ ) |virtual| |const| +:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.sleeping` and its respective getter. @@ -590,7 +590,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.sleeping`\ ) |virtual| +|void| **_set_angular_velocity**\ (\ velocity\: :ref:`float`\ ) |virtual| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_velocity` and its respective setter. @@ -602,7 +602,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_vel .. rst-class:: classref-method -|void| **_set_constant_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| +|void| **_set_constant_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.set_constant_force`. @@ -614,7 +614,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.set_constant_force`\ ) |virtual| +|void| **_set_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsDirectBodyState2D.set_constant_torque`. @@ -626,7 +626,7 @@ Overridable version of :ref:`PhysicsDirectBodyState2D.set_constant_torque`\ ) |virtual| +|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.linear_velocity` and its respective setter. @@ -638,7 +638,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.linear_velo .. rst-class:: classref-method -|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| +|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.sleeping` and its respective setter. @@ -650,7 +650,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.sleeping`\ ) |virtual| +|void| **_set_transform**\ (\ transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.transform` and its respective setter. diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index dbfa83c98eb..14622b57b8e 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -149,7 +149,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **angular_velocity** +:ref:`Vector3` **angular_velocity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ The body's rotational velocity in *radians* per second. .. rst-class:: classref-property -:ref:`Vector3` **center_of_mass** +:ref:`Vector3` **center_of_mass** :ref:`🔗` .. rst-class:: classref-property-setget @@ -182,7 +182,7 @@ The body's center of mass position relative to the body's center in the global c .. rst-class:: classref-property -:ref:`Vector3` **center_of_mass_local** +:ref:`Vector3` **center_of_mass_local** :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ The body's center of mass position in the body's local coordinate system. .. rst-class:: classref-property -:ref:`Vector3` **inverse_inertia** +:ref:`Vector3` **inverse_inertia** :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,7 +214,7 @@ The inverse of the inertia of the body. .. rst-class:: classref-property -:ref:`Basis` **inverse_inertia_tensor** +:ref:`Basis` **inverse_inertia_tensor** :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ The inverse of the inertia tensor of the body. .. rst-class:: classref-property -:ref:`float` **inverse_mass** +:ref:`float` **inverse_mass** :ref:`🔗` .. rst-class:: classref-property-setget @@ -246,7 +246,7 @@ The inverse of the mass of the body. .. rst-class:: classref-property -:ref:`Vector3` **linear_velocity** +:ref:`Vector3` **linear_velocity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -263,7 +263,7 @@ The body's linear velocity in units per second. .. rst-class:: classref-property -:ref:`Basis` **principal_inertia_axes** +:ref:`Basis` **principal_inertia_axes** :ref:`🔗` .. rst-class:: classref-property-setget @@ -281,7 +281,7 @@ The body's linear velocity in units per second. .. rst-class:: classref-property -:ref:`bool` **sleeping** +:ref:`bool` **sleeping** :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +298,7 @@ If ``true``, this body is currently sleeping (not active). .. rst-class:: classref-property -:ref:`float` **step** +:ref:`float` **step** :ref:`🔗` .. rst-class:: classref-property-setget @@ -314,7 +314,7 @@ The timestep (delta) used for the simulation. .. rst-class:: classref-property -:ref:`float` **total_angular_damp** +:ref:`float` **total_angular_damp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -330,7 +330,7 @@ The rate at which the body stops rotating, if there are not any other forces mov .. rst-class:: classref-property -:ref:`Vector3` **total_gravity** +:ref:`Vector3` **total_gravity** :ref:`🔗` .. rst-class:: classref-property-setget @@ -346,7 +346,7 @@ The total gravity vector being currently applied to this body. .. rst-class:: classref-property -:ref:`float` **total_linear_damp** +:ref:`float` **total_linear_damp** :ref:`🔗` .. rst-class:: classref-property-setget @@ -362,7 +362,7 @@ The rate at which the body stops moving, if there are not any other forces movin .. rst-class:: classref-property -:ref:`Transform3D` **transform** +:ref:`Transform3D` **transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -384,7 +384,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -398,7 +398,7 @@ This is equivalent to using :ref:`add_constant_force`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -412,7 +412,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) +|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) :ref:`🔗` Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``. @@ -424,7 +424,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -|void| **apply_central_force**\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **apply_central_force**\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -438,7 +438,7 @@ This is equivalent to using :ref:`apply_force` = Vector3(0, 0, 0)\ ) +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a directional impulse without affecting rotation. @@ -454,7 +454,7 @@ This is equivalent to using :ref:`apply_impulse`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -468,7 +468,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a positioned impulse to the body. @@ -484,7 +484,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **apply_torque**\ (\ torque\: :ref:`Vector3`\ ) +|void| **apply_torque**\ (\ torque\: :ref:`Vector3`\ ) :ref:`🔗` Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -498,7 +498,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) +|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) :ref:`🔗` Applies a rotational impulse to the body without affecting the position. @@ -514,7 +514,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Vector3` **get_constant_force**\ (\ ) |const| +:ref:`Vector3` **get_constant_force**\ (\ ) |const| :ref:`🔗` Returns the body's total constant positional forces applied during each physics update. @@ -528,7 +528,7 @@ See :ref:`add_constant_force` **get_constant_torque**\ (\ ) |const| +:ref:`Vector3` **get_constant_torque**\ (\ ) |const| :ref:`🔗` Returns the body's total constant rotational forces applied during each physics update. @@ -542,7 +542,7 @@ See :ref:`add_constant_torque` **get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`RID` **get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider's :ref:`RID`. @@ -554,7 +554,7 @@ Returns the collider's :ref:`RID`. .. rst-class:: classref-method -:ref:`int` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider's object id. @@ -566,7 +566,7 @@ Returns the collider's object id. .. rst-class:: classref-method -:ref:`Object` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Object` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider object. @@ -578,7 +578,7 @@ Returns the collider object. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the contact point on the collider in the global coordinate system. @@ -590,7 +590,7 @@ Returns the position of the contact point on the collider in the global coordina .. rst-class:: classref-method -:ref:`int` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collider's shape index. @@ -602,7 +602,7 @@ Returns the collider's shape index. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the linear velocity vector at the collider's contact point. @@ -614,7 +614,7 @@ Returns the linear velocity vector at the collider's contact point. .. rst-class:: classref-method -:ref:`int` **get_contact_count**\ (\ ) |const| +:ref:`int` **get_contact_count**\ (\ ) |const| :ref:`🔗` Returns the number of contacts this body has with other bodies. @@ -628,7 +628,7 @@ Returns the number of contacts this body has with other bodies. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Impulse created by the contact. @@ -640,7 +640,7 @@ Impulse created by the contact. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local normal at the contact point. @@ -652,7 +652,7 @@ Returns the local normal at the contact point. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the contact point on the body in the global coordinate system. @@ -664,7 +664,7 @@ Returns the position of the contact point on the body in the global coordinate s .. rst-class:: classref-method -:ref:`int` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local shape index of the collision. @@ -676,7 +676,7 @@ Returns the local shape index of the collision. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the linear velocity vector at the body's contact point. @@ -688,7 +688,7 @@ Returns the linear velocity vector at the body's contact point. .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **get_space_state**\ (\ ) +:ref:`PhysicsDirectSpaceState3D` **get_space_state**\ (\ ) :ref:`🔗` Returns the current state of the space, useful for queries. @@ -700,7 +700,7 @@ Returns the current state of the space, useful for queries. .. rst-class:: classref-method -:ref:`Vector3` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the body's velocity at the given relative position, including both translation and rotation. @@ -712,7 +712,7 @@ Returns the body's velocity at the given relative position, including both trans .. rst-class:: classref-method -|void| **integrate_forces**\ (\ ) +|void| **integrate_forces**\ (\ ) :ref:`🔗` Updates the body's linear and angular velocity by applying gravity and damping for the equivalent of one physics tick. @@ -724,7 +724,7 @@ Updates the body's linear and angular velocity by applying gravity and damping f .. rst-class:: classref-method -|void| **set_constant_force**\ (\ force\: :ref:`Vector3`\ ) +|void| **set_constant_force**\ (\ force\: :ref:`Vector3`\ ) :ref:`🔗` Sets the body's total constant positional forces applied during each physics update. @@ -738,7 +738,7 @@ See :ref:`add_constant_force`\ ) +|void| **set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) :ref:`🔗` Sets the body's total constant rotational forces applied during each physics update. diff --git a/classes/class_physicsdirectbodystate3dextension.rst b/classes/class_physicsdirectbodystate3dextension.rst index 218c03a0e1d..c2b184ea997 100644 --- a/classes/class_physicsdirectbodystate3dextension.rst +++ b/classes/class_physicsdirectbodystate3dextension.rst @@ -138,7 +138,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| +|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -152,7 +152,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| +|void| **_add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -166,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| +|void| **_add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -180,7 +180,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| +|void| **_apply_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -194,7 +194,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| +|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -208,7 +208,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| +|void| **_apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -222,7 +222,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| +|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -236,7 +236,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| +|void| **_apply_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -250,7 +250,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| +|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -264,7 +264,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_angular_velocity**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_angular_velocity**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -278,7 +278,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_center_of_mass**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_center_of_mass**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -292,7 +292,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_center_of_mass_local**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_center_of_mass_local**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -306,7 +306,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_constant_force**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_constant_force**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -320,7 +320,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_constant_torque**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_constant_torque**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -334,7 +334,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -348,7 +348,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -362,7 +362,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -376,7 +376,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -390,7 +390,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -404,7 +404,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -418,7 +418,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -432,7 +432,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -446,7 +446,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -460,7 +460,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -474,7 +474,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -488,7 +488,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -502,7 +502,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_inverse_inertia**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_inverse_inertia**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -516,7 +516,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Basis` **_get_inverse_inertia_tensor**\ (\ ) |virtual| |const| +:ref:`Basis` **_get_inverse_inertia_tensor**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -530,7 +530,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| +:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -544,7 +544,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_linear_velocity**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_linear_velocity**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -558,7 +558,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Basis` **_get_principal_inertia_axes**\ (\ ) |virtual| |const| +:ref:`Basis` **_get_principal_inertia_axes**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -572,7 +572,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **_get_space_state**\ (\ ) |virtual| +:ref:`PhysicsDirectSpaceState3D` **_get_space_state**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -586,7 +586,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_get_step**\ (\ ) |virtual| |const| +:ref:`float` **_get_step**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -600,7 +600,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| +:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -614,7 +614,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_total_gravity**\ (\ ) |virtual| |const| +:ref:`Vector3` **_get_total_gravity**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -628,7 +628,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| +:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -642,7 +642,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **_get_transform**\ (\ ) |virtual| |const| +:ref:`Transform3D` **_get_transform**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -656,7 +656,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |const| +:ref:`Vector3` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -670,7 +670,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ ) |virtual| +|void| **_integrate_forces**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -684,7 +684,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| +:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -698,7 +698,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_angular_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| +|void| **_set_angular_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -712,7 +712,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_constant_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| +|void| **_set_constant_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -726,7 +726,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| +|void| **_set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -740,7 +740,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| +|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -754,7 +754,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| +|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -768,7 +768,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_transform**\ (\ transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_set_transform**\ (\ transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index 408315066b6..976046cd908 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) +:ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) :ref:`🔗` Checks how far a :ref:`Shape2D` can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a :ref:`PhysicsShapeQueryParameters2D` object. @@ -83,7 +83,7 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) +:ref:`Array`\[:ref:`Vector2`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. @@ -97,7 +97,7 @@ Returned points are a list of pairs of contact points. For each pair the first o .. rst-class:: classref-method -:ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) +:ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. @@ -123,7 +123,7 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters2D`, max_results\: :ref:`int` = 32\ ) +:ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters2D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks whether a point is inside any solid shape. Position and other parameters are defined through :ref:`PhysicsPointQueryParameters2D`. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -147,7 +147,7 @@ The number of intersections can be limited with the ``max_results`` parameter, t .. rst-class:: classref-method -:ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters2D`\ ) +:ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters2D`\ ) :ref:`🔗` Intersects a ray in a given space. Ray position and other parameters are defined through :ref:`PhysicsRayQueryParameters2D`. The returned object is a dictionary with the following fields: @@ -173,7 +173,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) +:ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` 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: diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst index 4a42684ced4..956bbef265a 100644 --- a/classes/class_physicsdirectspacestate2dextension.rst +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -60,7 +60,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| +:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| +:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| +:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| +:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| +:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -130,7 +130,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| +:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_body_excluded_from_query**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **is_body_excluded_from_query**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_physicsdirectspacestate3d.rst b/classes/class_physicsdirectspacestate3d.rst index 6423345582a..5011f0d4b24 100644 --- a/classes/class_physicsdirectspacestate3d.rst +++ b/classes/class_physicsdirectspacestate3d.rst @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) +:ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) :ref:`🔗` Checks how far a :ref:`Shape3D` can move without colliding. All the parameters for the query, including the shape, are supplied through a :ref:`PhysicsShapeQueryParameters3D` object. @@ -83,7 +83,7 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector3`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) +:ref:`Array`\[:ref:`Vector3`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. @@ -99,7 +99,7 @@ Returned points are a list of pairs of contact points. For each pair the first o .. rst-class:: classref-method -:ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) +:ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: @@ -127,7 +127,7 @@ If the shape did not intersect anything, then an empty dictionary is returned in .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters3D`, max_results\: :ref:`int` = 32\ ) +:ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters3D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks whether a point is inside any solid shape. Position and other parameters are defined through :ref:`PhysicsPointQueryParameters3D`. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -149,7 +149,7 @@ The number of intersections can be limited with the ``max_results`` parameter, t .. rst-class:: classref-method -:ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters3D`\ ) +:ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters3D`\ ) :ref:`🔗` Intersects a ray in a given space. Ray position and other parameters are defined through :ref:`PhysicsRayQueryParameters3D`. The returned object is a dictionary with the following fields: @@ -179,7 +179,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) +:ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` 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: diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index 59bc58aaccd..81dc0b95419 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -62,7 +62,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| +:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -76,7 +76,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| +:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -90,7 +90,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_closest_point_to_object_volume**\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |const| +:ref:`Vector3` **_get_closest_point_to_object_volume**\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -104,7 +104,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| +:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| +:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -132,7 +132,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| +:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -146,7 +146,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| +:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -160,7 +160,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_body_excluded_from_query**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **is_body_excluded_from_query**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 0dc3f9e70f6..4920b20e6db 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **absorbent** = ``false`` +:ref:`bool` **absorbent** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ If ``true``, subtracts the bounciness from the colliding object's bounciness ins .. rst-class:: classref-property -:ref:`float` **bounce** = ``0.0`` +:ref:`float` **bounce** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -78,7 +78,7 @@ If ``true``, subtracts the bounciness from the colliding object's bounciness ins The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). -\ **Note:** Even with :ref:`bounce` set to ``1.0``, some energy will be lost over time due to linear and angular damping. To have a :ref:`PhysicsBody3D` that preserves all its energy over time, set :ref:`bounce` to ``1.0``, the body's linear damp mode to **Replace** (if applicable), its linear damp to ``0.0``, its angular damp mode to **Replace** (if applicable), and its angular damp to ``0.0``. +\ **Note:** Even with :ref:`bounce` set to ``1.0``, some energy will be lost over time due to linear and angular damping. To have a physics body that preserves all its energy over time, set :ref:`bounce` to ``1.0``, the body's linear damp mode to **Replace** (if applicable), its linear damp to ``0.0``, its angular damp mode to **Replace** (if applicable), and its angular damp to ``0.0``. .. rst-class:: classref-item-separator @@ -88,7 +88,7 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci .. rst-class:: classref-property -:ref:`float` **friction** = ``1.0`` +:ref:`float` **friction** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum fr .. rst-class:: classref-property -:ref:`bool` **rough** = ``false`` +:ref:`bool` **rough** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicspointqueryparameters2d.rst b/classes/class_physicspointqueryparameters2d.rst index 219ee10bc72..0127643629b 100644 --- a/classes/class_physicspointqueryparameters2d.rst +++ b/classes/class_physicspointqueryparameters2d.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **canvas_instance_id** = ``0`` +:ref:`int` **canvas_instance_id** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ If ``0``, restricts the query to the Viewport's default canvas layer. .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -92,7 +92,7 @@ If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -109,7 +109,7 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``4294967295`` +:ref:`int` **collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -126,7 +126,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -143,7 +143,7 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicspointqueryparameters3d.rst b/classes/class_physicspointqueryparameters3d.rst index 85345983199..2f2765e9c99 100644 --- a/classes/class_physicspointqueryparameters3d.rst +++ b/classes/class_physicspointqueryparameters3d.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ If ``true``, the query will take :ref:`Area3D`\ s into account. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ If ``true``, the query will take :ref:`PhysicsBody3D`\ s in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``4294967295`` +:ref:`int` **collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property -:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicsrayqueryparameters2d.rst b/classes/class_physicsrayqueryparameters2d.rst index 83a6f22772d..4daa99ecba0 100644 --- a/classes/class_physicsrayqueryparameters2d.rst +++ b/classes/class_physicsrayqueryparameters2d.rst @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -87,7 +87,7 @@ If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``4294967295`` +:ref:`int` **collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property -:ref:`Vector2` **from** = ``Vector2(0, 0)`` +:ref:`Vector2` **from** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ The starting point of the ray being queried for, in global coordinates. .. rst-class:: classref-property -:ref:`bool` **hit_from_inside** = ``false`` +:ref:`bool` **hit_from_inside** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ If ``true``, the query will detect a hit when starting inside shapes. In this ca .. rst-class:: classref-property -:ref:`Vector2` **to** = ``Vector2(0, 0)`` +:ref:`Vector2` **to** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -194,7 +194,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsRayQueryParameters2D` **create**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| +:ref:`PhysicsRayQueryParameters2D` **create**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| :ref:`🔗` Returns a new, pre-configured **PhysicsRayQueryParameters2D** object. Use it to quickly create query parameters using the most common options. diff --git a/classes/class_physicsrayqueryparameters3d.rst b/classes/class_physicsrayqueryparameters3d.rst index f773c8cb726..e53ca2eb15e 100644 --- a/classes/class_physicsrayqueryparameters3d.rst +++ b/classes/class_physicsrayqueryparameters3d.rst @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -89,7 +89,7 @@ If ``true``, the query will take :ref:`Area3D`\ s into account. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -106,7 +106,7 @@ If ``true``, the query will take :ref:`PhysicsBody3D`\ s in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``4294967295`` +:ref:`int` **collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property -:ref:`Vector3` **from** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **from** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ The starting point of the ray being queried for, in global coordinates. .. rst-class:: classref-property -:ref:`bool` **hit_back_faces** = ``true`` +:ref:`bool` **hit_back_faces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ If ``true``, the query will hit back faces with concave polygon shapes with back .. rst-class:: classref-property -:ref:`bool` **hit_from_inside** = ``false`` +:ref:`bool` **hit_from_inside** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ If ``true``, the query will detect a hit when starting inside shapes. In this ca .. rst-class:: classref-property -:ref:`Vector3` **to** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **to** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsRayQueryParameters3D` **create**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| +:ref:`PhysicsRayQueryParameters3D` **create**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| :ref:`🔗` Returns a new, pre-configured **PhysicsRayQueryParameters3D** object. Use it to quickly create query parameters using the most common options. diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index 1043482c2af..8a58d30b956 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -296,7 +296,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SpaceParameter**: +enum **SpaceParameter**: :ref:`🔗` .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS: @@ -378,7 +378,7 @@ Constant to set/get the number of solver iterations for all contacts and constra .. rst-class:: classref-enumeration -enum **ShapeType**: +enum **ShapeType**: :ref:`🔗` .. _class_PhysicsServer2D_constant_SHAPE_WORLD_BOUNDARY: @@ -460,7 +460,7 @@ This constant is used internally by the engine. Any attempt to create this kind .. rst-class:: classref-enumeration -enum **AreaParameter**: +enum **AreaParameter**: :ref:`🔗` .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE: @@ -552,7 +552,7 @@ Constant to set/get the priority (order of processing) of an area. The default v .. rst-class:: classref-enumeration -enum **AreaSpaceOverrideMode**: +enum **AreaSpaceOverrideMode**: :ref:`🔗` .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_DISABLED: @@ -602,7 +602,7 @@ This area replaces any gravity/damp calculated so far, but keeps calculating the .. rst-class:: classref-enumeration -enum **BodyMode**: +enum **BodyMode**: :ref:`🔗` .. _class_PhysicsServer2D_constant_BODY_MODE_STATIC: @@ -644,7 +644,7 @@ Constant for linear rigid bodies. In this mode, a body can not rotate, and only .. rst-class:: classref-enumeration -enum **BodyParameter**: +enum **BodyParameter**: :ref:`🔗` .. _class_PhysicsServer2D_constant_BODY_PARAM_BOUNCE: @@ -746,7 +746,7 @@ Represents the size of the :ref:`BodyParameter` .. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_COMBINE: @@ -772,7 +772,7 @@ The body's damping value replaces any value set in areas or the default value. .. rst-class:: classref-enumeration -enum **BodyState**: +enum **BodyState**: :ref:`🔗` .. _class_PhysicsServer2D_constant_BODY_STATE_TRANSFORM: @@ -822,7 +822,7 @@ Constant to set/get whether the body can sleep. .. rst-class:: classref-enumeration -enum **JointType**: +enum **JointType**: :ref:`🔗` .. _class_PhysicsServer2D_constant_JOINT_TYPE_PIN: @@ -864,7 +864,7 @@ Represents the size of the :ref:`JointType` enum .. rst-class:: classref-enumeration -enum **JointParam**: +enum **JointParam**: :ref:`🔗` .. _class_PhysicsServer2D_constant_JOINT_PARAM_BIAS: @@ -904,7 +904,7 @@ Constant to set/get the maximum force that the joint can use to act on the two b .. rst-class:: classref-enumeration -enum **PinJointParam**: +enum **PinJointParam**: :ref:`🔗` .. _class_PhysicsServer2D_constant_PIN_JOINT_SOFTNESS: @@ -946,7 +946,7 @@ Target speed for the motor. In radians per second. .. rst-class:: classref-enumeration -enum **PinJointFlag**: +enum **PinJointFlag**: :ref:`🔗` .. _class_PhysicsServer2D_constant_PIN_JOINT_FLAG_ANGULAR_LIMIT_ENABLED: @@ -972,7 +972,7 @@ If ``true``, a motor turns the pin. .. rst-class:: classref-enumeration -enum **DampedSpringParam**: +enum **DampedSpringParam**: :ref:`🔗` .. _class_PhysicsServer2D_constant_DAMPED_SPRING_REST_LENGTH: @@ -1006,7 +1006,7 @@ Sets the damping ratio of the spring joint. A value of 0 indicates an undamped s .. rst-class:: classref-enumeration -enum **CCDMode**: +enum **CCDMode**: :ref:`🔗` .. _class_PhysicsServer2D_constant_CCD_MODE_DISABLED: @@ -1040,7 +1040,7 @@ Enables continuous collision detection by shapecasting. It is the slowest CCD me .. rst-class:: classref-enumeration -enum **AreaBodyStatus**: +enum **AreaBodyStatus**: :ref:`🔗` .. _class_PhysicsServer2D_constant_AREA_BODY_ADDED: @@ -1066,7 +1066,7 @@ The value of the first parameter and area callback function receives, when an ob .. rst-class:: classref-enumeration -enum **ProcessInfo**: +enum **ProcessInfo**: :ref:`🔗` .. _class_PhysicsServer2D_constant_INFO_ACTIVE_OBJECTS: @@ -1105,7 +1105,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) +|void| **area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) :ref:`🔗` Adds a shape to the area, with the given local transform. The shape (together with its ``transform`` and ``disabled`` properties) is added to an array of shapes, and the shapes of an area are usually referenced by their index in this array. @@ -1117,7 +1117,7 @@ Adds a shape to the area, with the given local transform. The shape (together wi .. rst-class:: classref-method -|void| **area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Attaches the ``ObjectID`` of a canvas to the area. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CanvasLayer`. @@ -1129,7 +1129,7 @@ Attaches the ``ObjectID`` of a canvas to the area. Use :ref:`Object.get_instance .. rst-class:: classref-method -|void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Attaches the ``ObjectID`` of an :ref:`Object` to the area. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CollisionObject2D`. @@ -1141,7 +1141,7 @@ Attaches the ``ObjectID`` of an :ref:`Object` to the area. Use :re .. rst-class:: classref-method -|void| **area_clear_shapes**\ (\ area\: :ref:`RID`\ ) +|void| **area_clear_shapes**\ (\ area\: :ref:`RID`\ ) :ref:`🔗` Removes all shapes from the area. This does not delete the shapes themselves, so they can continue to be used elsewhere or added back later. @@ -1153,7 +1153,7 @@ Removes all shapes from the area. This does not delete the shapes themselves, so .. rst-class:: classref-method -:ref:`RID` **area_create**\ (\ ) +:ref:`RID` **area_create**\ (\ ) :ref:`🔗` Creates a 2D area object in the physics server, and returns the :ref:`RID` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and ``monitorable`` set to ``false``. @@ -1167,7 +1167,7 @@ Use :ref:`area_add_shape` to add sh .. rst-class:: classref-method -:ref:`int` **area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` of the canvas attached to the area. Use :ref:`@GlobalScope.instance_from_id` to retrieve a :ref:`CanvasLayer` from a nonzero ``ObjectID``. @@ -1179,7 +1179,7 @@ Returns the ``ObjectID`` of the canvas attached to the area. Use :ref:`@GlobalSc .. rst-class:: classref-method -:ref:`int` **area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers the area belongs to, as a bitmask. @@ -1191,7 +1191,7 @@ Returns the physics layer or layers the area belongs to, as a bitmask. .. rst-class:: classref-method -:ref:`int` **area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers the area can contact with, as a bitmask. @@ -1203,7 +1203,7 @@ Returns the physics layer or layers the area can contact with, as a bitmask. .. rst-class:: classref-method -:ref:`int` **area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` attached to the area. Use :ref:`@GlobalScope.instance_from_id` to retrieve an :ref:`Object` from a nonzero ``ObjectID``. @@ -1215,7 +1215,7 @@ Returns the ``ObjectID`` attached to the area. Use :ref:`@GlobalScope.instance_f .. rst-class:: classref-method -:ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| +:ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| :ref:`🔗` Returns the value of the given area parameter. See :ref:`AreaParameter` for the list of available parameters. @@ -1227,7 +1227,7 @@ Returns the value of the given area parameter. See :ref:`AreaParameter` **area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`RID` **area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the shape with the given index in the area's array of shapes. @@ -1239,7 +1239,7 @@ Returns the :ref:`RID` of the shape with the given index in the area' .. rst-class:: classref-method -:ref:`int` **area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of shapes added to the area. @@ -1251,7 +1251,7 @@ Returns the number of shapes added to the area. .. rst-class:: classref-method -:ref:`Transform2D` **area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`Transform2D` **area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local transform matrix of the shape with the given index in the area's array of shapes. @@ -1263,7 +1263,7 @@ Returns the local transform matrix of the shape with the given index in the area .. rst-class:: classref-method -:ref:`RID` **area_get_space**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`RID` **area_get_space**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the space assigned to the area. Returns an empty :ref:`RID` if no space is assigned. @@ -1275,7 +1275,7 @@ Returns the :ref:`RID` of the space assigned to the area. Returns an .. rst-class:: classref-method -:ref:`Transform2D` **area_get_transform**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`Transform2D` **area_get_transform**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the transform matrix of the area. @@ -1287,7 +1287,7 @@ Returns the transform matrix of the area. .. rst-class:: classref-method -|void| **area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) +|void| **area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) :ref:`🔗` Removes the shape with the given index from the area's array of shapes. The shape itself is not deleted, so it can continue to be used elsewhere or added back later. As a result of this operation, the area's shapes which used to have indices higher than ``shape_idx`` will have their index decreased by one. @@ -1299,7 +1299,7 @@ Removes the shape with the given index from the area's array of shapes. The shap .. rst-class:: classref-method -|void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters: @@ -1323,7 +1323,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -|void| **area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) +|void| **area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) :ref:`🔗` Assigns the area to one or many physics layers, via a bitmask. @@ -1335,7 +1335,7 @@ Assigns the area to one or many physics layers, via a bitmask. .. rst-class:: classref-method -|void| **area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets which physics layers the area will monitor, via a bitmask. @@ -1347,7 +1347,7 @@ Sets which physics layers the area will monitor, via a bitmask. .. rst-class:: classref-method -|void| **area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters: @@ -1371,7 +1371,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -|void| **area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) +|void| **area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the area is monitorable or not. If ``monitorable`` is ``true``, the area monitoring callback of other areas will be called when this area enters or exits them. @@ -1383,7 +1383,7 @@ Sets whether the area is monitorable or not. If ``monitorable`` is ``true``, the .. rst-class:: classref-method -|void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) +|void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the value of the given area parameter. See :ref:`AreaParameter` for the list of available parameters. @@ -1395,7 +1395,7 @@ Sets the value of the given area parameter. See :ref:`AreaParameter`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) +|void| **area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) :ref:`🔗` Replaces the area's shape at the given index by another shape, while not affecting the ``transform`` and ``disabled`` properties at the same index. @@ -1407,7 +1407,7 @@ Replaces the area's shape at the given index by another shape, while not affecti .. rst-class:: classref-method -|void| **area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Sets the disabled property of the area's shape with the given index. If ``disabled`` is ``true``, then the shape will not detect any other shapes entering or exiting it. @@ -1419,7 +1419,7 @@ Sets the disabled property of the area's shape with the given index. If ``disabl .. rst-class:: classref-method -|void| **area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the local transform matrix of the area's shape with the given index. @@ -1431,7 +1431,7 @@ Sets the local transform matrix of the area's shape with the given index. .. rst-class:: classref-method -|void| **area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) +|void| **area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) :ref:`🔗` Adds the area to the given space, after removing the area from the previously assigned space (if any). @@ -1445,7 +1445,7 @@ Adds the area to the given space, after removing the area from the previously as .. rst-class:: classref-method -|void| **area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the transform matrix of the area. @@ -1457,7 +1457,7 @@ Sets the transform matrix of the area. .. rst-class:: classref-method -|void| **body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) +|void| **body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) :ref:`🔗` Adds ``excepted_body`` to the body's list of collision exceptions, so that collisions with it are ignored. @@ -1469,7 +1469,7 @@ Adds ``excepted_body`` to the body's list of collision exceptions, so that colli .. rst-class:: classref-method -|void| **body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) +|void| **body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) :ref:`🔗` Adds a constant directional force to the body. The force does not affect rotation. The force remains applied over time until cleared with ``PhysicsServer2D.body_set_constant_force(body, Vector2(0, 0))``. @@ -1483,7 +1483,7 @@ This is equivalent to using :ref:`body_add_constant_force`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds a constant positioned force to the body. The force can affect rotation if ``position`` is different from the body's center of mass. The force remains applied over time until cleared with ``PhysicsServer2D.body_set_constant_force(body, Vector2(0, 0))``. @@ -1497,7 +1497,7 @@ Adds a constant positioned force to the body. The force can affect rotation if ` .. rst-class:: classref-method -|void| **body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) +|void| **body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) :ref:`🔗` Adds a constant rotational force to the body. The force does not affect position. The force remains applied over time until cleared with ``PhysicsServer2D.body_set_constant_torque(body, 0)``. @@ -1509,7 +1509,7 @@ Adds a constant rotational force to the body. The force does not affect position .. rst-class:: classref-method -|void| **body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) +|void| **body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) :ref:`🔗` Adds a shape to the area, with the given local transform. The shape (together with its ``transform`` and ``disabled`` properties) is added to an array of shapes, and the shapes of a body are usually referenced by their index in this array. @@ -1521,7 +1521,7 @@ Adds a shape to the area, with the given local transform. The shape (together wi .. rst-class:: classref-method -|void| **body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) +|void| **body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) :ref:`🔗` Applies a directional force to the body, at the body's center of mass. The force does not affect rotation. A force is time dependent and meant to be applied every physics update. @@ -1535,7 +1535,7 @@ This is equivalent to using :ref:`body_apply_force`, impulse\: :ref:`Vector2`\ ) +|void| **body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) :ref:`🔗` Applies a directional impulse to the body, at the body's center of mass. The impulse does not affect rotation. @@ -1551,7 +1551,7 @@ This is equivalent to using :ref:`body_apply_impulse`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a positioned force to the body. The force can affect rotation if ``position`` is different from the body's center of mass. A force is time dependent and meant to be applied every physics update. @@ -1565,7 +1565,7 @@ Applies a positioned force to the body. The force can affect rotation if ``posit .. rst-class:: classref-method -|void| **body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a positioned impulse to the body. The impulse can affect rotation if ``position`` is different from the body's center of mass. @@ -1581,7 +1581,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) +|void| **body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) :ref:`🔗` Applies a rotational force to the body. The force does not affect position. A force is time dependent and meant to be applied every physics update. @@ -1593,7 +1593,7 @@ Applies a rotational force to the body. The force does not affect position. A fo .. rst-class:: classref-method -|void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) +|void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) :ref:`🔗` Applies a rotational impulse to the body. The impulse does not affect position. @@ -1607,7 +1607,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Attaches the ``ObjectID`` of a canvas to the body. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CanvasLayer`. @@ -1619,7 +1619,7 @@ Attaches the ``ObjectID`` of a canvas to the body. Use :ref:`Object.get_instance .. rst-class:: classref-method -|void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Attaches the ``ObjectID`` of an :ref:`Object` to the body. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CollisionObject2D`. @@ -1631,7 +1631,7 @@ Attaches the ``ObjectID`` of an :ref:`Object` to the body. Use :re .. rst-class:: classref-method -|void| **body_clear_shapes**\ (\ body\: :ref:`RID`\ ) +|void| **body_clear_shapes**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Removes all shapes from the body. This does not delete the shapes themselves, so they can continue to be used elsewhere or added back later. @@ -1643,7 +1643,7 @@ Removes all shapes from the body. This does not delete the shapes themselves, so .. rst-class:: classref-method -:ref:`RID` **body_create**\ (\ ) +:ref:`RID` **body_create**\ (\ ) :ref:`🔗` Creates a 2D body object in the physics server, and returns the :ref:`RID` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and body mode set to :ref:`BODY_MODE_RIGID`. @@ -1657,7 +1657,7 @@ Use :ref:`body_add_shape` to add sh .. rst-class:: classref-method -:ref:`int` **body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` of the canvas attached to the body. Use :ref:`@GlobalScope.instance_from_id` to retrieve a :ref:`CanvasLayer` from a nonzero ``ObjectID``. @@ -1669,7 +1669,7 @@ Returns the ``ObjectID`` of the canvas attached to the body. Use :ref:`@GlobalSc .. rst-class:: classref-method -:ref:`int` **body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers the body belongs to, as a bitmask. @@ -1681,7 +1681,7 @@ Returns the physics layer or layers the body belongs to, as a bitmask. .. rst-class:: classref-method -:ref:`int` **body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers the body can collide with, as a bitmask. @@ -1693,7 +1693,7 @@ Returns the physics layer or layers the body can collide with, as a bitmask. .. rst-class:: classref-method -:ref:`float` **body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's collision priority. This is used in the depenetration phase of :ref:`body_test_motion`. The higher the priority is, the lower the penetration into the body will be. @@ -1705,7 +1705,7 @@ Returns the body's collision priority. This is used in the depenetration phase o .. rst-class:: classref-method -:ref:`Vector2` **body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`Vector2` **body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's total constant positional force applied during each physics update. @@ -1719,7 +1719,7 @@ See :ref:`body_add_constant_force` **body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's total constant rotational force applied during each physics update. @@ -1733,7 +1733,7 @@ See :ref:`body_add_constant_torque` **body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`CCDMode` **body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's continuous collision detection mode (see :ref:`CCDMode`). @@ -1745,7 +1745,7 @@ Returns the body's continuous collision detection mode (see :ref:`CCDMode` **body_get_direct_state**\ (\ body\: :ref:`RID`\ ) +:ref:`PhysicsDirectBodyState2D` **body_get_direct_state**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Returns the :ref:`PhysicsDirectBodyState2D` of the body. Returns ``null`` if the body is destroyed or not assigned to a space. @@ -1757,7 +1757,7 @@ Returns the :ref:`PhysicsDirectBodyState2D` of t .. rst-class:: classref-method -:ref:`int` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum number of contacts that the body can report. See :ref:`body_set_max_contacts_reported`. @@ -1769,7 +1769,7 @@ Returns the maximum number of contacts that the body can report. See :ref:`body_ .. rst-class:: classref-method -:ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's mode (see :ref:`BodyMode`). @@ -1781,7 +1781,7 @@ Returns the body's mode (see :ref:`BodyMode`). .. rst-class:: classref-method -:ref:`int` **body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the ``ObjectID`` attached to the body. Use :ref:`@GlobalScope.instance_from_id` to retrieve an :ref:`Object` from a nonzero ``ObjectID``. @@ -1793,7 +1793,7 @@ Returns the ``ObjectID`` attached to the body. Use :ref:`@GlobalScope.instance_f .. rst-class:: classref-method -:ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| +:ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| :ref:`🔗` Returns the value of the given body parameter. See :ref:`BodyParameter` for the list of available parameters. @@ -1805,7 +1805,7 @@ Returns the value of the given body parameter. See :ref:`BodyParameter` **body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`RID` **body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the shape with the given index in the body's array of shapes. @@ -1817,7 +1817,7 @@ Returns the :ref:`RID` of the shape with the given index in the body' .. rst-class:: classref-method -:ref:`int` **body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of shapes added to the body. @@ -1829,7 +1829,7 @@ Returns the number of shapes added to the body. .. rst-class:: classref-method -:ref:`Transform2D` **body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`Transform2D` **body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local transform matrix of the shape with the given index in the area's array of shapes. @@ -1841,7 +1841,7 @@ Returns the local transform matrix of the shape with the given index in the area .. rst-class:: classref-method -:ref:`RID` **body_get_space**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`RID` **body_get_space**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the space assigned to the body. Returns an empty :ref:`RID` if no space is assigned. @@ -1853,7 +1853,7 @@ Returns the :ref:`RID` of the space assigned to the body. Returns an .. rst-class:: classref-method -:ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| +:ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| :ref:`🔗` Returns the value of the given state of the body. See :ref:`BodyState` for the list of available states. @@ -1865,7 +1865,7 @@ Returns the value of the given state of the body. See :ref:`BodyState` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the body is omitting the standard force integration. See :ref:`body_set_omit_force_integration`. @@ -1877,7 +1877,7 @@ Returns ``true`` if the body is omitting the standard force integration. See :re .. rst-class:: classref-method -|void| **body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) +|void| **body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) :ref:`🔗` Removes ``excepted_body`` from the body's list of collision exceptions, so that collisions with it are no longer ignored. @@ -1889,7 +1889,7 @@ Removes ``excepted_body`` from the body's list of collision exceptions, so that .. rst-class:: classref-method -|void| **body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) +|void| **body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) :ref:`🔗` Removes the shape with the given index from the body's array of shapes. The shape itself is not deleted, so it can continue to be used elsewhere or added back later. As a result of this operation, the body's shapes which used to have indices higher than ``shape_idx`` will have their index decreased by one. @@ -1901,7 +1901,7 @@ Removes the shape with the given index from the body's array of shapes. The shap .. rst-class:: classref-method -|void| **body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) +|void| **body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Restores the default inertia and center of mass of the body based on its shapes. This undoes any custom values previously set using :ref:`body_set_param`. @@ -1913,7 +1913,7 @@ Restores the default inertia and center of mass of the body based on its shapes. .. rst-class:: classref-method -|void| **body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) +|void| **body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) :ref:`🔗` Modifies the body's linear velocity so that its projection to the axis ``axis_velocity.normalized()`` is exactly ``axis_velocity.length()``. This is useful for jumping behavior. @@ -1925,7 +1925,7 @@ Modifies the body's linear velocity so that its projection to the axis ``axis_ve .. rst-class:: classref-method -|void| **body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) +|void| **body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer or layers the body belongs to, via a bitmask. @@ -1937,7 +1937,7 @@ Sets the physics layer or layers the body belongs to, via a bitmask. .. rst-class:: classref-method -|void| **body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer or layers the body can collide with, via a bitmask. @@ -1949,7 +1949,7 @@ Sets the physics layer or layers the body can collide with, via a bitmask. .. rst-class:: classref-method -|void| **body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) +|void| **body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) :ref:`🔗` Sets the body's collision priority. This is used in the depenetration phase of :ref:`body_test_motion`. The higher the priority is, the lower the penetration into the body will be. @@ -1961,7 +1961,7 @@ Sets the body's collision priority. This is used in the depenetration phase of : .. rst-class:: classref-method -|void| **body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) +|void| **body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) :ref:`🔗` Sets the body's total constant positional force applied during each physics update. @@ -1975,7 +1975,7 @@ See :ref:`body_add_constant_force`, torque\: :ref:`float`\ ) +|void| **body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) :ref:`🔗` Sets the body's total constant rotational force applied during each physics update. @@ -1989,7 +1989,7 @@ See :ref:`body_add_constant_torque`, mode\: :ref:`CCDMode`\ ) +|void| **body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) :ref:`🔗` Sets the continuous collision detection mode using one of the :ref:`CCDMode` constants. @@ -2003,7 +2003,7 @@ Continuous collision detection tries to predict where a moving body would collid .. rst-class:: classref-method -|void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) +|void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) :ref:`🔗` Sets the body's custom force integration callback function to ``callable``. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. @@ -2025,7 +2025,7 @@ If ``userdata`` is ``null``, then ``callable`` must take only the ``state`` para .. rst-class:: classref-method -|void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) +|void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) :ref:`🔗` Sets the maximum number of contacts that the body can report. If ``amount`` is greater than zero, then the body will keep track of at most this many contacts with other bodies. @@ -2037,7 +2037,7 @@ Sets the maximum number of contacts that the body can report. If ``amount`` is g .. rst-class:: classref-method -|void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) +|void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) :ref:`🔗` Sets the body's mode. See :ref:`BodyMode` for the list of available modes. @@ -2049,7 +2049,7 @@ Sets the body's mode. See :ref:`BodyMode` for the .. rst-class:: classref-method -|void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the body omits the standard force integration. If ``enable`` is ``true``, the body will not automatically use applied forces, torques, and damping to update the body's linear and angular velocity. In this case, :ref:`body_set_force_integration_callback` can be used to manually update the linear and angular velocity instead. @@ -2063,7 +2063,7 @@ This method is called when the property :ref:`RigidBody2D.custom_integrator`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) +|void| **body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the value of the given body parameter. See :ref:`BodyParameter` for the list of available parameters. @@ -2075,7 +2075,7 @@ Sets the value of the given body parameter. See :ref:`BodyParameter`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) +|void| **body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) :ref:`🔗` Replaces the body's shape at the given index by another shape, while not affecting the ``transform``, ``disabled``, and one-way collision properties at the same index. @@ -2087,7 +2087,7 @@ Replaces the body's shape at the given index by another shape, while not affecti .. rst-class:: classref-method -|void| **body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) +|void| **body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) :ref:`🔗` Sets the one-way collision properties of the body's shape with the given index. If ``enable`` is ``true``, the one-way collision direction given by the shape's local upward axis ``body_get_shape_transform(body, shape_idx).y`` will be used to ignore collisions with the shape in the opposite direction, and to ensure depenetration of kinematic bodies happens in this direction. @@ -2099,7 +2099,7 @@ Sets the one-way collision properties of the body's shape with the given index. .. rst-class:: classref-method -|void| **body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Sets the disabled property of the body's shape with the given index. If ``disabled`` is ``true``, then the shape will be ignored in all collision detection. @@ -2111,7 +2111,7 @@ Sets the disabled property of the body's shape with the given index. If ``disabl .. rst-class:: classref-method -|void| **body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the local transform matrix of the body's shape with the given index. @@ -2123,7 +2123,7 @@ Sets the local transform matrix of the body's shape with the given index. .. rst-class:: classref-method -|void| **body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) +|void| **body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) :ref:`🔗` Adds the body to the given space, after removing the body from the previously assigned space (if any). If the body's mode is set to :ref:`BODY_MODE_RIGID`, then adding the body to a space will have the following additional effects: @@ -2141,7 +2141,7 @@ Adds the body to the given space, after removing the body from the previously as .. rst-class:: classref-method -|void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) +|void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the value of a body's state. See :ref:`BodyState` for the list of available states. @@ -2155,7 +2155,7 @@ Sets the value of a body's state. See :ref:`BodyState` **body_test_motion**\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters2D`, result\: :ref:`PhysicsTestMotionResult2D` = null\ ) +:ref:`bool` **body_test_motion**\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters2D`, result\: :ref:`PhysicsTestMotionResult2D` = null\ ) :ref:`🔗` Returns ``true`` if a collision would result from moving the body along a motion vector from a given point in space. See :ref:`PhysicsTestMotionParameters2D` for the available motion parameters. Optionally a :ref:`PhysicsTestMotionResult2D` object can be passed, which will be used to store the information about the resulting collision. @@ -2167,7 +2167,7 @@ Returns ``true`` if a collision would result from moving the body along a motion .. rst-class:: classref-method -:ref:`RID` **capsule_shape_create**\ (\ ) +:ref:`RID` **capsule_shape_create**\ (\ ) :ref:`🔗` Creates a 2D capsule shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the capsule's height and radius. @@ -2179,7 +2179,7 @@ Creates a 2D capsule shape in the physics server, and returns the :ref:`RID` **circle_shape_create**\ (\ ) +:ref:`RID` **circle_shape_create**\ (\ ) :ref:`🔗` Creates a 2D circle shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the circle's radius. @@ -2191,7 +2191,7 @@ Creates a 2D circle shape in the physics server, and returns the :ref:`RID` **concave_polygon_shape_create**\ (\ ) +:ref:`RID` **concave_polygon_shape_create**\ (\ ) :ref:`🔗` Creates a 2D concave polygon shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the concave polygon's segments. @@ -2203,7 +2203,7 @@ Creates a 2D concave polygon shape in the physics server, and returns the :ref:` .. rst-class:: classref-method -:ref:`RID` **convex_polygon_shape_create**\ (\ ) +:ref:`RID` **convex_polygon_shape_create**\ (\ ) :ref:`🔗` Creates a 2D convex polygon shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the convex polygon's points. @@ -2215,7 +2215,7 @@ Creates a 2D convex polygon shape in the physics server, and returns the :ref:`R .. rst-class:: classref-method -:ref:`float` **damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |const| +:ref:`float` **damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |const| :ref:`🔗` Returns the value of the given damped spring joint parameter. See :ref:`DampedSpringParam` for the list of available parameters. @@ -2227,7 +2227,7 @@ Returns the value of the given damped spring joint parameter. See :ref:`DampedSp .. rst-class:: classref-method -|void| **damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) +|void| **damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the given damped spring joint parameter. See :ref:`DampedSpringParam` for the list of available parameters. @@ -2239,7 +2239,7 @@ Sets the value of the given damped spring joint parameter. See :ref:`DampedSprin .. rst-class:: classref-method -|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer2D, an error will be printed to the console. @@ -2251,7 +2251,7 @@ Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) :ref:`🔗` Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo` for the list of available states. @@ -2263,7 +2263,7 @@ Returns information about the current state of the 2D physics engine. See :ref:` .. rst-class:: classref-method -|void| **joint_clear**\ (\ joint\: :ref:`RID`\ ) +|void| **joint_clear**\ (\ joint\: :ref:`RID`\ ) :ref:`🔗` Destroys the joint with the given :ref:`RID`, creates a new uninitialized joint, and makes the :ref:`RID` refer to this new joint. @@ -2275,7 +2275,7 @@ Destroys the joint with the given :ref:`RID`, creates a new uninitial .. rst-class:: classref-method -:ref:`RID` **joint_create**\ (\ ) +:ref:`RID` **joint_create**\ (\ ) :ref:`🔗` Creates a 2D joint in the physics server, and returns the :ref:`RID` that identifies it. To set the joint type, use :ref:`joint_make_damped_spring`, :ref:`joint_make_groove` or :ref:`joint_make_pin`. Use :ref:`joint_set_param` to set generic joint parameters. @@ -2287,7 +2287,7 @@ Creates a 2D joint in the physics server, and returns the :ref:`RID` .. rst-class:: classref-method -|void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) +|void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the bodies attached to the :ref:`Joint2D` will collide with each other. @@ -2299,7 +2299,7 @@ Sets whether the bodies attached to the :ref:`Joint2D` will colli .. rst-class:: classref-method -:ref:`float` **joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |const| +:ref:`float` **joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |const| :ref:`🔗` Returns the value of the given joint parameter. See :ref:`JointParam` for the list of available parameters. @@ -2311,7 +2311,7 @@ Returns the value of the given joint parameter. See :ref:`JointParam` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`JointType` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the joint's type (see :ref:`JointType`). @@ -2323,7 +2323,7 @@ Returns the joint's type (see :ref:`JointType`). .. rst-class:: classref-method -:ref:`bool` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`bool` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the bodies attached to the :ref:`Joint2D` will collide with each other. @@ -2335,7 +2335,7 @@ Returns whether the bodies attached to the :ref:`Joint2D` will co .. rst-class:: classref-method -|void| **joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) +|void| **joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) :ref:`🔗` Makes the joint a damped spring joint, attached at the point ``anchor_a`` (given in global coordinates) on the body ``body_a`` and at the point ``anchor_b`` (given in global coordinates) on the body ``body_b``. To set the parameters which are specific to the damped spring, see :ref:`damped_spring_joint_set_param`. @@ -2347,7 +2347,7 @@ Makes the joint a damped spring joint, attached at the point ``anchor_a`` (given .. rst-class:: classref-method -|void| **joint_make_groove**\ (\ joint\: :ref:`RID`, groove1_a\: :ref:`Vector2`, groove2_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID` = RID(), body_b\: :ref:`RID` = RID()\ ) +|void| **joint_make_groove**\ (\ joint\: :ref:`RID`, groove1_a\: :ref:`Vector2`, groove2_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID` = RID(), body_b\: :ref:`RID` = RID()\ ) :ref:`🔗` Makes the joint a groove joint. @@ -2359,7 +2359,7 @@ Makes the joint a groove joint. .. rst-class:: classref-method -|void| **joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) +|void| **joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) :ref:`🔗` Makes the joint a pin joint. If ``body_b`` is an empty :ref:`RID`, then ``body_a`` is pinned to the point ``anchor`` (given in global coordinates); otherwise, ``body_a`` is pinned to ``body_b`` at the point ``anchor`` (given in global coordinates). To set the parameters which are specific to the pin joint, see :ref:`pin_joint_set_param`. @@ -2371,7 +2371,7 @@ Makes the joint a pin joint. If ``body_b`` is an empty :ref:`RID`, th .. rst-class:: classref-method -|void| **joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) +|void| **joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the given joint parameter. See :ref:`JointParam` for the list of available parameters. @@ -2383,7 +2383,7 @@ Sets the value of the given joint parameter. See :ref:`JointParam` **pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |const| +:ref:`bool` **pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |const| :ref:`🔗` Gets a pin joint flag (see :ref:`PinJointFlag` constants). @@ -2395,7 +2395,7 @@ Gets a pin joint flag (see :ref:`PinJointFlag .. rst-class:: classref-method -:ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| +:ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| :ref:`🔗` Returns the value of a pin joint parameter. See :ref:`PinJointParam` for a list of available parameters. @@ -2407,7 +2407,7 @@ Returns the value of a pin joint parameter. See :ref:`PinJointParam`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) +|void| **pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets a pin joint flag (see :ref:`PinJointFlag` constants). @@ -2419,7 +2419,7 @@ Sets a pin joint flag (see :ref:`PinJointFlag .. rst-class:: classref-method -|void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) +|void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets a pin joint parameter. See :ref:`PinJointParam` for a list of available parameters. @@ -2431,7 +2431,7 @@ Sets a pin joint parameter. See :ref:`PinJointParam` **rectangle_shape_create**\ (\ ) +:ref:`RID` **rectangle_shape_create**\ (\ ) :ref:`🔗` Creates a 2D rectangle shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the rectangle's half-extents. @@ -2443,7 +2443,7 @@ Creates a 2D rectangle shape in the physics server, and returns the :ref:`RID` **segment_shape_create**\ (\ ) +:ref:`RID` **segment_shape_create**\ (\ ) :ref:`🔗` Creates a 2D segment shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the segment's start and end points. @@ -2455,7 +2455,7 @@ Creates a 2D segment shape in the physics server, and returns the :ref:`RID` **separation_ray_shape_create**\ (\ ) +:ref:`RID` **separation_ray_shape_create**\ (\ ) :ref:`🔗` Creates a 2D separation ray shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the shape's ``length`` and ``slide_on_slope`` properties. @@ -2467,7 +2467,7 @@ Creates a 2D separation ray shape in the physics server, and returns the :ref:`R .. rst-class:: classref-method -|void| **set_active**\ (\ active\: :ref:`bool`\ ) +|void| **set_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` Activates or deactivates the 2D physics server. If ``active`` is ``false``, then the physics server will not do anything in its physics step. @@ -2479,7 +2479,7 @@ Activates or deactivates the 2D physics server. If ``active`` is ``false``, then .. rst-class:: classref-method -:ref:`Variant` **shape_get_data**\ (\ shape\: :ref:`RID`\ ) |const| +:ref:`Variant` **shape_get_data**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the shape data that defines the configuration of the shape, such as the half-extents of a rectangle or the segments of a concave shape. See :ref:`shape_set_data` for the precise format of this data in each case. @@ -2491,7 +2491,7 @@ Returns the shape data that defines the configuration of the shape, such as the .. rst-class:: classref-method -:ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| +:ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the shape's type (see :ref:`ShapeType`). @@ -2503,7 +2503,7 @@ Returns the shape's type (see :ref:`ShapeType`). .. rst-class:: classref-method -|void| **shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) +|void| **shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) :ref:`🔗` Sets the shape data that defines the configuration of the shape. The ``data`` to be passed depends on the shape's type (see :ref:`shape_get_type`): @@ -2533,7 +2533,7 @@ Sets the shape data that defines the configuration of the shape. The ``data`` to .. rst-class:: classref-method -:ref:`RID` **space_create**\ (\ ) +:ref:`RID` **space_create**\ (\ ) :ref:`🔗` Creates a 2D space in the physics server, and returns the :ref:`RID` that identifies it. A space contains bodies and areas, and controls the stepping of the physics simulation of the objects in it. @@ -2545,7 +2545,7 @@ Creates a 2D space in the physics server, and returns the :ref:`RID` .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **space_get_direct_state**\ (\ space\: :ref:`RID`\ ) +:ref:`PhysicsDirectSpaceState2D` **space_get_direct_state**\ (\ space\: :ref:`RID`\ ) :ref:`🔗` Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D`. This object can be used for collision/intersection queries. @@ -2557,7 +2557,7 @@ Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| +:ref:`float` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| :ref:`🔗` Returns the value of the given space parameter. See :ref:`SpaceParameter` for the list of available parameters. @@ -2569,7 +2569,7 @@ Returns the value of the given space parameter. See :ref:`SpaceParameter` **space_is_active**\ (\ space\: :ref:`RID`\ ) |const| +:ref:`bool` **space_is_active**\ (\ space\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the space is active. @@ -2581,7 +2581,7 @@ Returns ``true`` if the space is active. .. rst-class:: classref-method -|void| **space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) +|void| **space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) :ref:`🔗` Activates or deactivates the space. If ``active`` is ``false``, then the physics server will not do anything with this space in its physics step. @@ -2593,7 +2593,7 @@ Activates or deactivates the space. If ``active`` is ``false``, then the physics .. rst-class:: classref-method -|void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) +|void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the given space parameter. See :ref:`SpaceParameter` for the list of available parameters. @@ -2605,7 +2605,7 @@ Sets the value of the given space parameter. See :ref:`SpaceParameter` **world_boundary_shape_create**\ (\ ) +:ref:`RID` **world_boundary_shape_create**\ (\ ) :ref:`🔗` Creates a 2D world boundary shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the shape's normal direction and distance properties. diff --git a/classes/class_physicsserver2dextension.rst b/classes/class_physicsserver2dextension.rst index bfe35343593..c93a466d3c2 100644 --- a/classes/class_physicsserver2dextension.rst +++ b/classes/class_physicsserver2dextension.rst @@ -326,7 +326,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_add_shape`. @@ -338,7 +338,7 @@ Overridable version of :ref:`PhysicsServer2D.area_add_shape`, id\: :ref:`int`\ ) |virtual| +|void| **_area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_attach_canvas_instance_id`. @@ -350,7 +350,7 @@ Overridable version of :ref:`PhysicsServer2D.area_attach_canvas_instance_id`, id\: :ref:`int`\ ) |virtual| +|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_attach_object_instance_id`. @@ -362,7 +362,7 @@ Overridable version of :ref:`PhysicsServer2D.area_attach_object_instance_id`\ ) |virtual| +|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_clear_shapes`. @@ -374,7 +374,7 @@ Overridable version of :ref:`PhysicsServer2D.area_clear_shapes` **_area_create**\ (\ ) |virtual| +:ref:`RID` **_area_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_create`. @@ -386,7 +386,7 @@ Overridable version of :ref:`PhysicsServer2D.area_create` **_area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_canvas_instance_id`. @@ -398,7 +398,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_canvas_instance_id` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_collision_layer`. @@ -410,7 +410,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_collision_layer` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_collision_mask`. @@ -422,7 +422,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_collision_mask` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_object_instance_id`. @@ -434,7 +434,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_object_instance_id` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| +:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_param`. @@ -446,7 +446,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_param` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_shape`. @@ -458,7 +458,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_shape` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_shape_count`. @@ -470,7 +470,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_shape_count` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Transform2D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_shape_transform`. @@ -482,7 +482,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_shape_transform` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_space`. @@ -494,7 +494,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_space` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`Transform2D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_get_transform`. @@ -506,7 +506,7 @@ Overridable version of :ref:`PhysicsServer2D.area_get_transform`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_remove_shape`. @@ -518,7 +518,7 @@ Overridable version of :ref:`PhysicsServer2D.area_remove_shape`, callback\: :ref:`Callable`\ ) |virtual| +|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_area_monitor_callback`. @@ -530,7 +530,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_area_monitor_callback`, layer\: :ref:`int`\ ) |virtual| +|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_collision_layer`. @@ -542,7 +542,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_collision_layer`, mask\: :ref:`int`\ ) |virtual| +|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_collision_mask`. @@ -554,7 +554,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_collision_mask`, callback\: :ref:`Callable`\ ) |virtual| +|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_monitor_callback`. @@ -566,7 +566,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_monitor_callback`, monitorable\: :ref:`bool`\ ) |virtual| +|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_monitorable`. @@ -578,7 +578,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_monitorable`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| +|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_param`. @@ -590,7 +590,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_param`, pickable\: :ref:`bool`\ ) |virtual| +|void| **_area_set_pickable**\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| :ref:`🔗` If set to ``true``, allows the area with the given :ref:`RID` to detect mouse inputs when the mouse cursor is hovering on it. @@ -604,7 +604,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| +|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_shape`. @@ -616,7 +616,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_shape`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_shape_disabled`. @@ -628,7 +628,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_shape_disabled`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| +|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_shape_transform`. @@ -640,7 +640,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_shape_transform`, space\: :ref:`RID`\ ) |virtual| +|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_space`. @@ -652,7 +652,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_space`, transform\: :ref:`Transform2D`\ ) |virtual| +|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.area_set_transform`. @@ -664,7 +664,7 @@ Overridable version of :ref:`PhysicsServer2D.area_set_transform`, excepted_body\: :ref:`RID`\ ) |virtual| +|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_add_collision_exception`. @@ -676,7 +676,7 @@ Overridable version of :ref:`PhysicsServer2D.body_add_collision_exception`, force\: :ref:`Vector2`\ ) |virtual| +|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_add_constant_central_force`. @@ -688,7 +688,7 @@ Overridable version of :ref:`PhysicsServer2D.body_add_constant_central_force`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| +|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_add_constant_force`. @@ -700,7 +700,7 @@ Overridable version of :ref:`PhysicsServer2D.body_add_constant_force`, torque\: :ref:`float`\ ) |virtual| +|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_add_constant_torque`. @@ -712,7 +712,7 @@ Overridable version of :ref:`PhysicsServer2D.body_add_constant_torque`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_add_shape`. @@ -724,7 +724,7 @@ Overridable version of :ref:`PhysicsServer2D.body_add_shape`, force\: :ref:`Vector2`\ ) |virtual| +|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_apply_central_force`. @@ -736,7 +736,7 @@ Overridable version of :ref:`PhysicsServer2D.body_apply_central_force`, impulse\: :ref:`Vector2`\ ) |virtual| +|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_apply_central_impulse`. @@ -748,7 +748,7 @@ Overridable version of :ref:`PhysicsServer2D.body_apply_central_impulse`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| +|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_apply_force`. @@ -760,7 +760,7 @@ Overridable version of :ref:`PhysicsServer2D.body_apply_force`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| +|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_apply_impulse`. @@ -772,7 +772,7 @@ Overridable version of :ref:`PhysicsServer2D.body_apply_impulse`, torque\: :ref:`float`\ ) |virtual| +|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_apply_torque`. @@ -784,7 +784,7 @@ Overridable version of :ref:`PhysicsServer2D.body_apply_torque`, impulse\: :ref:`float`\ ) |virtual| +|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_apply_torque_impulse`. @@ -796,7 +796,7 @@ Overridable version of :ref:`PhysicsServer2D.body_apply_torque_impulse`, id\: :ref:`int`\ ) |virtual| +|void| **_body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_attach_canvas_instance_id`. @@ -808,7 +808,7 @@ Overridable version of :ref:`PhysicsServer2D.body_attach_canvas_instance_id`, id\: :ref:`int`\ ) |virtual| +|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_attach_object_instance_id`. @@ -820,7 +820,7 @@ Overridable version of :ref:`PhysicsServer2D.body_attach_object_instance_id`\ ) |virtual| +|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_clear_shapes`. @@ -832,7 +832,7 @@ Overridable version of :ref:`PhysicsServer2D.body_clear_shapes` **_body_collide_shape**\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| +:ref:`bool` **_body_collide_shape**\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` Given a ``body``, a ``shape``, and their respective parameters, this method should return ``true`` if a collision between the two would occur, with additional details passed in ``results``. @@ -846,7 +846,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`RID` **_body_create**\ (\ ) |virtual| +:ref:`RID` **_body_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_create`. @@ -858,7 +858,7 @@ Overridable version of :ref:`PhysicsServer2D.body_create` **_body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_canvas_instance_id`. @@ -870,7 +870,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_canvas_instance_id`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Returns the :ref:`RID`\ s of all bodies added as collision exceptions for the given ``body``. See also :ref:`_body_add_collision_exception` and :ref:`_body_remove_collision_exception`. @@ -884,7 +884,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_collision_layer`. @@ -896,7 +896,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_collision_layer` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_collision_mask`. @@ -908,7 +908,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_collision_mask` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_collision_priority`. @@ -920,7 +920,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_collision_priority` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector2` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_constant_force`. @@ -932,7 +932,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_constant_force` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_constant_torque`. @@ -944,7 +944,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_constant_torque` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D`'s internal ``body_get_contacts_reported_depth_threshold`` method. @@ -958,7 +958,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`CCDMode` **_body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`CCDMode` **_body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_continuous_collision_detection_mode`. @@ -970,7 +970,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_continuous_collision_detec .. rst-class:: classref-method -:ref:`PhysicsDirectBodyState2D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| +:ref:`PhysicsDirectBodyState2D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_direct_state`. @@ -982,7 +982,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_direct_state` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_max_contacts_reported`. @@ -994,7 +994,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_max_contacts_reported` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_mode`. @@ -1006,7 +1006,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_mode` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_object_instance_id`. @@ -1018,7 +1018,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_object_instance_id` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| +:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_param`. @@ -1030,7 +1030,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_param` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_shape`. @@ -1042,7 +1042,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_shape` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_shape_count`. @@ -1054,7 +1054,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_shape_count` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Transform2D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_shape_transform`. @@ -1066,7 +1066,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_shape_transform` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_space`. @@ -1078,7 +1078,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_space` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| +:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_get_state`. @@ -1090,7 +1090,7 @@ Overridable version of :ref:`PhysicsServer2D.body_get_state` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_is_omitting_force_integration`. @@ -1102,7 +1102,7 @@ Overridable version of :ref:`PhysicsServer2D.body_is_omitting_force_integration< .. rst-class:: classref-method -|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| +|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_remove_collision_exception`. @@ -1114,7 +1114,7 @@ Overridable version of :ref:`PhysicsServer2D.body_remove_collision_exception`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_remove_shape`. @@ -1126,7 +1126,7 @@ Overridable version of :ref:`PhysicsServer2D.body_remove_shape`\ ) |virtual| +|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_reset_mass_properties`. @@ -1138,7 +1138,7 @@ Overridable version of :ref:`PhysicsServer2D.body_reset_mass_properties`, axis_velocity\: :ref:`Vector2`\ ) |virtual| +|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_axis_velocity`. @@ -1150,7 +1150,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_axis_velocity`, layer\: :ref:`int`\ ) |virtual| +|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_collision_layer`. @@ -1162,7 +1162,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_collision_layer`, mask\: :ref:`int`\ ) |virtual| +|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_collision_mask`. @@ -1174,7 +1174,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_collision_mask`, priority\: :ref:`float`\ ) |virtual| +|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_collision_priority`. @@ -1186,7 +1186,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_collision_priority`, force\: :ref:`Vector2`\ ) |virtual| +|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_constant_force`. @@ -1198,7 +1198,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_constant_force`, torque\: :ref:`float`\ ) |virtual| +|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_constant_torque`. @@ -1210,7 +1210,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_constant_torque`, threshold\: :ref:`float`\ ) |virtual| +|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D`'s internal ``body_set_contacts_reported_depth_threshold`` method. @@ -1224,7 +1224,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| +|void| **_body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_continuous_collision_detection_mode`. @@ -1236,7 +1236,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_continuous_collision_detec .. rst-class:: classref-method -|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| +|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_force_integration_callback`. @@ -1248,7 +1248,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_force_integration_callback .. rst-class:: classref-method -|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| +|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_max_contacts_reported`. @@ -1260,7 +1260,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_max_contacts_reported`, mode\: :ref:`BodyMode`\ ) |virtual| +|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_mode`. @@ -1272,7 +1272,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_mode`, enable\: :ref:`bool`\ ) |virtual| +|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_omit_force_integration`. @@ -1284,7 +1284,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_omit_force_integration`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| +|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_param`. @@ -1296,7 +1296,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_param`, pickable\: :ref:`bool`\ ) |virtual| +|void| **_body_set_pickable**\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| :ref:`🔗` If set to ``true``, allows the body with the given :ref:`RID` to detect mouse inputs when the mouse cursor is hovering on it. @@ -1310,7 +1310,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| +|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_shape`. @@ -1322,7 +1322,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_shape`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| +|void| **_body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_shape_as_one_way_collision`. @@ -1334,7 +1334,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_shape_as_one_way_collision .. rst-class:: classref-method -|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_shape_disabled`. @@ -1346,7 +1346,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_shape_disabled`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| +|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_shape_transform`. @@ -1358,7 +1358,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_shape_transform`, space\: :ref:`RID`\ ) |virtual| +|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_space`. @@ -1370,7 +1370,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_space`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| +|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_set_state`. @@ -1382,7 +1382,7 @@ Overridable version of :ref:`PhysicsServer2D.body_set_state`, callable\: :ref:`Callable`\ ) |virtual| +|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| :ref:`🔗` Assigns the ``body`` to call the given ``callable`` during the synchronization phase of the loop, before :ref:`_step` is called. See also :ref:`_sync`. @@ -1396,7 +1396,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |const| +:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.body_test_motion`. Unlike the exposed implementation, this method does not receive all of the arguments inside a :ref:`PhysicsTestMotionParameters2D`. @@ -1408,7 +1408,7 @@ Overridable version of :ref:`PhysicsServer2D.body_test_motion` **_capsule_shape_create**\ (\ ) |virtual| +:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.capsule_shape_create`. @@ -1420,7 +1420,7 @@ Overridable version of :ref:`PhysicsServer2D.capsule_shape_create` **_circle_shape_create**\ (\ ) |virtual| +:ref:`RID` **_circle_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.circle_shape_create`. @@ -1432,7 +1432,7 @@ Overridable version of :ref:`PhysicsServer2D.circle_shape_create` **_concave_polygon_shape_create**\ (\ ) |virtual| +:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.concave_polygon_shape_create`. @@ -1444,7 +1444,7 @@ Overridable version of :ref:`PhysicsServer2D.concave_polygon_shape_create` **_convex_polygon_shape_create**\ (\ ) |virtual| +:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.convex_polygon_shape_create`. @@ -1456,7 +1456,7 @@ Overridable version of :ref:`PhysicsServer2D.convex_polygon_shape_create` **_damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |const| +:ref:`float` **_damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.damped_spring_joint_get_param`. @@ -1468,7 +1468,7 @@ Overridable version of :ref:`PhysicsServer2D.damped_spring_joint_get_param`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| +|void| **_damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.damped_spring_joint_set_param`. @@ -1480,7 +1480,7 @@ Overridable version of :ref:`PhysicsServer2D.damped_spring_joint_set_param` Called to indicate that the physics server has stopped synchronizing. It is in the loop's iteration/physics phase, and can access physics objects even if running on a separate thread. See also :ref:`_sync`. @@ -1494,7 +1494,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_finish**\ (\ ) |virtual| +|void| **_finish**\ (\ ) |virtual| :ref:`🔗` Called when the main loop finalizes to shut down the physics server. See also :ref:`MainLoop._finalize` and :ref:`_init`. @@ -1508,7 +1508,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_flush_queries**\ (\ ) |virtual| +|void| **_flush_queries**\ (\ ) |virtual| :ref:`🔗` Called every physics step before :ref:`_step` to process all remaining queries. @@ -1522,7 +1522,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.free_rid`. @@ -1534,7 +1534,7 @@ Overridable version of :ref:`PhysicsServer2D.free_rid` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| +:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.get_process_info`. @@ -1546,7 +1546,7 @@ Overridable version of :ref:`PhysicsServer2D.get_process_info` Called when the main loop is initialized and creates a new instance of this physics server. See also :ref:`MainLoop._initialize` and :ref:`_finish`. @@ -1560,7 +1560,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| +:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method that should return ``true`` when the physics server is processing queries. See also :ref:`_flush_queries`. @@ -1574,7 +1574,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| +|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_clear`. @@ -1586,7 +1586,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_clear` **_joint_create**\ (\ ) |virtual| +:ref:`RID` **_joint_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_create`. @@ -1598,7 +1598,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_create`, disable\: :ref:`bool`\ ) |virtual| +|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_disable_collisions_between_bodies`. @@ -1610,7 +1610,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_disable_collisions_between_bo .. rst-class:: classref-method -:ref:`float` **_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |const| +:ref:`float` **_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_get_param`. @@ -1622,7 +1622,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_get_param` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_get_type`. @@ -1634,7 +1634,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_get_type` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_is_disabled_collisions_between_bodies`. @@ -1646,7 +1646,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_is_disabled_collisions_betwee .. rst-class:: classref-method -|void| **_joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| +|void| **_joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_make_damped_spring`. @@ -1658,7 +1658,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_make_damped_spring`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| +|void| **_joint_make_groove**\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_make_groove`. @@ -1670,7 +1670,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_make_groove`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| +|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_make_pin`. @@ -1682,7 +1682,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_make_pin`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| +|void| **_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.joint_set_param`. @@ -1694,7 +1694,7 @@ Overridable version of :ref:`PhysicsServer2D.joint_set_param` **_pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |const| +:ref:`bool` **_pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.pin_joint_get_flag`. @@ -1706,7 +1706,7 @@ Overridable version of :ref:`PhysicsServer2D.pin_joint_get_flag` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| +:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.pin_joint_get_param`. @@ -1718,7 +1718,7 @@ Overridable version of :ref:`PhysicsServer2D.pin_joint_get_param`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| +|void| **_pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.pin_joint_set_flag`. @@ -1730,7 +1730,7 @@ Overridable version of :ref:`PhysicsServer2D.pin_joint_set_flag`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| +|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.pin_joint_set_param`. @@ -1742,7 +1742,7 @@ Overridable version of :ref:`PhysicsServer2D.pin_joint_set_param` **_rectangle_shape_create**\ (\ ) |virtual| +:ref:`RID` **_rectangle_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.rectangle_shape_create`. @@ -1754,7 +1754,7 @@ Overridable version of :ref:`PhysicsServer2D.rectangle_shape_create` **_segment_shape_create**\ (\ ) |virtual| +:ref:`RID` **_segment_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.segment_shape_create`. @@ -1766,7 +1766,7 @@ Overridable version of :ref:`PhysicsServer2D.segment_shape_create` **_separation_ray_shape_create**\ (\ ) |virtual| +:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.separation_ray_shape_create`. @@ -1778,7 +1778,7 @@ Overridable version of :ref:`PhysicsServer2D.separation_ray_shape_create`\ ) |virtual| +|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.set_active`. @@ -1790,7 +1790,7 @@ Overridable version of :ref:`PhysicsServer2D.set_active` **_shape_collide**\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| +:ref:`bool` **_shape_collide**\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗` Given two shapes and their parameters, should return ``true`` if a collision between the two would occur, with additional details passed in ``results``. @@ -1804,7 +1804,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Should return the custom solver bias of the given ``shape``, which defines how much bodies are forced to separate on contact when this shape is involved. @@ -1818,7 +1818,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.shape_get_data`. @@ -1830,7 +1830,7 @@ Overridable version of :ref:`PhysicsServer2D.shape_get_data` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.shape_get_type`. @@ -1842,7 +1842,7 @@ Overridable version of :ref:`PhysicsServer2D.shape_get_type`, bias\: :ref:`float`\ ) |virtual| +|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| :ref:`🔗` Should set the custom solver bias for the given ``shape``. It defines how much bodies are forced to separate on contact. @@ -1856,7 +1856,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| +|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.shape_set_data`. @@ -1868,7 +1868,7 @@ Overridable version of :ref:`PhysicsServer2D.shape_set_data` **_space_create**\ (\ ) |virtual| +:ref:`RID` **_space_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.space_create`. @@ -1880,7 +1880,7 @@ Overridable version of :ref:`PhysicsServer2D.space_create` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Should return how many contacts have occurred during the last physics step in the given ``space``. See also :ref:`_space_get_contacts` and :ref:`_space_set_debug_contacts`. @@ -1894,7 +1894,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`PackedVector2Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| +:ref:`PackedVector2Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Should return the positions of all contacts that have occurred during the last physics step in the given ``space``. See also :ref:`_space_get_contact_count` and :ref:`_space_set_debug_contacts`. @@ -1908,7 +1908,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| +:ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.space_get_direct_state`. @@ -1920,7 +1920,7 @@ Overridable version of :ref:`PhysicsServer2D.space_get_direct_state` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| +:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.space_get_param`. @@ -1932,7 +1932,7 @@ Overridable version of :ref:`PhysicsServer2D.space_get_param` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.space_is_active`. @@ -1944,7 +1944,7 @@ Overridable version of :ref:`PhysicsServer2D.space_is_active`, active\: :ref:`bool`\ ) |virtual| +|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.space_set_active`. @@ -1956,7 +1956,7 @@ Overridable version of :ref:`PhysicsServer2D.space_set_active`, max_contacts\: :ref:`int`\ ) |virtual| +|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| :ref:`🔗` Used internally to allow the given ``space`` to store contact points, up to ``max_contacts``. This is automatically set for the main :ref:`World2D`'s space when :ref:`SceneTree.debug_collisions_hint` is ``true``, or by checking "Visible Collision Shapes" in the editor. Only works in debug builds. @@ -1970,7 +1970,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| +|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.space_set_param`. @@ -1982,7 +1982,7 @@ Overridable version of :ref:`PhysicsServer2D.space_set_param`\ ) |virtual| +|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| :ref:`🔗` Called every physics step to process the physics simulation. ``step`` is the time elapsed since the last physics step, in seconds. It is usually the same as :ref:`Node.get_physics_process_delta_time`. @@ -1996,7 +1996,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -|void| **_sync**\ (\ ) |virtual| +|void| **_sync**\ (\ ) |virtual| :ref:`🔗` Called to indicate that the physics server is synchronizing and cannot access physics states if running on a separate thread. See also :ref:`_end_sync`. @@ -2010,7 +2010,7 @@ Overridable version of :ref:`PhysicsServer2D`'s internal .. rst-class:: classref-method -:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| +:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| :ref:`🔗` Overridable version of :ref:`PhysicsServer2D.world_boundary_shape_create`. @@ -2022,7 +2022,7 @@ Overridable version of :ref:`PhysicsServer2D.world_boundary_shape_create` **body_test_motion_is_excluding_body**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **body_test_motion_is_excluding_body**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the body with the given :ref:`RID` is being excluded from :ref:`_body_test_motion`. See also :ref:`Object.get_instance_id`. @@ -2034,7 +2034,7 @@ Returns ``true`` if the body with the given :ref:`RID` is being exclu .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_object**\ (\ object\: :ref:`int`\ ) |const| +:ref:`bool` **body_test_motion_is_excluding_object**\ (\ object\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the object with the given instance ID is being excluded from :ref:`_body_test_motion`. See also :ref:`Object.get_instance_id`. diff --git a/classes/class_physicsserver2dmanager.rst b/classes/class_physicsserver2dmanager.rst index 0af8d163b9f..68e12e909f8 100644 --- a/classes/class_physicsserver2dmanager.rst +++ b/classes/class_physicsserver2dmanager.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **register_server**\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) +|void| **register_server**\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) :ref:`🔗` Register a :ref:`PhysicsServer2D` implementation by passing a ``name`` and a :ref:`Callable` that returns a :ref:`PhysicsServer2D` object. @@ -62,7 +62,7 @@ Register a :ref:`PhysicsServer2D` implementation by passi .. rst-class:: classref-method -|void| **set_default_server**\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) +|void| **set_default_server**\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) :ref:`🔗` Set the default :ref:`PhysicsServer2D` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation. diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index cafb2a27076..bb6015042b8 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -288,10 +288,14 @@ Methods +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shape_get_data`\ (\ shape\: :ref:`RID`\ ) |const| | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shape_get_margin`\ (\ shape\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ShapeType` | :ref:`shape_get_type`\ (\ shape\: :ref:`RID`\ ) |const| | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_set_margin`\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`slider_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |const| | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`slider_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) | @@ -392,7 +396,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **JointType**: +enum **JointType**: :ref:`🔗` .. _class_PhysicsServer3D_constant_JOINT_TYPE_PIN: @@ -450,7 +454,7 @@ Represents the size of the :ref:`JointType` enum .. rst-class:: classref-enumeration -enum **PinJointParam**: +enum **PinJointParam**: :ref:`🔗` .. _class_PhysicsServer3D_constant_PIN_JOINT_BIAS: @@ -488,7 +492,7 @@ If above 0, this value is the maximum value for an impulse that this Joint3D put .. rst-class:: classref-enumeration -enum **HingeJointParam**: +enum **HingeJointParam**: :ref:`🔗` .. _class_PhysicsServer3D_constant_HINGE_JOINT_BIAS: @@ -566,7 +570,7 @@ Maximum acceleration for the motor. .. rst-class:: classref-enumeration -enum **HingeJointFlag**: +enum **HingeJointFlag**: :ref:`🔗` .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_USE_LIMIT: @@ -592,7 +596,7 @@ If ``true``, a motor turns the Hinge. .. rst-class:: classref-enumeration -enum **SliderJointParam**: +enum **SliderJointParam**: :ref:`🔗` .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER: @@ -786,7 +790,7 @@ Represents the size of the :ref:`SliderJointParam` .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SWING_SPAN: @@ -846,7 +850,7 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce .. rst-class:: classref-enumeration -enum **G6DOFJointAxisParam**: +enum **G6DOFJointAxisParam**: :ref:`🔗` .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT: @@ -1064,7 +1068,7 @@ Represents the size of the :ref:`G6DOFJointAxisParam` .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT: @@ -1138,7 +1142,7 @@ Represents the size of the :ref:`G6DOFJointAxisFlag` .. _class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY: @@ -1236,7 +1240,7 @@ This constant is used internally by the engine. Any attempt to create this kind .. rst-class:: classref-enumeration -enum **AreaParameter**: +enum **AreaParameter**: :ref:`🔗` .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE: @@ -1360,7 +1364,7 @@ Constant to set/get the exponential rate at which wind force decreases with dist .. rst-class:: classref-enumeration -enum **AreaSpaceOverrideMode**: +enum **AreaSpaceOverrideMode**: :ref:`🔗` .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_DISABLED: @@ -1410,7 +1414,7 @@ This area replaces any gravity/damp calculated so far, but keeps calculating the .. rst-class:: classref-enumeration -enum **BodyMode**: +enum **BodyMode**: :ref:`🔗` .. _class_PhysicsServer3D_constant_BODY_MODE_STATIC: @@ -1452,7 +1456,7 @@ Constant for linear rigid bodies. In this mode, a body can not rotate, and only .. rst-class:: classref-enumeration -enum **BodyParameter**: +enum **BodyParameter**: :ref:`🔗` .. _class_PhysicsServer3D_constant_BODY_PARAM_BOUNCE: @@ -1550,7 +1554,7 @@ Represents the size of the :ref:`BodyParameter` .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE: @@ -1576,7 +1580,7 @@ The body's damping value replaces any value set in areas or the default value. .. rst-class:: classref-enumeration -enum **BodyState**: +enum **BodyState**: :ref:`🔗` .. _class_PhysicsServer3D_constant_BODY_STATE_TRANSFORM: @@ -1626,7 +1630,7 @@ Constant to set/get whether the body can sleep. .. rst-class:: classref-enumeration -enum **AreaBodyStatus**: +enum **AreaBodyStatus**: :ref:`🔗` .. _class_PhysicsServer3D_constant_AREA_BODY_ADDED: @@ -1652,7 +1656,7 @@ The value of the first parameter and area callback function receives, when an ob .. rst-class:: classref-enumeration -enum **ProcessInfo**: +enum **ProcessInfo**: :ref:`🔗` .. _class_PhysicsServer3D_constant_INFO_ACTIVE_OBJECTS: @@ -1686,7 +1690,7 @@ Constant to get the number of space regions where a collision could occur. .. rst-class:: classref-enumeration -enum **SpaceParameter**: +enum **SpaceParameter**: :ref:`🔗` .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS: @@ -1760,7 +1764,7 @@ Constant to set/get the number of solver iterations for contacts and constraints .. rst-class:: classref-enumeration -enum **BodyAxis**: +enum **BodyAxis**: :ref:`🔗` .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_X: @@ -1847,7 +1851,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) +|void| **area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) :ref:`🔗` Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -1859,7 +1863,7 @@ Adds a shape to the area, along with a transform matrix. Shapes are usually refe .. rst-class:: classref-method -|void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. @@ -1871,7 +1875,7 @@ Assigns the area to a descendant of :ref:`Object`, so it can exist .. rst-class:: classref-method -|void| **area_clear_shapes**\ (\ area\: :ref:`RID`\ ) +|void| **area_clear_shapes**\ (\ area\: :ref:`RID`\ ) :ref:`🔗` Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. @@ -1883,7 +1887,7 @@ Removes all shapes from an area. It does not delete the shapes, so they can be r .. rst-class:: classref-method -:ref:`RID` **area_create**\ (\ ) +:ref:`RID` **area_create**\ (\ ) :ref:`🔗` Creates a 3D area object in the physics server, and returns the :ref:`RID` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and ``monitorable`` set to ``false``. @@ -1897,7 +1901,7 @@ Use :ref:`area_add_shape` to add sh .. rst-class:: classref-method -:ref:`int` **area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers an area belongs to. @@ -1909,7 +1913,7 @@ Returns the physics layer or layers an area belongs to. .. rst-class:: classref-method -:ref:`int` **area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers an area can contact with. @@ -1921,7 +1925,7 @@ Returns the physics layer or layers an area can contact with. .. rst-class:: classref-method -:ref:`int` **area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Gets the instance ID of the object the area is assigned to. @@ -1933,7 +1937,7 @@ Gets the instance ID of the object the area is assigned to. .. rst-class:: classref-method -:ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| +:ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| :ref:`🔗` Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter` constants. @@ -1945,7 +1949,7 @@ Returns an area parameter value. A list of available parameters is on the :ref:` .. rst-class:: classref-method -:ref:`RID` **area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`RID` **area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the nth shape of an area. @@ -1957,7 +1961,7 @@ Returns the :ref:`RID` of the nth shape of an area. .. rst-class:: classref-method -:ref:`int` **area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`int` **area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of shapes assigned to an area. @@ -1969,7 +1973,7 @@ Returns the number of shapes assigned to an area. .. rst-class:: classref-method -:ref:`Transform3D` **area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transform matrix of a shape within an area. @@ -1981,7 +1985,7 @@ Returns the transform matrix of a shape within an area. .. rst-class:: classref-method -:ref:`RID` **area_get_space**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`RID` **area_get_space**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the space assigned to the area. @@ -1993,7 +1997,7 @@ Returns the space assigned to the area. .. rst-class:: classref-method -:ref:`Transform3D` **area_get_transform**\ (\ area\: :ref:`RID`\ ) |const| +:ref:`Transform3D` **area_get_transform**\ (\ area\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the transform matrix for an area. @@ -2005,7 +2009,7 @@ Returns the transform matrix for an area. .. rst-class:: classref-method -|void| **area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) +|void| **area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) :ref:`🔗` Removes a shape from an area. It does not delete the shape, so it can be reassigned later. @@ -2017,7 +2021,7 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig .. rst-class:: classref-method -|void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters: @@ -2041,7 +2045,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -|void| **area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) +|void| **area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) :ref:`🔗` Assigns the area to one or many physics layers. @@ -2053,7 +2057,7 @@ Assigns the area to one or many physics layers. .. rst-class:: classref-method -|void| **area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets which physics layers the area will monitor. @@ -2065,7 +2069,7 @@ Sets which physics layers the area will monitor. .. rst-class:: classref-method -|void| **area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) +|void| **area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters: @@ -2089,7 +2093,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -|void| **area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) +|void| **area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2103,7 +2107,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -|void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) +|void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter` constants. @@ -2115,7 +2119,7 @@ Sets the value for an area parameter. A list of available parameters is on the : .. rst-class:: classref-method -|void| **area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets object pickable with rays. @@ -2127,7 +2131,7 @@ Sets object pickable with rays. .. rst-class:: classref-method -|void| **area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) +|void| **area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) :ref:`🔗` Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. @@ -2139,7 +2143,7 @@ Substitutes a given area shape by another. The old shape is selected by its inde .. rst-class:: classref-method -|void| **area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2153,7 +2157,7 @@ Substitutes a given area shape by another. The old shape is selected by its inde .. rst-class:: classref-method -|void| **area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform matrix for an area shape. @@ -2165,7 +2169,7 @@ Sets the transform matrix for an area shape. .. rst-class:: classref-method -|void| **area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) +|void| **area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) :ref:`🔗` Assigns a space to the area. @@ -2177,7 +2181,7 @@ Assigns a space to the area. .. rst-class:: classref-method -|void| **area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) +|void| **area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform matrix for an area. @@ -2189,7 +2193,7 @@ Sets the transform matrix for an area. .. rst-class:: classref-method -|void| **body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) +|void| **body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) :ref:`🔗` Adds a body to the list of bodies exempt from collisions. @@ -2201,7 +2205,7 @@ Adds a body to the list of bodies exempt from collisions. .. rst-class:: classref-method -|void| **body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) +|void| **body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) :ref:`🔗` Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``. @@ -2215,7 +2219,7 @@ This is equivalent to using :ref:`body_add_constant_force`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Adds a constant positioned force to the body that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``. @@ -2229,7 +2233,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -|void| **body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) +|void| **body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) :ref:`🔗` Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``body_set_constant_torque(body, Vector3(0, 0, 0))``. @@ -2241,7 +2245,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -|void| **body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) +|void| **body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) :ref:`🔗` Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -2253,7 +2257,7 @@ Adds a shape to the body, along with a transform matrix. Shapes are usually refe .. rst-class:: classref-method -|void| **body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) +|void| **body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) :ref:`🔗` Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -2267,7 +2271,7 @@ This is equivalent to using :ref:`body_apply_force`, impulse\: :ref:`Vector3`\ ) +|void| **body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) :ref:`🔗` Applies a directional impulse without affecting rotation. @@ -2283,7 +2287,7 @@ This is equivalent to using :ref:`body_apply_impulse`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -2297,7 +2301,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -|void| **body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a positioned impulse to the body. @@ -2313,7 +2317,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) +|void| **body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) :ref:`🔗` Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -2325,7 +2329,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -|void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) +|void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) :ref:`🔗` Applies a rotational impulse to the body without affecting the position. @@ -2339,7 +2343,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. @@ -2351,7 +2355,7 @@ Assigns the area to a descendant of :ref:`Object`, so it can exist .. rst-class:: classref-method -|void| **body_clear_shapes**\ (\ body\: :ref:`RID`\ ) +|void| **body_clear_shapes**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Removes all shapes from a body. @@ -2363,7 +2367,7 @@ Removes all shapes from a body. .. rst-class:: classref-method -:ref:`RID` **body_create**\ (\ ) +:ref:`RID` **body_create**\ (\ ) :ref:`🔗` Creates a 3D body object in the physics server, and returns the :ref:`RID` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and body mode set to :ref:`BODY_MODE_RIGID`. @@ -2377,7 +2381,7 @@ Use :ref:`body_add_shape` to add sh .. rst-class:: classref-method -:ref:`int` **body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers a body belongs to. @@ -2389,7 +2393,7 @@ Returns the physics layer or layers a body belongs to. .. rst-class:: classref-method -:ref:`int` **body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers a body can collide with. @@ -2401,7 +2405,7 @@ Returns the physics layer or layers a body can collide with. .. rst-class:: classref-method -:ref:`float` **body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's collision priority. @@ -2413,7 +2417,7 @@ Returns the body's collision priority. .. rst-class:: classref-method -:ref:`Vector3` **body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`Vector3` **body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's total constant positional forces applied during each physics update. @@ -2427,7 +2431,7 @@ See :ref:`body_add_constant_force` **body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`Vector3` **body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body's total constant rotational forces applied during each physics update. @@ -2441,7 +2445,7 @@ See :ref:`body_add_constant_torque` **body_get_direct_state**\ (\ body\: :ref:`RID`\ ) +:ref:`PhysicsDirectBodyState3D` **body_get_direct_state**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Returns the :ref:`PhysicsDirectBodyState3D` of the body. Returns ``null`` if the body is destroyed or removed from the physics space. @@ -2453,7 +2457,7 @@ Returns the :ref:`PhysicsDirectBodyState3D` of t .. rst-class:: classref-method -:ref:`int` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. @@ -2465,7 +2469,7 @@ Returns the maximum contacts that can be reported. See :ref:`body_set_max_contac .. rst-class:: classref-method -:ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the body mode. @@ -2477,7 +2481,7 @@ Returns the body mode. .. rst-class:: classref-method -:ref:`int` **body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Gets the instance ID of the object the area is assigned to. @@ -2489,7 +2493,7 @@ Gets the instance ID of the object the area is assigned to. .. rst-class:: classref-method -:ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| +:ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| :ref:`🔗` Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter` constants. @@ -2501,7 +2505,7 @@ Returns the value of a body parameter. A list of available parameters is on the .. rst-class:: classref-method -:ref:`RID` **body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`RID` **body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the nth shape of a body. @@ -2513,7 +2517,7 @@ Returns the :ref:`RID` of the nth shape of a body. .. rst-class:: classref-method -:ref:`int` **body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of shapes assigned to a body. @@ -2525,7 +2529,7 @@ Returns the number of shapes assigned to a body. .. rst-class:: classref-method -:ref:`Transform3D` **body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transform matrix of a body shape. @@ -2537,7 +2541,7 @@ Returns the transform matrix of a body shape. .. rst-class:: classref-method -:ref:`RID` **body_get_space**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`RID` **body_get_space**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the space assigned to a body. @@ -2549,7 +2553,7 @@ Returns the :ref:`RID` of the space assigned to a body. .. rst-class:: classref-method -:ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| +:ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| :ref:`🔗` Returns a body state. @@ -2561,7 +2565,7 @@ Returns a body state. .. rst-class:: classref-method -:ref:`bool` **body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |const| +:ref:`bool` **body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |const| :ref:`🔗` .. container:: contribute @@ -2575,7 +2579,7 @@ Returns a body state. .. rst-class:: classref-method -:ref:`bool` **body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` If ``true``, the continuous collision detection mode is enabled. @@ -2587,7 +2591,7 @@ If ``true``, the continuous collision detection mode is enabled. .. rst-class:: classref-method -:ref:`bool` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the body is omitting the standard force integration. See :ref:`body_set_omit_force_integration`. @@ -2599,7 +2603,7 @@ Returns ``true`` if the body is omitting the standard force integration. See :re .. rst-class:: classref-method -|void| **body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) +|void| **body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) :ref:`🔗` Removes a body from the list of bodies exempt from collisions. @@ -2613,7 +2617,7 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-method -|void| **body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) +|void| **body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) :ref:`🔗` Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. @@ -2625,7 +2629,7 @@ Removes a shape from a body. The shape is not deleted, so it can be reused after .. rst-class:: classref-method -|void| **body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) +|void| **body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using :ref:`body_set_param`. @@ -2637,7 +2641,7 @@ Restores the default inertia and center of mass based on shapes to cancel any cu .. rst-class:: classref-method -|void| **body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +|void| **body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2651,7 +2655,7 @@ Restores the default inertia and center of mass based on shapes to cancel any cu .. rst-class:: classref-method -|void| **body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) +|void| **body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -2663,7 +2667,7 @@ Sets an axis velocity. The velocity in the given vector axis will be set as the .. rst-class:: classref-method -|void| **body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) +|void| **body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer or layers a body belongs to. @@ -2675,7 +2679,7 @@ Sets the physics layer or layers a body belongs to. .. rst-class:: classref-method -|void| **body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer or layers a body can collide with. @@ -2687,7 +2691,7 @@ Sets the physics layer or layers a body can collide with. .. rst-class:: classref-method -|void| **body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) +|void| **body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) :ref:`🔗` Sets the body's collision priority. @@ -2699,7 +2703,7 @@ Sets the body's collision priority. .. rst-class:: classref-method -|void| **body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) +|void| **body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) :ref:`🔗` Sets the body's total constant positional forces applied during each physics update. @@ -2713,7 +2717,7 @@ See :ref:`body_add_constant_force`, torque\: :ref:`Vector3`\ ) +|void| **body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) :ref:`🔗` Sets the body's total constant rotational forces applied during each physics update. @@ -2727,7 +2731,7 @@ See :ref:`body_add_constant_torque`, enable\: :ref:`bool`\ ) +|void| **body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the continuous collision detection mode is enabled. @@ -2741,7 +2745,7 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-method -|void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) +|void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) :ref:`🔗` Sets the body's custom force integration callback function to ``callable``. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. @@ -2763,7 +2767,7 @@ If ``userdata`` is ``null``, then ``callable`` must take only the ``state`` para .. rst-class:: classref-method -|void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) +|void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) :ref:`🔗` Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies. This is enabled by setting the maximum number of contacts reported to a number greater than 0. @@ -2775,7 +2779,7 @@ Sets the maximum contacts to report. Bodies can keep a log of the contacts with .. rst-class:: classref-method -|void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) +|void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) :ref:`🔗` Sets the body mode, from one of the :ref:`BodyMode` constants. @@ -2787,7 +2791,7 @@ Sets the body mode, from one of the :ref:`BodyMode`, enable\: :ref:`bool`\ ) +|void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the body omits the standard force integration. If ``enable`` is ``true``, the body will not automatically use applied forces, torques, and damping to update the body's linear and angular velocity. In this case, :ref:`body_set_force_integration_callback` can be used to manually update the linear and angular velocity instead. @@ -2801,7 +2805,7 @@ This method is called when the property :ref:`RigidBody3D.custom_integrator`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) +|void| **body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter` constants. @@ -2813,7 +2817,7 @@ Sets a body parameter. A list of available parameters is on the :ref:`BodyParame .. rst-class:: classref-method -|void| **body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets the body pickable with rays if ``enable`` is set. @@ -2825,7 +2829,7 @@ Sets the body pickable with rays if ``enable`` is set. .. rst-class:: classref-method -|void| **body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) +|void| **body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) :ref:`🔗` Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. @@ -2837,7 +2841,7 @@ Substitutes a given body shape by another. The old shape is selected by its inde .. rst-class:: classref-method -|void| **body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -2851,7 +2855,7 @@ Substitutes a given body shape by another. The old shape is selected by its inde .. rst-class:: classref-method -|void| **body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform matrix for a body shape. @@ -2863,7 +2867,7 @@ Sets the transform matrix for a body shape. .. rst-class:: classref-method -|void| **body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) +|void| **body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) :ref:`🔗` Assigns a space to the body (see :ref:`space_create`). @@ -2875,7 +2879,7 @@ Assigns a space to the body (see :ref:`space_create`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) +|void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets a body state (see :ref:`BodyState` constants). @@ -2887,7 +2891,7 @@ Sets a body state (see :ref:`BodyState` constant .. rst-class:: classref-method -:ref:`bool` **body_test_motion**\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters3D`, result\: :ref:`PhysicsTestMotionResult3D` = null\ ) +:ref:`bool` **body_test_motion**\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters3D`, result\: :ref:`PhysicsTestMotionResult3D` = null\ ) :ref:`🔗` Returns ``true`` if a collision would result from moving along a motion vector from a given point in space. :ref:`PhysicsTestMotionParameters3D` is passed to set motion parameters. :ref:`PhysicsTestMotionResult3D` can be passed to return additional information. @@ -2899,7 +2903,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`RID` **box_shape_create**\ (\ ) +:ref:`RID` **box_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -2913,7 +2917,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`RID` **capsule_shape_create**\ (\ ) +:ref:`RID` **capsule_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -2927,7 +2931,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`RID` **concave_polygon_shape_create**\ (\ ) +:ref:`RID` **concave_polygon_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -2941,7 +2945,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`float` **cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |const| +:ref:`float` **cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |const| :ref:`🔗` Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` constants). @@ -2953,7 +2957,7 @@ Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) +|void| **cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` constants). @@ -2965,7 +2969,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **convex_polygon_shape_create**\ (\ ) +:ref:`RID` **convex_polygon_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -2979,7 +2983,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **custom_shape_create**\ (\ ) +:ref:`RID` **custom_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -2993,7 +2997,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **cylinder_shape_create**\ (\ ) +:ref:`RID` **cylinder_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -3007,7 +3011,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Destroys any of the objects created by PhysicsServer3D. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console. @@ -3019,7 +3023,7 @@ Destroys any of the objects created by PhysicsServer3D. If the :ref:`RID` **generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |const| +:ref:`bool` **generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |const| :ref:`🔗` Returns the value of a generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag` for the list of available flags. @@ -3031,7 +3035,7 @@ Returns the value of a generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag` **generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |const| +:ref:`float` **generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |const| :ref:`🔗` Returns the value of a generic 6DOF joint parameter. See :ref:`G6DOFJointAxisParam` for the list of available parameters. @@ -3043,7 +3047,7 @@ Returns the value of a generic 6DOF joint parameter. See :ref:`G6DOFJointAxisPar .. rst-class:: classref-method -|void| **generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) +|void| **generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets the value of a given generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag` for the list of available flags. @@ -3055,7 +3059,7 @@ Sets the value of a given generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag< .. rst-class:: classref-method -|void| **generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) +|void| **generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of a given generic 6DOF joint parameter. See :ref:`G6DOFJointAxisParam` for the list of available parameters. @@ -3067,7 +3071,7 @@ Sets the value of a given generic 6DOF joint parameter. See :ref:`G6DOFJointAxis .. rst-class:: classref-method -:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) :ref:`🔗` Returns information about the current state of the 3D physics engine. See :ref:`ProcessInfo` for a list of available states. @@ -3079,7 +3083,7 @@ Returns information about the current state of the 3D physics engine. See :ref:` .. rst-class:: classref-method -:ref:`RID` **heightmap_shape_create**\ (\ ) +:ref:`RID` **heightmap_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -3093,7 +3097,7 @@ Returns information about the current state of the 3D physics engine. See :ref:` .. rst-class:: classref-method -:ref:`bool` **hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |const| +:ref:`bool` **hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |const| :ref:`🔗` Gets a hinge_joint flag (see :ref:`HingeJointFlag` constants). @@ -3105,7 +3109,7 @@ Gets a hinge_joint flag (see :ref:`HingeJointFlag` **hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |const| +:ref:`float` **hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |const| :ref:`🔗` Gets a hinge_joint parameter (see :ref:`HingeJointParam`). @@ -3117,7 +3121,7 @@ Gets a hinge_joint parameter (see :ref:`HingeJointParam`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) +|void| **hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets a hinge_joint flag (see :ref:`HingeJointFlag` constants). @@ -3129,7 +3133,7 @@ Sets a hinge_joint flag (see :ref:`HingeJointFlag`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) +|void| **hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets a hinge_joint parameter (see :ref:`HingeJointParam` constants). @@ -3141,7 +3145,7 @@ Sets a hinge_joint parameter (see :ref:`HingeJointParam`\ ) +|void| **joint_clear**\ (\ joint\: :ref:`RID`\ ) :ref:`🔗` .. container:: contribute @@ -3155,7 +3159,7 @@ Sets a hinge_joint parameter (see :ref:`HingeJointParam` **joint_create**\ (\ ) +:ref:`RID` **joint_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -3169,7 +3173,7 @@ Sets a hinge_joint parameter (see :ref:`HingeJointParam`, disable\: :ref:`bool`\ ) +|void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the bodies attached to the :ref:`Joint3D` will collide with each other. @@ -3181,7 +3185,7 @@ Sets whether the bodies attached to the :ref:`Joint3D` will colli .. rst-class:: classref-method -:ref:`int` **joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`int` **joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Gets the priority value of the Joint3D. @@ -3193,7 +3197,7 @@ Gets the priority value of the Joint3D. .. rst-class:: classref-method -:ref:`JointType` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`JointType` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the type of the Joint3D. @@ -3205,7 +3209,7 @@ Returns the type of the Joint3D. .. rst-class:: classref-method -:ref:`bool` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`bool` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the bodies attached to the :ref:`Joint3D` will collide with each other. @@ -3217,7 +3221,7 @@ Returns whether the bodies attached to the :ref:`Joint3D` will co .. rst-class:: classref-method -|void| **joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) +|void| **joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) :ref:`🔗` .. container:: contribute @@ -3231,7 +3235,7 @@ Returns whether the bodies attached to the :ref:`Joint3D` will co .. rst-class:: classref-method -|void| **joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) +|void| **joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) :ref:`🔗` Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_6dof_joint_set_flag` and :ref:`generic_6dof_joint_set_param` to set the joint's flags and parameters respectively. @@ -3243,7 +3247,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. rst-class:: classref-method -|void| **joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) +|void| **joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) :ref:`🔗` .. container:: contribute @@ -3257,7 +3261,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. rst-class:: classref-method -|void| **joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) +|void| **joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) :ref:`🔗` .. container:: contribute @@ -3271,7 +3275,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. rst-class:: classref-method -|void| **joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) +|void| **joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) :ref:`🔗` .. container:: contribute @@ -3285,7 +3289,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. rst-class:: classref-method -|void| **joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) +|void| **joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) :ref:`🔗` Sets the priority value of the Joint3D. @@ -3297,7 +3301,7 @@ Sets the priority value of the Joint3D. .. rst-class:: classref-method -:ref:`Vector3` **pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`Vector3` **pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Returns position of the joint in the local space of body a of the joint. @@ -3309,7 +3313,7 @@ Returns position of the joint in the local space of body a of the joint. .. rst-class:: classref-method -:ref:`Vector3` **pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |const| +:ref:`Vector3` **pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |const| :ref:`🔗` Returns position of the joint in the local space of body b of the joint. @@ -3321,7 +3325,7 @@ Returns position of the joint in the local space of body b of the joint. .. rst-class:: classref-method -:ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| +:ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| :ref:`🔗` Gets a pin_joint parameter (see :ref:`PinJointParam` constants). @@ -3333,7 +3337,7 @@ Gets a pin_joint parameter (see :ref:`PinJointParam`, local_A\: :ref:`Vector3`\ ) +|void| **pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) :ref:`🔗` Sets position of the joint in the local space of body a of the joint. @@ -3345,7 +3349,7 @@ Sets position of the joint in the local space of body a of the joint. .. rst-class:: classref-method -|void| **pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) +|void| **pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) :ref:`🔗` Sets position of the joint in the local space of body b of the joint. @@ -3357,7 +3361,7 @@ Sets position of the joint in the local space of body b of the joint. .. rst-class:: classref-method -|void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) +|void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets a pin_joint parameter (see :ref:`PinJointParam` constants). @@ -3369,7 +3373,7 @@ Sets a pin_joint parameter (see :ref:`PinJointParam` **separation_ray_shape_create**\ (\ ) +:ref:`RID` **separation_ray_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -3383,7 +3387,7 @@ Sets a pin_joint parameter (see :ref:`PinJointParam`\ ) +|void| **set_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` Activates or deactivates the 3D physics engine. @@ -3395,7 +3399,7 @@ Activates or deactivates the 3D physics engine. .. rst-class:: classref-method -:ref:`Variant` **shape_get_data**\ (\ shape\: :ref:`RID`\ ) |const| +:ref:`Variant` **shape_get_data**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the shape data. @@ -3403,11 +3407,25 @@ Returns the shape data. ---- +.. _class_PhysicsServer3D_method_shape_get_margin: + +.. rst-class:: classref-method + +:ref:`float` **shape_get_margin**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns the collision margin for the shape. + +\ **Note:** This is not used in Godot Physics, so will always return ``0``. + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer3D_method_shape_get_type: .. rst-class:: classref-method -:ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| +:ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the type of shape (see :ref:`ShapeType` constants). @@ -3419,7 +3437,7 @@ Returns the type of shape (see :ref:`ShapeType` .. rst-class:: classref-method -|void| **shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) +|void| **shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) :ref:`🔗` Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. @@ -3427,11 +3445,25 @@ Sets the shape data that defines its shape and size. The data to be passed depen ---- +.. _class_PhysicsServer3D_method_shape_set_margin: + +.. rst-class:: classref-method + +|void| **shape_set_margin**\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) :ref:`🔗` + +Sets the collision margin for the shape. + +\ **Note:** This is not used in Godot Physics. + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer3D_method_slider_joint_get_param: .. rst-class:: classref-method -:ref:`float` **slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |const| +:ref:`float` **slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |const| :ref:`🔗` Gets a slider_joint parameter (see :ref:`SliderJointParam` constants). @@ -3443,7 +3475,7 @@ Gets a slider_joint parameter (see :ref:`SliderJointParam`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) +|void| **slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) :ref:`🔗` Gets a slider_joint parameter (see :ref:`SliderJointParam` constants). @@ -3455,7 +3487,7 @@ Gets a slider_joint parameter (see :ref:`SliderJointParam`, body_b\: :ref:`RID`\ ) +|void| **soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) :ref:`🔗` Adds the given body to the list of bodies exempt from collisions. @@ -3467,7 +3499,7 @@ Adds the given body to the list of bodies exempt from collisions. .. rst-class:: classref-method -:ref:`RID` **soft_body_create**\ (\ ) +:ref:`RID` **soft_body_create**\ (\ ) :ref:`🔗` Creates a new soft body and returns its internal :ref:`RID`. @@ -3479,7 +3511,7 @@ Creates a new soft body and returns its internal :ref:`RID`. .. rst-class:: classref-method -:ref:`AABB` **soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`AABB` **soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the bounds of the given soft body in global coordinates. @@ -3491,7 +3523,7 @@ Returns the bounds of the given soft body in global coordinates. .. rst-class:: classref-method -:ref:`int` **soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers that the given soft body belongs to. @@ -3503,7 +3535,7 @@ Returns the physics layer or layers that the given soft body belongs to. .. rst-class:: classref-method -:ref:`int` **soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the physics layer or layers that the given soft body can collide with. @@ -3515,7 +3547,7 @@ Returns the physics layer or layers that the given soft body can collide with. .. rst-class:: classref-method -:ref:`float` **soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the damping coefficient of the given soft body. @@ -3527,7 +3559,7 @@ Returns the damping coefficient of the given soft body. .. rst-class:: classref-method -:ref:`float` **soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the drag coefficient of the given soft body. @@ -3539,7 +3571,7 @@ Returns the drag coefficient of the given soft body. .. rst-class:: classref-method -:ref:`float` **soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the linear stiffness of the given soft body. @@ -3551,7 +3583,7 @@ Returns the linear stiffness of the given soft body. .. rst-class:: classref-method -:ref:`Vector3` **soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| +:ref:`Vector3` **soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the current position of the given soft body point in global coordinates. @@ -3563,7 +3595,7 @@ Returns the current position of the given soft body point in global coordinates. .. rst-class:: classref-method -:ref:`float` **soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the pressure coefficient of the given soft body. @@ -3575,7 +3607,7 @@ Returns the pressure coefficient of the given soft body. .. rst-class:: classref-method -:ref:`int` **soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`int` **soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the simulation precision of the given soft body. @@ -3587,7 +3619,7 @@ Returns the simulation precision of the given soft body. .. rst-class:: classref-method -:ref:`RID` **soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`RID` **soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the space assigned to the given soft body. @@ -3599,7 +3631,7 @@ Returns the :ref:`RID` of the space assigned to the given soft body. .. rst-class:: classref-method -:ref:`Variant` **soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| +:ref:`Variant` **soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| :ref:`🔗` Returns the given soft body state (see :ref:`BodyState` constants). @@ -3613,7 +3645,7 @@ Returns the given soft body state (see :ref:`BodyState` **soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`float` **soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the total mass assigned to the given soft body. @@ -3625,7 +3657,7 @@ Returns the total mass assigned to the given soft body. .. rst-class:: classref-method -:ref:`bool` **soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| +:ref:`bool` **soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the given soft body point is pinned. @@ -3637,7 +3669,7 @@ Returns whether the given soft body point is pinned. .. rst-class:: classref-method -|void| **soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) +|void| **soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) :ref:`🔗` Moves the given soft body point to a position in global coordinates. @@ -3649,7 +3681,7 @@ Moves the given soft body point to a position in global coordinates. .. rst-class:: classref-method -|void| **soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) +|void| **soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) :ref:`🔗` Pins or unpins the given soft body point based on the value of ``pin``. @@ -3663,7 +3695,7 @@ Pins or unpins the given soft body point based on the value of ``pin``. .. rst-class:: classref-method -|void| **soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) +|void| **soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Unpins all points of the given soft body. @@ -3675,7 +3707,7 @@ Unpins all points of the given soft body. .. rst-class:: classref-method -|void| **soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) +|void| **soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) :ref:`🔗` Removes the given body from the list of bodies exempt from collisions. @@ -3687,7 +3719,7 @@ Removes the given body from the list of bodies exempt from collisions. .. rst-class:: classref-method -|void| **soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) +|void| **soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer or layers the given soft body belongs to. @@ -3699,7 +3731,7 @@ Sets the physics layer or layers the given soft body belongs to. .. rst-class:: classref-method -|void| **soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer or layers the given soft body can collide with. @@ -3711,7 +3743,7 @@ Sets the physics layer or layers the given soft body can collide with. .. rst-class:: classref-method -|void| **soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) +|void| **soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) :ref:`🔗` Sets the damping coefficient of the given soft body. Higher values will slow down the body more noticeably when forces are applied. @@ -3723,7 +3755,7 @@ Sets the damping coefficient of the given soft body. Higher values will slow dow .. rst-class:: classref-method -|void| **soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) +|void| **soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) :ref:`🔗` Sets the drag coefficient of the given soft body. Higher values increase this body's air resistance. @@ -3737,7 +3769,7 @@ Sets the drag coefficient of the given soft body. Higher values increase this bo .. rst-class:: classref-method -|void| **soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, stiffness\: :ref:`float`\ ) +|void| **soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, stiffness\: :ref:`float`\ ) :ref:`🔗` Sets the linear stiffness of the given soft body. Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between ``0.0`` and ``1.0`` (inclusive). @@ -3749,7 +3781,7 @@ Sets the linear stiffness of the given soft body. Higher values will result in a .. rst-class:: classref-method -|void| **soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) +|void| **soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) :ref:`🔗` Sets the mesh of the given soft body. @@ -3761,7 +3793,7 @@ Sets the mesh of the given soft body. .. rst-class:: classref-method -|void| **soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) +|void| **soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) :ref:`🔗` Sets the pressure coefficient of the given soft body. Simulates pressure build-up from inside this body. Higher values increase the strength of this effect. @@ -3773,7 +3805,7 @@ Sets the pressure coefficient of the given soft body. Simulates pressure build-u .. rst-class:: classref-method -|void| **soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the given soft body will be pickable when using object picking. @@ -3785,7 +3817,7 @@ Sets whether the given soft body will be pickable when using object picking. .. rst-class:: classref-method -|void| **soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) +|void| **soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) :ref:`🔗` Sets the simulation precision of the given soft body. Increasing this value will improve the resulting simulation, but can affect performance. Use with care. @@ -3797,7 +3829,7 @@ Sets the simulation precision of the given soft body. Increasing this value will .. rst-class:: classref-method -|void| **soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) +|void| **soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) :ref:`🔗` Assigns a space to the given soft body (see :ref:`space_create`). @@ -3809,7 +3841,7 @@ Assigns a space to the given soft body (see :ref:`space_create`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) +|void| **soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) :ref:`🔗` Sets the given body state for the given body (see :ref:`BodyState` constants). @@ -3823,7 +3855,7 @@ Sets the given body state for the given body (see :ref:`BodyState`, total_mass\: :ref:`float`\ ) +|void| **soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) :ref:`🔗` Sets the total mass for the given soft body. @@ -3835,7 +3867,7 @@ Sets the total mass for the given soft body. .. rst-class:: classref-method -|void| **soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) +|void| **soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the global transform of the given soft body. @@ -3847,7 +3879,7 @@ Sets the global transform of the given soft body. .. rst-class:: classref-method -|void| **soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) +|void| **soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) :ref:`🔗` Requests that the physics server updates the rendering server with the latest positions of the given soft body's points through the ``rendering_server_handler`` interface. @@ -3859,7 +3891,7 @@ Requests that the physics server updates the rendering server with the latest po .. rst-class:: classref-method -:ref:`RID` **space_create**\ (\ ) +:ref:`RID` **space_create**\ (\ ) :ref:`🔗` Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. @@ -3871,7 +3903,7 @@ Creates a space. A space is a collection of parameters for the physics engine th .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **space_get_direct_state**\ (\ space\: :ref:`RID`\ ) +:ref:`PhysicsDirectSpaceState3D` **space_get_direct_state**\ (\ space\: :ref:`RID`\ ) :ref:`🔗` Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D`. This object can be used to make collision/intersection queries. @@ -3883,7 +3915,7 @@ Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| +:ref:`float` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| :ref:`🔗` Returns the value of a space parameter. @@ -3895,7 +3927,7 @@ Returns the value of a space parameter. .. rst-class:: classref-method -:ref:`bool` **space_is_active**\ (\ space\: :ref:`RID`\ ) |const| +:ref:`bool` **space_is_active**\ (\ space\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the space is active. @@ -3907,7 +3939,7 @@ Returns whether the space is active. .. rst-class:: classref-method -|void| **space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) +|void| **space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) :ref:`🔗` Marks a space as active. It will not have an effect, unless it is assigned to an area or body. @@ -3919,7 +3951,7 @@ Marks a space as active. It will not have an effect, unless it is assigned to an .. rst-class:: classref-method -|void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) +|void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter` constants. @@ -3931,7 +3963,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. rst-class:: classref-method -:ref:`RID` **sphere_shape_create**\ (\ ) +:ref:`RID` **sphere_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute @@ -3945,7 +3977,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. rst-class:: classref-method -:ref:`RID` **world_boundary_shape_create**\ (\ ) +:ref:`RID` **world_boundary_shape_create**\ (\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index 420e8cffe98..91e6c462e0b 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -426,7 +426,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -440,7 +440,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| +|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -454,7 +454,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| +|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -468,7 +468,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_area_create**\ (\ ) |virtual| +:ref:`RID` **_area_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -482,7 +482,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -496,7 +496,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -510,7 +510,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -524,7 +524,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| +:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -538,7 +538,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -552,7 +552,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -566,7 +566,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Transform3D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -580,7 +580,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -594,7 +594,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| +:ref:`Transform3D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -608,7 +608,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -622,7 +622,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| +|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -636,7 +636,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| +|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -650,7 +650,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| +|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -664,7 +664,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| +|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -678,7 +678,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| +|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -692,7 +692,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| +|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -706,7 +706,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| +|void| **_area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -720,7 +720,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| +|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -734,7 +734,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -748,7 +748,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -762,7 +762,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| +|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -776,7 +776,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -790,7 +790,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| +|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -804,7 +804,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| +|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -818,7 +818,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| +|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -832,7 +832,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| +|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -846,7 +846,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -860,7 +860,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| +|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -874,7 +874,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| +|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -888,7 +888,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| +|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -902,7 +902,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| +|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -916,7 +916,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| +|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -930,7 +930,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| +|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -944,7 +944,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| +|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -958,7 +958,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| +|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -972,7 +972,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_body_create**\ (\ ) |virtual| +:ref:`RID` **_body_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -986,7 +986,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1000,7 +1000,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1014,7 +1014,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1028,7 +1028,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1042,7 +1042,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector3` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1056,7 +1056,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector3` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1070,7 +1070,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1084,7 +1084,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsDirectBodyState3D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| +:ref:`PhysicsDirectBodyState3D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1098,7 +1098,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1112,7 +1112,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1126,7 +1126,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1140,7 +1140,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| +:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1154,7 +1154,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1168,7 +1168,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1182,7 +1182,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| +:ref:`Transform3D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1196,7 +1196,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1210,7 +1210,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| +:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1224,7 +1224,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_body_get_user_flags**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_body_get_user_flags**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1238,7 +1238,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |const| +:ref:`bool` **_body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1252,7 +1252,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1266,7 +1266,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1280,7 +1280,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| +|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1294,7 +1294,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1308,7 +1308,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| +|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1322,7 +1322,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| +|void| **_body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1336,7 +1336,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| +|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1350,7 +1350,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| +|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1364,7 +1364,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| +|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1378,7 +1378,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| +|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1392,7 +1392,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| +|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1406,7 +1406,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| +|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1420,7 +1420,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| +|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1434,7 +1434,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| +|void| **_body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1448,7 +1448,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| +|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1462,7 +1462,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| +|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1476,7 +1476,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| +|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1490,7 +1490,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| +|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1504,7 +1504,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| +|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1518,7 +1518,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| +|void| **_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1532,7 +1532,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| +|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1546,7 +1546,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| +|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1560,7 +1560,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1574,7 +1574,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| +|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1588,7 +1588,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| +|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1602,7 +1602,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| +|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1616,7 +1616,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_body_set_user_flags**\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| +|void| **_body_set_user_flags**\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1630,7 +1630,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |const| +:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1644,7 +1644,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_box_shape_create**\ (\ ) |virtual| +:ref:`RID` **_box_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1658,7 +1658,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| +:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1672,7 +1672,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| +:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1686,7 +1686,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |const| +:ref:`float` **_cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1700,7 +1700,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| +|void| **_cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1714,7 +1714,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| +:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1728,7 +1728,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_custom_shape_create**\ (\ ) |virtual| +:ref:`RID` **_custom_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1742,7 +1742,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_cylinder_shape_create**\ (\ ) |virtual| +:ref:`RID` **_cylinder_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1756,7 +1756,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_end_sync**\ (\ ) |virtual| +|void| **_end_sync**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1770,7 +1770,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_finish**\ (\ ) |virtual| +|void| **_finish**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1784,7 +1784,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_flush_queries**\ (\ ) |virtual| +|void| **_flush_queries**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1798,7 +1798,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1812,7 +1812,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |const| +:ref:`bool` **_generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1826,7 +1826,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |const| +:ref:`float` **_generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1840,7 +1840,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| +|void| **_generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1854,7 +1854,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| +|void| **_generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1868,7 +1868,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| +:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1882,7 +1882,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_heightmap_shape_create**\ (\ ) |virtual| +:ref:`RID` **_heightmap_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1896,7 +1896,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |const| +:ref:`bool` **_hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1910,7 +1910,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |const| +:ref:`float` **_hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1924,7 +1924,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| +|void| **_hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1938,7 +1938,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| +|void| **_hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1952,7 +1952,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_init**\ (\ ) |virtual| +|void| **_init**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1966,7 +1966,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| +:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1980,7 +1980,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| +|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1994,7 +1994,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_joint_create**\ (\ ) |virtual| +:ref:`RID` **_joint_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2008,7 +2008,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| +|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2022,7 +2022,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2036,7 +2036,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2050,7 +2050,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2064,7 +2064,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| +|void| **_joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2078,7 +2078,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| +|void| **_joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2092,7 +2092,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| +|void| **_joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2106,7 +2106,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_make_hinge_simple**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| +|void| **_joint_make_hinge_simple**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2120,7 +2120,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| +|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2134,7 +2134,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| +|void| **_joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2148,7 +2148,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| +|void| **_joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2162,7 +2162,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector3` **_pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2176,7 +2176,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector3` **_pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2190,7 +2190,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| +:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2204,7 +2204,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| +|void| **_pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2218,7 +2218,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| +|void| **_pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2232,7 +2232,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| +|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2246,7 +2246,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| +:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2260,7 +2260,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| +|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2274,7 +2274,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2288,7 +2288,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2302,7 +2302,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_shape_get_margin**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shape_get_margin**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2316,7 +2316,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| +:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2330,7 +2330,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| +|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2344,7 +2344,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| +|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2358,7 +2358,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_shape_set_margin**\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| +|void| **_shape_set_margin**\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2372,7 +2372,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |const| +:ref:`float` **_slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2386,7 +2386,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| +|void| **_slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2400,7 +2400,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| +|void| **_soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2414,7 +2414,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_soft_body_create**\ (\ ) |virtual| +:ref:`RID` **_soft_body_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2428,7 +2428,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **_soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`AABB` **_soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2442,7 +2442,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **_soft_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`Array`\[:ref:`RID`\] **_soft_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2456,7 +2456,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2470,7 +2470,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2484,7 +2484,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2498,7 +2498,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2512,7 +2512,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2526,7 +2526,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2540,7 +2540,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2554,7 +2554,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2568,7 +2568,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`RID` **_soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2582,7 +2582,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| +:ref:`Variant` **_soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2596,7 +2596,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2610,7 +2610,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| +:ref:`bool` **_soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2624,7 +2624,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| +|void| **_soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2638,7 +2638,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| +|void| **_soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2652,7 +2652,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) |virtual| +|void| **_soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2666,7 +2666,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| +|void| **_soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2680,7 +2680,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| +|void| **_soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2694,7 +2694,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| +|void| **_soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2708,7 +2708,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| +|void| **_soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2722,7 +2722,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| +|void| **_soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2736,7 +2736,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| +|void| **_soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2750,7 +2750,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| +|void| **_soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2764,7 +2764,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| +|void| **_soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2778,7 +2778,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| +|void| **_soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2792,7 +2792,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| +|void| **_soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2806,7 +2806,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| +|void| **_soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2820,7 +2820,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| +|void| **_soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2834,7 +2834,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| +|void| **_soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2848,7 +2848,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| +|void| **_soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2862,7 +2862,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| +|void| **_soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2876,7 +2876,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_space_create**\ (\ ) |virtual| +:ref:`RID` **_space_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2890,7 +2890,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2904,7 +2904,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector3Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| +:ref:`PackedVector3Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2918,7 +2918,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| +:ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2932,7 +2932,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| +:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2946,7 +2946,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2960,7 +2960,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| +|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2974,7 +2974,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| +|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -2988,7 +2988,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| +|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -3002,7 +3002,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_sphere_shape_create**\ (\ ) |virtual| +:ref:`RID` **_sphere_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -3016,7 +3016,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| +|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -3030,7 +3030,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_sync**\ (\ ) |virtual| +|void| **_sync**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -3044,7 +3044,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| +:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -3058,7 +3058,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_body**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **body_test_motion_is_excluding_body**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -3072,7 +3072,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_object**\ (\ object\: :ref:`int`\ ) |const| +:ref:`bool` **body_test_motion_is_excluding_object**\ (\ object\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_physicsserver3dmanager.rst b/classes/class_physicsserver3dmanager.rst index 618e2214e66..79f40c2aeda 100644 --- a/classes/class_physicsserver3dmanager.rst +++ b/classes/class_physicsserver3dmanager.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **register_server**\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) +|void| **register_server**\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) :ref:`🔗` Register a :ref:`PhysicsServer3D` implementation by passing a ``name`` and a :ref:`Callable` that returns a :ref:`PhysicsServer3D` object. @@ -62,7 +62,7 @@ Register a :ref:`PhysicsServer3D` implementation by passi .. rst-class:: classref-method -|void| **set_default_server**\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) +|void| **set_default_server**\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) :ref:`🔗` Set the default :ref:`PhysicsServer3D` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation. diff --git a/classes/class_physicsserver3drenderingserverhandler.rst b/classes/class_physicsserver3drenderingserverhandler.rst index c2eb526306e..19046b42b30 100644 --- a/classes/class_physicsserver3drenderingserverhandler.rst +++ b/classes/class_physicsserver3drenderingserverhandler.rst @@ -49,7 +49,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_aabb**\ (\ aabb\: :ref:`AABB`\ ) |virtual| +|void| **_set_aabb**\ (\ aabb\: :ref:`AABB`\ ) |virtual| :ref:`🔗` Called by the :ref:`PhysicsServer3D` to set the bounding box for the :ref:`SoftBody3D`. @@ -61,7 +61,7 @@ Called by the :ref:`PhysicsServer3D` to set the bounding .. rst-class:: classref-method -|void| **_set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| +|void| **_set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` Called by the :ref:`PhysicsServer3D` to set the normal for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -75,7 +75,7 @@ Called by the :ref:`PhysicsServer3D` to set the normal fo .. rst-class:: classref-method -|void| **_set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| +|void| **_set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| :ref:`🔗` Called by the :ref:`PhysicsServer3D` to set the position for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -89,7 +89,7 @@ Called by the :ref:`PhysicsServer3D` to set the position .. rst-class:: classref-method -|void| **set_aabb**\ (\ aabb\: :ref:`AABB`\ ) +|void| **set_aabb**\ (\ aabb\: :ref:`AABB`\ ) :ref:`🔗` Sets the bounding box for the :ref:`SoftBody3D`. @@ -101,7 +101,7 @@ Sets the bounding box for the :ref:`SoftBody3D`. .. rst-class:: classref-method -|void| **set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) +|void| **set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) :ref:`🔗` Sets the normal for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -113,7 +113,7 @@ Sets the normal for the :ref:`SoftBody3D` vertex at the index .. rst-class:: classref-method -|void| **set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) +|void| **set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) :ref:`🔗` Sets the position for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. diff --git a/classes/class_physicsshapequeryparameters2d.rst b/classes/class_physicsshapequeryparameters2d.rst index a33959d4a60..d374905b937 100644 --- a/classes/class_physicsshapequeryparameters2d.rst +++ b/classes/class_physicsshapequeryparameters2d.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``4294967295`` +:ref:`int` **collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property -:ref:`float` **margin** = ``0.0`` +:ref:`float` **margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The collision margin for the shape. .. rst-class:: classref-property -:ref:`Vector2` **motion** = ``Vector2(0, 0)`` +:ref:`Vector2` **motion** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The motion of the shape being queried for. .. rst-class:: classref-property -:ref:`Resource` **shape** +:ref:`Resource` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ The :ref:`Shape2D` that will be used for collision/intersection q .. rst-class:: classref-property -:ref:`RID` **shape_rid** = ``RID()`` +:ref:`RID` **shape_rid** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ The queried shape's :ref:`RID` that will be used for collision/inters .. rst-class:: classref-property -:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` +:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicsshapequeryparameters3d.rst b/classes/class_physicsshapequeryparameters3d.rst index 9a5f4c0e08f..67ae0a513c6 100644 --- a/classes/class_physicsshapequeryparameters3d.rst +++ b/classes/class_physicsshapequeryparameters3d.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ If ``true``, the query will take :ref:`Area3D`\ s into account. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ If ``true``, the query will take :ref:`PhysicsBody3D`\ s in .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``4294967295`` +:ref:`int` **collision_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property -:ref:`float` **margin** = ``0.0`` +:ref:`float` **margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The collision margin for the shape. .. rst-class:: classref-property -:ref:`Vector3` **motion** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **motion** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The motion of the shape being queried for. .. rst-class:: classref-property -:ref:`Resource` **shape** +:ref:`Resource` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ The :ref:`Shape3D` that will be used for collision/intersection q .. rst-class:: classref-property -:ref:`RID` **shape_rid** = ``RID()`` +:ref:`RID` **shape_rid** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ The queried shape's :ref:`RID` that will be used for collision/inters .. rst-class:: classref-property -:ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicstestmotionparameters2d.rst b/classes/class_physicstestmotionparameters2d.rst index ed19581fe64..7c57d1d9620 100644 --- a/classes/class_physicstestmotionparameters2d.rst +++ b/classes/class_physicstestmotionparameters2d.rst @@ -58,7 +58,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_separation_ray** = ``false`` +:ref:`bool` **collide_separation_ray** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -77,7 +77,7 @@ If set to ``false``, shapes of type :ref:`PhysicsServer2D.SHAPE_SEPARATION_RAY`\[:ref:`RID`\] **exclude_bodies** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude_bodies** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ Optional array of body :ref:`RID` to exclude from collision. Use :ref .. rst-class:: classref-property -:ref:`Array`\[:ref:`int`\] **exclude_objects** = ``[]`` +:ref:`Array`\[:ref:`int`\] **exclude_objects** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Optional array of object unique instance ID to exclude from collision. See :ref: .. rst-class:: classref-property -:ref:`Transform2D` **from** = ``Transform2D(1, 0, 0, 1, 0, 0)`` +:ref:`Transform2D` **from** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -128,7 +128,7 @@ Transform in global space where the motion should start. Usually set to :ref:`No .. rst-class:: classref-property -:ref:`float` **margin** = ``0.08`` +:ref:`float` **margin** = ``0.08`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -145,7 +145,7 @@ Increases the size of the shapes involved in the collision detection. .. rst-class:: classref-property -:ref:`Vector2` **motion** = ``Vector2(0, 0)`` +:ref:`Vector2` **motion** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ Motion vector to define the length and direction of the motion to test. .. rst-class:: classref-property -:ref:`bool` **recovery_as_collision** = ``false`` +:ref:`bool` **recovery_as_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicstestmotionparameters3d.rst b/classes/class_physicstestmotionparameters3d.rst index f41eeb262a8..e9325fa676b 100644 --- a/classes/class_physicstestmotionparameters3d.rst +++ b/classes/class_physicstestmotionparameters3d.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_separation_ray** = ``false`` +:ref:`bool` **collide_separation_ray** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ If set to ``false``, shapes of type :ref:`PhysicsServer3D.SHAPE_SEPARATION_RAY`\[:ref:`RID`\] **exclude_bodies** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude_bodies** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Optional array of body :ref:`RID` to exclude from collision. Use :ref .. rst-class:: classref-property -:ref:`Array`\[:ref:`int`\] **exclude_objects** = ``[]`` +:ref:`Array`\[:ref:`int`\] **exclude_objects** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ Optional array of object unique instance ID to exclude from collision. See :ref: .. rst-class:: classref-property -:ref:`Transform3D` **from** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **from** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Transform in global space where the motion should start. Usually set to :ref:`No .. rst-class:: classref-property -:ref:`float` **margin** = ``0.001`` +:ref:`float` **margin** = ``0.001`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ Increases the size of the shapes involved in the collision detection. .. rst-class:: classref-property -:ref:`int` **max_collisions** = ``1`` +:ref:`int` **max_collisions** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ Maximum number of returned collisions, between ``1`` and ``32``. Always returns .. rst-class:: classref-property -:ref:`Vector3` **motion** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **motion** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ Motion vector to define the length and direction of the motion to test. .. rst-class:: classref-property -:ref:`bool` **recovery_as_collision** = ``false`` +:ref:`bool` **recovery_as_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_physicstestmotionresult2d.rst b/classes/class_physicstestmotionresult2d.rst index 03d61822c50..7d141717112 100644 --- a/classes/class_physicstestmotionresult2d.rst +++ b/classes/class_physicstestmotionresult2d.rst @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ ) |const| +:ref:`Object` **get_collider**\ (\ ) |const| :ref:`🔗` Returns the colliding body's attached :ref:`Object`, if a collision occurred. @@ -82,7 +82,7 @@ Returns the colliding body's attached :ref:`Object`, if a collisio .. rst-class:: classref-method -:ref:`int` **get_collider_id**\ (\ ) |const| +:ref:`int` **get_collider_id**\ (\ ) |const| :ref:`🔗` Returns the unique instance ID of the colliding body's attached :ref:`Object`, if a collision occurred. See :ref:`Object.get_instance_id`. @@ -94,7 +94,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid**\ (\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| :ref:`🔗` Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer2D`, if a collision occurred. @@ -106,7 +106,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`int` **get_collider_shape**\ (\ ) |const| +:ref:`int` **get_collider_shape**\ (\ ) |const| :ref:`🔗` Returns the colliding body's shape index, if a collision occurred. See :ref:`CollisionObject2D`. @@ -118,7 +118,7 @@ Returns the colliding body's shape index, if a collision occurred. See :ref:`Col .. rst-class:: classref-method -:ref:`Vector2` **get_collider_velocity**\ (\ ) |const| +:ref:`Vector2` **get_collider_velocity**\ (\ ) |const| :ref:`🔗` Returns the colliding body's velocity, if a collision occurred. @@ -130,7 +130,7 @@ Returns the colliding body's velocity, if a collision occurred. .. rst-class:: classref-method -:ref:`float` **get_collision_depth**\ (\ ) |const| +:ref:`float` **get_collision_depth**\ (\ ) |const| :ref:`🔗` Returns the length of overlap along the collision normal, if a collision occurred. @@ -142,7 +142,7 @@ Returns the length of overlap along the collision normal, if a collision occurre .. rst-class:: classref-method -:ref:`int` **get_collision_local_shape**\ (\ ) |const| +:ref:`int` **get_collision_local_shape**\ (\ ) |const| :ref:`🔗` Returns the moving object's colliding shape, if a collision occurred. @@ -154,7 +154,7 @@ Returns the moving object's colliding shape, if a collision occurred. .. rst-class:: classref-method -:ref:`Vector2` **get_collision_normal**\ (\ ) |const| +:ref:`Vector2` **get_collision_normal**\ (\ ) |const| :ref:`🔗` Returns the colliding body's shape's normal at the point of collision, if a collision occurred. @@ -166,7 +166,7 @@ Returns the colliding body's shape's normal at the point of collision, if a coll .. rst-class:: classref-method -:ref:`Vector2` **get_collision_point**\ (\ ) |const| +:ref:`Vector2` **get_collision_point**\ (\ ) |const| :ref:`🔗` Returns the point of collision in global coordinates, if a collision occurred. @@ -178,7 +178,7 @@ Returns the point of collision in global coordinates, if a collision occurred. .. rst-class:: classref-method -:ref:`float` **get_collision_safe_fraction**\ (\ ) |const| +:ref:`float` **get_collision_safe_fraction**\ (\ ) |const| :ref:`🔗` Returns the maximum fraction of the motion that can occur without a collision, between ``0`` and ``1``. @@ -190,7 +190,7 @@ Returns the maximum fraction of the motion that can occur without a collision, b .. rst-class:: classref-method -:ref:`float` **get_collision_unsafe_fraction**\ (\ ) |const| +:ref:`float` **get_collision_unsafe_fraction**\ (\ ) |const| :ref:`🔗` Returns the minimum fraction of the motion needed to collide, if a collision occurred, between ``0`` and ``1``. @@ -202,7 +202,7 @@ Returns the minimum fraction of the motion needed to collide, if a collision occ .. rst-class:: classref-method -:ref:`Vector2` **get_remainder**\ (\ ) |const| +:ref:`Vector2` **get_remainder**\ (\ ) |const| :ref:`🔗` Returns the moving object's remaining movement vector. @@ -214,7 +214,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector2` **get_travel**\ (\ ) |const| +:ref:`Vector2` **get_travel**\ (\ ) |const| :ref:`🔗` Returns the moving object's travel before collision. diff --git a/classes/class_physicstestmotionresult3d.rst b/classes/class_physicstestmotionresult3d.rst index a34169f8eff..2608eb0eac2 100644 --- a/classes/class_physicstestmotionresult3d.rst +++ b/classes/class_physicstestmotionresult3d.rst @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default), if a collision occurred. @@ -84,7 +84,7 @@ Returns the colliding body's attached :ref:`Object` given a collis .. rst-class:: classref-method -:ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the unique instance ID of the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default), if a collision occurred. See :ref:`Object.get_instance_id`. @@ -96,7 +96,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer3D` given a collision index (the deepest collision by default), if a collision occurred. @@ -108,7 +108,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`int` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occurred. See :ref:`CollisionObject3D`. @@ -120,7 +120,7 @@ Returns the colliding body's shape index given a collision index (the deepest co .. rst-class:: classref-method -:ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occurred. @@ -132,7 +132,7 @@ Returns the colliding body's velocity given a collision index (the deepest colli .. rst-class:: classref-method -:ref:`int` **get_collision_count**\ (\ ) |const| +:ref:`int` **get_collision_count**\ (\ ) |const| :ref:`🔗` Returns the number of detected collisions. @@ -144,7 +144,7 @@ Returns the number of detected collisions. .. rst-class:: classref-method -:ref:`float` **get_collision_depth**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`float` **get_collision_depth**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occurred. @@ -156,7 +156,7 @@ Returns the length of overlap along the collision normal given a collision index .. rst-class:: classref-method -:ref:`int` **get_collision_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_collision_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occurred. @@ -168,7 +168,7 @@ Returns the moving object's colliding shape given a collision index (the deepest .. rst-class:: classref-method -:ref:`Vector3` **get_collision_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector3` **get_collision_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occurred. @@ -180,7 +180,7 @@ Returns the colliding body's shape's normal at the point of collision given a co .. rst-class:: classref-method -:ref:`Vector3` **get_collision_point**\ (\ collision_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector3` **get_collision_point**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occurred. @@ -192,7 +192,7 @@ Returns the point of collision in global coordinates given a collision index (th .. rst-class:: classref-method -:ref:`float` **get_collision_safe_fraction**\ (\ ) |const| +:ref:`float` **get_collision_safe_fraction**\ (\ ) |const| :ref:`🔗` Returns the maximum fraction of the motion that can occur without a collision, between ``0`` and ``1``. @@ -204,7 +204,7 @@ Returns the maximum fraction of the motion that can occur without a collision, b .. rst-class:: classref-method -:ref:`float` **get_collision_unsafe_fraction**\ (\ ) |const| +:ref:`float` **get_collision_unsafe_fraction**\ (\ ) |const| :ref:`🔗` Returns the minimum fraction of the motion needed to collide, if a collision occurred, between ``0`` and ``1``. @@ -216,7 +216,7 @@ Returns the minimum fraction of the motion needed to collide, if a collision occ .. rst-class:: classref-method -:ref:`Vector3` **get_remainder**\ (\ ) |const| +:ref:`Vector3` **get_remainder**\ (\ ) |const| :ref:`🔗` Returns the moving object's remaining movement vector. @@ -228,7 +228,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector3` **get_travel**\ (\ ) |const| +:ref:`Vector3` **get_travel**\ (\ ) |const| :ref:`🔗` Returns the moving object's travel before collision. diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 291e05434fc..c24843ce26f 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **angular_limit_enabled** = ``false`` +:ref:`bool` **angular_limit_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ If ``true``, the pin maximum and minimum rotation, defined by :ref:`angular_limi .. rst-class:: classref-property -:ref:`float` **angular_limit_lower** = ``0.0`` +:ref:`float` **angular_limit_lower** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The minimum rotation. Only active if :ref:`angular_limit_enabled` **angular_limit_upper** = ``0.0`` +:ref:`float` **angular_limit_upper** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The maximum rotation. Only active if :ref:`angular_limit_enabled` **motor_enabled** = ``false`` +:ref:`bool` **motor_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ When activated, a motor turns the pin. .. rst-class:: classref-property -:ref:`float` **motor_target_velocity** = ``0.0`` +:ref:`float` **motor_target_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ Target speed for the motor. In radians per second. .. rst-class:: classref-property -:ref:`float` **softness** = ``0.0`` +:ref:`float` **softness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_pinjoint3d.rst b/classes/class_pinjoint3d.rst index f873e9266c2..d181620efa7 100644 --- a/classes/class_pinjoint3d.rst +++ b/classes/class_pinjoint3d.rst @@ -64,7 +64,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Param**: +enum **Param**: :ref:`🔗` .. _class_PinJoint3D_constant_PARAM_BIAS: @@ -103,7 +103,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **params/bias** = ``0.3`` +:ref:`float` **params/bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ The force with which the pinned objects stay in positional relation to each othe .. rst-class:: classref-property -:ref:`float` **params/damping** = ``1.0`` +:ref:`float` **params/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ The force with which the pinned objects stay in velocity relation to each other. .. rst-class:: classref-property -:ref:`float` **params/impulse_clamp** = ``0.0`` +:ref:`float` **params/impulse_clamp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the specified parameter. @@ -171,7 +171,7 @@ Returns the value of the specified parameter. .. rst-class:: classref-method -|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the specified parameter. diff --git a/classes/class_placeholdermesh.rst b/classes/class_placeholdermesh.rst index 6867812aebb..1e0c294abac 100644 --- a/classes/class_placeholdermesh.rst +++ b/classes/class_placeholdermesh.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AABB` **aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_placeholdertexture2d.rst b/classes/class_placeholdertexture2d.rst index 814cd46e520..8a2f2e534a6 100644 --- a/classes/class_placeholdertexture2d.rst +++ b/classes/class_placeholdertexture2d.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **size** = ``Vector2(1, 1)`` +:ref:`Vector2` **size** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_placeholdertexture3d.rst b/classes/class_placeholdertexture3d.rst index 0cf6ab26e88..35545d95ced 100644 --- a/classes/class_placeholdertexture3d.rst +++ b/classes/class_placeholdertexture3d.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3i` **size** = ``Vector3i(1, 1, 1)`` +:ref:`Vector3i` **size** = ``Vector3i(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_placeholdertexturelayered.rst b/classes/class_placeholdertexturelayered.rst index 1b24e0f0261..46e594af1fa 100644 --- a/classes/class_placeholdertexturelayered.rst +++ b/classes/class_placeholdertexturelayered.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **layers** = ``1`` +:ref:`int` **layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ The number of layers in the texture array. .. rst-class:: classref-property -:ref:`Vector2i` **size** = ``Vector2i(1, 1)`` +:ref:`Vector2i` **size** = ``Vector2i(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 7f865faf1b2..cd689fd05f4 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -135,7 +135,7 @@ Constants .. rst-class:: classref-constant -**PLANE_YZ** = ``Plane(1, 0, 0, 0)`` +**PLANE_YZ** = ``Plane(1, 0, 0, 0)`` :ref:`🔗` A plane that extends in the Y and Z axes (normal vector points +X). @@ -143,7 +143,7 @@ A plane that extends in the Y and Z axes (normal vector points +X). .. rst-class:: classref-constant -**PLANE_XZ** = ``Plane(0, 1, 0, 0)`` +**PLANE_XZ** = ``Plane(0, 1, 0, 0)`` :ref:`🔗` A plane that extends in the X and Z axes (normal vector points +Y). @@ -151,7 +151,7 @@ A plane that extends in the X and Z axes (normal vector points +Y). .. rst-class:: classref-constant -**PLANE_XY** = ``Plane(0, 0, 1, 0)`` +**PLANE_XY** = ``Plane(0, 0, 1, 0)`` :ref:`🔗` A plane that extends in the X and Y axes (normal vector points +Z). @@ -168,7 +168,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **d** = ``0.0`` +:ref:`float` **d** = ``0.0`` :ref:`🔗` The distance from the origin to the plane, expressed in terms of :ref:`normal` (according to its direction and magnitude). Actual absolute distance from the origin to the plane can be calculated as ``abs(d) / normal.length()`` (if :ref:`normal` has zero length then this **Plane** does not represent a valid plane). @@ -182,7 +182,7 @@ In the scalar equation of the plane ``ax + by + cz = d``, this is ``d``, while t .. rst-class:: classref-property -:ref:`Vector3` **normal** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **normal** = ``Vector3(0, 0, 0)`` :ref:`🔗` The normal of the plane, typically a unit vector. Shouldn't be a zero vector as **Plane** with such :ref:`normal` does not represent a valid plane. @@ -196,7 +196,7 @@ In the scalar equation of the plane ``ax + by + cz = d``, this is the vector ``( .. rst-class:: classref-property -:ref:`float` **x** = ``0.0`` +:ref:`float` **x** = ``0.0`` :ref:`🔗` The X component of the plane's :ref:`normal` vector. @@ -208,7 +208,7 @@ The X component of the plane's :ref:`normal` vector .. rst-class:: classref-property -:ref:`float` **y** = ``0.0`` +:ref:`float` **y** = ``0.0`` :ref:`🔗` The Y component of the plane's :ref:`normal` vector. @@ -220,7 +220,7 @@ The Y component of the plane's :ref:`normal` vector .. rst-class:: classref-property -:ref:`float` **z** = ``0.0`` +:ref:`float` **z** = ``0.0`` :ref:`🔗` The Z component of the plane's :ref:`normal` vector. @@ -237,7 +237,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Plane` **Plane**\ (\ ) +:ref:`Plane` **Plane**\ (\ ) :ref:`🔗` Constructs a default-initialized **Plane** with all components set to ``0``. @@ -320,7 +320,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **distance_to**\ (\ point\: :ref:`Vector3`\ ) |const| +:ref:`float` **distance_to**\ (\ point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the shortest distance from the plane to the position ``point``. If the point is above the plane, the distance will be positive. If below, the distance will be negative. @@ -332,7 +332,7 @@ Returns the shortest distance from the plane to the position ``point``. If the p .. rst-class:: classref-method -:ref:`Vector3` **get_center**\ (\ ) |const| +:ref:`Vector3` **get_center**\ (\ ) |const| :ref:`🔗` Returns the center of the plane. @@ -344,7 +344,7 @@ Returns the center of the plane. .. rst-class:: classref-method -:ref:`bool` **has_point**\ (\ point\: :ref:`Vector3`, tolerance\: :ref:`float` = 1e-05\ ) |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector3`, tolerance\: :ref:`float` = 1e-05\ ) |const| :ref:`🔗` Returns ``true`` if ``point`` is inside the plane. Comparison uses a custom minimum ``tolerance`` threshold. @@ -356,7 +356,7 @@ Returns ``true`` if ``point`` is inside the plane. Comparison uses a custom mini .. rst-class:: classref-method -:ref:`Variant` **intersect_3**\ (\ b\: :ref:`Plane`, c\: :ref:`Plane`\ ) |const| +:ref:`Variant` **intersect_3**\ (\ b\: :ref:`Plane`, c\: :ref:`Plane`\ ) |const| :ref:`🔗` Returns the intersection point of the three planes ``b``, ``c`` and this plane. If no intersection is found, ``null`` is returned. @@ -368,7 +368,7 @@ Returns the intersection point of the three planes ``b``, ``c`` and this plane. .. rst-class:: classref-method -:ref:`Variant` **intersects_ray**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| +:ref:`Variant` **intersects_ray**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the intersection point of a ray consisting of the position ``from`` and the direction normal ``dir`` with this plane. If no intersection is found, ``null`` is returned. @@ -380,7 +380,7 @@ Returns the intersection point of a ray consisting of the position ``from`` and .. rst-class:: classref-method -:ref:`Variant` **intersects_segment**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| +:ref:`Variant` **intersects_segment**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the intersection point of a segment from position ``from`` to position ``to`` with this plane. If no intersection is found, ``null`` is returned. @@ -392,7 +392,7 @@ Returns the intersection point of a segment from position ``from`` to position ` .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ to_plane\: :ref:`Plane`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ to_plane\: :ref:`Plane`\ ) |const| :ref:`🔗` Returns ``true`` if this plane and ``to_plane`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -404,7 +404,7 @@ Returns ``true`` if this plane and ``to_plane`` are approximately equal, by runn .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this plane is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -416,7 +416,7 @@ Returns ``true`` if this plane is finite, by calling :ref:`@GlobalScope.is_finit .. rst-class:: classref-method -:ref:`bool` **is_point_over**\ (\ point\: :ref:`Vector3`\ ) |const| +:ref:`bool` **is_point_over**\ (\ point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if ``point`` is located above the plane. @@ -428,7 +428,7 @@ Returns ``true`` if ``point`` is located above the plane. .. rst-class:: classref-method -:ref:`Plane` **normalized**\ (\ ) |const| +:ref:`Plane` **normalized**\ (\ ) |const| :ref:`🔗` Returns a copy of the plane, with normalized :ref:`normal` (so it's a unit vector). Returns ``Plane(0, 0, 0, 0)`` if :ref:`normal` can't be normalized (it has zero length). @@ -440,7 +440,7 @@ Returns a copy of the plane, with normalized :ref:`normal` **project**\ (\ point\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **project**\ (\ point\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the orthogonal projection of ``point`` into a point in the plane. @@ -457,7 +457,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Plane`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Plane`\ ) :ref:`🔗` Returns ``true`` if the planes are not equal. @@ -471,7 +471,7 @@ Returns ``true`` if the planes are not equal. .. rst-class:: classref-operator -:ref:`Plane` **operator ***\ (\ right\: :ref:`Transform3D`\ ) +:ref:`Plane` **operator ***\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D` transformation matrix. @@ -485,7 +485,7 @@ Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D` **operator ==**\ (\ right\: :ref:`Plane`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Plane`\ ) :ref:`🔗` Returns ``true`` if the planes are exactly equal. @@ -499,7 +499,7 @@ Returns ``true`` if the planes are exactly equal. .. rst-class:: classref-operator -:ref:`Plane` **operator unary+**\ (\ ) +:ref:`Plane` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -511,7 +511,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Plane` **operator unary-**\ (\ ) +:ref:`Plane` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Plane**. This is the same as writing ``Plane(-p.normal, -p.d)``. This operation flips the direction of the normal vector and also flips the distance value, resulting in a Plane that is in the same place, but facing the opposite direction. diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index e4701fecf53..7291f9a132d 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -58,7 +58,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Orientation**: +enum **Orientation**: :ref:`🔗` .. _class_PlaneMesh_constant_FACE_X: @@ -97,7 +97,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **center_offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **center_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ Offset of the generated plane. Useful for particles. .. rst-class:: classref-property -:ref:`Orientation` **orientation** = ``1`` +:ref:`Orientation` **orientation** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ Direction that the **PlaneMesh** is facing. See :ref:`Orientation` **size** = ``Vector2(2, 2)`` +:ref:`Vector2` **size** = ``Vector2(2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ Size of the generated plane. .. rst-class:: classref-property -:ref:`int` **subdivide_depth** = ``0`` +:ref:`int` **subdivide_depth** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -165,7 +165,7 @@ Number of subdivision along the Z axis. .. rst-class:: classref-property -:ref:`int` **subdivide_width** = ``0`` +:ref:`int` **subdivide_width** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_pointlight2d.rst b/classes/class_pointlight2d.rst index 99d1702e93a..d80a2c49736 100644 --- a/classes/class_pointlight2d.rst +++ b/classes/class_pointlight2d.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``0.0`` +:ref:`float` **height** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ The height of the light. Used with 2D normal mapping. The units are in pixels, e .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ The offset of the light's :ref:`texture`. .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The offset of the light's :ref:`texture`. .. rst-class:: classref-property -:ref:`float` **texture_scale** = ``1.0`` +:ref:`float` **texture_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 561bdcf7197..3ccc0cef189 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -102,7 +102,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **antialiased** = ``false`` +:ref:`bool` **antialiased** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -119,7 +119,7 @@ If ``true``, polygon edges will be anti-aliased. .. rst-class:: classref-property -:ref:`Array` **bones** = ``[]`` +:ref:`Array` **bones** = ``[]`` :ref:`🔗` Internal list of :ref:`Bone2D` nodes used by the assigned :ref:`skeleton`. Edited using the Polygon2D editor ("UV" button on the top toolbar). @@ -131,7 +131,7 @@ Internal list of :ref:`Bone2D` nodes used by the assigned :ref:`sk .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ The polygon's fill color. If :ref:`texture` is .. rst-class:: classref-property -:ref:`int` **internal_vertex_count** = ``0`` +:ref:`int` **internal_vertex_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -165,7 +165,7 @@ Number of internal vertices, used for UV mapping. .. rst-class:: classref-property -:ref:`float` **invert_border** = ``100.0`` +:ref:`float` **invert_border** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -182,7 +182,7 @@ Added padding applied to the bounding box when :ref:`invert_enabled` **invert_enabled** = ``false`` +:ref:`bool` **invert_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -199,7 +199,7 @@ If ``true``, the polygon will be inverted, containing the area outside the defin .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -216,7 +216,7 @@ The offset applied to each vertex. .. rst-class:: classref-property -:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -235,7 +235,7 @@ The polygon's list of vertices. The final point will be connected to the first. .. rst-class:: classref-property -:ref:`Array` **polygons** = ``[]`` +:ref:`Array` **polygons** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -252,7 +252,7 @@ The list of polygons, in case more than one is being represented. Every individu .. rst-class:: classref-property -:ref:`NodePath` **skeleton** = ``NodePath("")`` +:ref:`NodePath` **skeleton** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -269,7 +269,7 @@ Path to a :ref:`Skeleton2D` node used for skeleton-based defor .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -286,7 +286,7 @@ The polygon's fill texture. Use :ref:`uv` to set te .. rst-class:: classref-property -:ref:`Vector2` **texture_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **texture_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -303,7 +303,7 @@ Amount to offset the polygon's :ref:`texture`. .. rst-class:: classref-property -:ref:`float` **texture_rotation** = ``0.0`` +:ref:`float` **texture_rotation** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -320,7 +320,7 @@ The texture's rotation in radians. .. rst-class:: classref-property -:ref:`Vector2` **texture_scale** = ``Vector2(1, 1)`` +:ref:`Vector2` **texture_scale** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -337,7 +337,7 @@ Amount to multiply the :ref:`uv` coordinates when u .. rst-class:: classref-property -:ref:`PackedVector2Array` **uv** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **uv** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +356,7 @@ Texture coordinates for each vertex of the polygon. There should be one UV value .. rst-class:: classref-property -:ref:`PackedColorArray` **vertex_colors** = ``PackedColorArray()`` +:ref:`PackedColorArray` **vertex_colors** = ``PackedColorArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -380,7 +380,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_bone**\ (\ path\: :ref:`NodePath`, weights\: :ref:`PackedFloat32Array`\ ) +|void| **add_bone**\ (\ path\: :ref:`NodePath`, weights\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Adds a bone with the specified ``path`` and ``weights``. @@ -392,7 +392,7 @@ Adds a bone with the specified ``path`` and ``weights``. .. rst-class:: classref-method -|void| **clear_bones**\ (\ ) +|void| **clear_bones**\ (\ ) :ref:`🔗` Removes all bones from this **Polygon2D**. @@ -404,7 +404,7 @@ Removes all bones from this **Polygon2D**. .. rst-class:: classref-method -|void| **erase_bone**\ (\ index\: :ref:`int`\ ) +|void| **erase_bone**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes the specified bone from this **Polygon2D**. @@ -416,7 +416,7 @@ Removes the specified bone from this **Polygon2D**. .. rst-class:: classref-method -:ref:`int` **get_bone_count**\ (\ ) |const| +:ref:`int` **get_bone_count**\ (\ ) |const| :ref:`🔗` Returns the number of bones in this **Polygon2D**. @@ -428,7 +428,7 @@ Returns the number of bones in this **Polygon2D**. .. rst-class:: classref-method -:ref:`NodePath` **get_bone_path**\ (\ index\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_bone_path**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path to the node associated with the specified bone. @@ -440,7 +440,7 @@ Returns the path to the node associated with the specified bone. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **get_bone_weights**\ (\ index\: :ref:`int`\ ) |const| +:ref:`PackedFloat32Array` **get_bone_weights**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the weight values of the specified bone. @@ -452,7 +452,7 @@ Returns the weight values of the specified bone. .. rst-class:: classref-method -|void| **set_bone_path**\ (\ index\: :ref:`int`, path\: :ref:`NodePath`\ ) +|void| **set_bone_path**\ (\ index\: :ref:`int`, path\: :ref:`NodePath`\ ) :ref:`🔗` Sets the path to the node associated with the specified bone. @@ -464,7 +464,7 @@ Sets the path to the node associated with the specified bone. .. rst-class:: classref-method -|void| **set_bone_weights**\ (\ index\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) +|void| **set_bone_weights**\ (\ index\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Sets the weight values for the specified bone. diff --git a/classes/class_polygonoccluder3d.rst b/classes/class_polygonoccluder3d.rst index cafe861f5ca..493c7753668 100644 --- a/classes/class_polygonoccluder3d.rst +++ b/classes/class_polygonoccluder3d.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **polygon** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 480ab2cb910..cf7319af0f3 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -55,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array` **find_path**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) +:ref:`PackedVector2Array` **find_path**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) :ref:`🔗` .. container:: contribute @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_bounds**\ (\ ) |const| +:ref:`Rect2` **get_bounds**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -83,7 +83,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point**\ (\ point\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **get_closest_point**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` .. container:: contribute @@ -97,7 +97,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_intersections**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) |const| +:ref:`PackedVector2Array` **get_intersections**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) |const| :ref:`🔗` .. container:: contribute @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_point_penalty**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`float` **get_point_penalty**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -125,7 +125,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_point_inside**\ (\ point\: :ref:`Vector2`\ ) |const| +:ref:`bool` **is_point_inside**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` .. container:: contribute @@ -139,7 +139,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_point_penalty**\ (\ idx\: :ref:`int`, penalty\: :ref:`float`\ ) +|void| **set_point_penalty**\ (\ idx\: :ref:`int`, penalty\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -153,7 +153,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **setup**\ (\ points\: :ref:`PackedVector2Array`, connections\: :ref:`PackedInt32Array`\ ) +|void| **setup**\ (\ points\: :ref:`PackedVector2Array`, connections\: :ref:`PackedInt32Array`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 4d4ea1582a3..912e6e85b29 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -58,7 +58,7 @@ Signals .. rst-class:: classref-signal -**popup_hide**\ (\ ) +**popup_hide**\ (\ ) :ref:`🔗` Emitted when the popup is hidden. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 74fc80d06c4..07e5d0822ef 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -296,7 +296,7 @@ Signals .. rst-class:: classref-signal -**id_focused**\ (\ id\: :ref:`int`\ ) +**id_focused**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when the user navigated to an item of some ``id`` using the :ref:`ProjectSettings.input/ui_up` or :ref:`ProjectSettings.input/ui_down` input action. @@ -308,7 +308,7 @@ Emitted when the user navigated to an item of some ``id`` using the :ref:`Projec .. rst-class:: classref-signal -**id_pressed**\ (\ id\: :ref:`int`\ ) +**id_pressed**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when an item of some ``id`` is pressed or its accelerator is activated. @@ -322,7 +322,7 @@ Emitted when an item of some ``id`` is pressed or its accelerator is activated. .. rst-class:: classref-signal -**index_pressed**\ (\ index\: :ref:`int`\ ) +**index_pressed**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Emitted when an item of some ``index`` is pressed or its accelerator is activated. @@ -334,7 +334,7 @@ Emitted when an item of some ``index`` is pressed or its accelerator is activate .. rst-class:: classref-signal -**menu_changed**\ (\ ) +**menu_changed**\ (\ ) :ref:`🔗` Emitted when any item is added, modified or removed. @@ -351,7 +351,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_search** = ``true`` +:ref:`bool` **allow_search** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -368,7 +368,7 @@ If ``true``, allows navigating **PopupMenu** with letter keys. .. rst-class:: classref-property -:ref:`bool` **hide_on_checkable_item_selection** = ``true`` +:ref:`bool` **hide_on_checkable_item_selection** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -385,7 +385,7 @@ If ``true``, hides the **PopupMenu** when a checkbox or radio button is selected .. rst-class:: classref-property -:ref:`bool` **hide_on_item_selection** = ``true`` +:ref:`bool` **hide_on_item_selection** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -402,7 +402,7 @@ If ``true``, hides the **PopupMenu** when an item is selected. .. rst-class:: classref-property -:ref:`bool` **hide_on_state_item_selection** = ``false`` +:ref:`bool` **hide_on_state_item_selection** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -419,7 +419,7 @@ If ``true``, hides the **PopupMenu** when a state item is selected. .. rst-class:: classref-property -:ref:`int` **item_count** = ``0`` +:ref:`int` **item_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -436,7 +436,7 @@ The number of items currently in the list. .. rst-class:: classref-property -:ref:`bool` **prefer_native_menu** = ``false`` +:ref:`bool` **prefer_native_menu** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -453,7 +453,7 @@ If ``true``, :ref:`MenuBar` will use native menu when supported. .. rst-class:: classref-property -:ref:`float` **submenu_popup_delay** = ``0.3`` +:ref:`float` **submenu_popup_delay** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -470,7 +470,7 @@ Sets the delay time in seconds for the submenu item to popup on mouse hovering. .. rst-class:: classref-property -:ref:`SystemMenus` **system_menu_id** = ``0`` +:ref:`SystemMenus` **system_menu_id** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -492,7 +492,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **activate_item_by_event**\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) +:ref:`bool` **activate_item_by_event**\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) :ref:`🔗` Checks the provided ``event`` against the **PopupMenu**'s shortcuts and accelerators, and activates the first item with matching events. If ``for_global_only`` is ``true``, only shortcuts and accelerators with ``global`` set to ``true`` will be called. @@ -508,7 +508,7 @@ Returns ``true`` if an item was successfully activated. .. rst-class:: classref-method -|void| **add_check_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_check_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Adds a new checkable item with text ``label``. @@ -524,7 +524,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -|void| **add_check_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) +|void| **add_check_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) :ref:`🔗` Adds a new checkable item and assigns the specified :ref:`Shortcut` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -540,7 +540,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -|void| **add_icon_check_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_icon_check_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Adds a new checkable item with text ``label`` and icon ``texture``. @@ -556,7 +556,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -|void| **add_icon_check_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) +|void| **add_icon_check_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) :ref:`🔗` Adds a new checkable item and assigns the specified :ref:`Shortcut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -572,7 +572,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -|void| **add_icon_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_icon_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Adds a new item with text ``label`` and icon ``texture``. @@ -586,7 +586,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -|void| **add_icon_radio_check_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_icon_radio_check_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Same as :ref:`add_icon_check_item`, but uses a radio check button. @@ -598,7 +598,7 @@ Same as :ref:`add_icon_check_item`, .. rst-class:: classref-method -|void| **add_icon_radio_check_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) +|void| **add_icon_radio_check_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) :ref:`🔗` Same as :ref:`add_icon_check_shortcut`, but uses a radio check button. @@ -610,7 +610,7 @@ Same as :ref:`add_icon_check_shortcut`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) +|void| **add_icon_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) :ref:`🔗` Adds a new item and assigns the specified :ref:`Shortcut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -626,7 +626,7 @@ If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. .. rst-class:: classref-method -|void| **add_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Adds a new item with text ``label``. @@ -642,7 +642,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -|void| **add_multistate_item**\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_multistate_item**\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Adds a new multistate item with text ``label``. @@ -678,7 +678,7 @@ Example usage: .. rst-class:: classref-method -|void| **add_radio_check_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) +|void| **add_radio_check_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) :ref:`🔗` Adds a new radio check button with text ``label``. @@ -694,7 +694,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -|void| **add_radio_check_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) +|void| **add_radio_check_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) :ref:`🔗` Adds a new radio check button and assigns a :ref:`Shortcut` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -710,7 +710,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -|void| **add_separator**\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) +|void| **add_separator**\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) :ref:`🔗` Adds a separator between items. Separators also occupy an index, which you can set by using the ``id`` parameter. @@ -724,7 +724,7 @@ A ``label`` can optionally be provided, which will appear at the center of the s .. rst-class:: classref-method -|void| **add_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) +|void| **add_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) :ref:`🔗` Adds a :ref:`Shortcut`. @@ -740,7 +740,7 @@ If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. .. rst-class:: classref-method -|void| **add_submenu_item**\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) +|void| **add_submenu_item**\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Prefer using :ref:`add_submenu_node_item` instead. @@ -756,7 +756,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -|void| **add_submenu_node_item**\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) +|void| **add_submenu_node_item**\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) :ref:`🔗` Adds an item that will act as a submenu of the parent **PopupMenu** node when clicked. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ``ui_select`` or ``ui_right`` input actions. @@ -772,7 +772,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -|void| **clear**\ (\ free_submenus\: :ref:`bool` = false\ ) +|void| **clear**\ (\ free_submenus\: :ref:`bool` = false\ ) :ref:`🔗` Removes all items from the **PopupMenu**. If ``free_submenus`` is ``true``, the submenu nodes are automatically freed. @@ -784,7 +784,7 @@ Removes all items from the **PopupMenu**. If ``free_submenus`` is ``true``, the .. rst-class:: classref-method -:ref:`int` **get_focused_item**\ (\ ) |const| +:ref:`int` **get_focused_item**\ (\ ) |const| :ref:`🔗` Returns the index of the currently focused item. Returns ``-1`` if no item is focused. @@ -796,7 +796,7 @@ Returns the index of the currently focused item. Returns ``-1`` if no item is fo .. rst-class:: classref-method -:ref:`Key` **get_item_accelerator**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Key` **get_item_accelerator**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). If no accelerator is defined for the specified ``index``, :ref:`get_item_accelerator` returns ``0`` (corresponding to :ref:`@GlobalScope.KEY_NONE`). @@ -808,7 +808,7 @@ Returns the accelerator of the item at the given ``index``. An accelerator is a .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_item_icon**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon of the item at the given ``index``. @@ -820,7 +820,7 @@ Returns the icon of the item at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_item_icon_max_width**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_item_icon_max_width**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum allowed width of the icon for the item at the given ``index``. @@ -832,7 +832,7 @@ Returns the maximum allowed width of the icon for the item at the given ``index` .. rst-class:: classref-method -:ref:`Color` **get_item_icon_modulate**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Color` **get_item_icon_modulate**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`Color` modulating the item's icon at the given ``index``. @@ -844,7 +844,7 @@ Returns a :ref:`Color` modulating the item's icon at the given ``in .. rst-class:: classref-method -:ref:`int` **get_item_id**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_item_id**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ID of the item at the given ``index``. ``id`` can be manually assigned, while index can not. @@ -856,7 +856,7 @@ Returns the ID of the item at the given ``index``. ``id`` can be manually assign .. rst-class:: classref-method -:ref:`int` **get_item_indent**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_item_indent**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the horizontal offset of the item at the given ``index``. @@ -868,7 +868,7 @@ Returns the horizontal offset of the item at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_item_index**\ (\ id\: :ref:`int`\ ) |const| +:ref:`int` **get_item_index**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine and can not be set manually. @@ -880,7 +880,7 @@ Returns the index of the item containing the specified ``id``. Index is automati .. rst-class:: classref-method -:ref:`String` **get_item_language**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **get_item_language**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text language code. @@ -892,7 +892,7 @@ Returns item's text language code. .. rst-class:: classref-method -:ref:`Variant` **get_item_metadata**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Variant` **get_item_metadata**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. @@ -904,7 +904,7 @@ Returns the metadata of the specified item, which might be of any type. You can .. rst-class:: classref-method -:ref:`int` **get_item_multistate**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_item_multistate**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the state of the item at the given ``index``. @@ -916,7 +916,7 @@ Returns the state of the item at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_item_multistate_max**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_item_multistate_max**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the max states of the item at the given ``index``. @@ -928,7 +928,7 @@ Returns the max states of the item at the given ``index``. .. rst-class:: classref-method -:ref:`Shortcut` **get_item_shortcut**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Shortcut` **get_item_shortcut**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Shortcut` associated with the item at the given ``index``. @@ -940,7 +940,7 @@ Returns the :ref:`Shortcut` associated with the item at the give .. rst-class:: classref-method -:ref:`String` **get_item_submenu**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **get_item_submenu**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Prefer using :ref:`get_item_submenu_node` instead. @@ -954,7 +954,7 @@ Returns the submenu name of the item at the given ``index``. See :ref:`add_subme .. rst-class:: classref-method -:ref:`PopupMenu` **get_item_submenu_node**\ (\ index\: :ref:`int`\ ) |const| +:ref:`PopupMenu` **get_item_submenu_node**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the submenu of the item at the given ``index``, or ``null`` if no submenu was added. See :ref:`add_submenu_node_item` for more info on how to add a submenu. @@ -966,7 +966,7 @@ Returns the submenu of the item at the given ``index``, or ``null`` if no submen .. rst-class:: classref-method -:ref:`String` **get_item_text**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **get_item_text**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text of the item at the given ``index``. @@ -978,7 +978,7 @@ Returns the text of the item at the given ``index``. .. rst-class:: classref-method -:ref:`TextDirection` **get_item_text_direction**\ (\ index\: :ref:`int`\ ) |const| +:ref:`TextDirection` **get_item_text_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text base writing direction. @@ -990,7 +990,7 @@ Returns item's text base writing direction. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **get_item_tooltip**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip associated with the item at the given ``index``. @@ -1002,7 +1002,7 @@ Returns the tooltip associated with the item at the given ``index``. .. rst-class:: classref-method -:ref:`bool` **is_item_checkable**\ (\ index\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_checkable**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the given ``index`` is checkable in some way, i.e. if it has a checkbox or radio button. @@ -1016,7 +1016,7 @@ Returns ``true`` if the item at the given ``index`` is checkable in some way, i. .. rst-class:: classref-method -:ref:`bool` **is_item_checked**\ (\ index\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_checked**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the given ``index`` is checked. @@ -1028,7 +1028,7 @@ Returns ``true`` if the item at the given ``index`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_item_disabled**\ (\ index\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_disabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the given ``index`` is disabled. When it is disabled it can't be selected, or its action invoked. @@ -1042,7 +1042,7 @@ See :ref:`set_item_disabled` for more .. rst-class:: classref-method -:ref:`bool` **is_item_radio_checkable**\ (\ index\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_radio_checkable**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item at the given ``index`` has radio button-style checkability. @@ -1056,7 +1056,7 @@ Returns ``true`` if the item at the given ``index`` has radio button-style check .. rst-class:: classref-method -:ref:`bool` **is_item_separator**\ (\ index\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_separator**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the item is a separator. If it is, it will be displayed as a line. See :ref:`add_separator` for more info on how to add a separator. @@ -1068,7 +1068,7 @@ Returns ``true`` if the item is a separator. If it is, it will be displayed as a .. rst-class:: classref-method -:ref:`bool` **is_item_shortcut_disabled**\ (\ index\: :ref:`int`\ ) |const| +:ref:`bool` **is_item_shortcut_disabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified item's shortcut is disabled. @@ -1080,7 +1080,7 @@ Returns ``true`` if the specified item's shortcut is disabled. .. rst-class:: classref-method -:ref:`bool` **is_system_menu**\ (\ ) |const| +:ref:`bool` **is_system_menu**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the menu is bound to the special system menu. @@ -1092,7 +1092,7 @@ Returns ``true`` if the menu is bound to the special system menu. .. rst-class:: classref-method -|void| **remove_item**\ (\ index\: :ref:`int`\ ) +|void| **remove_item**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes the item at the given ``index`` from the menu. @@ -1106,7 +1106,7 @@ Removes the item at the given ``index`` from the menu. .. rst-class:: classref-method -|void| **scroll_to_item**\ (\ index\: :ref:`int`\ ) +|void| **scroll_to_item**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Moves the scroll view to make the item at the given ``index`` visible. @@ -1118,7 +1118,7 @@ Moves the scroll view to make the item at the given ``index`` visible. .. rst-class:: classref-method -|void| **set_focused_item**\ (\ index\: :ref:`int`\ ) +|void| **set_focused_item**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Sets the currently focused item as the given ``index``. @@ -1132,7 +1132,7 @@ Passing ``-1`` as the index makes so that no item is focused. .. rst-class:: classref-method -|void| **set_item_accelerator**\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) +|void| **set_item_accelerator**\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) :ref:`🔗` Sets the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. ``accel`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). @@ -1144,7 +1144,7 @@ Sets the accelerator of the item at the given ``index``. An accelerator is a key .. rst-class:: classref-method -|void| **set_item_as_checkable**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_item_as_checkable**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets whether the item at the given ``index`` has a checkbox. If ``false``, sets the type of the item to plain text. @@ -1158,7 +1158,7 @@ Sets whether the item at the given ``index`` has a checkbox. If ``false``, sets .. rst-class:: classref-method -|void| **set_item_as_radio_checkable**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_item_as_radio_checkable**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets the type of the item at the given ``index`` to radio button. If ``false``, sets the type of the item to plain text. @@ -1170,7 +1170,7 @@ Sets the type of the item at the given ``index`` to radio button. If ``false``, .. rst-class:: classref-method -|void| **set_item_as_separator**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_item_as_separator**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Mark the item at the given ``index`` as a separator, which means that it would be displayed as a line. If ``false``, sets the type of the item to plain text. @@ -1182,7 +1182,7 @@ Mark the item at the given ``index`` as a separator, which means that it would b .. rst-class:: classref-method -|void| **set_item_checked**\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) +|void| **set_item_checked**\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) :ref:`🔗` Sets the checkstate status of the item at the given ``index``. @@ -1194,7 +1194,7 @@ Sets the checkstate status of the item at the given ``index``. .. rst-class:: classref-method -|void| **set_item_disabled**\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_item_disabled**\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Enables/disables the item at the given ``index``. When it is disabled, it can't be selected and its action can't be invoked. @@ -1206,7 +1206,7 @@ Enables/disables the item at the given ``index``. When it is disabled, it can't .. rst-class:: classref-method -|void| **set_item_icon**\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_item_icon**\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Replaces the :ref:`Texture2D` icon of the item at the given ``index``. @@ -1218,7 +1218,7 @@ Replaces the :ref:`Texture2D` icon of the item at the given ``i .. rst-class:: classref-method -|void| **set_item_icon_max_width**\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) +|void| **set_item_icon_max_width**\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) :ref:`🔗` Sets the maximum allowed width of the icon for the item at the given ``index``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1230,7 +1230,7 @@ Sets the maximum allowed width of the icon for the item at the given ``index``. .. rst-class:: classref-method -|void| **set_item_icon_modulate**\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) +|void| **set_item_icon_modulate**\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) :ref:`🔗` Sets a modulating :ref:`Color` of the item's icon at the given ``index``. @@ -1242,7 +1242,7 @@ Sets a modulating :ref:`Color` of the item's icon at the given ``in .. rst-class:: classref-method -|void| **set_item_id**\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) +|void| **set_item_id**\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) :ref:`🔗` Sets the ``id`` of the item at the given ``index``. @@ -1256,7 +1256,7 @@ The ``id`` is used in :ref:`id_pressed` and : .. rst-class:: classref-method -|void| **set_item_indent**\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) +|void| **set_item_indent**\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) :ref:`🔗` Sets the horizontal offset of the item at the given ``index``. @@ -1268,7 +1268,7 @@ Sets the horizontal offset of the item at the given ``index``. .. rst-class:: classref-method -|void| **set_item_language**\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) +|void| **set_item_language**\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1280,7 +1280,7 @@ Sets language code of item's text used for line-breaking and text shaping algori .. rst-class:: classref-method -|void| **set_item_metadata**\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) +|void| **set_item_metadata**\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata of an item, which may be of any type. You can later get it with :ref:`get_item_metadata`, which provides a simple way of assigning context data to items. @@ -1292,7 +1292,7 @@ Sets the metadata of an item, which may be of any type. You can later get it wit .. rst-class:: classref-method -|void| **set_item_multistate**\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) +|void| **set_item_multistate**\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) :ref:`🔗` Sets the state of a multistate item. See :ref:`add_multistate_item` for details. @@ -1304,7 +1304,7 @@ Sets the state of a multistate item. See :ref:`add_multistate_item`, max_states\: :ref:`int`\ ) +|void| **set_item_multistate_max**\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) :ref:`🔗` Sets the max states of a multistate item. See :ref:`add_multistate_item` for details. @@ -1316,7 +1316,7 @@ Sets the max states of a multistate item. See :ref:`add_multistate_item`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) +|void| **set_item_shortcut**\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) :ref:`🔗` Sets a :ref:`Shortcut` for the item at the given ``index``. @@ -1328,7 +1328,7 @@ Sets a :ref:`Shortcut` for the item at the given ``index``. .. rst-class:: classref-method -|void| **set_item_shortcut_disabled**\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_item_shortcut_disabled**\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` Disables the :ref:`Shortcut` of the item at the given ``index``. @@ -1340,7 +1340,7 @@ Disables the :ref:`Shortcut` of the item at the given ``index``. .. rst-class:: classref-method -|void| **set_item_submenu**\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) +|void| **set_item_submenu**\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) :ref:`🔗` **Deprecated:** Prefer using :ref:`set_item_submenu_node` instead. @@ -1354,7 +1354,7 @@ Sets the submenu of the item at the given ``index``. The submenu is the name of .. rst-class:: classref-method -|void| **set_item_submenu_node**\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) +|void| **set_item_submenu_node**\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) :ref:`🔗` Sets the submenu of the item at the given ``index``. The submenu is a **PopupMenu** node that would be shown when the item is clicked. It must either be a child of this **PopupMenu** or has no parent (in which case it will be automatically added as a child). If the ``submenu`` popup has another parent, this method will fail. @@ -1366,7 +1366,7 @@ Sets the submenu of the item at the given ``index``. The submenu is a **PopupMen .. rst-class:: classref-method -|void| **set_item_text**\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_item_text**\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets the text of the item at the given ``index``. @@ -1378,7 +1378,7 @@ Sets the text of the item at the given ``index``. .. rst-class:: classref-method -|void| **set_item_text_direction**\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) +|void| **set_item_text_direction**\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) :ref:`🔗` Sets item's text base writing direction. @@ -1390,7 +1390,7 @@ Sets item's text base writing direction. .. rst-class:: classref-method -|void| **set_item_tooltip**\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_item_tooltip**\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the :ref:`String` tooltip of the item at the given ``index``. @@ -1402,7 +1402,7 @@ Sets the :ref:`String` tooltip of the item at the given ``index``. .. rst-class:: classref-method -|void| **toggle_item_checked**\ (\ index\: :ref:`int`\ ) +|void| **toggle_item_checked**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Toggles the check state of the item at the given ``index``. @@ -1414,7 +1414,7 @@ Toggles the check state of the item at the given ``index``. .. rst-class:: classref-method -|void| **toggle_item_multistate**\ (\ index\: :ref:`int`\ ) +|void| **toggle_item_multistate**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Cycle to the next state of a multistate item. See :ref:`add_multistate_item` for details. @@ -1431,7 +1431,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_accelerator_color** = ``Color(0.7, 0.7, 0.7, 0.8)`` +:ref:`Color` **font_accelerator_color** = ``Color(0.7, 0.7, 0.7, 0.8)`` :ref:`🔗` The text :ref:`Color` used for shortcuts and accelerators that show next to the menu item name when defined. See :ref:`get_item_accelerator` for more info on accelerators. @@ -1443,7 +1443,7 @@ The text :ref:`Color` used for shortcuts and accelerators that show .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` The default text :ref:`Color` for menu items' names. @@ -1455,7 +1455,7 @@ The default text :ref:`Color` for menu items' names. .. rst-class:: classref-themeproperty -:ref:`Color` **font_disabled_color** = ``Color(0.4, 0.4, 0.4, 0.8)`` +:ref:`Color` **font_disabled_color** = ``Color(0.4, 0.4, 0.4, 0.8)`` :ref:`🔗` :ref:`Color` used for disabled menu items' text. @@ -1467,7 +1467,7 @@ The default text :ref:`Color` for menu items' names. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hover_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_hover_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` :ref:`Color` used for the hovered text. @@ -1479,7 +1479,7 @@ The default text :ref:`Color` for menu items' names. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the menu item. @@ -1491,7 +1491,7 @@ The tint of text outline of the menu item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_separator_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_separator_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` :ref:`Color` used for labeled separators' text. See :ref:`add_separator`. @@ -1503,7 +1503,7 @@ The tint of text outline of the menu item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_separator_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_separator_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the labeled separator. @@ -1515,7 +1515,7 @@ The tint of text outline of the labeled separator. .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal space between the item's elements. @@ -1527,7 +1527,7 @@ The horizontal space between the item's elements. .. rst-class:: classref-themeproperty -:ref:`int` **icon_max_width** = ``0`` +:ref:`int` **icon_max_width** = ``0`` :ref:`🔗` The maximum allowed width of the item's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`set_item_icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1539,7 +1539,7 @@ The maximum allowed width of the item's icon. This limit is applied on top of th .. rst-class:: classref-themeproperty -:ref:`int` **indent** = ``10`` +:ref:`int` **indent** = ``10`` :ref:`🔗` Width of the single indentation level. @@ -1551,7 +1551,7 @@ Width of the single indentation level. .. rst-class:: classref-themeproperty -:ref:`int` **item_end_padding** = ``2`` +:ref:`int` **item_end_padding** = ``2`` :ref:`🔗` Horizontal padding to the right of the items (or left, in RTL layout). @@ -1563,7 +1563,7 @@ Horizontal padding to the right of the items (or left, in RTL layout). .. rst-class:: classref-themeproperty -:ref:`int` **item_start_padding** = ``2`` +:ref:`int` **item_start_padding** = ``2`` :ref:`🔗` Horizontal padding to the left of the items (or right, in RTL layout). @@ -1575,7 +1575,7 @@ Horizontal padding to the left of the items (or right, in RTL layout). .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the item text outline. @@ -1589,7 +1589,7 @@ The size of the item text outline. .. rst-class:: classref-themeproperty -:ref:`int` **separator_outline_size** = ``0`` +:ref:`int` **separator_outline_size** = ``0`` :ref:`🔗` The size of the labeled separator text outline. @@ -1601,7 +1601,7 @@ The size of the labeled separator text outline. .. rst-class:: classref-themeproperty -:ref:`int` **v_separation** = ``4`` +:ref:`int` **v_separation** = ``4`` :ref:`🔗` The vertical space between each menu item. @@ -1613,7 +1613,7 @@ The vertical space between each menu item. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` used for the menu items. @@ -1625,7 +1625,7 @@ The vertical space between each menu item. .. rst-class:: classref-themeproperty -:ref:`Font` **font_separator** +:ref:`Font` **font_separator** :ref:`🔗` :ref:`Font` used for the labeled separator. @@ -1637,7 +1637,7 @@ The vertical space between each menu item. .. rst-class:: classref-themeproperty -:ref:`int` **font_separator_size** +:ref:`int` **font_separator_size** :ref:`🔗` Font size of the labeled separator. @@ -1649,7 +1649,7 @@ Font size of the labeled separator. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the menu items. @@ -1661,7 +1661,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked** +:ref:`Texture2D` **checked** :ref:`🔗` :ref:`Texture2D` icon for the checked checkbox items. @@ -1673,7 +1673,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked_disabled** +:ref:`Texture2D` **checked_disabled** :ref:`🔗` :ref:`Texture2D` icon for the checked checkbox items when they are disabled. @@ -1685,7 +1685,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_checked** +:ref:`Texture2D` **radio_checked** :ref:`🔗` :ref:`Texture2D` icon for the checked radio button items. @@ -1697,7 +1697,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_checked_disabled** +:ref:`Texture2D` **radio_checked_disabled** :ref:`🔗` :ref:`Texture2D` icon for the checked radio button items when they are disabled. @@ -1709,7 +1709,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_unchecked** +:ref:`Texture2D` **radio_unchecked** :ref:`🔗` :ref:`Texture2D` icon for the unchecked radio button items. @@ -1721,7 +1721,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **radio_unchecked_disabled** +:ref:`Texture2D` **radio_unchecked_disabled** :ref:`🔗` :ref:`Texture2D` icon for the unchecked radio button items when they are disabled. @@ -1733,7 +1733,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **submenu** +:ref:`Texture2D` **submenu** :ref:`🔗` :ref:`Texture2D` icon for the submenu arrow (for left-to-right layouts). @@ -1745,7 +1745,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **submenu_mirrored** +:ref:`Texture2D` **submenu_mirrored** :ref:`🔗` :ref:`Texture2D` icon for the submenu arrow (for right-to-left layouts). @@ -1757,7 +1757,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked** +:ref:`Texture2D` **unchecked** :ref:`🔗` :ref:`Texture2D` icon for the unchecked checkbox items. @@ -1769,7 +1769,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **unchecked_disabled** +:ref:`Texture2D` **unchecked_disabled** :ref:`🔗` :ref:`Texture2D` icon for the unchecked checkbox items when they are disabled. @@ -1781,7 +1781,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **hover** +:ref:`StyleBox` **hover** :ref:`🔗` :ref:`StyleBox` displayed when the **PopupMenu** item is hovered. @@ -1793,7 +1793,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **labeled_separator_left** +:ref:`StyleBox` **labeled_separator_left** :ref:`🔗` :ref:`StyleBox` for the left side of labeled separator. See :ref:`add_separator`. @@ -1805,7 +1805,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **labeled_separator_right** +:ref:`StyleBox` **labeled_separator_right** :ref:`🔗` :ref:`StyleBox` for the right side of labeled separator. See :ref:`add_separator`. @@ -1817,7 +1817,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` :ref:`StyleBox` for the the background panel. @@ -1829,7 +1829,7 @@ Font size of the menu items. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **separator** +:ref:`StyleBox` **separator** :ref:`🔗` :ref:`StyleBox` used for the separators. See :ref:`add_separator`. diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index c69e3cc65d0..c72c9c55a66 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -46,7 +46,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` :ref:`StyleBox` for the the background panel. diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index a1f84cd830a..5ccb0fd9995 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -80,7 +80,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CompressionMode**: +enum **CompressionMode**: :ref:`🔗` .. _class_PortableCompressedTexture2D_constant_COMPRESSION_MODE_LOSSLESS: @@ -167,7 +167,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedByteArray` **_data** = ``PackedByteArray()`` +:ref:`PackedByteArray` **_data** = ``PackedByteArray()`` :ref:`🔗` .. container:: contribute @@ -181,7 +181,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **keep_compressed_buffer** = ``false`` +:ref:`bool` **keep_compressed_buffer** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ This flag allows to keep the compressed data in memory if you intend it to persi .. rst-class:: classref-property -:ref:`Vector2` **size_override** = ``Vector2(0, 0)`` +:ref:`Vector2` **size_override** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **create_from_image**\ (\ image\: :ref:`Image`, compression_mode\: :ref:`CompressionMode`, normal_map\: :ref:`bool` = false, lossy_quality\: :ref:`float` = 0.8\ ) +|void| **create_from_image**\ (\ image\: :ref:`Image`, compression_mode\: :ref:`CompressionMode`, normal_map\: :ref:`bool` = false, lossy_quality\: :ref:`float` = 0.8\ ) :ref:`🔗` Initializes the compressed texture from a base image. The compression mode must be provided. @@ -238,7 +238,7 @@ If lossy compression is requested, the quality setting can optionally be provide .. rst-class:: classref-method -:ref:`CompressionMode` **get_compression_mode**\ (\ ) |const| +:ref:`CompressionMode` **get_compression_mode**\ (\ ) |const| :ref:`🔗` Return the compression mode used (valid after initialized). @@ -250,7 +250,7 @@ Return the compression mode used (valid after initialized). .. rst-class:: classref-method -:ref:`Format` **get_format**\ (\ ) |const| +:ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` Return the image format used (valid after initialized). @@ -262,7 +262,7 @@ Return the image format used (valid after initialized). .. rst-class:: classref-method -:ref:`bool` **is_keeping_all_compressed_buffers**\ (\ ) |static| +:ref:`bool` **is_keeping_all_compressed_buffers**\ (\ ) |static| :ref:`🔗` Return whether the flag is overridden for all textures of this type. @@ -274,7 +274,7 @@ Return whether the flag is overridden for all textures of this type. .. rst-class:: classref-method -|void| **set_keep_all_compressed_buffers**\ (\ keep\: :ref:`bool`\ ) |static| +|void| **set_keep_all_compressed_buffers**\ (\ keep\: :ref:`bool`\ ) |static| :ref:`🔗` Overrides the flag globally for all textures of this type. This is used primarily by the editor. diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 08ac3ece1db..7bfc97eb325 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **add_uv2** = ``false`` +:ref:`bool` **add_uv2** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -89,7 +89,7 @@ If set, generates UV2 UV coordinates applying a padding using the :ref:`uv2_padd .. rst-class:: classref-property -:ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` +:ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -106,7 +106,7 @@ Overrides the :ref:`AABB` with one defined by user for use with frus .. rst-class:: classref-property -:ref:`bool` **flip_faces** = ``false`` +:ref:`bool` **flip_faces** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ This gives the same result as using :ref:`BaseMaterial3D.CULL_FRONT` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ The current :ref:`Material` of the primitive mesh. .. rst-class:: classref-property -:ref:`float` **uv2_padding** = ``2.0`` +:ref:`float` **uv2_padding** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **_create_mesh_array**\ (\ ) |virtual| |const| +:ref:`Array` **_create_mesh_array**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to customize how this primitive mesh should be generated. Should return an :ref:`Array` where each element is another Array of values required for the mesh (see the :ref:`ArrayType` constants). @@ -178,7 +178,7 @@ Override this method to customize how this primitive mesh should be generated. S .. rst-class:: classref-method -:ref:`Array` **get_mesh_arrays**\ (\ ) |const| +:ref:`Array` **get_mesh_arrays**\ (\ ) |const| :ref:`🔗` Returns mesh arrays used to constitute surface of :ref:`Mesh`. The result can be passed to :ref:`ArrayMesh.add_surface_from_arrays` to create a new surface. For example: @@ -207,7 +207,7 @@ Returns mesh arrays used to constitute surface of :ref:`Mesh`. The r .. rst-class:: classref-method -|void| **request_update**\ (\ ) +|void| **request_update**\ (\ ) :ref:`🔗` Request an update of this primitive mesh based on its properties. diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index b60f1c21613..0ea4f8e725f 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **left_to_right** = ``0.5`` +:ref:`float` **left_to_right** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ Displacement of the upper edge along the X axis. 0.0 positions edge straight abo .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ Size of the prism. .. rst-class:: classref-property -:ref:`int` **subdivide_depth** = ``0`` +:ref:`int` **subdivide_depth** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ Number of added edge loops along the Z axis. .. rst-class:: classref-property -:ref:`int` **subdivide_height** = ``0`` +:ref:`int` **subdivide_height** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Number of added edge loops along the Y axis. .. rst-class:: classref-property -:ref:`int` **subdivide_width** = ``0`` +:ref:`int` **subdivide_width** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_proceduralskymaterial.rst b/classes/class_proceduralskymaterial.rst index 1c61e842d84..6c49f70d94b 100644 --- a/classes/class_proceduralskymaterial.rst +++ b/classes/class_proceduralskymaterial.rst @@ -76,7 +76,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **energy_multiplier** = ``1.0`` +:ref:`float` **energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-property -:ref:`Color` **ground_bottom_color** = ``Color(0.2, 0.169, 0.133, 1)`` +:ref:`Color` **ground_bottom_color** = ``Color(0.2, 0.169, 0.133, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ Color of the ground at the bottom. Blends with :ref:`ground_horizon_color` **ground_curve** = ``0.02`` +:ref:`float` **ground_curve** = ``0.02`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ How quickly the :ref:`ground_horizon_color` **ground_energy_multiplier** = ``1.0`` +:ref:`float` **ground_energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ Multiplier for ground color. A higher value will make the ground brighter. .. rst-class:: classref-property -:ref:`Color` **ground_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` +:ref:`Color` **ground_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ Color of the ground at the horizon. Blends with :ref:`ground_bottom_color` **sky_cover** +:ref:`Texture2D` **sky_cover** :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ The sky cover texture to use. This texture must use an equirectangular projectio .. rst-class:: classref-property -:ref:`Color` **sky_cover_modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **sky_cover_modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ The tint to apply to the :ref:`sky_cover` **sky_curve** = ``0.15`` +:ref:`float` **sky_curve** = ``0.15`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ How quickly the :ref:`sky_horizon_color` **sky_energy_multiplier** = ``1.0`` +:ref:`float` **sky_energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -229,7 +229,7 @@ Multiplier for sky color. A higher value will make the sky brighter. .. rst-class:: classref-property -:ref:`Color` **sky_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` +:ref:`Color` **sky_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -246,7 +246,7 @@ Color of the sky at the horizon. Blends with :ref:`sky_top_color` **sky_top_color** = ``Color(0.385, 0.454, 0.55, 1)`` +:ref:`Color` **sky_top_color** = ``Color(0.385, 0.454, 0.55, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -263,7 +263,7 @@ Color of the sky at the top. Blends with :ref:`sky_horizon_color` **sun_angle_max** = ``30.0`` +:ref:`float` **sun_angle_max** = ``30.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -280,7 +280,7 @@ Distance from center of sun where it fades out completely. .. rst-class:: classref-property -:ref:`float` **sun_curve** = ``0.15`` +:ref:`float` **sun_curve** = ``0.15`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -297,7 +297,7 @@ How quickly the sun fades away between the edge of the sun disk and :ref:`sun_an .. rst-class:: classref-property -:ref:`bool` **use_debanding** = ``true`` +:ref:`bool` **use_debanding** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 9e9e5a421e3..d0b82a3b012 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -76,7 +76,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FillMode**: +enum **FillMode**: :ref:`🔗` .. _class_ProgressBar_constant_FILL_BEGIN_TO_END: @@ -123,7 +123,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **editor_preview_indeterminate** +:ref:`bool` **editor_preview_indeterminate** :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ If ``false``, the :ref:`indeterminate` .. rst-class:: classref-property -:ref:`int` **fill_mode** = ``0`` +:ref:`int` **fill_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ The fill direction. See :ref:`FillMode` for possible .. rst-class:: classref-property -:ref:`bool` **indeterminate** = ``false`` +:ref:`bool` **indeterminate** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ When set to ``true``, the progress bar indicates that something is happening wit .. rst-class:: classref-property -:ref:`bool` **show_percentage** = ``true`` +:ref:`bool` **show_percentage** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` The color of the text. @@ -208,7 +208,7 @@ The color of the text. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the **ProgressBar**. @@ -220,7 +220,7 @@ The tint of text outline of the **ProgressBar**. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -234,7 +234,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` Font used to draw the fill percentage if :ref:`show_percentage` is ``true``. @@ -246,7 +246,7 @@ Font used to draw the fill percentage if :ref:`show_percentage` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size used to draw the fill percentage if :ref:`show_percentage` is ``true``. @@ -258,7 +258,7 @@ Font size used to draw the fill percentage if :ref:`show_percentage` **background** +:ref:`StyleBox` **background** :ref:`🔗` The style of the background. @@ -270,7 +270,7 @@ The style of the background. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **fill** +:ref:`StyleBox` **fill** :ref:`🔗` The style of the progress (i.e. the part that fills the bar). diff --git a/classes/class_projection.rst b/classes/class_projection.rst index 90b0600165c..f9cd5d58242 100644 --- a/classes/class_projection.rst +++ b/classes/class_projection.rst @@ -158,7 +158,7 @@ Constants .. rst-class:: classref-constant -**PLANE_NEAR** = ``0`` +**PLANE_NEAR** = ``0`` :ref:`🔗` The index value of the projection's near clipping plane. @@ -166,7 +166,7 @@ The index value of the projection's near clipping plane. .. rst-class:: classref-constant -**PLANE_FAR** = ``1`` +**PLANE_FAR** = ``1`` :ref:`🔗` The index value of the projection's far clipping plane. @@ -174,7 +174,7 @@ The index value of the projection's far clipping plane. .. rst-class:: classref-constant -**PLANE_LEFT** = ``2`` +**PLANE_LEFT** = ``2`` :ref:`🔗` The index value of the projection's left clipping plane. @@ -182,7 +182,7 @@ The index value of the projection's left clipping plane. .. rst-class:: classref-constant -**PLANE_TOP** = ``3`` +**PLANE_TOP** = ``3`` :ref:`🔗` The index value of the projection's top clipping plane. @@ -190,7 +190,7 @@ The index value of the projection's top clipping plane. .. rst-class:: classref-constant -**PLANE_RIGHT** = ``4`` +**PLANE_RIGHT** = ``4`` :ref:`🔗` The index value of the projection's right clipping plane. @@ -198,7 +198,7 @@ The index value of the projection's right clipping plane. .. rst-class:: classref-constant -**PLANE_BOTTOM** = ``5`` +**PLANE_BOTTOM** = ``5`` :ref:`🔗` The index value of the projection bottom clipping plane. @@ -206,7 +206,7 @@ The index value of the projection bottom clipping plane. .. rst-class:: classref-constant -**IDENTITY** = ``Projection(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1)`` +**IDENTITY** = ``Projection(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1)`` :ref:`🔗` A **Projection** with no transformation defined. When applied to other data structures, no transformation is performed. @@ -214,7 +214,7 @@ A **Projection** with no transformation defined. When applied to other data stru .. rst-class:: classref-constant -**ZERO** = ``Projection(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)`` +**ZERO** = ``Projection(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)`` :ref:`🔗` A **Projection** with all values initialized to 0. When applied to other data structures, they will be zeroed. @@ -231,7 +231,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector4` **w** = ``Vector4(0, 0, 0, 1)`` +:ref:`Vector4` **w** = ``Vector4(0, 0, 0, 1)`` :ref:`🔗` The projection matrix's W vector (column 3). Equivalent to array index ``3``. @@ -243,7 +243,7 @@ The projection matrix's W vector (column 3). Equivalent to array index ``3``. .. rst-class:: classref-property -:ref:`Vector4` **x** = ``Vector4(1, 0, 0, 0)`` +:ref:`Vector4` **x** = ``Vector4(1, 0, 0, 0)`` :ref:`🔗` The projection matrix's X vector (column 0). Equivalent to array index ``0``. @@ -255,7 +255,7 @@ The projection matrix's X vector (column 0). Equivalent to array index ``0``. .. rst-class:: classref-property -:ref:`Vector4` **y** = ``Vector4(0, 1, 0, 0)`` +:ref:`Vector4` **y** = ``Vector4(0, 1, 0, 0)`` :ref:`🔗` The projection matrix's Y vector (column 1). Equivalent to array index ``1``. @@ -267,7 +267,7 @@ The projection matrix's Y vector (column 1). Equivalent to array index ``1``. .. rst-class:: classref-property -:ref:`Vector4` **z** = ``Vector4(0, 0, 1, 0)`` +:ref:`Vector4` **z** = ``Vector4(0, 0, 1, 0)`` :ref:`🔗` The projection matrix's Z vector (column 2). Equivalent to array index ``2``. @@ -284,7 +284,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Projection` **Projection**\ (\ ) +:ref:`Projection` **Projection**\ (\ ) :ref:`🔗` Constructs a default-initialized **Projection** set to :ref:`IDENTITY`. @@ -331,7 +331,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Projection` **create_depth_correction**\ (\ flip_y\: :ref:`bool`\ ) |static| +:ref:`Projection` **create_depth_correction**\ (\ flip_y\: :ref:`bool`\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions from a depth range of ``-1`` to ``1`` to one that ranges from ``0`` to ``1``, and flips the projected positions vertically, according to ``flip_y``. @@ -343,7 +343,7 @@ Creates a new **Projection** that projects positions from a depth range of ``-1` .. rst-class:: classref-method -:ref:`Projection` **create_fit_aabb**\ (\ aabb\: :ref:`AABB`\ ) |static| +:ref:`Projection` **create_fit_aabb**\ (\ aabb\: :ref:`AABB`\ ) |static| :ref:`🔗` Creates a new **Projection** that scales a given projection to fit around a given :ref:`AABB` in projection space. @@ -355,7 +355,7 @@ Creates a new **Projection** that scales a given projection to fit around a give .. rst-class:: classref-method -:ref:`Projection` **create_for_hmd**\ (\ eye\: :ref:`int`, aspect\: :ref:`float`, intraocular_dist\: :ref:`float`, display_width\: :ref:`float`, display_to_lens\: :ref:`float`, oversample\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| +:ref:`Projection` **create_for_hmd**\ (\ eye\: :ref:`int`, aspect\: :ref:`float`, intraocular_dist\: :ref:`float`, display_width\: :ref:`float`, display_to_lens\: :ref:`float`, oversample\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| :ref:`🔗` Creates a new **Projection** for projecting positions onto a head-mounted display with the given X:Y aspect ratio, distance between eyes, display width, distance to lens, oversampling factor, and depth clipping planes. @@ -369,7 +369,7 @@ Creates a new **Projection** for projecting positions onto a head-mounted displa .. rst-class:: classref-method -:ref:`Projection` **create_frustum**\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| +:ref:`Projection` **create_frustum**\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions in a frustum with the given clipping planes. @@ -381,7 +381,7 @@ Creates a new **Projection** that projects positions in a frustum with the given .. rst-class:: classref-method -:ref:`Projection` **create_frustum_aspect**\ (\ size\: :ref:`float`, aspect\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| +:ref:`Projection` **create_frustum_aspect**\ (\ size\: :ref:`float`, aspect\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions in a frustum with the given size, X:Y aspect ratio, offset, and clipping planes. @@ -395,7 +395,7 @@ Creates a new **Projection** that projects positions in a frustum with the given .. rst-class:: classref-method -:ref:`Projection` **create_light_atlas_rect**\ (\ rect\: :ref:`Rect2`\ ) |static| +:ref:`Projection` **create_light_atlas_rect**\ (\ rect\: :ref:`Rect2`\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions into the given :ref:`Rect2`. @@ -407,7 +407,7 @@ Creates a new **Projection** that projects positions into the given :ref:`Rect2< .. rst-class:: classref-method -:ref:`Projection` **create_orthogonal**\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| +:ref:`Projection` **create_orthogonal**\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions using an orthogonal projection with the given clipping planes. @@ -419,7 +419,7 @@ Creates a new **Projection** that projects positions using an orthogonal project .. rst-class:: classref-method -:ref:`Projection` **create_orthogonal_aspect**\ (\ size\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| +:ref:`Projection` **create_orthogonal_aspect**\ (\ size\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions using an orthogonal projection with the given size, X:Y aspect ratio, and clipping planes. @@ -433,7 +433,7 @@ Creates a new **Projection** that projects positions using an orthogonal project .. rst-class:: classref-method -:ref:`Projection` **create_perspective**\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| +:ref:`Projection` **create_perspective**\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions using a perspective projection with the given Y-axis field of view (in degrees), X:Y aspect ratio, and clipping planes. @@ -447,7 +447,7 @@ Creates a new **Projection** that projects positions using a perspective project .. rst-class:: classref-method -:ref:`Projection` **create_perspective_hmd**\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool`, eye\: :ref:`int`, intraocular_dist\: :ref:`float`, convergence_dist\: :ref:`float`\ ) |static| +:ref:`Projection` **create_perspective_hmd**\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool`, eye\: :ref:`int`, intraocular_dist\: :ref:`float`, convergence_dist\: :ref:`float`\ ) |static| :ref:`🔗` Creates a new **Projection** that projects positions using a perspective projection with the given Y-axis field of view (in degrees), X:Y aspect ratio, and clipping distances. The projection is adjusted for a head-mounted display with the given distance between eyes and distance to a point that can be focused on. @@ -463,7 +463,7 @@ Creates a new **Projection** that projects positions using a perspective project .. rst-class:: classref-method -:ref:`float` **determinant**\ (\ ) |const| +:ref:`float` **determinant**\ (\ ) |const| :ref:`🔗` Returns a scalar value that is the signed factor by which areas are scaled by this matrix. If the sign is negative, the matrix flips the orientation of the area. @@ -477,7 +477,7 @@ The determinant can be used to calculate the invertibility of a matrix or solve .. rst-class:: classref-method -:ref:`Projection` **flipped_y**\ (\ ) |const| +:ref:`Projection` **flipped_y**\ (\ ) |const| :ref:`🔗` Returns a copy of this **Projection** with the signs of the values of the Y column flipped. @@ -489,7 +489,7 @@ Returns a copy of this **Projection** with the signs of the values of the Y colu .. rst-class:: classref-method -:ref:`float` **get_aspect**\ (\ ) |const| +:ref:`float` **get_aspect**\ (\ ) |const| :ref:`🔗` Returns the X:Y aspect ratio of this **Projection**'s viewport. @@ -501,7 +501,7 @@ Returns the X:Y aspect ratio of this **Projection**'s viewport. .. rst-class:: classref-method -:ref:`Vector2` **get_far_plane_half_extents**\ (\ ) |const| +:ref:`Vector2` **get_far_plane_half_extents**\ (\ ) |const| :ref:`🔗` Returns the dimensions of the far clipping plane of the projection, divided by two. @@ -513,7 +513,7 @@ Returns the dimensions of the far clipping plane of the projection, divided by t .. rst-class:: classref-method -:ref:`float` **get_fov**\ (\ ) |const| +:ref:`float` **get_fov**\ (\ ) |const| :ref:`🔗` Returns the horizontal field of view of the projection (in degrees). @@ -525,7 +525,7 @@ Returns the horizontal field of view of the projection (in degrees). .. rst-class:: classref-method -:ref:`float` **get_fovy**\ (\ fovx\: :ref:`float`, aspect\: :ref:`float`\ ) |static| +:ref:`float` **get_fovy**\ (\ fovx\: :ref:`float`, aspect\: :ref:`float`\ ) |static| :ref:`🔗` Returns the vertical field of view of the projection (in degrees) associated with the given horizontal field of view (in degrees) and aspect ratio. @@ -537,7 +537,7 @@ Returns the vertical field of view of the projection (in degrees) associated wit .. rst-class:: classref-method -:ref:`float` **get_lod_multiplier**\ (\ ) |const| +:ref:`float` **get_lod_multiplier**\ (\ ) |const| :ref:`🔗` Returns the factor by which the visible level of detail is scaled by this **Projection**. @@ -549,7 +549,7 @@ Returns the factor by which the visible level of detail is scaled by this **Proj .. rst-class:: classref-method -:ref:`int` **get_pixels_per_meter**\ (\ for_pixel_width\: :ref:`int`\ ) |const| +:ref:`int` **get_pixels_per_meter**\ (\ for_pixel_width\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of pixels with the given pixel width displayed per meter, after this **Projection** is applied. @@ -561,7 +561,7 @@ Returns the number of pixels with the given pixel width displayed per meter, aft .. rst-class:: classref-method -:ref:`Plane` **get_projection_plane**\ (\ plane\: :ref:`int`\ ) |const| +:ref:`Plane` **get_projection_plane**\ (\ plane\: :ref:`int`\ ) |const| :ref:`🔗` Returns the clipping plane of this **Projection** whose index is given by ``plane``. @@ -575,7 +575,7 @@ Returns the clipping plane of this **Projection** whose index is given by ``plan .. rst-class:: classref-method -:ref:`Vector2` **get_viewport_half_extents**\ (\ ) |const| +:ref:`Vector2` **get_viewport_half_extents**\ (\ ) |const| :ref:`🔗` Returns the dimensions of the viewport plane that this **Projection** projects positions onto, divided by two. @@ -587,7 +587,7 @@ Returns the dimensions of the viewport plane that this **Projection** projects p .. rst-class:: classref-method -:ref:`float` **get_z_far**\ (\ ) |const| +:ref:`float` **get_z_far**\ (\ ) |const| :ref:`🔗` Returns the distance for this **Projection** beyond which positions are clipped. @@ -599,7 +599,7 @@ Returns the distance for this **Projection** beyond which positions are clipped. .. rst-class:: classref-method -:ref:`float` **get_z_near**\ (\ ) |const| +:ref:`float` **get_z_near**\ (\ ) |const| :ref:`🔗` Returns the distance for this **Projection** before which positions are clipped. @@ -611,7 +611,7 @@ Returns the distance for this **Projection** before which positions are clipped. .. rst-class:: classref-method -:ref:`Projection` **inverse**\ (\ ) |const| +:ref:`Projection` **inverse**\ (\ ) |const| :ref:`🔗` Returns a **Projection** that performs the inverse of this **Projection**'s projective transformation. @@ -623,7 +623,7 @@ Returns a **Projection** that performs the inverse of this **Projection**'s proj .. rst-class:: classref-method -:ref:`bool` **is_orthogonal**\ (\ ) |const| +:ref:`bool` **is_orthogonal**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Projection** performs an orthogonal projection. @@ -635,7 +635,7 @@ Returns ``true`` if this **Projection** performs an orthogonal projection. .. rst-class:: classref-method -:ref:`Projection` **jitter_offseted**\ (\ offset\: :ref:`Vector2`\ ) |const| +:ref:`Projection` **jitter_offseted**\ (\ offset\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a **Projection** with the X and Y values from the given :ref:`Vector2` added to the first and second values of the final column respectively. @@ -647,7 +647,7 @@ Returns a **Projection** with the X and Y values from the given :ref:`Vector2` **perspective_znear_adjusted**\ (\ new_znear\: :ref:`float`\ ) |const| +:ref:`Projection` **perspective_znear_adjusted**\ (\ new_znear\: :ref:`float`\ ) |const| :ref:`🔗` Returns a **Projection** with the near clipping distance adjusted to be ``new_znear``. @@ -666,7 +666,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Projection`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Projection`\ ) :ref:`🔗` Returns ``true`` if the projections are not equal. @@ -680,7 +680,7 @@ Returns ``true`` if the projections are not equal. .. rst-class:: classref-operator -:ref:`Projection` **operator ***\ (\ right\: :ref:`Projection`\ ) +:ref:`Projection` **operator ***\ (\ right\: :ref:`Projection`\ ) :ref:`🔗` Returns a **Projection** that applies the combined transformations of this **Projection** and ``right``. @@ -692,7 +692,7 @@ Returns a **Projection** that applies the combined transformations of this **Pro .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Projects (multiplies) the given :ref:`Vector4` by this **Projection** matrix. @@ -704,7 +704,7 @@ Projects (multiplies) the given :ref:`Vector4` by this **Projecti .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Projection`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Projection`\ ) :ref:`🔗` Returns ``true`` if the projections are equal. @@ -718,7 +718,7 @@ Returns ``true`` if the projections are equal. .. rst-class:: classref-operator -:ref:`Vector4` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Vector4` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the column of the **Projection** with the given index. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 496292ce884..f04fb10f045 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1679,7 +1679,7 @@ Signals .. rst-class:: classref-signal -**settings_changed**\ (\ ) +**settings_changed**\ (\ ) :ref:`🔗` Emitted when any setting is changed, up to once per process frame. @@ -1696,7 +1696,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **animation/warnings/check_angle_interpolation_type_conflicting** = ``true`` +:ref:`bool` **animation/warnings/check_angle_interpolation_type_conflicting** = ``true`` :ref:`🔗` If ``true``, :ref:`AnimationMixer` prints the warning of interpolation being forced to choose the shortest rotation path due to multiple angle interpolation types being mixed in the :ref:`AnimationMixer` cache. @@ -1708,7 +1708,7 @@ If ``true``, :ref:`AnimationMixer` prints the warning of i .. rst-class:: classref-property -:ref:`bool` **animation/warnings/check_invalid_track_paths** = ``true`` +:ref:`bool` **animation/warnings/check_invalid_track_paths** = ``true`` :ref:`🔗` If ``true``, :ref:`AnimationMixer` prints the warning of no matching object of the track path in the scene. @@ -1720,7 +1720,7 @@ If ``true``, :ref:`AnimationMixer` prints the warning of n .. rst-class:: classref-property -:ref:`Color` **application/boot_splash/bg_color** = ``Color(0.14, 0.14, 0.14, 1)`` +:ref:`Color` **application/boot_splash/bg_color** = ``Color(0.14, 0.14, 0.14, 1)`` :ref:`🔗` Background color for the boot splash. @@ -1732,7 +1732,7 @@ Background color for the boot splash. .. rst-class:: classref-property -:ref:`bool` **application/boot_splash/fullsize** = ``true`` +:ref:`bool` **application/boot_splash/fullsize** = ``true`` :ref:`🔗` If ``true``, scale the boot splash image to the full window size (preserving the aspect ratio) when the engine starts. If ``false``, the engine will leave it at the default pixel size. @@ -1744,7 +1744,7 @@ If ``true``, scale the boot splash image to the full window size (preserving the .. rst-class:: classref-property -:ref:`String` **application/boot_splash/image** = ``""`` +:ref:`String` **application/boot_splash/image** = ``""`` :ref:`🔗` Path to an image used as the boot splash. If left empty, the default Godot Engine splash will be displayed instead. @@ -1762,7 +1762,7 @@ Path to an image used as the boot splash. If left empty, the default Godot Engin .. rst-class:: classref-property -:ref:`int` **application/boot_splash/minimum_display_time** = ``0`` +:ref:`int` **application/boot_splash/minimum_display_time** = ``0`` :ref:`🔗` Minimum boot splash display time (in milliseconds). It is not recommended to set too high values for this setting. @@ -1774,7 +1774,7 @@ Minimum boot splash display time (in milliseconds). It is not recommended to set .. rst-class:: classref-property -:ref:`bool` **application/boot_splash/show_image** = ``true`` +:ref:`bool` **application/boot_splash/show_image** = ``true`` :ref:`🔗` If ``true``, displays the image specified in :ref:`application/boot_splash/image` when the engine starts. If ``false``, only displays the plain color specified in :ref:`application/boot_splash/bg_color`. @@ -1786,7 +1786,7 @@ If ``true``, displays the image specified in :ref:`application/boot_splash/image .. rst-class:: classref-property -:ref:`bool` **application/boot_splash/use_filter** = ``true`` +:ref:`bool` **application/boot_splash/use_filter** = ``true`` :ref:`🔗` If ``true``, applies linear filtering when scaling the image (recommended for high-resolution artwork). If ``false``, uses nearest-neighbor interpolation (recommended for pixel art). @@ -1798,7 +1798,7 @@ If ``true``, applies linear filtering when scaling the image (recommended for hi .. rst-class:: classref-property -:ref:`bool` **application/config/auto_accept_quit** = ``true`` +:ref:`bool` **application/config/auto_accept_quit** = ``true`` :ref:`🔗` If ``true``, the application automatically accepts quitting requests. @@ -1810,7 +1810,7 @@ If ``true``, the application automatically accepts quitting requests. .. rst-class:: classref-property -:ref:`String` **application/config/custom_user_dir_name** = ``""`` +:ref:`String` **application/config/custom_user_dir_name** = ``""`` :ref:`🔗` This user directory is used for storing persistent data (``user://`` filesystem). If a custom directory name is defined, this name will be appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). @@ -1824,7 +1824,7 @@ The :ref:`application/config/use_custom_user_dir` **application/config/description** = ``""`` +:ref:`String` **application/config/description** = ``""`` :ref:`🔗` The project's description, displayed as a tooltip in the Project Manager when hovering the project. @@ -1836,7 +1836,7 @@ The project's description, displayed as a tooltip in the Project Manager when ho .. rst-class:: classref-property -:ref:`String` **application/config/icon** = ``""`` +:ref:`String` **application/config/icon** = ``""`` :ref:`🔗` Icon used for the project, set when project loads. Exporters will also use this icon as a fallback if necessary. @@ -1848,7 +1848,7 @@ Icon used for the project, set when project loads. Exporters will also use this .. rst-class:: classref-property -:ref:`String` **application/config/macos_native_icon** = ``""`` +:ref:`String` **application/config/macos_native_icon** = ``""`` :ref:`🔗` Icon set in ``.icns`` format used on macOS to set the game's icon. This is done automatically on start by calling :ref:`DisplayServer.set_native_icon`. @@ -1860,7 +1860,7 @@ Icon set in ``.icns`` format used on macOS to set the game's icon. This is done .. rst-class:: classref-property -:ref:`String` **application/config/name** = ``""`` +:ref:`String` **application/config/name** = ``""`` :ref:`🔗` The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. The window title will be set to match the project name automatically on startup. @@ -1874,7 +1874,7 @@ The project's name. It is used both by the Project Manager and by exporters. The .. rst-class:: classref-property -:ref:`Dictionary` **application/config/name_localized** = ``{}`` +:ref:`Dictionary` **application/config/name_localized** = ``{}`` :ref:`🔗` Translations of the project's name. This setting is used by OS tools to translate application name on Android, iOS and macOS. @@ -1886,7 +1886,7 @@ Translations of the project's name. This setting is used by OS tools to translat .. rst-class:: classref-property -:ref:`String` **application/config/project_settings_override** = ``""`` +:ref:`String` **application/config/project_settings_override** = ``""`` :ref:`🔗` Specifies a file to override project settings. For example: ``user://custom_settings.cfg``. See "Overriding" in the **ProjectSettings** class description at the top for more information. @@ -1900,7 +1900,7 @@ Specifies a file to override project settings. For example: ``user://custom_sett .. rst-class:: classref-property -:ref:`bool` **application/config/quit_on_go_back** = ``true`` +:ref:`bool` **application/config/quit_on_go_back** = ``true`` :ref:`🔗` If ``true``, the application quits automatically when navigating back (e.g. using the system "Back" button on Android). @@ -1912,7 +1912,7 @@ If ``true``, the application quits automatically when navigating back (e.g. usin .. rst-class:: classref-property -:ref:`bool` **application/config/use_custom_user_dir** = ``false`` +:ref:`bool` **application/config/use_custom_user_dir** = ``false`` :ref:`🔗` If ``true``, the project will save user data to its own user directory. If :ref:`application/config/custom_user_dir_name` is empty, ``/`` directory will be used. If ``false``, the project will save user data to ``/Godot/app_userdata/``. @@ -1926,7 +1926,7 @@ See also `File paths in Godot projects <../tutorials/io/data_paths.html#accessin .. rst-class:: classref-property -:ref:`bool` **application/config/use_hidden_project_data_directory** = ``true`` +:ref:`bool` **application/config/use_hidden_project_data_directory** = ``true`` :ref:`🔗` If ``true``, the project will use a hidden directory (``.godot``) for storing project-specific data (metadata, shader cache, etc.). @@ -1944,7 +1944,7 @@ If ``false``, a non-hidden directory (``godot``) will be used instead. .. rst-class:: classref-property -:ref:`String` **application/config/version** = ``""`` +:ref:`String` **application/config/version** = ``""`` :ref:`🔗` The project's human-readable version identifier. This is used by exporters if the version identifier isn't overridden there. If :ref:`application/config/version` is an empty string and the version identifier isn't overridden in an exporter, the exporter will use ``1.0.0`` as a version identifier. @@ -1956,7 +1956,7 @@ The project's human-readable version identifier. This is used by exporters if th .. rst-class:: classref-property -:ref:`String` **application/config/windows_native_icon** = ``""`` +:ref:`String` **application/config/windows_native_icon** = ``""`` :ref:`🔗` Icon set in ``.ico`` format used on Windows to set the game's icon. This is done automatically on start by calling :ref:`DisplayServer.set_native_icon`. @@ -1968,7 +1968,7 @@ Icon set in ``.ico`` format used on Windows to set the game's icon. This is done .. rst-class:: classref-property -:ref:`bool` **application/run/delta_smoothing** = ``true`` +:ref:`bool` **application/run/delta_smoothing** = ``true`` :ref:`🔗` Time samples for frame deltas are subject to random variation introduced by the platform, even when frames are displayed at regular intervals thanks to V-Sync. This can lead to jitter. Delta smoothing can often give a better result by filtering the input deltas to correct for minor fluctuations from the refresh rate. @@ -1984,7 +1984,7 @@ It may take several seconds at a stable frame rate before the smoothing is initi .. rst-class:: classref-property -:ref:`bool` **application/run/disable_stderr** = ``false`` +:ref:`bool` **application/run/disable_stderr** = ``false`` :ref:`🔗` If ``true``, disables printing to standard error. If ``true``, this also hides error and warning messages printed by :ref:`@GlobalScope.push_error` and :ref:`@GlobalScope.push_warning`. See also :ref:`application/run/disable_stdout`. @@ -1998,7 +1998,7 @@ Changes to this setting will only be applied upon restarting the application. .. rst-class:: classref-property -:ref:`bool` **application/run/disable_stdout** = ``false`` +:ref:`bool` **application/run/disable_stdout** = ``false`` :ref:`🔗` If ``true``, disables printing to standard output. This is equivalent to starting the editor or project with the ``--quiet`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. See also :ref:`application/run/disable_stderr`. @@ -2012,7 +2012,7 @@ Changes to this setting will only be applied upon restarting the application. .. rst-class:: classref-property -:ref:`bool` **application/run/enable_alt_space_menu** = ``false`` +:ref:`bool` **application/run/enable_alt_space_menu** = ``false`` :ref:`🔗` If ``true``, allows the :kbd:`Alt + Space` keys to display the window menu. This menu allows the user to perform various window management operations such as moving, resizing, or minimizing the window. @@ -2028,7 +2028,7 @@ If ``true``, allows the :kbd:`Alt + Space` keys to display the window menu. This .. rst-class:: classref-property -:ref:`bool` **application/run/flush_stdout_on_print** = ``false`` +:ref:`bool` **application/run/flush_stdout_on_print** = ``false`` :ref:`🔗` If ``true``, flushes the standard output stream every time a line is printed. This affects both terminal logging and file logging. @@ -2046,7 +2046,7 @@ Changes to this setting will only be applied upon restarting the application. .. rst-class:: classref-property -:ref:`bool` **application/run/flush_stdout_on_print.debug** = ``true`` +:ref:`bool` **application/run/flush_stdout_on_print.debug** = ``true`` :ref:`🔗` Debug build override for :ref:`application/run/flush_stdout_on_print`, as performance is less important during debugging. @@ -2060,7 +2060,7 @@ Changes to this setting will only be applied upon restarting the application. .. rst-class:: classref-property -:ref:`int` **application/run/frame_delay_msec** = ``0`` +:ref:`int` **application/run/frame_delay_msec** = ``0`` :ref:`🔗` Forces a *constant* delay between frames in the main loop (in milliseconds). In most situations, :ref:`application/run/max_fps` should be preferred as an FPS limiter as it's more precise. @@ -2074,7 +2074,7 @@ This setting can be overridden using the ``--frame-delay `` command line ar .. rst-class:: classref-property -:ref:`bool` **application/run/low_processor_mode** = ``false`` +:ref:`bool` **application/run/low_processor_mode** = ``false`` :ref:`🔗` If ``true``, enables low-processor usage mode. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. @@ -2086,7 +2086,7 @@ If ``true``, enables low-processor usage mode. The screen is not redrawn if noth .. rst-class:: classref-property -:ref:`int` **application/run/low_processor_mode_sleep_usec** = ``6900`` +:ref:`int` **application/run/low_processor_mode_sleep_usec** = ``6900`` :ref:`🔗` Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage. @@ -2098,7 +2098,7 @@ Amount of sleeping between frames when the low-processor usage mode is enabled ( .. rst-class:: classref-property -:ref:`String` **application/run/main_loop_type** = ``"SceneTree"`` +:ref:`String` **application/run/main_loop_type** = ``"SceneTree"`` :ref:`🔗` The name of the type implementing the engine's main loop. @@ -2110,7 +2110,7 @@ The name of the type implementing the engine's main loop. .. rst-class:: classref-property -:ref:`String` **application/run/main_scene** = ``""`` +:ref:`String` **application/run/main_scene** = ``""`` :ref:`🔗` Path to the main scene file that will be loaded when the project runs. @@ -2122,7 +2122,7 @@ Path to the main scene file that will be loaded when the project runs. .. rst-class:: classref-property -:ref:`int` **application/run/max_fps** = ``0`` +:ref:`int` **application/run/max_fps** = ``0`` :ref:`🔗` Maximum number of frames per second allowed. A value of ``0`` means "no limit". The actual number of frames per second may still be below this value if the CPU or GPU cannot keep up with the project logic and rendering. @@ -2148,7 +2148,7 @@ This setting can be overridden using the ``--max-fps `` command line argume .. rst-class:: classref-property -:ref:`bool` **application/run/print_header** = ``true`` +:ref:`bool` **application/run/print_header** = ``true`` :ref:`🔗` If ``true``, the engine header is printed in the console on startup. This header describes the current version of the engine, as well as the renderer being used. This behavior can also be disabled on the command line with the ``--no-header`` option. @@ -2160,7 +2160,7 @@ If ``true``, the engine header is printed in the console on startup. This header .. rst-class:: classref-property -:ref:`float` **audio/buses/channel_disable_threshold_db** = ``-60.0`` +:ref:`float` **audio/buses/channel_disable_threshold_db** = ``-60.0`` :ref:`🔗` Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. @@ -2172,7 +2172,7 @@ Audio buses will disable automatically when sound goes below a given dB threshol .. rst-class:: classref-property -:ref:`float` **audio/buses/channel_disable_time** = ``2.0`` +:ref:`float` **audio/buses/channel_disable_time** = ``2.0`` :ref:`🔗` Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. @@ -2184,7 +2184,7 @@ Audio buses will disable automatically when sound goes below a given dB threshol .. rst-class:: classref-property -:ref:`String` **audio/buses/default_bus_layout** = ``"res://default_bus_layout.tres"`` +:ref:`String` **audio/buses/default_bus_layout** = ``"res://default_bus_layout.tres"`` :ref:`🔗` Default :ref:`AudioBusLayout` resource file to use in the project, unless overridden by the scene. @@ -2196,7 +2196,7 @@ Default :ref:`AudioBusLayout` resource file to use in the .. rst-class:: classref-property -:ref:`String` **audio/driver/driver** +:ref:`String` **audio/driver/driver** :ref:`🔗` Specifies the audio driver to use. This setting is platform-dependent as each platform supports different audio drivers. If left empty, the default audio driver will be used. @@ -2212,7 +2212,7 @@ The ``Dummy`` audio driver disables all audio playback and recording, which is u .. rst-class:: classref-property -:ref:`bool` **audio/driver/enable_input** = ``false`` +:ref:`bool` **audio/driver/enable_input** = ``false`` :ref:`🔗` If ``true``, microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS. @@ -2226,7 +2226,7 @@ If ``true``, microphone input will be allowed. This requires appropriate permiss .. rst-class:: classref-property -:ref:`int` **audio/driver/mix_rate** = ``44100`` +:ref:`int` **audio/driver/mix_rate** = ``44100`` :ref:`🔗` The mixing rate used for audio (in Hz). In general, it's better to not touch this and leave it to the host operating system. @@ -2238,7 +2238,7 @@ The mixing rate used for audio (in Hz). In general, it's better to not touch thi .. rst-class:: classref-property -:ref:`int` **audio/driver/mix_rate.web** = ``0`` +:ref:`int` **audio/driver/mix_rate.web** = ``0`` :ref:`🔗` Safer override for :ref:`audio/driver/mix_rate` in the Web platform. Here ``0`` means "let the browser choose" (since some browsers do not like forcing the mix rate). @@ -2250,7 +2250,7 @@ Safer override for :ref:`audio/driver/mix_rate` **audio/driver/output_latency** = ``15`` +:ref:`int` **audio/driver/output_latency** = ``15`` :ref:`🔗` Specifies the preferred output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. @@ -2268,7 +2268,7 @@ Audio output latency can be overridden using the ``--audio-output-latency `` .. rst-class:: classref-property -:ref:`int` **audio/driver/output_latency.web** = ``50`` +:ref:`int` **audio/driver/output_latency.web** = ``50`` :ref:`🔗` Safer override for :ref:`audio/driver/output_latency` in the Web platform, to avoid audio issues especially on mobile devices. @@ -2280,7 +2280,7 @@ Safer override for :ref:`audio/driver/output_latency` **audio/general/2d_panning_strength** = ``0.5`` +:ref:`float` **audio/general/2d_panning_strength** = ``0.5`` :ref:`🔗` The base strength of the panning effect for all :ref:`AudioStreamPlayer2D` nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer2D.panning_strength`. A value of ``0.0`` disables stereo panning entirely, leaving only volume attenuation in place. A value of ``1.0`` completely mutes one of the channels if the sound is located exactly to the left (or right) of the listener. @@ -2294,7 +2294,7 @@ The default value of ``0.5`` is tuned for headphones. When using speakers, you m .. rst-class:: classref-property -:ref:`float` **audio/general/3d_panning_strength** = ``0.5`` +:ref:`float` **audio/general/3d_panning_strength** = ``0.5`` :ref:`🔗` The base strength of the panning effect for all :ref:`AudioStreamPlayer3D` nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer3D.panning_strength`. A value of ``0.0`` disables stereo panning entirely, leaving only volume attenuation in place. A value of ``1.0`` completely mutes one of the channels if the sound is located exactly to the left (or right) of the listener. @@ -2308,7 +2308,7 @@ The default value of ``0.5`` is tuned for headphones. When using speakers, you m .. rst-class:: classref-property -:ref:`bool` **audio/general/ios/mix_with_others** = ``false`` +:ref:`bool` **audio/general/ios/mix_with_others** = ``false`` :ref:`🔗` Sets the `mixWithOthers `__ option for the AVAudioSession on iOS. This will override the mix behavior, if the category is set to ``Play and Record``, ``Playback``, or ``Multi Route``. @@ -2322,7 +2322,7 @@ Sets the `mixWithOthers ` **audio/general/ios/session_category** = ``0`` +:ref:`int` **audio/general/ios/session_category** = ``0`` :ref:`🔗` Sets the `AVAudioSessionCategory `__ on iOS. Use the ``Playback`` category to get sound output, even if the phone is in silent mode. @@ -2334,7 +2334,7 @@ Sets the `AVAudioSessionCategory ` **audio/general/text_to_speech** = ``false`` +:ref:`bool` **audio/general/text_to_speech** = ``false`` :ref:`🔗` If ``true``, text-to-speech support is enabled, see :ref:`DisplayServer.tts_get_voices` and :ref:`DisplayServer.tts_speak`. @@ -2348,7 +2348,7 @@ If ``true``, text-to-speech support is enabled, see :ref:`DisplayServer.tts_get_ .. rst-class:: classref-property -:ref:`int` **audio/video/video_delay_compensation_ms** = ``0`` +:ref:`int` **audio/video/video_delay_compensation_ms** = ``0`` :ref:`🔗` Setting to hardcode audio delay when playing video. Best to leave this unchanged unless you know what you are doing. @@ -2360,7 +2360,7 @@ Setting to hardcode audio delay when playing video. Best to leave this unchanged .. rst-class:: classref-property -:ref:`bool` **collada/use_ambient** = ``false`` +:ref:`bool` **collada/use_ambient** = ``false`` :ref:`🔗` If ``true``, ambient lights will be imported from COLLADA models as :ref:`DirectionalLight3D`. If ``false``, ambient lights will be ignored. @@ -2372,7 +2372,7 @@ If ``true``, ambient lights will be imported from COLLADA models as :ref:`Direct .. rst-class:: classref-property -:ref:`int` **compression/formats/gzip/compression_level** = ``-1`` +:ref:`int` **compression/formats/gzip/compression_level** = ``-1`` :ref:`🔗` The default compression level for gzip. Affects compressed scenes and resources. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. ``-1`` uses the default gzip compression level, which is identical to ``6`` but could change in the future due to underlying zlib updates. @@ -2384,7 +2384,7 @@ The default compression level for gzip. Affects compressed scenes and resources. .. rst-class:: classref-property -:ref:`int` **compression/formats/zlib/compression_level** = ``-1`` +:ref:`int` **compression/formats/zlib/compression_level** = ``-1`` :ref:`🔗` The default compression level for Zlib. Affects compressed scenes and resources. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. ``-1`` uses the default gzip compression level, which is identical to ``6`` but could change in the future due to underlying zlib updates. @@ -2396,7 +2396,7 @@ The default compression level for Zlib. Affects compressed scenes and resources. .. rst-class:: classref-property -:ref:`int` **compression/formats/zstd/compression_level** = ``3`` +:ref:`int` **compression/formats/zstd/compression_level** = ``3`` :ref:`🔗` The default compression level for Zstandard. Affects compressed scenes and resources. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. @@ -2408,7 +2408,7 @@ The default compression level for Zstandard. Affects compressed scenes and resou .. rst-class:: classref-property -:ref:`bool` **compression/formats/zstd/long_distance_matching** = ``false`` +:ref:`bool` **compression/formats/zstd/long_distance_matching** = ``false`` :ref:`🔗` Enables `long-distance matching `__ in Zstandard. @@ -2420,7 +2420,7 @@ Enables `long-distance matching ` **compression/formats/zstd/window_log_size** = ``27`` +:ref:`int` **compression/formats/zstd/window_log_size** = ``27`` :ref:`🔗` Largest size limit (in power of 2) allowed when compressing using long-distance matching with Zstandard. Higher values can result in better compression, but will require more memory when compressing and decompressing. @@ -2432,7 +2432,7 @@ Largest size limit (in power of 2) allowed when compressing using long-distance .. rst-class:: classref-property -:ref:`Color` **debug/canvas_items/debug_redraw_color** = ``Color(1, 0.2, 0.2, 0.5)`` +:ref:`Color` **debug/canvas_items/debug_redraw_color** = ``Color(1, 0.2, 0.2, 0.5)`` :ref:`🔗` If canvas item redraw debugging is active, this color will be flashed on canvas items when they redraw. @@ -2444,7 +2444,7 @@ If canvas item redraw debugging is active, this color will be flashed on canvas .. rst-class:: classref-property -:ref:`float` **debug/canvas_items/debug_redraw_time** = ``1.0`` +:ref:`float` **debug/canvas_items/debug_redraw_time** = ``1.0`` :ref:`🔗` If canvas item redraw debugging is active, this will be the time the flash will last each time they redraw. @@ -2456,7 +2456,7 @@ If canvas item redraw debugging is active, this will be the time the flash will .. rst-class:: classref-property -:ref:`bool` **debug/file_logging/enable_file_logging** = ``false`` +:ref:`bool` **debug/file_logging/enable_file_logging** = ``false`` :ref:`🔗` If ``true``, logs all output and error messages to files. See also :ref:`debug/file_logging/log_path`, :ref:`debug/file_logging/max_log_files`, and :ref:`application/run/flush_stdout_on_print`. @@ -2468,7 +2468,7 @@ If ``true``, logs all output and error messages to files. See also :ref:`debug/f .. rst-class:: classref-property -:ref:`bool` **debug/file_logging/enable_file_logging.pc** = ``true`` +:ref:`bool` **debug/file_logging/enable_file_logging.pc** = ``true`` :ref:`🔗` Desktop override for :ref:`debug/file_logging/enable_file_logging`, as log files are not readily accessible on mobile/Web platforms. @@ -2480,7 +2480,7 @@ Desktop override for :ref:`debug/file_logging/enable_file_logging` **debug/file_logging/log_path** = ``"user://logs/godot.log"`` +:ref:`String` **debug/file_logging/log_path** = ``"user://logs/godot.log"`` :ref:`🔗` Path at which to store log files for the project. Using a path under ``user://`` is recommended. @@ -2494,7 +2494,7 @@ This can be specified manually on the command line using the ``--log-file .. rst-class:: classref-property -:ref:`int` **debug/file_logging/max_log_files** = ``5`` +:ref:`int` **debug/file_logging/max_log_files** = ``5`` :ref:`🔗` Specifies the maximum number of log files allowed (used for rotation). Set to ``1`` to disable log file rotation. @@ -2508,7 +2508,7 @@ If the ``--log-file `` :doc:`command line argument <../tutorials/editor/co .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/assert_always_false** = ``1`` +:ref:`int` **debug/gdscript/warnings/assert_always_false** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an ``assert`` call always evaluates to false. @@ -2520,7 +2520,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/assert_always_true** = ``1`` +:ref:`int` **debug/gdscript/warnings/assert_always_true** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an ``assert`` call always evaluates to true. @@ -2532,7 +2532,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/confusable_identifier** = ``1`` +:ref:`int` **debug/gdscript/warnings/confusable_identifier** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an identifier contains characters that can be confused with something else, like when mixing different alphabets. @@ -2544,7 +2544,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/confusable_local_declaration** = ``1`` +:ref:`int` **debug/gdscript/warnings/confusable_local_declaration** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an identifier declared in the nested block has the same name as an identifier declared below in the parent block. @@ -2556,7 +2556,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/confusable_local_usage** = ``1`` +:ref:`int` **debug/gdscript/warnings/confusable_local_usage** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an identifier that will be shadowed below in the block is used. @@ -2568,7 +2568,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/constant_used_as_function** = ``1`` +:ref:`int` **debug/gdscript/warnings/constant_used_as_function** = ``1`` :ref:`🔗` **Deprecated:** This warning is never produced. Instead, an error is generated if the expression type is known at compile time. @@ -2582,7 +2582,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/deprecated_keyword** = ``1`` +:ref:`int` **debug/gdscript/warnings/deprecated_keyword** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when deprecated keywords are used. @@ -2596,7 +2596,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/empty_file** = ``1`` +:ref:`int` **debug/gdscript/warnings/empty_file** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an empty file is parsed. @@ -2608,7 +2608,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/enable** = ``true`` +:ref:`bool` **debug/gdscript/warnings/enable** = ``true`` :ref:`🔗` If ``true``, enables specific GDScript warnings (see ``debug/gdscript/warnings/*`` settings). If ``false``, disables all GDScript warnings. @@ -2620,7 +2620,7 @@ If ``true``, enables specific GDScript warnings (see ``debug/gdscript/warnings/* .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/enum_variable_without_default** = ``1`` +:ref:`int` **debug/gdscript/warnings/enum_variable_without_default** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable has an enum type but no explicit default value, but only if the enum does not contain ``0`` as a valid value. @@ -2632,7 +2632,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/exclude_addons** = ``true`` +:ref:`bool` **debug/gdscript/warnings/exclude_addons** = ``true`` :ref:`🔗` If ``true``, scripts in the ``res://addons`` folder will not generate warnings. @@ -2644,7 +2644,7 @@ If ``true``, scripts in the ``res://addons`` folder will not generate warnings. .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/function_used_as_property** = ``1`` +:ref:`int` **debug/gdscript/warnings/function_used_as_property** = ``1`` :ref:`🔗` **Deprecated:** This warning is never produced. When a function is used as a property, a :ref:`Callable` is returned. @@ -2658,7 +2658,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/get_node_default_without_onready** = ``2`` +:ref:`int` **debug/gdscript/warnings/get_node_default_without_onready** = ``2`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when :ref:`Node.get_node` (or the shorthand ``$``) is used as default value of a class variable without the ``@onready`` annotation. @@ -2670,7 +2670,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/incompatible_ternary** = ``1`` +:ref:`int` **debug/gdscript/warnings/incompatible_ternary** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a ternary operator may emit values with incompatible types. @@ -2682,7 +2682,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/inference_on_variant** = ``2`` +:ref:`int` **debug/gdscript/warnings/inference_on_variant** = ``2`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a static inferred type uses a :ref:`Variant` as initial value, which makes the static type to also be Variant. @@ -2694,7 +2694,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/inferred_declaration** = ``0`` +:ref:`int` **debug/gdscript/warnings/inferred_declaration** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type. @@ -2708,7 +2708,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/int_as_enum_without_cast** = ``1`` +:ref:`int` **debug/gdscript/warnings/int_as_enum_without_cast** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when trying to use an integer as an enum without an explicit cast. @@ -2720,7 +2720,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/int_as_enum_without_match** = ``1`` +:ref:`int` **debug/gdscript/warnings/int_as_enum_without_match** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when trying to use an integer as an enum when there is no matching enum member for that numeric value. @@ -2732,7 +2732,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/integer_division** = ``1`` +:ref:`int` **debug/gdscript/warnings/integer_division** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when dividing an integer by another integer (the decimal part will be discarded). @@ -2744,7 +2744,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/narrowing_conversion** = ``1`` +:ref:`int` **debug/gdscript/warnings/narrowing_conversion** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). @@ -2756,7 +2756,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/native_method_override** = ``2`` +:ref:`int` **debug/gdscript/warnings/native_method_override** = ``2`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a method in the script overrides a native method, because it may not behave as expected. @@ -2768,7 +2768,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/onready_with_export** = ``2`` +:ref:`int` **debug/gdscript/warnings/onready_with_export** = ``2`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when the ``@onready`` annotation is used together with the ``@export`` annotation, since it may not behave as expected. @@ -2780,7 +2780,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/property_used_as_function** = ``1`` +:ref:`int` **debug/gdscript/warnings/property_used_as_function** = ``1`` :ref:`🔗` **Deprecated:** This warning is never produced. Instead, an error is generated if the expression type is known at compile time. @@ -2794,7 +2794,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/redundant_await** = ``1`` +:ref:`int` **debug/gdscript/warnings/redundant_await** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a function that is not a coroutine is called with await. @@ -2806,7 +2806,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/redundant_static_unload** = ``1`` +:ref:`int` **debug/gdscript/warnings/redundant_static_unload** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when the ``@static_unload`` annotation is used in a script without any static variables. @@ -2818,7 +2818,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/renamed_in_godot_4_hint** = ``1`` +:ref:`bool` **debug/gdscript/warnings/renamed_in_godot_4_hint** = ``1`` :ref:`🔗` When enabled, using a property, enum, or function that was renamed since Godot 3 will produce a hint if an error occurs. @@ -2830,7 +2830,7 @@ When enabled, using a property, enum, or function that was renamed since Godot 3 .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/return_value_discarded** = ``0`` +:ref:`int` **debug/gdscript/warnings/return_value_discarded** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a function without using its return value (by assigning it to a variable or using it as a function argument). These return values are sometimes used to indicate possible errors using the :ref:`Error` enum. @@ -2842,7 +2842,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/shadowed_global_identifier** = ``1`` +:ref:`int` **debug/gdscript/warnings/shadowed_global_identifier** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when defining a local or member variable, signal, or enum that would have the same name as a built-in function or global class name, thus shadowing it. @@ -2854,7 +2854,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/shadowed_variable** = ``1`` +:ref:`int` **debug/gdscript/warnings/shadowed_variable** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when defining a local or member variable that would shadow a member variable that the class defines. @@ -2866,7 +2866,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/shadowed_variable_base_class** = ``1`` +:ref:`int` **debug/gdscript/warnings/shadowed_variable_base_class** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when defining a local or subclass member variable that would shadow a variable that is inherited from a parent class. @@ -2878,7 +2878,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/standalone_expression** = ``1`` +:ref:`int` **debug/gdscript/warnings/standalone_expression** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when calling an expression that may have no effect on the surrounding code, such as writing ``2 + 2`` as a statement. @@ -2890,7 +2890,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/standalone_ternary** = ``1`` +:ref:`int` **debug/gdscript/warnings/standalone_ternary** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a ternary expression that may have no effect on the surrounding code, such as writing ``42 if active else 0`` as a statement. @@ -2902,7 +2902,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/static_called_on_instance** = ``1`` +:ref:`int` **debug/gdscript/warnings/static_called_on_instance** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a static method from an instance of a class instead of from the class directly. @@ -2914,7 +2914,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unassigned_variable** = ``1`` +:ref:`int` **debug/gdscript/warnings/unassigned_variable** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when using a variable that wasn't previously assigned. @@ -2926,7 +2926,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unassigned_variable_op_assign** = ``1`` +:ref:`int` **debug/gdscript/warnings/unassigned_variable_op_assign** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when assigning a variable using an assignment operator like ``+=`` if the variable wasn't previously assigned. @@ -2938,7 +2938,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unreachable_code** = ``1`` +:ref:`int` **debug/gdscript/warnings/unreachable_code** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when unreachable code is detected (such as after a ``return`` statement that will always be executed). @@ -2950,7 +2950,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unreachable_pattern** = ``1`` +:ref:`int` **debug/gdscript/warnings/unreachable_pattern** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when an unreachable ``match`` pattern is detected. @@ -2962,7 +2962,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unsafe_call_argument** = ``0`` +:ref:`int` **debug/gdscript/warnings/unsafe_call_argument** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when using an expression whose type may not be compatible with the function parameter expected. @@ -2974,7 +2974,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unsafe_cast** = ``0`` +:ref:`int` **debug/gdscript/warnings/unsafe_cast** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a :ref:`Variant` value is cast to a non-Variant. @@ -2986,7 +2986,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unsafe_method_access** = ``0`` +:ref:`int` **debug/gdscript/warnings/unsafe_method_access** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a method whose presence is not guaranteed at compile-time in the class. @@ -2998,7 +2998,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unsafe_property_access** = ``0`` +:ref:`int` **debug/gdscript/warnings/unsafe_property_access** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when accessing a property whose presence is not guaranteed at compile-time in the class. @@ -3010,7 +3010,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unsafe_void_return** = ``1`` +:ref:`int` **debug/gdscript/warnings/unsafe_void_return** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when returning a call from a ``void`` function when such call cannot be guaranteed to be also ``void``. @@ -3022,7 +3022,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/untyped_declaration** = ``0`` +:ref:`int` **debug/gdscript/warnings/untyped_declaration** = ``0`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable or parameter has no static type, or if a function has no static return type. @@ -3036,7 +3036,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unused_local_constant** = ``1`` +:ref:`int` **debug/gdscript/warnings/unused_local_constant** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a local constant is never used. @@ -3048,7 +3048,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unused_parameter** = ``1`` +:ref:`int` **debug/gdscript/warnings/unused_parameter** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a function parameter is never used. @@ -3060,7 +3060,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unused_private_class_variable** = ``1`` +:ref:`int` **debug/gdscript/warnings/unused_private_class_variable** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a private member variable is never used. @@ -3072,7 +3072,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unused_signal** = ``1`` +:ref:`int` **debug/gdscript/warnings/unused_signal** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a signal is declared but never explicitly used in the class. @@ -3084,7 +3084,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/unused_variable** = ``1`` +:ref:`int` **debug/gdscript/warnings/unused_variable** = ``1`` :ref:`🔗` When set to ``warn`` or ``error``, produces a warning or an error respectively when a local variable is unused. @@ -3096,7 +3096,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`String` **debug/settings/crash_handler/message** = ``"Please include this when reporting the bug to the project developer."`` +:ref:`String` **debug/settings/crash_handler/message** = ``"Please include this when reporting the bug to the project developer."`` :ref:`🔗` Message to be displayed before the backtrace when the engine crashes. By default, this message is only used in exported projects due to the editor-only override applied to this setting. @@ -3108,7 +3108,7 @@ Message to be displayed before the backtrace when the engine crashes. By default .. rst-class:: classref-property -:ref:`String` **debug/settings/crash_handler/message.editor** = ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` +:ref:`String` **debug/settings/crash_handler/message.editor** = ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` :ref:`🔗` Editor-only override for :ref:`debug/settings/crash_handler/message`. Does not affect exported projects in debug or release mode. @@ -3120,7 +3120,7 @@ Editor-only override for :ref:`debug/settings/crash_handler/message` **debug/settings/gdscript/max_call_stack** = ``1024`` +:ref:`int` **debug/settings/gdscript/max_call_stack** = ``1024`` :ref:`🔗` Maximum call stack allowed for debugging GDScript. @@ -3132,7 +3132,7 @@ Maximum call stack allowed for debugging GDScript. .. rst-class:: classref-property -:ref:`int` **debug/settings/profiler/max_functions** = ``16384`` +:ref:`int` **debug/settings/profiler/max_functions** = ``16384`` :ref:`🔗` Maximum number of functions per frame allowed when profiling. @@ -3144,7 +3144,7 @@ Maximum number of functions per frame allowed when profiling. .. rst-class:: classref-property -:ref:`bool` **debug/settings/stdout/print_fps** = ``false`` +:ref:`bool` **debug/settings/stdout/print_fps** = ``false`` :ref:`🔗` Print frames per second to standard output every second. @@ -3156,7 +3156,7 @@ Print frames per second to standard output every second. .. rst-class:: classref-property -:ref:`bool` **debug/settings/stdout/print_gpu_profile** = ``false`` +:ref:`bool` **debug/settings/stdout/print_gpu_profile** = ``false`` :ref:`🔗` Print GPU profile information to standard output every second. This includes how long each frame takes the GPU to render on average, broken down into different steps of the render pipeline, such as CanvasItems, shadows, glow, etc. @@ -3168,7 +3168,7 @@ Print GPU profile information to standard output every second. This includes how .. rst-class:: classref-property -:ref:`bool` **debug/settings/stdout/verbose_stdout** = ``false`` +:ref:`bool` **debug/settings/stdout/verbose_stdout** = ``false`` :ref:`🔗` Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc. This can also be enabled using the ``--verbose`` or ``-v`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`, even on an exported project. See also :ref:`OS.is_stdout_verbose` and :ref:`@GlobalScope.print_verbose`. @@ -3180,7 +3180,7 @@ Print more information to standard output when running. It displays information .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/device_limit_exceeded** = ``true`` +:ref:`bool` **debug/shader_language/warnings/device_limit_exceeded** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when the shader exceeds certain device limits. Currently, the only device limit checked is the limit on uniform buffer size. More device limits will be added in the future. @@ -3192,7 +3192,7 @@ When set to ``true``, produces a warning when the shader exceeds certain device .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/enable** = ``true`` +:ref:`bool` **debug/shader_language/warnings/enable** = ``true`` :ref:`🔗` If ``true``, enables specific shader warnings (see ``debug/shader_language/warnings/*`` settings). If ``false``, disables all shader warnings. @@ -3204,7 +3204,7 @@ If ``true``, enables specific shader warnings (see ``debug/shader_language/warni .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/float_comparison** = ``true`` +:ref:`bool` **debug/shader_language/warnings/float_comparison** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when two floating-point numbers are compared directly with the ``==`` operator or the ``!=`` operator. @@ -3216,7 +3216,7 @@ When set to ``true``, produces a warning when two floating-point numbers are com .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/formatting_error** = ``true`` +:ref:`bool` **debug/shader_language/warnings/formatting_error** = ``true`` :ref:`🔗` When set to ``true``, produces a warning upon encountering certain formatting errors. Currently this only checks for empty statements. More formatting errors may be added over time. @@ -3228,7 +3228,7 @@ When set to ``true``, produces a warning upon encountering certain formatting er .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/magic_position_write** = ``true`` +:ref:`bool` **debug/shader_language/warnings/magic_position_write** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when the shader contains ``POSITION = vec4(vertex,`` as this was very common code written in Godot 4.2 and earlier that was paired with a QuadMesh to produce a full screen post processes pass. With the switch to reversed z in 4.3, this trick no longer works, as it implicitly relied on the ``VERTEX.z`` being 0. @@ -3240,7 +3240,7 @@ When set to ``true``, produces a warning when the shader contains ``POSITION = v .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/treat_warnings_as_errors** = ``false`` +:ref:`bool` **debug/shader_language/warnings/treat_warnings_as_errors** = ``false`` :ref:`🔗` When set to ``true``, warnings are treated as errors. @@ -3252,7 +3252,7 @@ When set to ``true``, warnings are treated as errors. .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/unused_constant** = ``true`` +:ref:`bool` **debug/shader_language/warnings/unused_constant** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when a constant is never used. @@ -3264,7 +3264,7 @@ When set to ``true``, produces a warning when a constant is never used. .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/unused_function** = ``true`` +:ref:`bool` **debug/shader_language/warnings/unused_function** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when a function is never used. @@ -3276,7 +3276,7 @@ When set to ``true``, produces a warning when a function is never used. .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/unused_local_variable** = ``true`` +:ref:`bool` **debug/shader_language/warnings/unused_local_variable** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when a local variable is never used. @@ -3288,7 +3288,7 @@ When set to ``true``, produces a warning when a local variable is never used. .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/unused_struct** = ``true`` +:ref:`bool` **debug/shader_language/warnings/unused_struct** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when a struct is never used. @@ -3300,7 +3300,7 @@ When set to ``true``, produces a warning when a struct is never used. .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/unused_uniform** = ``true`` +:ref:`bool` **debug/shader_language/warnings/unused_uniform** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when a uniform is never used. @@ -3312,7 +3312,7 @@ When set to ``true``, produces a warning when a uniform is never used. .. rst-class:: classref-property -:ref:`bool` **debug/shader_language/warnings/unused_varying** = ``true`` +:ref:`bool` **debug/shader_language/warnings/unused_varying** = ``true`` :ref:`🔗` When set to ``true``, produces a warning when a varying is never used. @@ -3324,7 +3324,7 @@ When set to ``true``, produces a warning when a varying is never used. .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` +:ref:`Color` **debug/shapes/avoidance/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` Color of the avoidance agents radius, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3336,7 +3336,7 @@ Color of the avoidance agents radius, visible when "Visible Avoidance" is enable .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_agents_radius** = ``true`` +:ref:`bool` **debug/shapes/avoidance/enable_agents_radius** = ``true`` :ref:`🔗` If enabled, displays avoidance agents radius when "Visible Avoidance" is enabled in the Debug menu. @@ -3348,7 +3348,7 @@ If enabled, displays avoidance agents radius when "Visible Avoidance" is enabled .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_obstacles_radius** = ``true`` +:ref:`bool` **debug/shapes/avoidance/enable_obstacles_radius** = ``true`` :ref:`🔗` If enabled, displays avoidance obstacles radius when "Visible Avoidance" is enabled in the Debug menu. @@ -3360,7 +3360,7 @@ If enabled, displays avoidance obstacles radius when "Visible Avoidance" is enab .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_obstacles_static** = ``true`` +:ref:`bool` **debug/shapes/avoidance/enable_obstacles_static** = ``true`` :ref:`🔗` If enabled, displays static avoidance obstacles when "Visible Avoidance" is enabled in the Debug menu. @@ -3372,7 +3372,7 @@ If enabled, displays static avoidance obstacles when "Visible Avoidance" is enab .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` +:ref:`Color` **debug/shapes/avoidance/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` Color of the avoidance obstacles radius, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3384,7 +3384,7 @@ Color of the avoidance obstacles radius, visible when "Visible Avoidance" is ena .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` +:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` Color of the static avoidance obstacles edges when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3396,7 +3396,7 @@ Color of the static avoidance obstacles edges when their vertices are winded in .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` +:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` Color of the static avoidance obstacles edges when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3408,7 +3408,7 @@ Color of the static avoidance obstacles edges when their vertices are winded in .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` +:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` Color of the static avoidance obstacles faces when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3420,7 +3420,7 @@ Color of the static avoidance obstacles faces when their vertices are winded in .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` +:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` Color of the static avoidance obstacles faces when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3432,7 +3432,7 @@ Color of the static avoidance obstacles faces when their vertices are winded in .. rst-class:: classref-property -:ref:`Color` **debug/shapes/collision/contact_color** = ``Color(1, 0.2, 0.1, 0.8)`` +:ref:`Color` **debug/shapes/collision/contact_color** = ``Color(1, 0.2, 0.1, 0.8)`` :ref:`🔗` Color of the contact points between collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu. @@ -3444,7 +3444,7 @@ Color of the contact points between collision shapes, visible when "Visible Coll .. rst-class:: classref-property -:ref:`bool` **debug/shapes/collision/draw_2d_outlines** = ``true`` +:ref:`bool` **debug/shapes/collision/draw_2d_outlines** = ``true`` :ref:`🔗` Sets whether 2D physics will display collision outlines in game when "Visible Collision Shapes" is enabled in the Debug menu. @@ -3456,7 +3456,7 @@ Sets whether 2D physics will display collision outlines in game when "Visible Co .. rst-class:: classref-property -:ref:`int` **debug/shapes/collision/max_contacts_displayed** = ``10000`` +:ref:`int` **debug/shapes/collision/max_contacts_displayed** = ``10000`` :ref:`🔗` Maximum number of contact points between collision shapes to display when "Visible Collision Shapes" is enabled in the Debug menu. @@ -3468,7 +3468,7 @@ Maximum number of contact points between collision shapes to display when "Visib .. rst-class:: classref-property -:ref:`Color` **debug/shapes/collision/shape_color** = ``Color(0, 0.6, 0.7, 0.42)`` +:ref:`Color` **debug/shapes/collision/shape_color** = ``Color(0, 0.6, 0.7, 0.42)`` :ref:`🔗` Color of the collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu. @@ -3480,7 +3480,7 @@ Color of the collision shapes, visible when "Visible Collision Shapes" is enable .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/agent_path_color** = ``Color(1, 0, 0, 1)`` +:ref:`Color` **debug/shapes/navigation/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` Color to display enabled navigation agent paths when an agent has debug enabled. @@ -3492,7 +3492,7 @@ Color to display enabled navigation agent paths when an agent has debug enabled. .. rst-class:: classref-property -:ref:`float` **debug/shapes/navigation/agent_path_point_size** = ``4.0`` +:ref:`float` **debug/shapes/navigation/agent_path_point_size** = ``4.0`` :ref:`🔗` Rasterized size (pixel) used to render navigation agent path points when an agent has debug enabled. @@ -3504,7 +3504,7 @@ Rasterized size (pixel) used to render navigation agent path points when an agen .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/edge_connection_color** = ``Color(1, 0, 1, 1)`` +:ref:`Color` **debug/shapes/navigation/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` Color to display edge connections between navigation regions, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3516,7 +3516,7 @@ Color to display edge connections between navigation regions, visible when "Visi .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_agent_paths** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_agent_paths** = ``true`` :ref:`🔗` If enabled, displays navigation agent paths when an agent has debug enabled. @@ -3528,7 +3528,7 @@ If enabled, displays navigation agent paths when an agent has debug enabled. .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_agent_paths_xray** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_agent_paths_xray** = ``true`` :ref:`🔗` If enabled, displays navigation agent paths through geometry when an agent has debug enabled. @@ -3540,7 +3540,7 @@ If enabled, displays navigation agent paths through geometry when an agent has d .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_connections** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_edge_connections** = ``true`` :ref:`🔗` If enabled, displays edge connections between navigation regions when "Visible Navigation" is enabled in the Debug menu. @@ -3552,7 +3552,7 @@ If enabled, displays edge connections between navigation regions when "Visible N .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_connections_xray** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_edge_connections_xray** = ``true`` :ref:`🔗` If enabled, displays edge connections between navigation regions through geometry when "Visible Navigation" is enabled in the Debug menu. @@ -3564,7 +3564,7 @@ If enabled, displays edge connections between navigation regions through geometr .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_lines** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_edge_lines** = ``true`` :ref:`🔗` If enabled, displays navigation mesh polygon edges when "Visible Navigation" is enabled in the Debug menu. @@ -3576,7 +3576,7 @@ If enabled, displays navigation mesh polygon edges when "Visible Navigation" is .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_lines_xray** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_edge_lines_xray** = ``true`` :ref:`🔗` If enabled, displays navigation mesh polygon edges through geometry when "Visible Navigation" is enabled in the Debug menu. @@ -3588,7 +3588,7 @@ If enabled, displays navigation mesh polygon edges through geometry when "Visibl .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_geometry_face_random_color** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_geometry_face_random_color** = ``true`` :ref:`🔗` If enabled, colorizes each navigation mesh polygon face with a random color when "Visible Navigation" is enabled in the Debug menu. @@ -3600,7 +3600,7 @@ If enabled, colorizes each navigation mesh polygon face with a random color when .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_link_connections** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_link_connections** = ``true`` :ref:`🔗` If enabled, displays navigation link connections when "Visible Navigation" is enabled in the Debug menu. @@ -3612,7 +3612,7 @@ If enabled, displays navigation link connections when "Visible Navigation" is en .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_link_connections_xray** = ``true`` +:ref:`bool` **debug/shapes/navigation/enable_link_connections_xray** = ``true`` :ref:`🔗` If enabled, displays navigation link connections through geometry when "Visible Navigation" is enabled in the Debug menu. @@ -3624,7 +3624,7 @@ If enabled, displays navigation link connections through geometry when "Visible .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` +:ref:`Color` **debug/shapes/navigation/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` Color to display enabled navigation mesh polygon edges, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3636,7 +3636,7 @@ Color to display enabled navigation mesh polygon edges, visible when "Visible Na .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` +:ref:`Color` **debug/shapes/navigation/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` Color to display disabled navigation mesh polygon edges, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3648,7 +3648,7 @@ Color to display disabled navigation mesh polygon edges, visible when "Visible N .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` +:ref:`Color` **debug/shapes/navigation/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` Color to display enabled navigation mesh polygon faces, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3660,7 +3660,7 @@ Color to display enabled navigation mesh polygon faces, visible when "Visible Na .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` +:ref:`Color` **debug/shapes/navigation/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` Color to display disabled navigation mesh polygon faces, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3672,7 +3672,7 @@ Color to display disabled navigation mesh polygon faces, visible when "Visible N .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/link_connection_color** = ``Color(1, 0.5, 1, 1)`` +:ref:`Color` **debug/shapes/navigation/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` Color to use to display navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3684,7 +3684,7 @@ Color to use to display navigation link connections, visible when "Visible Navig .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` +:ref:`Color` **debug/shapes/navigation/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` Color to use to display disabled navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3696,7 +3696,7 @@ Color to use to display disabled navigation link connections, visible when "Visi .. rst-class:: classref-property -:ref:`Color` **debug/shapes/paths/geometry_color** = ``Color(0.1, 1, 0.7, 0.4)`` +:ref:`Color` **debug/shapes/paths/geometry_color** = ``Color(0.1, 1, 0.7, 0.4)`` :ref:`🔗` Color of the curve path geometry, visible when "Visible Paths" is enabled in the Debug menu. @@ -3708,7 +3708,7 @@ Color of the curve path geometry, visible when "Visible Paths" is enabled in the .. rst-class:: classref-property -:ref:`float` **debug/shapes/paths/geometry_width** = ``2.0`` +:ref:`float` **debug/shapes/paths/geometry_width** = ``2.0`` :ref:`🔗` Line width of the curve path geometry, visible when "Visible Paths" is enabled in the Debug menu. @@ -3720,7 +3720,7 @@ Line width of the curve path geometry, visible when "Visible Paths" is enabled i .. rst-class:: classref-property -:ref:`String` **display/display_server/driver** +:ref:`String` **display/display_server/driver** :ref:`🔗` Sets the driver to be used by the display server. This property can not be edited directly, instead, set the driver using the platform-specific overrides. @@ -3732,7 +3732,7 @@ Sets the driver to be used by the display server. This property can not be edite .. rst-class:: classref-property -:ref:`String` **display/display_server/driver.android** +:ref:`String` **display/display_server/driver.android** :ref:`🔗` Android override for :ref:`display/display_server/driver`. @@ -3744,7 +3744,7 @@ Android override for :ref:`display/display_server/driver` **display/display_server/driver.ios** +:ref:`String` **display/display_server/driver.ios** :ref:`🔗` iOS override for :ref:`display/display_server/driver`. @@ -3756,7 +3756,7 @@ iOS override for :ref:`display/display_server/driver` **display/display_server/driver.linuxbsd** +:ref:`String` **display/display_server/driver.linuxbsd** :ref:`🔗` LinuxBSD override for :ref:`display/display_server/driver`. @@ -3768,7 +3768,7 @@ LinuxBSD override for :ref:`display/display_server/driver` **display/display_server/driver.macos** +:ref:`String` **display/display_server/driver.macos** :ref:`🔗` MacOS override for :ref:`display/display_server/driver`. @@ -3780,7 +3780,7 @@ MacOS override for :ref:`display/display_server/driver` **display/display_server/driver.windows** +:ref:`String` **display/display_server/driver.windows** :ref:`🔗` Windows override for :ref:`display/display_server/driver`. @@ -3792,7 +3792,7 @@ Windows override for :ref:`display/display_server/driver` **display/mouse_cursor/custom_image** = ``""`` +:ref:`String` **display/mouse_cursor/custom_image** = ``""`` :ref:`🔗` Custom image for the mouse cursor (limited to 256×256). @@ -3804,7 +3804,7 @@ Custom image for the mouse cursor (limited to 256×256). .. rst-class:: classref-property -:ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** = ``Vector2(0, 0)`` +:ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** = ``Vector2(0, 0)`` :ref:`🔗` Hotspot for the custom mouse cursor image. @@ -3816,7 +3816,7 @@ Hotspot for the custom mouse cursor image. .. rst-class:: classref-property -:ref:`Vector2` **display/mouse_cursor/tooltip_position_offset** = ``Vector2(10, 10)`` +:ref:`Vector2` **display/mouse_cursor/tooltip_position_offset** = ``Vector2(10, 10)`` :ref:`🔗` Position offset for tooltips, relative to the mouse cursor's hotspot. @@ -3828,7 +3828,7 @@ Position offset for tooltips, relative to the mouse cursor's hotspot. .. rst-class:: classref-property -:ref:`bool` **display/window/dpi/allow_hidpi** = ``true`` +:ref:`bool` **display/window/dpi/allow_hidpi** = ``true`` :ref:`🔗` If ``true``, allows HiDPI display on Windows, macOS, Android, iOS and Web. If ``false``, the platform's low-DPI fallback will be used on HiDPI displays, which causes the window to be displayed in a blurry or pixelated manner (and can cause various window management bugs). Therefore, it is recommended to make your project scale to :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` instead of disabling this setting. @@ -3842,7 +3842,7 @@ If ``true``, allows HiDPI display on Windows, macOS, Android, iOS and Web. If `` .. rst-class:: classref-property -:ref:`bool` **display/window/energy_saving/keep_screen_on** = ``true`` +:ref:`bool` **display/window/energy_saving/keep_screen_on** = ``true`` :ref:`🔗` If ``true``, keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms. @@ -3854,7 +3854,7 @@ If ``true``, keeps the screen on (even in case of inactivity), so the screensave .. rst-class:: classref-property -:ref:`bool` **display/window/energy_saving/keep_screen_on.editor_hint** = ``false`` +:ref:`bool` **display/window/energy_saving/keep_screen_on.editor_hint** = ``false`` :ref:`🔗` Editor-only override for :ref:`display/window/energy_saving/keep_screen_on`. Does not affect running project. @@ -3866,7 +3866,7 @@ Editor-only override for :ref:`display/window/energy_saving/keep_screen_on` **display/window/handheld/orientation** = ``0`` +:ref:`int` **display/window/handheld/orientation** = ``0`` :ref:`🔗` The default screen orientation to use on mobile devices. See :ref:`ScreenOrientation` for possible values. @@ -3880,7 +3880,7 @@ The default screen orientation to use on mobile devices. See :ref:`ScreenOrienta .. rst-class:: classref-property -:ref:`bool` **display/window/ios/allow_high_refresh_rate** = ``true`` +:ref:`bool` **display/window/ios/allow_high_refresh_rate** = ``true`` :ref:`🔗` If ``true``, iOS devices that support high refresh rate/"ProMotion" will be allowed to render at up to 120 frames per second. @@ -3892,7 +3892,7 @@ If ``true``, iOS devices that support high refresh rate/"ProMotion" will be allo .. rst-class:: classref-property -:ref:`bool` **display/window/ios/hide_home_indicator** = ``true`` +:ref:`bool` **display/window/ios/hide_home_indicator** = ``true`` :ref:`🔗` If ``true``, the home indicator is hidden automatically. This only affects iOS devices without a physical home button. @@ -3904,7 +3904,7 @@ If ``true``, the home indicator is hidden automatically. This only affects iOS d .. rst-class:: classref-property -:ref:`bool` **display/window/ios/hide_status_bar** = ``true`` +:ref:`bool` **display/window/ios/hide_status_bar** = ``true`` :ref:`🔗` If ``true``, the status bar is hidden while the app is running. @@ -3916,7 +3916,7 @@ If ``true``, the status bar is hidden while the app is running. .. rst-class:: classref-property -:ref:`bool` **display/window/ios/suppress_ui_gesture** = ``true`` +:ref:`bool` **display/window/ios/suppress_ui_gesture** = ``true`` :ref:`🔗` If ``true``, it will require two swipes to access iOS UI that uses gestures. @@ -3930,7 +3930,7 @@ If ``true``, it will require two swipes to access iOS UI that uses gestures. .. rst-class:: classref-property -:ref:`bool` **display/window/per_pixel_transparency/allowed** = ``false`` +:ref:`bool` **display/window/per_pixel_transparency/allowed** = ``false`` :ref:`🔗` If ``true``, allows per-pixel transparency for the window background. This affects performance, so leave it on ``false`` unless you need it. See also :ref:`display/window/size/transparent` and :ref:`rendering/viewport/transparent_background`. @@ -3942,7 +3942,7 @@ If ``true``, allows per-pixel transparency for the window background. This affec .. rst-class:: classref-property -:ref:`bool` **display/window/size/always_on_top** = ``false`` +:ref:`bool` **display/window/size/always_on_top** = ``false`` :ref:`🔗` Forces the main window to be always on top. @@ -3956,7 +3956,7 @@ Forces the main window to be always on top. .. rst-class:: classref-property -:ref:`bool` **display/window/size/borderless** = ``false`` +:ref:`bool` **display/window/size/borderless** = ``false`` :ref:`🔗` Forces the main window to be borderless. @@ -3970,7 +3970,7 @@ Forces the main window to be borderless. .. rst-class:: classref-property -:ref:`bool` **display/window/size/extend_to_title** = ``false`` +:ref:`bool` **display/window/size/extend_to_title** = ``false`` :ref:`🔗` Main window content is expanded to the full size of the window. Unlike a borderless window, the frame is left intact and can be used to resize the window, and the title bar is transparent, but has minimize/maximize/close buttons. @@ -3984,7 +3984,7 @@ Main window content is expanded to the full size of the window. Unlike a borderl .. rst-class:: classref-property -:ref:`Vector2i` **display/window/size/initial_position** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **display/window/size/initial_position** = ``Vector2i(0, 0)`` :ref:`🔗` Main window initial position (in virtual desktop coordinates), this setting is used only if :ref:`display/window/size/initial_position_type` is set to "Absolute" (``0``). @@ -3998,7 +3998,7 @@ Main window initial position (in virtual desktop coordinates), this setting is u .. rst-class:: classref-property -:ref:`int` **display/window/size/initial_position_type** = ``1`` +:ref:`int` **display/window/size/initial_position_type** = ``1`` :ref:`🔗` Main window initial position. @@ -4018,7 +4018,7 @@ Main window initial position. .. rst-class:: classref-property -:ref:`int` **display/window/size/initial_screen** = ``0`` +:ref:`int` **display/window/size/initial_screen** = ``0`` :ref:`🔗` Main window initial screen, this setting is used only if :ref:`display/window/size/initial_position_type` is set to "Other Screen Center" (``2``). @@ -4032,7 +4032,7 @@ Main window initial screen, this setting is used only if :ref:`display/window/si .. rst-class:: classref-property -:ref:`int` **display/window/size/mode** = ``0`` +:ref:`int` **display/window/size/mode** = ``0`` :ref:`🔗` Main window mode. See :ref:`WindowMode` for possible values and how each mode behaves. @@ -4044,7 +4044,7 @@ Main window mode. See :ref:`WindowMode` for possi .. rst-class:: classref-property -:ref:`bool` **display/window/size/no_focus** = ``false`` +:ref:`bool` **display/window/size/no_focus** = ``false`` :ref:`🔗` Main window can't be focused. No-focus window will ignore all input, except mouse clicks. @@ -4056,7 +4056,7 @@ Main window can't be focused. No-focus window will ignore all input, except mous .. rst-class:: classref-property -:ref:`bool` **display/window/size/resizable** = ``true`` +:ref:`bool` **display/window/size/resizable** = ``true`` :ref:`🔗` If ``true``, allows the window to be resizable by default. @@ -4074,7 +4074,7 @@ If ``true``, allows the window to be resizable by default. .. rst-class:: classref-property -:ref:`bool` **display/window/size/transparent** = ``false`` +:ref:`bool` **display/window/size/transparent** = ``false`` :ref:`🔗` If ``true``, enables a window manager hint that the main window background *can* be transparent. This does not make the background actually transparent. For the background to be transparent, the root viewport must also be made transparent by enabling :ref:`rendering/viewport/transparent_background`. @@ -4090,7 +4090,7 @@ If ``true``, enables a window manager hint that the main window background *can* .. rst-class:: classref-property -:ref:`int` **display/window/size/viewport_height** = ``648`` +:ref:`int` **display/window/size/viewport_height** = ``648`` :ref:`🔗` Sets the game's main viewport height. On desktop platforms, this is also the initial window height, represented by an indigo-colored rectangle in the 2D editor. Stretch mode settings also use this as a reference when using the ``canvas_items`` or ``viewport`` stretch modes. See also :ref:`display/window/size/viewport_width`, :ref:`display/window/size/window_width_override` and :ref:`display/window/size/window_height_override`. @@ -4102,7 +4102,7 @@ Sets the game's main viewport height. On desktop platforms, this is also the ini .. rst-class:: classref-property -:ref:`int` **display/window/size/viewport_width** = ``1152`` +:ref:`int` **display/window/size/viewport_width** = ``1152`` :ref:`🔗` Sets the game's main viewport width. On desktop platforms, this is also the initial window width, represented by an indigo-colored rectangle in the 2D editor. Stretch mode settings also use this as a reference when using the ``canvas_items`` or ``viewport`` stretch modes. See also :ref:`display/window/size/viewport_height`, :ref:`display/window/size/window_width_override` and :ref:`display/window/size/window_height_override`. @@ -4114,7 +4114,7 @@ Sets the game's main viewport width. On desktop platforms, this is also the init .. rst-class:: classref-property -:ref:`int` **display/window/size/window_height_override** = ``0`` +:ref:`int` **display/window/size/window_height_override** = ``0`` :ref:`🔗` On desktop platforms, overrides the game's initial window height. See also :ref:`display/window/size/window_width_override`, :ref:`display/window/size/viewport_width` and :ref:`display/window/size/viewport_height`. @@ -4128,7 +4128,7 @@ On desktop platforms, overrides the game's initial window height. See also :ref: .. rst-class:: classref-property -:ref:`int` **display/window/size/window_width_override** = ``0`` +:ref:`int` **display/window/size/window_width_override** = ``0`` :ref:`🔗` On desktop platforms, overrides the game's initial window width. See also :ref:`display/window/size/window_height_override`, :ref:`display/window/size/viewport_width` and :ref:`display/window/size/viewport_height`. @@ -4142,7 +4142,7 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` .. rst-class:: classref-property -:ref:`String` **display/window/stretch/aspect** = ``"keep"`` +:ref:`String` **display/window/stretch/aspect** = ``"keep"`` :ref:`🔗` .. container:: contribute @@ -4156,7 +4156,7 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` .. rst-class:: classref-property -:ref:`String` **display/window/stretch/mode** = ``"disabled"`` +:ref:`String` **display/window/stretch/mode** = ``"disabled"`` :ref:`🔗` Defines how the base size is stretched to fit the resolution of the window or screen. @@ -4174,7 +4174,7 @@ Defines how the base size is stretched to fit the resolution of the window or sc .. rst-class:: classref-property -:ref:`float` **display/window/stretch/scale** = ``1.0`` +:ref:`float` **display/window/stretch/scale** = ``1.0`` :ref:`🔗` The scale factor multiplier to use for 2D elements. This multiplies the final scale factor determined by :ref:`display/window/stretch/mode`. If using the **Disabled** stretch mode, this scale factor is applied as-is. This can be adjusted to make the UI easier to read on certain displays. @@ -4186,7 +4186,7 @@ The scale factor multiplier to use for 2D elements. This multiplies the final sc .. rst-class:: classref-property -:ref:`String` **display/window/stretch/scale_mode** = ``"fractional"`` +:ref:`String` **display/window/stretch/scale_mode** = ``"fractional"`` :ref:`🔗` The policy to use to determine the final scale factor for 2D elements. This affects how :ref:`display/window/stretch/scale` is applied, in addition to the automatic scale factor determined by :ref:`display/window/stretch/mode`. @@ -4204,7 +4204,7 @@ The policy to use to determine the final scale factor for 2D elements. This affe .. rst-class:: classref-property -:ref:`bool` **display/window/subwindows/embed_subwindows** = ``true`` +:ref:`bool` **display/window/subwindows/embed_subwindows** = ``true`` :ref:`🔗` If ``true`` subwindows are embedded in the main window. @@ -4216,15 +4216,17 @@ If ``true`` subwindows are embedded in the main window. .. rst-class:: classref-property -:ref:`int` **display/window/vsync/vsync_mode** = ``1`` +:ref:`int` **display/window/vsync/vsync_mode** = ``1`` :ref:`🔗` Sets the V-Sync mode for the main game window. The editor's own V-Sync mode can be set using :ref:`EditorSettings.interface/editor/vsync_mode`. See :ref:`VSyncMode` for possible values and how they affect the behavior of your application. -Depending on the platform and used renderer, the engine will fall back to **Enabled** if the desired mode is not supported. +Depending on the platform and rendering method, the engine will fall back to **Enabled** if the desired mode is not supported. -\ **Note:** V-Sync modes other than **Enabled** are only supported in the Forward+ and Mobile rendering methods, not Compatibility. +V-Sync can be disabled on the command line using the ``--disable-vsync`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. + +\ **Note:** The **Adaptive** and **Mailbox** V-Sync modes are only supported in the Forward+ and Mobile rendering methods, not Compatibility. \ **Note:** This property is only read when the project starts. To change the V-Sync mode at runtime, call :ref:`DisplayServer.window_set_vsync_mode` instead. @@ -4236,7 +4238,7 @@ Depending on the platform and used renderer, the engine will fall back to **Enab .. rst-class:: classref-property -:ref:`String` **dotnet/project/assembly_name** = ``""`` +:ref:`String` **dotnet/project/assembly_name** = ``""`` :ref:`🔗` Name of the .NET assembly. This name is used as the name of the ``.csproj`` and ``.sln`` files. By default, it's set to the name of the project (:ref:`application/config/name`) allowing to change it in the future without affecting the .NET assembly. @@ -4248,7 +4250,7 @@ Name of the .NET assembly. This name is used as the name of the ``.csproj`` and .. rst-class:: classref-property -:ref:`int` **dotnet/project/assembly_reload_attempts** = ``3`` +:ref:`int` **dotnet/project/assembly_reload_attempts** = ``3`` :ref:`🔗` Number of times to attempt assembly reloading after rebuilding .NET assemblies. Effectively also the timeout in seconds to wait for unloading of script assemblies to finish. @@ -4260,7 +4262,7 @@ Number of times to attempt assembly reloading after rebuilding .NET assemblies. .. rst-class:: classref-property -:ref:`String` **dotnet/project/solution_directory** = ``""`` +:ref:`String` **dotnet/project/solution_directory** = ``""`` :ref:`🔗` Directory that contains the ``.sln`` file. By default, the ``.sln`` files is in the root of the project directory, next to the ``project.godot`` and ``.csproj`` files. @@ -4274,7 +4276,7 @@ Changing this value allows setting up a multi-project scenario where there are m .. rst-class:: classref-property -:ref:`bool` **editor/export/convert_text_resources_to_binary** = ``true`` +:ref:`bool` **editor/export/convert_text_resources_to_binary** = ``true`` :ref:`🔗` If ``true``, text resources are converted to a binary format on export. This decreases file sizes and speeds up loading slightly. @@ -4288,7 +4290,7 @@ If ``true``, text resources are converted to a binary format on export. This dec .. rst-class:: classref-property -:ref:`int` **editor/import/atlas_max_width** = ``2048`` +:ref:`int` **editor/import/atlas_max_width** = ``2048`` :ref:`🔗` The maximum width to use when importing textures as an atlas. The value will be rounded to the nearest power of two when used. Use this to prevent imported textures from growing too large in the other direction. @@ -4300,7 +4302,7 @@ The maximum width to use when importing textures as an atlas. The value will be .. rst-class:: classref-property -:ref:`bool` **editor/import/reimport_missing_imported_files** = ``true`` +:ref:`bool` **editor/import/reimport_missing_imported_files** = ``true`` :ref:`🔗` .. container:: contribute @@ -4314,7 +4316,7 @@ The maximum width to use when importing textures as an atlas. The value will be .. rst-class:: classref-property -:ref:`bool` **editor/import/use_multiple_threads** = ``true`` +:ref:`bool` **editor/import/use_multiple_threads** = ``true`` :ref:`🔗` If ``true`` importing of resources is run on multiple threads. @@ -4326,7 +4328,7 @@ If ``true`` importing of resources is run on multiple threads. .. rst-class:: classref-property -:ref:`bool` **editor/movie_writer/disable_vsync** = ``false`` +:ref:`bool` **editor/movie_writer/disable_vsync** = ``false`` :ref:`🔗` If ``true``, requests V-Sync to be disabled when writing a movie (similar to setting :ref:`display/window/vsync/vsync_mode` to **Disabled**). This can speed up video writing if the hardware is fast enough to render, encode and save the video at a framerate higher than the monitor's refresh rate. @@ -4340,7 +4342,7 @@ If ``true``, requests V-Sync to be disabled when writing a movie (similar to set .. rst-class:: classref-property -:ref:`int` **editor/movie_writer/fps** = ``60`` +:ref:`int` **editor/movie_writer/fps** = ``60`` :ref:`🔗` The number of frames per second to record in the video when writing a movie. Simulation speed will adjust to always match the specified framerate, which means the engine will appear to run slower at higher :ref:`editor/movie_writer/fps` values. Certain FPS values will require you to adjust :ref:`editor/movie_writer/mix_rate` to prevent audio from desynchronizing over time. @@ -4354,7 +4356,7 @@ This can be specified manually on the command line using the ``--fixed-fps .. rst-class:: classref-property -:ref:`int` **editor/movie_writer/mix_rate** = ``48000`` +:ref:`int` **editor/movie_writer/mix_rate** = ``48000`` :ref:`🔗` The audio mix rate to use in the recorded audio when writing a movie (in Hz). This can be different from :ref:`audio/driver/mix_rate`, but this value must be divisible by :ref:`editor/movie_writer/fps` to prevent audio from desynchronizing over time. @@ -4366,7 +4368,7 @@ The audio mix rate to use in the recorded audio when writing a movie (in Hz). Th .. rst-class:: classref-property -:ref:`float` **editor/movie_writer/mjpeg_quality** = ``0.75`` +:ref:`float` **editor/movie_writer/mjpeg_quality** = ``0.75`` :ref:`🔗` The JPEG quality to use when writing a video to an AVI file, between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger file sizes. Recommended ``quality`` values are between ``0.75`` and ``0.9``. Even at quality ``1.0``, JPEG compression remains lossy. @@ -4380,7 +4382,7 @@ The JPEG quality to use when writing a video to an AVI file, between ``0.01`` an .. rst-class:: classref-property -:ref:`String` **editor/movie_writer/movie_file** = ``""`` +:ref:`String` **editor/movie_writer/movie_file** = ``""`` :ref:`🔗` The output path for the movie. The file extension determines the :ref:`MovieWriter` that will be used. @@ -4402,7 +4404,7 @@ When using PNG output, the frame number will be appended at the end of the file .. rst-class:: classref-property -:ref:`int` **editor/movie_writer/speaker_mode** = ``0`` +:ref:`int` **editor/movie_writer/speaker_mode** = ``0`` :ref:`🔗` The speaker mode to use in the recorded audio when writing a movie. See :ref:`SpeakerMode` for possible values. @@ -4414,7 +4416,7 @@ The speaker mode to use in the recorded audio when writing a movie. See :ref:`Sp .. rst-class:: classref-property -:ref:`String` **editor/naming/default_signal_callback_name** = ``"_on_{node_name}_{signal_name}"`` +:ref:`String` **editor/naming/default_signal_callback_name** = ``"_on_{node_name}_{signal_name}"`` :ref:`🔗` The format of the default signal callback name (in the Signal Connection Dialog). The following substitutions are available: ``{NodeName}``, ``{nodeName}``, ``{node_name}``, ``{SignalName}``, ``{signalName}``, and ``{signal_name}``. @@ -4426,7 +4428,7 @@ The format of the default signal callback name (in the Signal Connection Dialog) .. rst-class:: classref-property -:ref:`String` **editor/naming/default_signal_callback_to_self_name** = ``"_on_{signal_name}"`` +:ref:`String` **editor/naming/default_signal_callback_to_self_name** = ``"_on_{signal_name}"`` :ref:`🔗` The format of the default signal callback name when a signal connects to the same node that emits it (in the Signal Connection Dialog). The following substitutions are available: ``{NodeName}``, ``{nodeName}``, ``{node_name}``, ``{SignalName}``, ``{signalName}``, and ``{signal_name}``. @@ -4438,7 +4440,7 @@ The format of the default signal callback name when a signal connects to the sam .. rst-class:: classref-property -:ref:`int` **editor/naming/node_name_casing** = ``0`` +:ref:`int` **editor/naming/node_name_casing** = ``0`` :ref:`🔗` When creating node names automatically, set the type of casing to use in this project. This is mostly an editor setting. @@ -4450,7 +4452,7 @@ When creating node names automatically, set the type of casing to use in this pr .. rst-class:: classref-property -:ref:`int` **editor/naming/node_name_num_separator** = ``0`` +:ref:`int` **editor/naming/node_name_num_separator** = ``0`` :ref:`🔗` What to use to separate node name from number. This is mostly an editor setting. @@ -4462,7 +4464,7 @@ What to use to separate node name from number. This is mostly an editor setting. .. rst-class:: classref-property -:ref:`int` **editor/naming/scene_name_casing** = ``2`` +:ref:`int` **editor/naming/scene_name_casing** = ``2`` :ref:`🔗` When generating scene file names from scene root node, set the type of casing to use in this project. This is mostly an editor setting. @@ -4474,7 +4476,7 @@ When generating scene file names from scene root node, set the type of casing to .. rst-class:: classref-property -:ref:`int` **editor/naming/script_name_casing** = ``0`` +:ref:`int` **editor/naming/script_name_casing** = ``0`` :ref:`🔗` When generating script file names from the selected node, set the type of casing to use in this project. This is mostly an editor setting. @@ -4486,7 +4488,7 @@ When generating script file names from the selected node, set the type of casing .. rst-class:: classref-property -:ref:`String` **editor/run/main_run_args** = ``""`` +:ref:`String` **editor/run/main_run_args** = ``""`` :ref:`🔗` The command-line arguments to append to Godot's own command line when running the project. This doesn't affect the editor itself. @@ -4506,7 +4508,7 @@ For example, this can be used to force the project to run on the dedicated GPU i .. rst-class:: classref-property -:ref:`PackedStringArray` **editor/script/search_in_file_extensions** = ``PackedStringArray("gd", "gdshader")`` +:ref:`PackedStringArray` **editor/script/search_in_file_extensions** = ``PackedStringArray("gd", "gdshader")`` :ref:`🔗` Text-based file extensions to include in the script editor's "Find in Files" feature. You can add e.g. ``tscn`` if you wish to also parse your scene files, especially if you use built-in scripts which are serialized in the scene files. @@ -4520,7 +4522,7 @@ Text-based file extensions to include in the script editor's "Find in Files" fea .. rst-class:: classref-property -:ref:`String` **editor/script/templates_search_path** = ``"res://script_templates"`` +:ref:`String` **editor/script/templates_search_path** = ``"res://script_templates"`` :ref:`🔗` Search path for project-specific script templates. Godot will search for script templates both in the editor-specific path and in this project-specific path. @@ -4532,7 +4534,7 @@ Search path for project-specific script templates. Godot will search for script .. rst-class:: classref-property -:ref:`bool` **editor/version_control/autoload_on_startup** = ``false`` +:ref:`bool` **editor/version_control/autoload_on_startup** = ``false`` :ref:`🔗` .. container:: contribute @@ -4546,7 +4548,7 @@ Search path for project-specific script templates. Godot will search for script .. rst-class:: classref-property -:ref:`String` **editor/version_control/plugin_name** = ``""`` +:ref:`String` **editor/version_control/plugin_name** = ``""`` :ref:`🔗` .. container:: contribute @@ -4560,7 +4562,7 @@ Search path for project-specific script templates. Godot will search for script .. rst-class:: classref-property -:ref:`bool` **filesystem/import/blender/enabled** = ``true`` +:ref:`bool` **filesystem/import/blender/enabled** = ``true`` :ref:`🔗` If ``true``, Blender 3D scene files with the ``.blend`` extension will be imported by converting them to glTF 2.0. @@ -4574,7 +4576,7 @@ This requires configuring a path to a Blender executable in the editor settings .. rst-class:: classref-property -:ref:`bool` **filesystem/import/blender/enabled.android** = ``false`` +:ref:`bool` **filesystem/import/blender/enabled.android** = ``false`` :ref:`🔗` Override for :ref:`filesystem/import/blender/enabled` on Android where Blender can't easily be accessed from Godot. @@ -4586,7 +4588,7 @@ Override for :ref:`filesystem/import/blender/enabled` **filesystem/import/blender/enabled.web** = ``false`` +:ref:`bool` **filesystem/import/blender/enabled.web** = ``false`` :ref:`🔗` Override for :ref:`filesystem/import/blender/enabled` on the Web where Blender can't easily be accessed from Godot. @@ -4598,11 +4600,11 @@ Override for :ref:`filesystem/import/blender/enabled` **filesystem/import/fbx2gltf/enabled** = ``true`` +:ref:`bool` **filesystem/import/fbx2gltf/enabled** = ``true`` :ref:`🔗` If ``true``, Autodesk FBX 3D scene files with the ``.fbx`` extension will be imported by converting them to glTF 2.0. -This requires configuring a path to an FBX2glTF executable in the editor settings at :ref:`EditorSettings.filesystem/import/fbx2gltf/fbx2gltf_path`. +This requires configuring a path to an FBX2glTF executable in the editor settings at :ref:`EditorSettings.filesystem/import/fbx/fbx2gltf_path`. .. rst-class:: classref-item-separator @@ -4612,7 +4614,7 @@ This requires configuring a path to an FBX2glTF executable in the editor setting .. rst-class:: classref-property -:ref:`bool` **filesystem/import/fbx2gltf/enabled.android** = ``false`` +:ref:`bool` **filesystem/import/fbx2gltf/enabled.android** = ``false`` :ref:`🔗` Override for :ref:`filesystem/import/fbx2gltf/enabled` on Android where FBX2glTF can't easily be accessed from Godot. @@ -4624,7 +4626,7 @@ Override for :ref:`filesystem/import/fbx2gltf/enabled` **filesystem/import/fbx2gltf/enabled.web** = ``false`` +:ref:`bool` **filesystem/import/fbx2gltf/enabled.web** = ``false`` :ref:`🔗` Override for :ref:`filesystem/import/fbx2gltf/enabled` on the Web where FBX2glTF can't easily be accessed from Godot. @@ -4636,7 +4638,7 @@ Override for :ref:`filesystem/import/fbx2gltf/enabled` **gui/common/default_scroll_deadzone** = ``0`` +:ref:`int` **gui/common/default_scroll_deadzone** = ``0`` :ref:`🔗` Default value for :ref:`ScrollContainer.scroll_deadzone`, which will be used for all :ref:`ScrollContainer`\ s unless overridden. @@ -4648,7 +4650,7 @@ Default value for :ref:`ScrollContainer.scroll_deadzone` **gui/common/snap_controls_to_pixels** = ``true`` +:ref:`bool` **gui/common/snap_controls_to_pixels** = ``true`` :ref:`🔗` If ``true``, snaps :ref:`Control` node vertices to the nearest pixel to ensure they remain crisp even when the camera moves or zooms. @@ -4660,7 +4662,7 @@ If ``true``, snaps :ref:`Control` node vertices to the nearest pi .. rst-class:: classref-property -:ref:`bool` **gui/common/swap_cancel_ok** +:ref:`bool` **gui/common/swap_cancel_ok** :ref:`🔗` If ``true``, swaps **Cancel** and **OK** buttons in dialogs on Windows to follow interface conventions. :ref:`DisplayServer.get_swap_cancel_ok` can be used to query whether buttons are swapped at run-time. @@ -4674,7 +4676,7 @@ If ``true``, swaps **Cancel** and **OK** buttons in dialogs on Windows to follow .. rst-class:: classref-property -:ref:`int` **gui/common/text_edit_undo_stack_max_size** = ``1024`` +:ref:`int` **gui/common/text_edit_undo_stack_max_size** = ``1024`` :ref:`🔗` Maximum undo/redo history size for :ref:`TextEdit` fields. @@ -4686,7 +4688,7 @@ Maximum undo/redo history size for :ref:`TextEdit` fields. .. rst-class:: classref-property -:ref:`bool` **gui/fonts/dynamic_fonts/use_oversampling** = ``true`` +:ref:`bool` **gui/fonts/dynamic_fonts/use_oversampling** = ``true`` :ref:`🔗` .. container:: contribute @@ -4700,7 +4702,7 @@ Maximum undo/redo history size for :ref:`TextEdit` fields. .. rst-class:: classref-property -:ref:`String` **gui/theme/custom** = ``""`` +:ref:`String` **gui/theme/custom** = ``""`` :ref:`🔗` Path to a custom :ref:`Theme` resource file to use for the project (``.theme`` or generic ``.tres``/``.res`` extension). @@ -4712,7 +4714,7 @@ Path to a custom :ref:`Theme` resource file to use for the project .. rst-class:: classref-property -:ref:`String` **gui/theme/custom_font** = ``""`` +:ref:`String` **gui/theme/custom_font** = ``""`` :ref:`🔗` Path to a custom :ref:`Font` resource to use as default for all GUI elements of the project. @@ -4724,7 +4726,7 @@ Path to a custom :ref:`Font` resource to use as default for all GUI .. rst-class:: classref-property -:ref:`int` **gui/theme/default_font_antialiasing** = ``1`` +:ref:`int` **gui/theme/default_font_antialiasing** = ``1`` :ref:`🔗` Font anti-aliasing mode for the default project font. See :ref:`FontFile.antialiasing`. @@ -4738,7 +4740,7 @@ Font anti-aliasing mode for the default project font. See :ref:`FontFile.antiali .. rst-class:: classref-property -:ref:`bool` **gui/theme/default_font_generate_mipmaps** = ``false`` +:ref:`bool` **gui/theme/default_font_generate_mipmaps** = ``false`` :ref:`🔗` If set to ``true``, the default font will have mipmaps generated. This prevents text from looking grainy when a :ref:`Control` is scaled down, or when a :ref:`Label3D` is viewed from a long distance (if :ref:`Label3D.texture_filter` is set to a mode that displays mipmaps). @@ -4754,7 +4756,7 @@ Enabling :ref:`gui/theme/default_font_generate_mipmaps` **gui/theme/default_font_hinting** = ``1`` +:ref:`int` **gui/theme/default_font_hinting** = ``1`` :ref:`🔗` Font hinting mode for the default project font. See :ref:`FontFile.hinting`. @@ -4768,7 +4770,7 @@ Font hinting mode for the default project font. See :ref:`FontFile.hinting` **gui/theme/default_font_multichannel_signed_distance_field** = ``false`` +:ref:`bool` **gui/theme/default_font_multichannel_signed_distance_field** = ``false`` :ref:`🔗` If set to ``true``, the default font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for :ref:`Control`\ s that are scaled down (or for :ref:`Label3D`\ s viewed from a long distance). @@ -4784,7 +4786,7 @@ MSDF font rendering can be combined with :ref:`gui/theme/default_font_generate_m .. rst-class:: classref-property -:ref:`int` **gui/theme/default_font_subpixel_positioning** = ``1`` +:ref:`int` **gui/theme/default_font_subpixel_positioning** = ``1`` :ref:`🔗` Font glyph subpixel positioning mode for the default project font. See :ref:`FontFile.subpixel_positioning`. @@ -4798,7 +4800,7 @@ Font glyph subpixel positioning mode for the default project font. See :ref:`Fon .. rst-class:: classref-property -:ref:`float` **gui/theme/default_theme_scale** = ``1.0`` +:ref:`float` **gui/theme/default_theme_scale** = ``1.0`` :ref:`🔗` The default scale factor for :ref:`Control`\ s, when not overridden by a :ref:`Theme`. @@ -4812,7 +4814,7 @@ The default scale factor for :ref:`Control`\ s, when not overridd .. rst-class:: classref-property -:ref:`int` **gui/theme/lcd_subpixel_layout** = ``1`` +:ref:`int` **gui/theme/lcd_subpixel_layout** = ``1`` :ref:`🔗` LCD subpixel layout used for font anti-aliasing. See :ref:`FontLCDSubpixelLayout`. @@ -4824,7 +4826,7 @@ LCD subpixel layout used for font anti-aliasing. See :ref:`FontLCDSubpixelLayout .. rst-class:: classref-property -:ref:`float` **gui/timers/button_shortcut_feedback_highlight_time** = ``0.2`` +:ref:`float` **gui/timers/button_shortcut_feedback_highlight_time** = ``0.2`` :ref:`🔗` When :ref:`BaseButton.shortcut_feedback` is enabled, this is the time the :ref:`BaseButton` will remain highlighted after a shortcut. @@ -4836,7 +4838,7 @@ When :ref:`BaseButton.shortcut_feedback` **gui/timers/incremental_search_max_interval_msec** = ``2000`` +:ref:`int` **gui/timers/incremental_search_max_interval_msec** = ``2000`` :ref:`🔗` Timer setting for incremental search in :ref:`Tree`, :ref:`ItemList`, etc. controls (in milliseconds). @@ -4848,7 +4850,7 @@ Timer setting for incremental search in :ref:`Tree`, :ref:`ItemList< .. rst-class:: classref-property -:ref:`float` **gui/timers/text_edit_idle_detect_sec** = ``3`` +:ref:`float` **gui/timers/text_edit_idle_detect_sec** = ``3`` :ref:`🔗` Timer for detecting idle in :ref:`TextEdit` (in seconds). @@ -4860,7 +4862,7 @@ Timer for detecting idle in :ref:`TextEdit` (in seconds). .. rst-class:: classref-property -:ref:`float` **gui/timers/tooltip_delay_sec** = ``0.5`` +:ref:`float` **gui/timers/tooltip_delay_sec** = ``0.5`` :ref:`🔗` Default delay for tooltips (in seconds). @@ -4872,7 +4874,7 @@ Default delay for tooltips (in seconds). .. rst-class:: classref-property -:ref:`float` **gui/timers/tooltip_delay_sec.editor_hint** = ``0.5`` +:ref:`float` **gui/timers/tooltip_delay_sec.editor_hint** = ``0.5`` :ref:`🔗` Delay for tooltips in the editor. @@ -4884,7 +4886,7 @@ Delay for tooltips in the editor. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_accept** +:ref:`Dictionary` **input/ui_accept** :ref:`🔗` Default :ref:`InputEventAction` to confirm a focused button, menu or list item, or validate input. @@ -4898,7 +4900,7 @@ Default :ref:`InputEventAction` to confirm a focused but .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_cancel** +:ref:`Dictionary` **input/ui_cancel** :ref:`🔗` Default :ref:`InputEventAction` to discard a modal or pending input. @@ -4912,7 +4914,7 @@ Default :ref:`InputEventAction` to discard a modal or pe .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_copy** +:ref:`Dictionary` **input/ui_copy** :ref:`🔗` Default :ref:`InputEventAction` to copy a selection to the clipboard. @@ -4926,7 +4928,7 @@ Default :ref:`InputEventAction` to copy a selection to t .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_cut** +:ref:`Dictionary` **input/ui_cut** :ref:`🔗` Default :ref:`InputEventAction` to cut a selection to the clipboard. @@ -4940,7 +4942,7 @@ Default :ref:`InputEventAction` to cut a selection to th .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_down** +:ref:`Dictionary` **input/ui_down** :ref:`🔗` Default :ref:`InputEventAction` to move down in the UI. @@ -4954,7 +4956,7 @@ Default :ref:`InputEventAction` to move down in the UI. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_end** +:ref:`Dictionary` **input/ui_end** :ref:`🔗` Default :ref:`InputEventAction` to go to the end position of a :ref:`Control` (e.g. last item in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_END` on typical desktop UI systems. @@ -4968,7 +4970,7 @@ Default :ref:`InputEventAction` to go to the end positio .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_filedialog_refresh** +:ref:`Dictionary` **input/ui_filedialog_refresh** :ref:`🔗` Default :ref:`InputEventAction` to refresh the contents of the current directory of a :ref:`FileDialog`. @@ -4982,7 +4984,7 @@ Default :ref:`InputEventAction` to refresh the contents .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_filedialog_show_hidden** +:ref:`Dictionary` **input/ui_filedialog_show_hidden** :ref:`🔗` Default :ref:`InputEventAction` to toggle showing hidden files and directories in a :ref:`FileDialog`. @@ -4996,7 +4998,7 @@ Default :ref:`InputEventAction` to toggle showing hidden .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_filedialog_up_one_level** +:ref:`Dictionary` **input/ui_filedialog_up_one_level** :ref:`🔗` Default :ref:`InputEventAction` to go up one directory in a :ref:`FileDialog`. @@ -5010,7 +5012,7 @@ Default :ref:`InputEventAction` to go up one directory i .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_focus_next** +:ref:`Dictionary` **input/ui_focus_next** :ref:`🔗` Default :ref:`InputEventAction` to focus the next :ref:`Control` in the scene. The focus behavior can be configured via :ref:`Control.focus_next`. @@ -5024,7 +5026,7 @@ Default :ref:`InputEventAction` to focus the next :ref:` .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_focus_prev** +:ref:`Dictionary` **input/ui_focus_prev** :ref:`🔗` Default :ref:`InputEventAction` to focus the previous :ref:`Control` in the scene. The focus behavior can be configured via :ref:`Control.focus_previous`. @@ -5038,7 +5040,7 @@ Default :ref:`InputEventAction` to focus the previous :r .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_graph_delete** +:ref:`Dictionary` **input/ui_graph_delete** :ref:`🔗` Default :ref:`InputEventAction` to delete a :ref:`GraphNode` in a :ref:`GraphEdit`. @@ -5052,7 +5054,7 @@ Default :ref:`InputEventAction` to delete a :ref:`GraphN .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_graph_duplicate** +:ref:`Dictionary` **input/ui_graph_duplicate** :ref:`🔗` Default :ref:`InputEventAction` to duplicate a :ref:`GraphNode` in a :ref:`GraphEdit`. @@ -5066,7 +5068,7 @@ Default :ref:`InputEventAction` to duplicate a :ref:`Gra .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_home** +:ref:`Dictionary` **input/ui_home** :ref:`🔗` Default :ref:`InputEventAction` to go to the start position of a :ref:`Control` (e.g. first item in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_HOME` on typical desktop UI systems. @@ -5080,7 +5082,7 @@ Default :ref:`InputEventAction` to go to the start posit .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_left** +:ref:`Dictionary` **input/ui_left** :ref:`🔗` Default :ref:`InputEventAction` to move left in the UI. @@ -5094,7 +5096,7 @@ Default :ref:`InputEventAction` to move left in the UI. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_menu** +:ref:`Dictionary` **input/ui_menu** :ref:`🔗` Default :ref:`InputEventAction` to open a context menu in a text field. @@ -5108,7 +5110,7 @@ Default :ref:`InputEventAction` to open a context menu i .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_page_down** +:ref:`Dictionary` **input/ui_page_down** :ref:`🔗` Default :ref:`InputEventAction` to go down a page in a :ref:`Control` (e.g. in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_PAGEDOWN` on typical desktop UI systems. @@ -5122,7 +5124,7 @@ Default :ref:`InputEventAction` to go down a page in a : .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_page_up** +:ref:`Dictionary` **input/ui_page_up** :ref:`🔗` Default :ref:`InputEventAction` to go up a page in a :ref:`Control` (e.g. in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_PAGEUP` on typical desktop UI systems. @@ -5136,7 +5138,7 @@ Default :ref:`InputEventAction` to go up a page in a :re .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_paste** +:ref:`Dictionary` **input/ui_paste** :ref:`🔗` Default :ref:`InputEventAction` to paste from the clipboard. @@ -5150,7 +5152,7 @@ Default :ref:`InputEventAction` to paste from the clipbo .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_redo** +:ref:`Dictionary` **input/ui_redo** :ref:`🔗` Default :ref:`InputEventAction` to redo an undone action. @@ -5164,7 +5166,7 @@ Default :ref:`InputEventAction` to redo an undone action .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_right** +:ref:`Dictionary` **input/ui_right** :ref:`🔗` Default :ref:`InputEventAction` to move right in the UI. @@ -5178,7 +5180,7 @@ Default :ref:`InputEventAction` to move right in the UI. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_select** +:ref:`Dictionary` **input/ui_select** :ref:`🔗` Default :ref:`InputEventAction` to select an item in a :ref:`Control` (e.g. in an :ref:`ItemList` or a :ref:`Tree`). @@ -5192,7 +5194,7 @@ Default :ref:`InputEventAction` to select an item in a : .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_swap_input_direction** +:ref:`Dictionary` **input/ui_swap_input_direction** :ref:`🔗` Default :ref:`InputEventAction` to swap input direction, i.e. change between left-to-right to right-to-left modes. Affects text-editing controls (:ref:`LineEdit`, :ref:`TextEdit`). @@ -5204,7 +5206,7 @@ Default :ref:`InputEventAction` to swap input direction, .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_add_selection_for_next_occurrence** +:ref:`Dictionary` **input/ui_text_add_selection_for_next_occurrence** :ref:`🔗` If a selection is currently active with the last caret in text fields, searches for the next occurrence of the selection, adds a caret and selects the next occurrence. @@ -5224,7 +5226,7 @@ The viewport is adjusted to the latest newly added caret. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_backspace** +:ref:`Dictionary` **input/ui_text_backspace** :ref:`🔗` Default :ref:`InputEventAction` to delete the character before the text cursor. @@ -5238,7 +5240,7 @@ Default :ref:`InputEventAction` to delete the character .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_backspace_all_to_left** +:ref:`Dictionary` **input/ui_text_backspace_all_to_left** :ref:`🔗` Default :ref:`InputEventAction` to delete **all** text before the text cursor. @@ -5252,7 +5254,7 @@ Default :ref:`InputEventAction` to delete **all** text b .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_backspace_all_to_left.macos** +:ref:`Dictionary` **input/ui_text_backspace_all_to_left.macos** :ref:`🔗` macOS specific override for the shortcut to delete all text before the text cursor. @@ -5264,7 +5266,7 @@ macOS specific override for the shortcut to delete all text before the text curs .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_backspace_word** +:ref:`Dictionary` **input/ui_text_backspace_word** :ref:`🔗` Default :ref:`InputEventAction` to delete all characters before the cursor up until a whitespace or punctuation character. @@ -5278,7 +5280,7 @@ Default :ref:`InputEventAction` to delete all characters .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_backspace_word.macos** +:ref:`Dictionary` **input/ui_text_backspace_word.macos** :ref:`🔗` macOS specific override for the shortcut to delete a word. @@ -5290,7 +5292,7 @@ macOS specific override for the shortcut to delete a word. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_add_above** +:ref:`Dictionary` **input/ui_text_caret_add_above** :ref:`🔗` Default :ref:`InputEventAction` to add an additional caret above every caret of a text. @@ -5302,7 +5304,7 @@ Default :ref:`InputEventAction` to add an additional car .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_add_above.macos** +:ref:`Dictionary` **input/ui_text_caret_add_above.macos** :ref:`🔗` macOS specific override for the shortcut to add a caret above every caret. @@ -5314,7 +5316,7 @@ macOS specific override for the shortcut to add a caret above every caret. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_add_below** +:ref:`Dictionary` **input/ui_text_caret_add_below** :ref:`🔗` Default :ref:`InputEventAction` to add an additional caret below every caret of a text. @@ -5326,7 +5328,7 @@ Default :ref:`InputEventAction` to add an additional car .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_add_below.macos** +:ref:`Dictionary` **input/ui_text_caret_add_below.macos** :ref:`🔗` macOS specific override for the shortcut to add a caret below every caret. @@ -5338,7 +5340,7 @@ macOS specific override for the shortcut to add a caret below every caret. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_document_end** +:ref:`Dictionary` **input/ui_text_caret_document_end** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor to the end of the text. @@ -5352,7 +5354,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_document_end.macos** +:ref:`Dictionary` **input/ui_text_caret_document_end.macos** :ref:`🔗` macOS specific override for the shortcut to move the text cursor to the end of the text. @@ -5364,7 +5366,7 @@ macOS specific override for the shortcut to move the text cursor to the end of t .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_document_start** +:ref:`Dictionary` **input/ui_text_caret_document_start** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor to the start of the text. @@ -5378,7 +5380,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_document_start.macos** +:ref:`Dictionary` **input/ui_text_caret_document_start.macos** :ref:`🔗` macOS specific override for the shortcut to move the text cursor to the start of the text. @@ -5390,7 +5392,7 @@ macOS specific override for the shortcut to move the text cursor to the start of .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_down** +:ref:`Dictionary` **input/ui_text_caret_down** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor down. @@ -5404,7 +5406,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_left** +:ref:`Dictionary` **input/ui_text_caret_left** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor left. @@ -5418,7 +5420,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_line_end** +:ref:`Dictionary` **input/ui_text_caret_line_end** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor to the end of the line. @@ -5432,7 +5434,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_line_end.macos** +:ref:`Dictionary` **input/ui_text_caret_line_end.macos** :ref:`🔗` macOS specific override for the shortcut to move the text cursor to the end of the line. @@ -5444,7 +5446,7 @@ macOS specific override for the shortcut to move the text cursor to the end of t .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_line_start** +:ref:`Dictionary` **input/ui_text_caret_line_start** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor to the start of the line. @@ -5458,7 +5460,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_line_start.macos** +:ref:`Dictionary` **input/ui_text_caret_line_start.macos** :ref:`🔗` macOS specific override for the shortcut to move the text cursor to the start of the line. @@ -5470,7 +5472,7 @@ macOS specific override for the shortcut to move the text cursor to the start of .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_page_down** +:ref:`Dictionary` **input/ui_text_caret_page_down** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor down one page. @@ -5484,7 +5486,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_page_up** +:ref:`Dictionary` **input/ui_text_caret_page_up** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor up one page. @@ -5498,7 +5500,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_right** +:ref:`Dictionary` **input/ui_text_caret_right** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor right. @@ -5512,7 +5514,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_up** +:ref:`Dictionary` **input/ui_text_caret_up** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor up. @@ -5526,7 +5528,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_word_left** +:ref:`Dictionary` **input/ui_text_caret_word_left** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor left to the next whitespace or punctuation. @@ -5540,7 +5542,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_word_left.macos** +:ref:`Dictionary` **input/ui_text_caret_word_left.macos** :ref:`🔗` macOS specific override for the shortcut to move the text cursor back one word. @@ -5552,7 +5554,7 @@ macOS specific override for the shortcut to move the text cursor back one word. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_word_right** +:ref:`Dictionary` **input/ui_text_caret_word_right** :ref:`🔗` Default :ref:`InputEventAction` to move the text cursor right to the next whitespace or punctuation. @@ -5566,7 +5568,7 @@ Default :ref:`InputEventAction` to move the text cursor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_caret_word_right.macos** +:ref:`Dictionary` **input/ui_text_caret_word_right.macos** :ref:`🔗` macOS specific override for the shortcut to move the text cursor forward one word. @@ -5578,7 +5580,7 @@ macOS specific override for the shortcut to move the text cursor forward one wor .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_clear_carets_and_selection** +:ref:`Dictionary` **input/ui_text_clear_carets_and_selection** :ref:`🔗` If there's only one caret active and with a selection, clears the selection. @@ -5594,7 +5596,7 @@ In case there's more than one caret active, removes the secondary carets and cle .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_completion_accept** +:ref:`Dictionary` **input/ui_text_completion_accept** :ref:`🔗` Default :ref:`InputEventAction` to accept an autocompletion hint. @@ -5608,7 +5610,7 @@ Default :ref:`InputEventAction` to accept an autocomplet .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_completion_query** +:ref:`Dictionary` **input/ui_text_completion_query** :ref:`🔗` Default :ref:`InputEventAction` to request autocompletion. @@ -5622,7 +5624,7 @@ Default :ref:`InputEventAction` to request autocompletio .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_completion_replace** +:ref:`Dictionary` **input/ui_text_completion_replace** :ref:`🔗` Default :ref:`InputEventAction` to accept an autocompletion hint, replacing existing text. @@ -5636,7 +5638,7 @@ Default :ref:`InputEventAction` to accept an autocomplet .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_dedent** +:ref:`Dictionary` **input/ui_text_dedent** :ref:`🔗` Default :ref:`InputEventAction` to unindent text. @@ -5650,7 +5652,7 @@ Default :ref:`InputEventAction` to unindent text. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_delete** +:ref:`Dictionary` **input/ui_text_delete** :ref:`🔗` Default :ref:`InputEventAction` to delete the character after the text cursor. @@ -5664,7 +5666,7 @@ Default :ref:`InputEventAction` to delete the character .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_delete_all_to_right** +:ref:`Dictionary` **input/ui_text_delete_all_to_right** :ref:`🔗` Default :ref:`InputEventAction` to delete **all** text after the text cursor. @@ -5678,7 +5680,7 @@ Default :ref:`InputEventAction` to delete **all** text a .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_delete_all_to_right.macos** +:ref:`Dictionary` **input/ui_text_delete_all_to_right.macos** :ref:`🔗` macOS specific override for the shortcut to delete all text after the text cursor. @@ -5690,7 +5692,7 @@ macOS specific override for the shortcut to delete all text after the text curso .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_delete_word** +:ref:`Dictionary` **input/ui_text_delete_word** :ref:`🔗` Default :ref:`InputEventAction` to delete all characters after the cursor up until a whitespace or punctuation character. @@ -5704,7 +5706,7 @@ Default :ref:`InputEventAction` to delete all characters .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_delete_word.macos** +:ref:`Dictionary` **input/ui_text_delete_word.macos** :ref:`🔗` macOS specific override for the shortcut to delete a word after the text cursor. @@ -5716,7 +5718,7 @@ macOS specific override for the shortcut to delete a word after the text cursor. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_indent** +:ref:`Dictionary` **input/ui_text_indent** :ref:`🔗` Default :ref:`InputEventAction` to indent the current line. @@ -5730,7 +5732,7 @@ Default :ref:`InputEventAction` to indent the current li .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_newline** +:ref:`Dictionary` **input/ui_text_newline** :ref:`🔗` Default :ref:`InputEventAction` to insert a new line at the position of the text cursor. @@ -5744,7 +5746,7 @@ Default :ref:`InputEventAction` to insert a new line at .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_newline_above** +:ref:`Dictionary` **input/ui_text_newline_above** :ref:`🔗` Default :ref:`InputEventAction` to insert a new line before the current one. @@ -5758,7 +5760,7 @@ Default :ref:`InputEventAction` to insert a new line bef .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_newline_blank** +:ref:`Dictionary` **input/ui_text_newline_blank** :ref:`🔗` Default :ref:`InputEventAction` to insert a new line after the current one. @@ -5772,7 +5774,7 @@ Default :ref:`InputEventAction` to insert a new line aft .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_scroll_down** +:ref:`Dictionary` **input/ui_text_scroll_down** :ref:`🔗` Default :ref:`InputEventAction` to scroll down one line of text. @@ -5786,7 +5788,7 @@ Default :ref:`InputEventAction` to scroll down one line .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_scroll_down.macos** +:ref:`Dictionary` **input/ui_text_scroll_down.macos** :ref:`🔗` macOS specific override for the shortcut to scroll down one line. @@ -5798,7 +5800,7 @@ macOS specific override for the shortcut to scroll down one line. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_scroll_up** +:ref:`Dictionary` **input/ui_text_scroll_up** :ref:`🔗` Default :ref:`InputEventAction` to scroll up one line of text. @@ -5812,7 +5814,7 @@ Default :ref:`InputEventAction` to scroll up one line of .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_scroll_up.macos** +:ref:`Dictionary` **input/ui_text_scroll_up.macos** :ref:`🔗` macOS specific override for the shortcut to scroll up one line. @@ -5824,7 +5826,7 @@ macOS specific override for the shortcut to scroll up one line. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_select_all** +:ref:`Dictionary` **input/ui_text_select_all** :ref:`🔗` Default :ref:`InputEventAction` to select all text. @@ -5838,7 +5840,7 @@ Default :ref:`InputEventAction` to select all text. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_select_word_under_caret** +:ref:`Dictionary` **input/ui_text_select_word_under_caret** :ref:`🔗` If no selection is currently active, selects the word currently under the caret in text fields. If a selection is currently active, deselects the current selection. @@ -5852,7 +5854,7 @@ If no selection is currently active, selects the word currently under the caret .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_select_word_under_caret.macos** +:ref:`Dictionary` **input/ui_text_select_word_under_caret.macos** :ref:`🔗` macOS specific override for the shortcut to select the word currently under the caret. @@ -5864,7 +5866,7 @@ macOS specific override for the shortcut to select the word currently under the .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_skip_selection_for_next_occurrence** +:ref:`Dictionary` **input/ui_text_skip_selection_for_next_occurrence** :ref:`🔗` If no selection is currently active with the last caret in text fields, searches for the next occurrence of the the word currently under the caret and moves the caret to the next occurrence. The action can be performed sequentially for other occurrences of the word under the last caret. @@ -5882,7 +5884,7 @@ The viewport is adjusted to the latest newly added caret. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_submit** +:ref:`Dictionary` **input/ui_text_submit** :ref:`🔗` Default :ref:`InputEventAction` to submit a text field. @@ -5896,7 +5898,7 @@ Default :ref:`InputEventAction` to submit a text field. .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_text_toggle_insert_mode** +:ref:`Dictionary` **input/ui_text_toggle_insert_mode** :ref:`🔗` Default :ref:`InputEventAction` to toggle *insert mode* in a text field. While in insert mode, inserting new text overrides the character after the cursor, unless the next character is a new line. @@ -5910,7 +5912,7 @@ Default :ref:`InputEventAction` to toggle *insert mode* .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_undo** +:ref:`Dictionary` **input/ui_undo** :ref:`🔗` Default :ref:`InputEventAction` to undo the most recent action. @@ -5924,7 +5926,7 @@ Default :ref:`InputEventAction` to undo the most recent .. rst-class:: classref-property -:ref:`Dictionary` **input/ui_up** +:ref:`Dictionary` **input/ui_up** :ref:`🔗` Default :ref:`InputEventAction` to move up in the UI. @@ -5938,7 +5940,7 @@ Default :ref:`InputEventAction` to move up in the UI. .. rst-class:: classref-property -:ref:`bool` **input_devices/buffering/agile_event_flushing** = ``false`` +:ref:`bool` **input_devices/buffering/agile_event_flushing** = ``false`` :ref:`🔗` If ``true``, key/touch/joystick events will be flushed just before every idle and physics frame. @@ -5956,7 +5958,7 @@ Enabling this can greatly improve the responsiveness to input, specially in devi .. rst-class:: classref-property -:ref:`bool` **input_devices/compatibility/legacy_just_pressed_behavior** = ``false`` +:ref:`bool` **input_devices/compatibility/legacy_just_pressed_behavior** = ``false`` :ref:`🔗` If ``true``, :ref:`Input.is_action_just_pressed` and :ref:`Input.is_action_just_released` will only return ``true`` if the action is still in the respective state, i.e. an action that is pressed *and* released on the same frame will be missed. @@ -5972,7 +5974,7 @@ If ``false``, no input will be lost. .. rst-class:: classref-property -:ref:`String` **input_devices/pen_tablet/driver** +:ref:`String` **input_devices/pen_tablet/driver** :ref:`🔗` Specifies the tablet driver to use. If left empty, the default driver will be used. @@ -5986,7 +5988,7 @@ Specifies the tablet driver to use. If left empty, the default driver will be us .. rst-class:: classref-property -:ref:`String` **input_devices/pen_tablet/driver.windows** +:ref:`String` **input_devices/pen_tablet/driver.windows** :ref:`🔗` Override for :ref:`input_devices/pen_tablet/driver` on Windows. @@ -5998,7 +6000,7 @@ Override for :ref:`input_devices/pen_tablet/driver` **input_devices/pointing/android/enable_long_press_as_right_click** = ``false`` +:ref:`bool` **input_devices/pointing/android/enable_long_press_as_right_click** = ``false`` :ref:`🔗` If ``true``, long press events on an Android touchscreen are transformed into right click events. @@ -6010,7 +6012,7 @@ If ``true``, long press events on an Android touchscreen are transformed into ri .. rst-class:: classref-property -:ref:`bool` **input_devices/pointing/android/enable_pan_and_scale_gestures** = ``false`` +:ref:`bool` **input_devices/pointing/android/enable_pan_and_scale_gestures** = ``false`` :ref:`🔗` If ``true``, multi-touch pan and scale gestures are enabled on Android devices. @@ -6022,7 +6024,7 @@ If ``true``, multi-touch pan and scale gestures are enabled on Android devices. .. rst-class:: classref-property -:ref:`int` **input_devices/pointing/android/rotary_input_scroll_axis** = ``1`` +:ref:`int` **input_devices/pointing/android/rotary_input_scroll_axis** = ``1`` :ref:`🔗` On Wear OS devices, defines which axis of the mouse wheel rotary input is mapped to. This rotary input is usually performed by rotating the physical or virtual (touch-based) bezel on a smartwatch. @@ -6034,7 +6036,7 @@ On Wear OS devices, defines which axis of the mouse wheel rotary input is mapped .. rst-class:: classref-property -:ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** = ``true`` +:ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** = ``true`` :ref:`🔗` If ``true``, sends mouse input events when tapping or swiping on the touchscreen. @@ -6046,7 +6048,7 @@ If ``true``, sends mouse input events when tapping or swiping on the touchscreen .. rst-class:: classref-property -:ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** = ``false`` +:ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** = ``false`` :ref:`🔗` If ``true``, sends touch input events when clicking or dragging the mouse. @@ -6058,7 +6060,7 @@ If ``true``, sends touch input events when clicking or dragging the mouse. .. rst-class:: classref-property -:ref:`String` **internationalization/locale/fallback** = ``"en"`` +:ref:`String` **internationalization/locale/fallback** = ``"en"`` :ref:`🔗` The locale to fall back to if a translation isn't available in a given language. If left empty, ``en`` (English) will be used. @@ -6070,7 +6072,7 @@ The locale to fall back to if a translation isn't available in a given language. .. rst-class:: classref-property -:ref:`bool` **internationalization/locale/include_text_server_data** = ``false`` +:ref:`bool` **internationalization/locale/include_text_server_data** = ``false`` :ref:`🔗` If ``true``, text server break iteration rule sets, dictionaries and other optional data are included in the exported project. @@ -6086,7 +6088,7 @@ If ``true``, text server break iteration rule sets, dictionaries and other optio .. rst-class:: classref-property -:ref:`String` **internationalization/locale/test** = ``""`` +:ref:`String` **internationalization/locale/test** = ``""`` :ref:`🔗` If non-empty, this locale will be used when running the project from the editor. @@ -6098,7 +6100,7 @@ If non-empty, this locale will be used when running the project from the editor. .. rst-class:: classref-property -:ref:`bool` **internationalization/pseudolocalization/double_vowels** = ``false`` +:ref:`bool` **internationalization/pseudolocalization/double_vowels** = ``false`` :ref:`🔗` Double vowels in strings during pseudolocalization to simulate the lengthening of text due to localization. @@ -6110,7 +6112,7 @@ Double vowels in strings during pseudolocalization to simulate the lengthening o .. rst-class:: classref-property -:ref:`float` **internationalization/pseudolocalization/expansion_ratio** = ``0.0`` +:ref:`float` **internationalization/pseudolocalization/expansion_ratio** = ``0.0`` :ref:`🔗` The expansion ratio to use during pseudolocalization. A value of ``0.3`` is sufficient for most practical purposes, and will increase the length of each string by 30%. @@ -6122,7 +6124,7 @@ The expansion ratio to use during pseudolocalization. A value of ``0.3`` is suff .. rst-class:: classref-property -:ref:`bool` **internationalization/pseudolocalization/fake_bidi** = ``false`` +:ref:`bool` **internationalization/pseudolocalization/fake_bidi** = ``false`` :ref:`🔗` If ``true``, emulate bidirectional (right-to-left) text when pseudolocalization is enabled. This can be used to spot issues with RTL layout and UI mirroring that will crop up if the project is localized to RTL languages such as Arabic or Hebrew. @@ -6134,7 +6136,7 @@ If ``true``, emulate bidirectional (right-to-left) text when pseudolocalization .. rst-class:: classref-property -:ref:`bool` **internationalization/pseudolocalization/override** = ``false`` +:ref:`bool` **internationalization/pseudolocalization/override** = ``false`` :ref:`🔗` Replace all characters in the string with ``*``. Useful for finding non-localizable strings. @@ -6146,7 +6148,7 @@ Replace all characters in the string with ``*``. Useful for finding non-localiza .. rst-class:: classref-property -:ref:`String` **internationalization/pseudolocalization/prefix** = ``"["`` +:ref:`String` **internationalization/pseudolocalization/prefix** = ``"["`` :ref:`🔗` Prefix that will be prepended to the pseudolocalized string. @@ -6158,7 +6160,7 @@ Prefix that will be prepended to the pseudolocalized string. .. rst-class:: classref-property -:ref:`bool` **internationalization/pseudolocalization/replace_with_accents** = ``true`` +:ref:`bool` **internationalization/pseudolocalization/replace_with_accents** = ``true`` :ref:`🔗` Replace all characters with their accented variants during pseudolocalization. @@ -6170,7 +6172,7 @@ Replace all characters with their accented variants during pseudolocalization. .. rst-class:: classref-property -:ref:`bool` **internationalization/pseudolocalization/skip_placeholders** = ``true`` +:ref:`bool` **internationalization/pseudolocalization/skip_placeholders** = ``true`` :ref:`🔗` Skip placeholders for string formatting like ``%s`` or ``%f`` during pseudolocalization. Useful to identify strings which need additional control characters to display correctly. @@ -6182,7 +6184,7 @@ Skip placeholders for string formatting like ``%s`` or ``%f`` during pseudolocal .. rst-class:: classref-property -:ref:`String` **internationalization/pseudolocalization/suffix** = ``"]"`` +:ref:`String` **internationalization/pseudolocalization/suffix** = ``"]"`` :ref:`🔗` Suffix that will be appended to the pseudolocalized string. @@ -6194,7 +6196,7 @@ Suffix that will be appended to the pseudolocalized string. .. rst-class:: classref-property -:ref:`bool` **internationalization/pseudolocalization/use_pseudolocalization** = ``false`` +:ref:`bool` **internationalization/pseudolocalization/use_pseudolocalization** = ``false`` :ref:`🔗` If ``true``, enables pseudolocalization for the project. This can be used to spot untranslatable strings or layout issues that may occur once the project is localized to languages that have longer strings than the source language. @@ -6208,7 +6210,7 @@ If ``true``, enables pseudolocalization for the project. This can be used to spo .. rst-class:: classref-property -:ref:`bool` **internationalization/rendering/force_right_to_left_layout_direction** = ``false`` +:ref:`bool` **internationalization/rendering/force_right_to_left_layout_direction** = ``false`` :ref:`🔗` Force layout direction and text writing direction to RTL for all controls. @@ -6220,7 +6222,7 @@ Force layout direction and text writing direction to RTL for all controls. .. rst-class:: classref-property -:ref:`bool` **internationalization/rendering/root_node_auto_translate** = ``true`` +:ref:`bool` **internationalization/rendering/root_node_auto_translate** = ``true`` :ref:`🔗` If ``true``, root node will use :ref:`Node.AUTO_TRANSLATE_MODE_ALWAYS`, otherwise :ref:`Node.AUTO_TRANSLATE_MODE_DISABLED` will be used. @@ -6234,7 +6236,7 @@ If ``true``, root node will use :ref:`Node.AUTO_TRANSLATE_MODE_ALWAYS` **internationalization/rendering/root_node_layout_direction** = ``0`` +:ref:`int` **internationalization/rendering/root_node_layout_direction** = ``0`` :ref:`🔗` Root node default layout direction. @@ -6246,7 +6248,7 @@ Root node default layout direction. .. rst-class:: classref-property -:ref:`String` **internationalization/rendering/text_driver** = ``""`` +:ref:`String` **internationalization/rendering/text_driver** = ``""`` :ref:`🔗` Specifies the :ref:`TextServer` to use. If left empty, the default will be used. @@ -6264,7 +6266,7 @@ Specifies the :ref:`TextServer` to use. If left empty, the def .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_1** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_1** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 1. If left empty, the layer will display as "Layer 1". @@ -6276,7 +6278,7 @@ Optional name for the 2D navigation layer 1. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_2** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_2** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 2. If left empty, the layer will display as "Layer 2". @@ -6288,7 +6290,7 @@ Optional name for the 2D navigation layer 2. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_3** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_3** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 3. If left empty, the layer will display as "Layer 3". @@ -6300,7 +6302,7 @@ Optional name for the 2D navigation layer 3. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_4** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_4** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 4. If left empty, the layer will display as "Layer 4". @@ -6312,7 +6314,7 @@ Optional name for the 2D navigation layer 4. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_5** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_5** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 5. If left empty, the layer will display as "Layer 5". @@ -6324,7 +6326,7 @@ Optional name for the 2D navigation layer 5. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_6** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_6** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 6. If left empty, the layer will display as "Layer 6". @@ -6336,7 +6338,7 @@ Optional name for the 2D navigation layer 6. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_7** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_7** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 7. If left empty, the layer will display as "Layer 7". @@ -6348,7 +6350,7 @@ Optional name for the 2D navigation layer 7. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_8** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_8** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 8. If left empty, the layer will display as "Layer 8". @@ -6360,7 +6362,7 @@ Optional name for the 2D navigation layer 8. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_9** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_9** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 9. If left empty, the layer will display as "Layer 9". @@ -6372,7 +6374,7 @@ Optional name for the 2D navigation layer 9. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_10** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_10** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 10. If left empty, the layer will display as "Layer 10". @@ -6384,7 +6386,7 @@ Optional name for the 2D navigation layer 10. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_11** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_11** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 11. If left empty, the layer will display as "Layer 11". @@ -6396,7 +6398,7 @@ Optional name for the 2D navigation layer 11. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_12** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_12** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 12. If left empty, the layer will display as "Layer 12". @@ -6408,7 +6410,7 @@ Optional name for the 2D navigation layer 12. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_13** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_13** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 13. If left empty, the layer will display as "Layer 13". @@ -6420,7 +6422,7 @@ Optional name for the 2D navigation layer 13. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_14** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_14** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 14. If left empty, the layer will display as "Layer 14". @@ -6432,7 +6434,7 @@ Optional name for the 2D navigation layer 14. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_15** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_15** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 15. If left empty, the layer will display as "Layer 15". @@ -6444,7 +6446,7 @@ Optional name for the 2D navigation layer 15. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_16** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_16** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 16. If left empty, the layer will display as "Layer 16". @@ -6456,7 +6458,7 @@ Optional name for the 2D navigation layer 16. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_17** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_17** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 17. If left empty, the layer will display as "Layer 17". @@ -6468,7 +6470,7 @@ Optional name for the 2D navigation layer 17. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_18** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_18** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 18. If left empty, the layer will display as "Layer 18". @@ -6480,7 +6482,7 @@ Optional name for the 2D navigation layer 18. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_19** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_19** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 19. If left empty, the layer will display as "Layer 19". @@ -6492,7 +6494,7 @@ Optional name for the 2D navigation layer 19. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_20** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_20** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 20. If left empty, the layer will display as "Layer 20". @@ -6504,7 +6506,7 @@ Optional name for the 2D navigation layer 20. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_21** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_21** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 21. If left empty, the layer will display as "Layer 21". @@ -6516,7 +6518,7 @@ Optional name for the 2D navigation layer 21. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_22** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_22** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 22. If left empty, the layer will display as "Layer 22". @@ -6528,7 +6530,7 @@ Optional name for the 2D navigation layer 22. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_23** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_23** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 23. If left empty, the layer will display as "Layer 23". @@ -6540,7 +6542,7 @@ Optional name for the 2D navigation layer 23. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_24** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_24** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 24. If left empty, the layer will display as "Layer 24". @@ -6552,7 +6554,7 @@ Optional name for the 2D navigation layer 24. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_25** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_25** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 25. If left empty, the layer will display as "Layer 25". @@ -6564,7 +6566,7 @@ Optional name for the 2D navigation layer 25. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_26** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_26** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 26. If left empty, the layer will display as "Layer 26". @@ -6576,7 +6578,7 @@ Optional name for the 2D navigation layer 26. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_27** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_27** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 27. If left empty, the layer will display as "Layer 27". @@ -6588,7 +6590,7 @@ Optional name for the 2D navigation layer 27. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_28** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_28** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 28. If left empty, the layer will display as "Layer 28". @@ -6600,7 +6602,7 @@ Optional name for the 2D navigation layer 28. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_29** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_29** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 29. If left empty, the layer will display as "Layer 29". @@ -6612,7 +6614,7 @@ Optional name for the 2D navigation layer 29. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_30** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_30** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 30. If left empty, the layer will display as "Layer 30". @@ -6624,7 +6626,7 @@ Optional name for the 2D navigation layer 30. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_31** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_31** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 31. If left empty, the layer will display as "Layer 31". @@ -6636,7 +6638,7 @@ Optional name for the 2D navigation layer 31. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_navigation/layer_32** = ``""`` +:ref:`String` **layer_names/2d_navigation/layer_32** = ``""`` :ref:`🔗` Optional name for the 2D navigation layer 32. If left empty, the layer will display as "Layer 32". @@ -6648,7 +6650,7 @@ Optional name for the 2D navigation layer 32. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_1** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_1** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 1. If left empty, the layer will display as "Layer 1". @@ -6660,7 +6662,7 @@ Optional name for the 2D physics layer 1. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_2** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_2** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 2. If left empty, the layer will display as "Layer 2". @@ -6672,7 +6674,7 @@ Optional name for the 2D physics layer 2. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_3** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_3** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 3. If left empty, the layer will display as "Layer 3". @@ -6684,7 +6686,7 @@ Optional name for the 2D physics layer 3. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_4** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_4** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 4. If left empty, the layer will display as "Layer 4". @@ -6696,7 +6698,7 @@ Optional name for the 2D physics layer 4. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_5** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_5** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 5. If left empty, the layer will display as "Layer 5". @@ -6708,7 +6710,7 @@ Optional name for the 2D physics layer 5. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_6** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_6** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 6. If left empty, the layer will display as "Layer 6". @@ -6720,7 +6722,7 @@ Optional name for the 2D physics layer 6. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_7** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_7** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 7. If left empty, the layer will display as "Layer 7". @@ -6732,7 +6734,7 @@ Optional name for the 2D physics layer 7. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_8** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_8** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 8. If left empty, the layer will display as "Layer 8". @@ -6744,7 +6746,7 @@ Optional name for the 2D physics layer 8. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_9** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_9** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 9. If left empty, the layer will display as "Layer 9". @@ -6756,7 +6758,7 @@ Optional name for the 2D physics layer 9. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_10** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_10** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 10. If left empty, the layer will display as "Layer 10". @@ -6768,7 +6770,7 @@ Optional name for the 2D physics layer 10. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_11** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_11** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 11. If left empty, the layer will display as "Layer 11". @@ -6780,7 +6782,7 @@ Optional name for the 2D physics layer 11. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_12** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_12** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 12. If left empty, the layer will display as "Layer 12". @@ -6792,7 +6794,7 @@ Optional name for the 2D physics layer 12. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_13** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_13** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 13. If left empty, the layer will display as "Layer 13". @@ -6804,7 +6806,7 @@ Optional name for the 2D physics layer 13. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_14** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_14** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 14. If left empty, the layer will display as "Layer 14". @@ -6816,7 +6818,7 @@ Optional name for the 2D physics layer 14. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_15** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_15** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 15. If left empty, the layer will display as "Layer 15". @@ -6828,7 +6830,7 @@ Optional name for the 2D physics layer 15. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_16** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_16** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 16. If left empty, the layer will display as "Layer 16". @@ -6840,7 +6842,7 @@ Optional name for the 2D physics layer 16. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_17** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_17** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 17. If left empty, the layer will display as "Layer 17". @@ -6852,7 +6854,7 @@ Optional name for the 2D physics layer 17. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_18** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_18** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 18. If left empty, the layer will display as "Layer 18". @@ -6864,7 +6866,7 @@ Optional name for the 2D physics layer 18. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_19** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_19** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 19. If left empty, the layer will display as "Layer 19". @@ -6876,7 +6878,7 @@ Optional name for the 2D physics layer 19. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_20** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_20** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 20. If left empty, the layer will display as "Layer 20". @@ -6888,7 +6890,7 @@ Optional name for the 2D physics layer 20. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_21** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_21** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 21. If left empty, the layer will display as "Layer 21". @@ -6900,7 +6902,7 @@ Optional name for the 2D physics layer 21. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_22** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_22** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 22. If left empty, the layer will display as "Layer 22". @@ -6912,7 +6914,7 @@ Optional name for the 2D physics layer 22. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_23** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_23** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 23. If left empty, the layer will display as "Layer 23". @@ -6924,7 +6926,7 @@ Optional name for the 2D physics layer 23. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_24** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_24** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 24. If left empty, the layer will display as "Layer 24". @@ -6936,7 +6938,7 @@ Optional name for the 2D physics layer 24. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_25** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_25** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 25. If left empty, the layer will display as "Layer 25". @@ -6948,7 +6950,7 @@ Optional name for the 2D physics layer 25. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_26** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_26** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 26. If left empty, the layer will display as "Layer 26". @@ -6960,7 +6962,7 @@ Optional name for the 2D physics layer 26. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_27** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_27** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 27. If left empty, the layer will display as "Layer 27". @@ -6972,7 +6974,7 @@ Optional name for the 2D physics layer 27. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_28** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_28** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 28. If left empty, the layer will display as "Layer 28". @@ -6984,7 +6986,7 @@ Optional name for the 2D physics layer 28. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_29** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_29** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 29. If left empty, the layer will display as "Layer 29". @@ -6996,7 +6998,7 @@ Optional name for the 2D physics layer 29. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_30** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_30** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 30. If left empty, the layer will display as "Layer 30". @@ -7008,7 +7010,7 @@ Optional name for the 2D physics layer 30. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_31** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_31** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 31. If left empty, the layer will display as "Layer 31". @@ -7020,7 +7022,7 @@ Optional name for the 2D physics layer 31. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_physics/layer_32** = ``""`` +:ref:`String` **layer_names/2d_physics/layer_32** = ``""`` :ref:`🔗` Optional name for the 2D physics layer 32. If left empty, the layer will display as "Layer 32". @@ -7032,7 +7034,7 @@ Optional name for the 2D physics layer 32. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_1** = ``""`` +:ref:`String` **layer_names/2d_render/layer_1** = ``""`` :ref:`🔗` Optional name for the 2D render layer 1. If left empty, the layer will display as "Layer 1". @@ -7044,7 +7046,7 @@ Optional name for the 2D render layer 1. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_2** = ``""`` +:ref:`String` **layer_names/2d_render/layer_2** = ``""`` :ref:`🔗` Optional name for the 2D render layer 2. If left empty, the layer will display as "Layer 2". @@ -7056,7 +7058,7 @@ Optional name for the 2D render layer 2. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_3** = ``""`` +:ref:`String` **layer_names/2d_render/layer_3** = ``""`` :ref:`🔗` Optional name for the 2D render layer 3. If left empty, the layer will display as "Layer 3". @@ -7068,7 +7070,7 @@ Optional name for the 2D render layer 3. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_4** = ``""`` +:ref:`String` **layer_names/2d_render/layer_4** = ``""`` :ref:`🔗` Optional name for the 2D render layer 4. If left empty, the layer will display as "Layer 4". @@ -7080,7 +7082,7 @@ Optional name for the 2D render layer 4. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_5** = ``""`` +:ref:`String` **layer_names/2d_render/layer_5** = ``""`` :ref:`🔗` Optional name for the 2D render layer 5. If left empty, the layer will display as "Layer 5". @@ -7092,7 +7094,7 @@ Optional name for the 2D render layer 5. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_6** = ``""`` +:ref:`String` **layer_names/2d_render/layer_6** = ``""`` :ref:`🔗` Optional name for the 2D render layer 6. If left empty, the layer will display as "Layer 6". @@ -7104,7 +7106,7 @@ Optional name for the 2D render layer 6. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_7** = ``""`` +:ref:`String` **layer_names/2d_render/layer_7** = ``""`` :ref:`🔗` Optional name for the 2D render layer 7. If left empty, the layer will display as "Layer 7". @@ -7116,7 +7118,7 @@ Optional name for the 2D render layer 7. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_8** = ``""`` +:ref:`String` **layer_names/2d_render/layer_8** = ``""`` :ref:`🔗` Optional name for the 2D render layer 8. If left empty, the layer will display as "Layer 8". @@ -7128,7 +7130,7 @@ Optional name for the 2D render layer 8. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_9** = ``""`` +:ref:`String` **layer_names/2d_render/layer_9** = ``""`` :ref:`🔗` Optional name for the 2D render layer 9. If left empty, the layer will display as "Layer 9". @@ -7140,7 +7142,7 @@ Optional name for the 2D render layer 9. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_10** = ``""`` +:ref:`String` **layer_names/2d_render/layer_10** = ``""`` :ref:`🔗` Optional name for the 2D render layer 10. If left empty, the layer will display as "Layer 10". @@ -7152,7 +7154,7 @@ Optional name for the 2D render layer 10. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_11** = ``""`` +:ref:`String` **layer_names/2d_render/layer_11** = ``""`` :ref:`🔗` Optional name for the 2D render layer 11. If left empty, the layer will display as "Layer 11". @@ -7164,7 +7166,7 @@ Optional name for the 2D render layer 11. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_12** = ``""`` +:ref:`String` **layer_names/2d_render/layer_12** = ``""`` :ref:`🔗` Optional name for the 2D render layer 12. If left empty, the layer will display as "Layer 12". @@ -7176,7 +7178,7 @@ Optional name for the 2D render layer 12. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_13** = ``""`` +:ref:`String` **layer_names/2d_render/layer_13** = ``""`` :ref:`🔗` Optional name for the 2D render layer 13. If left empty, the layer will display as "Layer 13". @@ -7188,7 +7190,7 @@ Optional name for the 2D render layer 13. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_14** = ``""`` +:ref:`String` **layer_names/2d_render/layer_14** = ``""`` :ref:`🔗` Optional name for the 2D render layer 14. If left empty, the layer will display as "Layer 14". @@ -7200,7 +7202,7 @@ Optional name for the 2D render layer 14. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_15** = ``""`` +:ref:`String` **layer_names/2d_render/layer_15** = ``""`` :ref:`🔗` Optional name for the 2D render layer 15. If left empty, the layer will display as "Layer 15". @@ -7212,7 +7214,7 @@ Optional name for the 2D render layer 15. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_16** = ``""`` +:ref:`String` **layer_names/2d_render/layer_16** = ``""`` :ref:`🔗` Optional name for the 2D render layer 16. If left empty, the layer will display as "Layer 16". @@ -7224,7 +7226,7 @@ Optional name for the 2D render layer 16. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_17** = ``""`` +:ref:`String` **layer_names/2d_render/layer_17** = ``""`` :ref:`🔗` Optional name for the 2D render layer 17. If left empty, the layer will display as "Layer 17". @@ -7236,7 +7238,7 @@ Optional name for the 2D render layer 17. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_18** = ``""`` +:ref:`String` **layer_names/2d_render/layer_18** = ``""`` :ref:`🔗` Optional name for the 2D render layer 18. If left empty, the layer will display as "Layer 18". @@ -7248,7 +7250,7 @@ Optional name for the 2D render layer 18. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_19** = ``""`` +:ref:`String` **layer_names/2d_render/layer_19** = ``""`` :ref:`🔗` Optional name for the 2D render layer 19. If left empty, the layer will display as "Layer 19". @@ -7260,7 +7262,7 @@ Optional name for the 2D render layer 19. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/2d_render/layer_20** = ``""`` +:ref:`String` **layer_names/2d_render/layer_20** = ``""`` :ref:`🔗` Optional name for the 2D render layer 20. If left empty, the layer will display as "Layer 20". @@ -7272,7 +7274,7 @@ Optional name for the 2D render layer 20. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_1** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_1** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 1. If left empty, the layer will display as "Layer 1". @@ -7284,7 +7286,7 @@ Optional name for the 3D navigation layer 1. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_2** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_2** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 2. If left empty, the layer will display as "Layer 2". @@ -7296,7 +7298,7 @@ Optional name for the 3D navigation layer 2. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_3** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_3** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 3. If left empty, the layer will display as "Layer 3". @@ -7308,7 +7310,7 @@ Optional name for the 3D navigation layer 3. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_4** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_4** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 4. If left empty, the layer will display as "Layer 4". @@ -7320,7 +7322,7 @@ Optional name for the 3D navigation layer 4. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_5** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_5** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 5. If left empty, the layer will display as "Layer 5". @@ -7332,7 +7334,7 @@ Optional name for the 3D navigation layer 5. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_6** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_6** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 6. If left empty, the layer will display as "Layer 6". @@ -7344,7 +7346,7 @@ Optional name for the 3D navigation layer 6. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_7** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_7** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 7. If left empty, the layer will display as "Layer 7". @@ -7356,7 +7358,7 @@ Optional name for the 3D navigation layer 7. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_8** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_8** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 8. If left empty, the layer will display as "Layer 8". @@ -7368,7 +7370,7 @@ Optional name for the 3D navigation layer 8. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_9** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_9** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 9. If left empty, the layer will display as "Layer 9". @@ -7380,7 +7382,7 @@ Optional name for the 3D navigation layer 9. If left empty, the layer will displ .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_10** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_10** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 10. If left empty, the layer will display as "Layer 10". @@ -7392,7 +7394,7 @@ Optional name for the 3D navigation layer 10. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_11** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_11** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 11. If left empty, the layer will display as "Layer 11". @@ -7404,7 +7406,7 @@ Optional name for the 3D navigation layer 11. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_12** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_12** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 12. If left empty, the layer will display as "Layer 12". @@ -7416,7 +7418,7 @@ Optional name for the 3D navigation layer 12. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_13** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_13** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 13. If left empty, the layer will display as "Layer 13". @@ -7428,7 +7430,7 @@ Optional name for the 3D navigation layer 13. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_14** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_14** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 14. If left empty, the layer will display as "Layer 14". @@ -7440,7 +7442,7 @@ Optional name for the 3D navigation layer 14. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_15** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_15** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 15. If left empty, the layer will display as "Layer 15". @@ -7452,7 +7454,7 @@ Optional name for the 3D navigation layer 15. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_16** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_16** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 16. If left empty, the layer will display as "Layer 16". @@ -7464,7 +7466,7 @@ Optional name for the 3D navigation layer 16. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_17** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_17** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 17. If left empty, the layer will display as "Layer 17". @@ -7476,7 +7478,7 @@ Optional name for the 3D navigation layer 17. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_18** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_18** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 18. If left empty, the layer will display as "Layer 18". @@ -7488,7 +7490,7 @@ Optional name for the 3D navigation layer 18. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_19** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_19** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 19. If left empty, the layer will display as "Layer 19". @@ -7500,7 +7502,7 @@ Optional name for the 3D navigation layer 19. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_20** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_20** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 20. If left empty, the layer will display as "Layer 20". @@ -7512,7 +7514,7 @@ Optional name for the 3D navigation layer 20. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_21** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_21** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 21. If left empty, the layer will display as "Layer 21". @@ -7524,7 +7526,7 @@ Optional name for the 3D navigation layer 21. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_22** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_22** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 22. If left empty, the layer will display as "Layer 22". @@ -7536,7 +7538,7 @@ Optional name for the 3D navigation layer 22. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_23** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_23** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 23. If left empty, the layer will display as "Layer 23". @@ -7548,7 +7550,7 @@ Optional name for the 3D navigation layer 23. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_24** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_24** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 24. If left empty, the layer will display as "Layer 24". @@ -7560,7 +7562,7 @@ Optional name for the 3D navigation layer 24. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_25** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_25** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 25. If left empty, the layer will display as "Layer 25". @@ -7572,7 +7574,7 @@ Optional name for the 3D navigation layer 25. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_26** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_26** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 26. If left empty, the layer will display as "Layer 26". @@ -7584,7 +7586,7 @@ Optional name for the 3D navigation layer 26. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_27** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_27** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 27. If left empty, the layer will display as "Layer 27". @@ -7596,7 +7598,7 @@ Optional name for the 3D navigation layer 27. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_28** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_28** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 28. If left empty, the layer will display as "Layer 28". @@ -7608,7 +7610,7 @@ Optional name for the 3D navigation layer 28. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_29** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_29** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 29. If left empty, the layer will display as "Layer 29". @@ -7620,7 +7622,7 @@ Optional name for the 3D navigation layer 29. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_30** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_30** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 30. If left empty, the layer will display as "Layer 30". @@ -7632,7 +7634,7 @@ Optional name for the 3D navigation layer 30. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_31** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_31** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 31. If left empty, the layer will display as "Layer 31". @@ -7644,7 +7646,7 @@ Optional name for the 3D navigation layer 31. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_navigation/layer_32** = ``""`` +:ref:`String` **layer_names/3d_navigation/layer_32** = ``""`` :ref:`🔗` Optional name for the 3D navigation layer 32. If left empty, the layer will display as "Layer 32". @@ -7656,7 +7658,7 @@ Optional name for the 3D navigation layer 32. If left empty, the layer will disp .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_1** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_1** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 1. If left empty, the layer will display as "Layer 1". @@ -7668,7 +7670,7 @@ Optional name for the 3D physics layer 1. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_2** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_2** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 2. If left empty, the layer will display as "Layer 2". @@ -7680,7 +7682,7 @@ Optional name for the 3D physics layer 2. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_3** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_3** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 3. If left empty, the layer will display as "Layer 3". @@ -7692,7 +7694,7 @@ Optional name for the 3D physics layer 3. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_4** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_4** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 4. If left empty, the layer will display as "Layer 4". @@ -7704,7 +7706,7 @@ Optional name for the 3D physics layer 4. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_5** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_5** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 5. If left empty, the layer will display as "Layer 5". @@ -7716,7 +7718,7 @@ Optional name for the 3D physics layer 5. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_6** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_6** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 6. If left empty, the layer will display as "Layer 6". @@ -7728,7 +7730,7 @@ Optional name for the 3D physics layer 6. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_7** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_7** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 7. If left empty, the layer will display as "Layer 7". @@ -7740,7 +7742,7 @@ Optional name for the 3D physics layer 7. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_8** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_8** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 8. If left empty, the layer will display as "Layer 8". @@ -7752,7 +7754,7 @@ Optional name for the 3D physics layer 8. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_9** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_9** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 9. If left empty, the layer will display as "Layer 9". @@ -7764,7 +7766,7 @@ Optional name for the 3D physics layer 9. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_10** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_10** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 10. If left empty, the layer will display as "Layer 10". @@ -7776,7 +7778,7 @@ Optional name for the 3D physics layer 10. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_11** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_11** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 11. If left empty, the layer will display as "Layer 11". @@ -7788,7 +7790,7 @@ Optional name for the 3D physics layer 11. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_12** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_12** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 12. If left empty, the layer will display as "Layer 12". @@ -7800,7 +7802,7 @@ Optional name for the 3D physics layer 12. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_13** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_13** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 13. If left empty, the layer will display as "Layer 13". @@ -7812,7 +7814,7 @@ Optional name for the 3D physics layer 13. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_14** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_14** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 14. If left empty, the layer will display as "Layer 14". @@ -7824,7 +7826,7 @@ Optional name for the 3D physics layer 14. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_15** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_15** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 15. If left empty, the layer will display as "Layer 15". @@ -7836,7 +7838,7 @@ Optional name for the 3D physics layer 15. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_16** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_16** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 16. If left empty, the layer will display as "Layer 16". @@ -7848,7 +7850,7 @@ Optional name for the 3D physics layer 16. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_17** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_17** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 17. If left empty, the layer will display as "Layer 17". @@ -7860,7 +7862,7 @@ Optional name for the 3D physics layer 17. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_18** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_18** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 18. If left empty, the layer will display as "Layer 18". @@ -7872,7 +7874,7 @@ Optional name for the 3D physics layer 18. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_19** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_19** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 19. If left empty, the layer will display as "Layer 19". @@ -7884,7 +7886,7 @@ Optional name for the 3D physics layer 19. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_20** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_20** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 20. If left empty, the layer will display as "Layer 20". @@ -7896,7 +7898,7 @@ Optional name for the 3D physics layer 20. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_21** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_21** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 21. If left empty, the layer will display as "Layer 21". @@ -7908,7 +7910,7 @@ Optional name for the 3D physics layer 21. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_22** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_22** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 22. If left empty, the layer will display as "Layer 22". @@ -7920,7 +7922,7 @@ Optional name for the 3D physics layer 22. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_23** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_23** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 23. If left empty, the layer will display as "Layer 23". @@ -7932,7 +7934,7 @@ Optional name for the 3D physics layer 23. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_24** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_24** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 24. If left empty, the layer will display as "Layer 24". @@ -7944,7 +7946,7 @@ Optional name for the 3D physics layer 24. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_25** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_25** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 25. If left empty, the layer will display as "Layer 25". @@ -7956,7 +7958,7 @@ Optional name for the 3D physics layer 25. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_26** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_26** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 26. If left empty, the layer will display as "Layer 26". @@ -7968,7 +7970,7 @@ Optional name for the 3D physics layer 26. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_27** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_27** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 27. If left empty, the layer will display as "Layer 27". @@ -7980,7 +7982,7 @@ Optional name for the 3D physics layer 27. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_28** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_28** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 28. If left empty, the layer will display as "Layer 28". @@ -7992,7 +7994,7 @@ Optional name for the 3D physics layer 28. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_29** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_29** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 29. If left empty, the layer will display as "Layer 29". @@ -8004,7 +8006,7 @@ Optional name for the 3D physics layer 29. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_30** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_30** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 30. If left empty, the layer will display as "Layer 30". @@ -8016,7 +8018,7 @@ Optional name for the 3D physics layer 30. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_31** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_31** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 31. If left empty, the layer will display as "Layer 31". @@ -8028,7 +8030,7 @@ Optional name for the 3D physics layer 31. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_physics/layer_32** = ``""`` +:ref:`String` **layer_names/3d_physics/layer_32** = ``""`` :ref:`🔗` Optional name for the 3D physics layer 32. If left empty, the layer will display as "Layer 32". @@ -8040,7 +8042,7 @@ Optional name for the 3D physics layer 32. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_1** = ``""`` +:ref:`String` **layer_names/3d_render/layer_1** = ``""`` :ref:`🔗` Optional name for the 3D render layer 1. If left empty, the layer will display as "Layer 1". @@ -8052,7 +8054,7 @@ Optional name for the 3D render layer 1. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_2** = ``""`` +:ref:`String` **layer_names/3d_render/layer_2** = ``""`` :ref:`🔗` Optional name for the 3D render layer 2. If left empty, the layer will display as "Layer 2". @@ -8064,7 +8066,7 @@ Optional name for the 3D render layer 2. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_3** = ``""`` +:ref:`String` **layer_names/3d_render/layer_3** = ``""`` :ref:`🔗` Optional name for the 3D render layer 3. If left empty, the layer will display as "Layer 3". @@ -8076,7 +8078,7 @@ Optional name for the 3D render layer 3. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_4** = ``""`` +:ref:`String` **layer_names/3d_render/layer_4** = ``""`` :ref:`🔗` Optional name for the 3D render layer 4. If left empty, the layer will display as "Layer 4". @@ -8088,7 +8090,7 @@ Optional name for the 3D render layer 4. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_5** = ``""`` +:ref:`String` **layer_names/3d_render/layer_5** = ``""`` :ref:`🔗` Optional name for the 3D render layer 5. If left empty, the layer will display as "Layer 5". @@ -8100,7 +8102,7 @@ Optional name for the 3D render layer 5. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_6** = ``""`` +:ref:`String` **layer_names/3d_render/layer_6** = ``""`` :ref:`🔗` Optional name for the 3D render layer 6. If left empty, the layer will display as "Layer 6". @@ -8112,7 +8114,7 @@ Optional name for the 3D render layer 6. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_7** = ``""`` +:ref:`String` **layer_names/3d_render/layer_7** = ``""`` :ref:`🔗` Optional name for the 3D render layer 7. If left empty, the layer will display as "Layer 7". @@ -8124,7 +8126,7 @@ Optional name for the 3D render layer 7. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_8** = ``""`` +:ref:`String` **layer_names/3d_render/layer_8** = ``""`` :ref:`🔗` Optional name for the 3D render layer 8. If left empty, the layer will display as "Layer 8". @@ -8136,7 +8138,7 @@ Optional name for the 3D render layer 8. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_9** = ``""`` +:ref:`String` **layer_names/3d_render/layer_9** = ``""`` :ref:`🔗` Optional name for the 3D render layer 9. If left empty, the layer will display as "Layer 9". @@ -8148,7 +8150,7 @@ Optional name for the 3D render layer 9. If left empty, the layer will display a .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_10** = ``""`` +:ref:`String` **layer_names/3d_render/layer_10** = ``""`` :ref:`🔗` Optional name for the 3D render layer 10. If left empty, the layer will display as "Layer 10". @@ -8160,7 +8162,7 @@ Optional name for the 3D render layer 10. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_11** = ``""`` +:ref:`String` **layer_names/3d_render/layer_11** = ``""`` :ref:`🔗` Optional name for the 3D render layer 11. If left empty, the layer will display as "Layer 11". @@ -8172,7 +8174,7 @@ Optional name for the 3D render layer 11. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_12** = ``""`` +:ref:`String` **layer_names/3d_render/layer_12** = ``""`` :ref:`🔗` Optional name for the 3D render layer 12. If left empty, the layer will display as "Layer 12". @@ -8184,7 +8186,7 @@ Optional name for the 3D render layer 12. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_13** = ``""`` +:ref:`String` **layer_names/3d_render/layer_13** = ``""`` :ref:`🔗` Optional name for the 3D render layer 13. If left empty, the layer will display as "Layer 13". @@ -8196,7 +8198,7 @@ Optional name for the 3D render layer 13. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_14** = ``""`` +:ref:`String` **layer_names/3d_render/layer_14** = ``""`` :ref:`🔗` Optional name for the 3D render layer 14. If left empty, the layer will display as "Layer 14". @@ -8208,7 +8210,7 @@ Optional name for the 3D render layer 14. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_15** = ``""`` +:ref:`String` **layer_names/3d_render/layer_15** = ``""`` :ref:`🔗` Optional name for the 3D render layer 15. If left empty, the layer will display as "Layer 15". @@ -8220,7 +8222,7 @@ Optional name for the 3D render layer 15. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_16** = ``""`` +:ref:`String` **layer_names/3d_render/layer_16** = ``""`` :ref:`🔗` Optional name for the 3D render layer 16. If left empty, the layer will display as "Layer 16". @@ -8232,7 +8234,7 @@ Optional name for the 3D render layer 16. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_17** = ``""`` +:ref:`String` **layer_names/3d_render/layer_17** = ``""`` :ref:`🔗` Optional name for the 3D render layer 17. If left empty, the layer will display as "Layer 17". @@ -8244,7 +8246,7 @@ Optional name for the 3D render layer 17. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_18** = ``""`` +:ref:`String` **layer_names/3d_render/layer_18** = ``""`` :ref:`🔗` Optional name for the 3D render layer 18. If left empty, the layer will display as "Layer 18". @@ -8256,7 +8258,7 @@ Optional name for the 3D render layer 18. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_19** = ``""`` +:ref:`String` **layer_names/3d_render/layer_19** = ``""`` :ref:`🔗` Optional name for the 3D render layer 19. If left empty, the layer will display as "Layer 19". @@ -8268,7 +8270,7 @@ Optional name for the 3D render layer 19. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/3d_render/layer_20** = ``""`` +:ref:`String` **layer_names/3d_render/layer_20** = ``""`` :ref:`🔗` Optional name for the 3D render layer 20. If left empty, the layer will display as "Layer 20". @@ -8280,7 +8282,7 @@ Optional name for the 3D render layer 20. If left empty, the layer will display .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_1** = ``""`` +:ref:`String` **layer_names/avoidance/layer_1** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 1. If left empty, the layer will display as "Layer 1". @@ -8292,7 +8294,7 @@ Optional name for the navigation avoidance layer 1. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_2** = ``""`` +:ref:`String` **layer_names/avoidance/layer_2** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 2. If left empty, the layer will display as "Layer 2". @@ -8304,7 +8306,7 @@ Optional name for the navigation avoidance layer 2. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_3** = ``""`` +:ref:`String` **layer_names/avoidance/layer_3** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 3. If left empty, the layer will display as "Layer 3". @@ -8316,7 +8318,7 @@ Optional name for the navigation avoidance layer 3. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_4** = ``""`` +:ref:`String` **layer_names/avoidance/layer_4** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 4. If left empty, the layer will display as "Layer 4". @@ -8328,7 +8330,7 @@ Optional name for the navigation avoidance layer 4. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_5** = ``""`` +:ref:`String` **layer_names/avoidance/layer_5** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 5. If left empty, the layer will display as "Layer 5". @@ -8340,7 +8342,7 @@ Optional name for the navigation avoidance layer 5. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_6** = ``""`` +:ref:`String` **layer_names/avoidance/layer_6** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 6. If left empty, the layer will display as "Layer 6". @@ -8352,7 +8354,7 @@ Optional name for the navigation avoidance layer 6. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_7** = ``""`` +:ref:`String` **layer_names/avoidance/layer_7** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 7. If left empty, the layer will display as "Layer 7". @@ -8364,7 +8366,7 @@ Optional name for the navigation avoidance layer 7. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_8** = ``""`` +:ref:`String` **layer_names/avoidance/layer_8** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 8. If left empty, the layer will display as "Layer 8". @@ -8376,7 +8378,7 @@ Optional name for the navigation avoidance layer 8. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_9** = ``""`` +:ref:`String` **layer_names/avoidance/layer_9** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 9. If left empty, the layer will display as "Layer 9". @@ -8388,7 +8390,7 @@ Optional name for the navigation avoidance layer 9. If left empty, the layer wil .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_10** = ``""`` +:ref:`String` **layer_names/avoidance/layer_10** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 10. If left empty, the layer will display as "Layer 10". @@ -8400,7 +8402,7 @@ Optional name for the navigation avoidance layer 10. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_11** = ``""`` +:ref:`String` **layer_names/avoidance/layer_11** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 11. If left empty, the layer will display as "Layer 11". @@ -8412,7 +8414,7 @@ Optional name for the navigation avoidance layer 11. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_12** = ``""`` +:ref:`String` **layer_names/avoidance/layer_12** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 12. If left empty, the layer will display as "Layer 12". @@ -8424,7 +8426,7 @@ Optional name for the navigation avoidance layer 12. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_13** = ``""`` +:ref:`String` **layer_names/avoidance/layer_13** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 13. If left empty, the layer will display as "Layer 13". @@ -8436,7 +8438,7 @@ Optional name for the navigation avoidance layer 13. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_14** = ``""`` +:ref:`String` **layer_names/avoidance/layer_14** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 14. If left empty, the layer will display as "Layer 14". @@ -8448,7 +8450,7 @@ Optional name for the navigation avoidance layer 14. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_15** = ``""`` +:ref:`String` **layer_names/avoidance/layer_15** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 15. If left empty, the layer will display as "Layer 15". @@ -8460,7 +8462,7 @@ Optional name for the navigation avoidance layer 15. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_16** = ``""`` +:ref:`String` **layer_names/avoidance/layer_16** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 16. If left empty, the layer will display as "Layer 16". @@ -8472,7 +8474,7 @@ Optional name for the navigation avoidance layer 16. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_17** = ``""`` +:ref:`String` **layer_names/avoidance/layer_17** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 17. If left empty, the layer will display as "Layer 17". @@ -8484,7 +8486,7 @@ Optional name for the navigation avoidance layer 17. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_18** = ``""`` +:ref:`String` **layer_names/avoidance/layer_18** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 18. If left empty, the layer will display as "Layer 18". @@ -8496,7 +8498,7 @@ Optional name for the navigation avoidance layer 18. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_19** = ``""`` +:ref:`String` **layer_names/avoidance/layer_19** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 19. If left empty, the layer will display as "Layer 19". @@ -8508,7 +8510,7 @@ Optional name for the navigation avoidance layer 19. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_20** = ``""`` +:ref:`String` **layer_names/avoidance/layer_20** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 20. If left empty, the layer will display as "Layer 20". @@ -8520,7 +8522,7 @@ Optional name for the navigation avoidance layer 20. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_21** = ``""`` +:ref:`String` **layer_names/avoidance/layer_21** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 21. If left empty, the layer will display as "Layer 21". @@ -8532,7 +8534,7 @@ Optional name for the navigation avoidance layer 21. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_22** = ``""`` +:ref:`String` **layer_names/avoidance/layer_22** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 22. If left empty, the layer will display as "Layer 22". @@ -8544,7 +8546,7 @@ Optional name for the navigation avoidance layer 22. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_23** = ``""`` +:ref:`String` **layer_names/avoidance/layer_23** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 23. If left empty, the layer will display as "Layer 23". @@ -8556,7 +8558,7 @@ Optional name for the navigation avoidance layer 23. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_24** = ``""`` +:ref:`String` **layer_names/avoidance/layer_24** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 24. If left empty, the layer will display as "Layer 24". @@ -8568,7 +8570,7 @@ Optional name for the navigation avoidance layer 24. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_25** = ``""`` +:ref:`String` **layer_names/avoidance/layer_25** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 25. If left empty, the layer will display as "Layer 25". @@ -8580,7 +8582,7 @@ Optional name for the navigation avoidance layer 25. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_26** = ``""`` +:ref:`String` **layer_names/avoidance/layer_26** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 26. If left empty, the layer will display as "Layer 26". @@ -8592,7 +8594,7 @@ Optional name for the navigation avoidance layer 26. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_27** = ``""`` +:ref:`String` **layer_names/avoidance/layer_27** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 27. If left empty, the layer will display as "Layer 27". @@ -8604,7 +8606,7 @@ Optional name for the navigation avoidance layer 27. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_28** = ``""`` +:ref:`String` **layer_names/avoidance/layer_28** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 28. If left empty, the layer will display as "Layer 28". @@ -8616,7 +8618,7 @@ Optional name for the navigation avoidance layer 28. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_29** = ``""`` +:ref:`String` **layer_names/avoidance/layer_29** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 29. If left empty, the layer will display as "Layer 29". @@ -8628,7 +8630,7 @@ Optional name for the navigation avoidance layer 29. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_30** = ``""`` +:ref:`String` **layer_names/avoidance/layer_30** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 30. If left empty, the layer will display as "Layer 30". @@ -8640,7 +8642,7 @@ Optional name for the navigation avoidance layer 30. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_31** = ``""`` +:ref:`String` **layer_names/avoidance/layer_31** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 31. If left empty, the layer will display as "Layer 31". @@ -8652,7 +8654,7 @@ Optional name for the navigation avoidance layer 31. If left empty, the layer wi .. rst-class:: classref-property -:ref:`String` **layer_names/avoidance/layer_32** = ``""`` +:ref:`String` **layer_names/avoidance/layer_32** = ``""`` :ref:`🔗` Optional name for the navigation avoidance layer 32. If left empty, the layer will display as "Layer 32". @@ -8664,7 +8666,7 @@ Optional name for the navigation avoidance layer 32. If left empty, the layer wi .. rst-class:: classref-property -:ref:`int` **memory/limits/message_queue/max_size_mb** = ``32`` +:ref:`int` **memory/limits/message_queue/max_size_mb** = ``32`` :ref:`🔗` Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. @@ -8676,7 +8678,7 @@ Godot uses a message queue to defer some function calls. If you run out of space .. rst-class:: classref-property -:ref:`float` **navigation/2d/default_cell_size** = ``1.0`` +:ref:`float` **navigation/2d/default_cell_size** = ``1.0`` :ref:`🔗` Default cell size for 2D navigation maps. See :ref:`NavigationServer2D.map_set_cell_size`. @@ -8688,7 +8690,7 @@ Default cell size for 2D navigation maps. See :ref:`NavigationServer2D.map_set_c .. rst-class:: classref-property -:ref:`float` **navigation/2d/default_edge_connection_margin** = ``1.0`` +:ref:`float` **navigation/2d/default_edge_connection_margin** = ``1.0`` :ref:`🔗` Default edge connection margin for 2D navigation maps. See :ref:`NavigationServer2D.map_set_edge_connection_margin`. @@ -8700,7 +8702,7 @@ Default edge connection margin for 2D navigation maps. See :ref:`NavigationServe .. rst-class:: classref-property -:ref:`float` **navigation/2d/default_link_connection_radius** = ``4.0`` +:ref:`float` **navigation/2d/default_link_connection_radius** = ``4.0`` :ref:`🔗` Default link connection radius for 2D navigation maps. See :ref:`NavigationServer2D.map_set_link_connection_radius`. @@ -8712,7 +8714,7 @@ Default link connection radius for 2D navigation maps. See :ref:`NavigationServe .. rst-class:: classref-property -:ref:`bool` **navigation/2d/use_edge_connections** = ``true`` +:ref:`bool` **navigation/2d/use_edge_connections** = ``true`` :ref:`🔗` If enabled 2D navigation regions will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. This setting only affects World2D default navigation maps. @@ -8724,7 +8726,7 @@ If enabled 2D navigation regions will use edge connections to connect with other .. rst-class:: classref-property -:ref:`float` **navigation/3d/default_cell_height** = ``0.25`` +:ref:`float` **navigation/3d/default_cell_height** = ``0.25`` :ref:`🔗` Default cell height for 3D navigation maps. See :ref:`NavigationServer3D.map_set_cell_height`. @@ -8736,7 +8738,7 @@ Default cell height for 3D navigation maps. See :ref:`NavigationServer3D.map_set .. rst-class:: classref-property -:ref:`float` **navigation/3d/default_cell_size** = ``0.25`` +:ref:`float` **navigation/3d/default_cell_size** = ``0.25`` :ref:`🔗` Default cell size for 3D navigation maps. See :ref:`NavigationServer3D.map_set_cell_size`. @@ -8748,7 +8750,7 @@ Default cell size for 3D navigation maps. See :ref:`NavigationServer3D.map_set_c .. rst-class:: classref-property -:ref:`float` **navigation/3d/default_edge_connection_margin** = ``0.25`` +:ref:`float` **navigation/3d/default_edge_connection_margin** = ``0.25`` :ref:`🔗` Default edge connection margin for 3D navigation maps. See :ref:`NavigationServer3D.map_set_edge_connection_margin`. @@ -8760,7 +8762,7 @@ Default edge connection margin for 3D navigation maps. See :ref:`NavigationServe .. rst-class:: classref-property -:ref:`float` **navigation/3d/default_link_connection_radius** = ``1.0`` +:ref:`float` **navigation/3d/default_link_connection_radius** = ``1.0`` :ref:`🔗` Default link connection radius for 3D navigation maps. See :ref:`NavigationServer3D.map_set_link_connection_radius`. @@ -8772,7 +8774,7 @@ Default link connection radius for 3D navigation maps. See :ref:`NavigationServe .. rst-class:: classref-property -:ref:`Vector3` **navigation/3d/default_up** = ``Vector3(0, 1, 0)`` +:ref:`Vector3` **navigation/3d/default_up** = ``Vector3(0, 1, 0)`` :ref:`🔗` Default up orientation for 3D navigation maps. See :ref:`NavigationServer3D.map_set_up`. @@ -8784,7 +8786,7 @@ Default up orientation for 3D navigation maps. See :ref:`NavigationServer3D.map_ .. rst-class:: classref-property -:ref:`float` **navigation/3d/merge_rasterizer_cell_scale** = ``1.0`` +:ref:`float` **navigation/3d/merge_rasterizer_cell_scale** = ``1.0`` :ref:`🔗` Default merge rasterizer cell scale for 3D navigation maps. See :ref:`NavigationServer3D.map_set_merge_rasterizer_cell_scale`. @@ -8796,7 +8798,7 @@ Default merge rasterizer cell scale for 3D navigation maps. See :ref:`Navigation .. rst-class:: classref-property -:ref:`bool` **navigation/3d/use_edge_connections** = ``true`` +:ref:`bool` **navigation/3d/use_edge_connections** = ``true`` :ref:`🔗` If enabled 3D navigation regions will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. This setting only affects World3D default navigation maps. @@ -8808,7 +8810,7 @@ If enabled 3D navigation regions will use edge connections to connect with other .. rst-class:: classref-property -:ref:`bool` **navigation/avoidance/thread_model/avoidance_use_high_priority_threads** = ``true`` +:ref:`bool` **navigation/avoidance/thread_model/avoidance_use_high_priority_threads** = ``true`` :ref:`🔗` If enabled and avoidance calculations use multiple threads the threads run with high priority. @@ -8820,7 +8822,7 @@ If enabled and avoidance calculations use multiple threads the threads run with .. rst-class:: classref-property -:ref:`bool` **navigation/avoidance/thread_model/avoidance_use_multiple_threads** = ``true`` +:ref:`bool` **navigation/avoidance/thread_model/avoidance_use_multiple_threads** = ``true`` :ref:`🔗` If enabled the avoidance calculations use multiple threads. @@ -8832,7 +8834,7 @@ If enabled the avoidance calculations use multiple threads. .. rst-class:: classref-property -:ref:`bool` **navigation/baking/thread_model/baking_use_high_priority_threads** = ``true`` +:ref:`bool` **navigation/baking/thread_model/baking_use_high_priority_threads** = ``true`` :ref:`🔗` If enabled and async navmesh baking uses multiple threads the threads run with high priority. @@ -8844,7 +8846,7 @@ If enabled and async navmesh baking uses multiple threads the threads run with h .. rst-class:: classref-property -:ref:`bool` **navigation/baking/thread_model/baking_use_multiple_threads** = ``true`` +:ref:`bool` **navigation/baking/thread_model/baking_use_multiple_threads** = ``true`` :ref:`🔗` If enabled the async navmesh baking uses multiple threads. @@ -8856,7 +8858,7 @@ If enabled the async navmesh baking uses multiple threads. .. rst-class:: classref-property -:ref:`bool` **navigation/baking/use_crash_prevention_checks** = ``true`` +:ref:`bool` **navigation/baking/use_crash_prevention_checks** = ``true`` :ref:`🔗` If enabled, and baking would potentially lead to an engine crash, the baking will be interrupted and an error message with explanation will be raised. @@ -8868,7 +8870,7 @@ If enabled, and baking would potentially lead to an engine crash, the baking wil .. rst-class:: classref-property -:ref:`int` **network/limits/debugger/max_chars_per_second** = ``32768`` +:ref:`int` **network/limits/debugger/max_chars_per_second** = ``32768`` :ref:`🔗` Maximum number of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. @@ -8880,7 +8882,7 @@ Maximum number of characters allowed to send as output from the debugger. Over t .. rst-class:: classref-property -:ref:`int` **network/limits/debugger/max_errors_per_second** = ``400`` +:ref:`int` **network/limits/debugger/max_errors_per_second** = ``400`` :ref:`🔗` Maximum number of errors allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. @@ -8892,7 +8894,7 @@ Maximum number of errors allowed to be sent from the debugger. Over this value, .. rst-class:: classref-property -:ref:`int` **network/limits/debugger/max_queued_messages** = ``2048`` +:ref:`int` **network/limits/debugger/max_queued_messages** = ``2048`` :ref:`🔗` Maximum number of messages in the debugger queue. Over this value, content is dropped. This helps to limit the debugger memory usage. @@ -8904,7 +8906,7 @@ Maximum number of messages in the debugger queue. Over this value, content is dr .. rst-class:: classref-property -:ref:`int` **network/limits/debugger/max_warnings_per_second** = ``400`` +:ref:`int` **network/limits/debugger/max_warnings_per_second** = ``400`` :ref:`🔗` Maximum number of warnings allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. @@ -8916,7 +8918,7 @@ Maximum number of warnings allowed to be sent from the debugger. Over this value .. rst-class:: classref-property -:ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** = ``16`` +:ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** = ``16`` :ref:`🔗` Default size of packet peer stream for deserializing Godot data (in bytes, specified as a power of two). The default value ``16`` is equal to 65,536 bytes. Over this size, data is dropped. @@ -8928,7 +8930,7 @@ Default size of packet peer stream for deserializing Godot data (in bytes, speci .. rst-class:: classref-property -:ref:`int` **network/limits/tcp/connect_timeout_seconds** = ``30`` +:ref:`int` **network/limits/tcp/connect_timeout_seconds** = ``30`` :ref:`🔗` Timeout (in seconds) for connection attempts using TCP. @@ -8940,7 +8942,7 @@ Timeout (in seconds) for connection attempts using TCP. .. rst-class:: classref-property -:ref:`int` **network/limits/webrtc/max_channel_in_buffer_kb** = ``64`` +:ref:`int` **network/limits/webrtc/max_channel_in_buffer_kb** = ``64`` :ref:`🔗` Maximum size (in kiB) for the :ref:`WebRTCDataChannel` input buffer. @@ -8952,7 +8954,7 @@ Maximum size (in kiB) for the :ref:`WebRTCDataChannel` .. rst-class:: classref-property -:ref:`String` **network/tls/certificate_bundle_override** = ``""`` +:ref:`String` **network/tls/certificate_bundle_override** = ``""`` :ref:`🔗` The CA certificates bundle to use for TLS connections. If this is set to a non-empty value, this will *override* Godot's default `Mozilla certificate bundle `__. If left empty, the default certificate bundle will be used. @@ -8966,7 +8968,7 @@ If in doubt, leave this setting empty. .. rst-class:: classref-property -:ref:`float` **physics/2d/default_angular_damp** = ``1.0`` +:ref:`float` **physics/2d/default_angular_damp** = ``1.0`` :ref:`🔗` The default rotational motion damping in 2D. Damping is used to gradually slow down physical objects over time. RigidBodies will fall back to this value when combining their own damping values and no area damping value is present. @@ -8986,7 +8988,7 @@ During each physics tick, Godot will multiply the linear velocity of RigidBodies .. rst-class:: classref-property -:ref:`float` **physics/2d/default_gravity** = ``980.0`` +:ref:`float` **physics/2d/default_gravity** = ``980.0`` :ref:`🔗` The default gravity strength in 2D (in pixels per second squared). @@ -9015,7 +9017,7 @@ The default gravity strength in 2D (in pixels per second squared). .. rst-class:: classref-property -:ref:`Vector2` **physics/2d/default_gravity_vector** = ``Vector2(0, 1)`` +:ref:`Vector2` **physics/2d/default_gravity_vector** = ``Vector2(0, 1)`` :ref:`🔗` The default gravity direction in 2D. @@ -9044,7 +9046,7 @@ The default gravity direction in 2D. .. rst-class:: classref-property -:ref:`float` **physics/2d/default_linear_damp** = ``0.1`` +:ref:`float` **physics/2d/default_linear_damp** = ``0.1`` :ref:`🔗` The default linear motion damping in 2D. Damping is used to gradually slow down physical objects over time. RigidBodies will fall back to this value when combining their own damping values and no area damping value is present. @@ -9064,7 +9066,7 @@ During each physics tick, Godot will multiply the linear velocity of RigidBodies .. rst-class:: classref-property -:ref:`String` **physics/2d/physics_engine** = ``"DEFAULT"`` +:ref:`String` **physics/2d/physics_engine** = ``"DEFAULT"`` :ref:`🔗` Sets which physics engine to use for 2D physics. @@ -9078,7 +9080,7 @@ Sets which physics engine to use for 2D physics. .. rst-class:: classref-property -:ref:`bool` **physics/2d/run_on_separate_thread** = ``false`` +:ref:`bool` **physics/2d/run_on_separate_thread** = ``false`` :ref:`🔗` If ``true``, the 2D physics server runs on a separate thread, making better use of multi-core CPUs. If ``false``, the 2D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process. @@ -9090,7 +9092,7 @@ If ``true``, the 2D physics server runs on a separate thread, making better use .. rst-class:: classref-property -:ref:`float` **physics/2d/sleep_threshold_angular** = ``0.139626`` +:ref:`float` **physics/2d/sleep_threshold_angular** = ``0.139626`` :ref:`🔗` Threshold angular velocity under which a 2D physics body will be considered inactive. See :ref:`PhysicsServer2D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD`. @@ -9102,7 +9104,7 @@ Threshold angular velocity under which a 2D physics body will be considered inac .. rst-class:: classref-property -:ref:`float` **physics/2d/sleep_threshold_linear** = ``2.0`` +:ref:`float` **physics/2d/sleep_threshold_linear** = ``2.0`` :ref:`🔗` Threshold linear velocity under which a 2D physics body will be considered inactive. See :ref:`PhysicsServer2D.SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD`. @@ -9114,7 +9116,7 @@ Threshold linear velocity under which a 2D physics body will be considered inact .. rst-class:: classref-property -:ref:`float` **physics/2d/solver/contact_max_allowed_penetration** = ``0.3`` +:ref:`float` **physics/2d/solver/contact_max_allowed_penetration** = ``0.3`` :ref:`🔗` Maximum distance a shape can penetrate another shape before it is considered a collision. See :ref:`PhysicsServer2D.SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION`. @@ -9126,7 +9128,7 @@ Maximum distance a shape can penetrate another shape before it is considered a c .. rst-class:: classref-property -:ref:`float` **physics/2d/solver/contact_max_separation** = ``1.5`` +:ref:`float` **physics/2d/solver/contact_max_separation** = ``1.5`` :ref:`🔗` Maximum distance a shape can be from another before they are considered separated and the contact is discarded. See :ref:`PhysicsServer2D.SPACE_PARAM_CONTACT_MAX_SEPARATION`. @@ -9138,7 +9140,7 @@ Maximum distance a shape can be from another before they are considered separate .. rst-class:: classref-property -:ref:`float` **physics/2d/solver/contact_recycle_radius** = ``1.0`` +:ref:`float` **physics/2d/solver/contact_recycle_radius** = ``1.0`` :ref:`🔗` Maximum distance a pair of bodies has to move before their collision status has to be recalculated. See :ref:`PhysicsServer2D.SPACE_PARAM_CONTACT_RECYCLE_RADIUS`. @@ -9150,7 +9152,7 @@ Maximum distance a pair of bodies has to move before their collision status has .. rst-class:: classref-property -:ref:`float` **physics/2d/solver/default_constraint_bias** = ``0.2`` +:ref:`float` **physics/2d/solver/default_constraint_bias** = ``0.2`` :ref:`🔗` Default solver bias for all physics constraints. Defines how much bodies react to enforce constraints. See :ref:`PhysicsServer2D.SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS`. @@ -9164,7 +9166,7 @@ Individual constraints can have a specific bias value (see :ref:`Joint2D.bias` **physics/2d/solver/default_contact_bias** = ``0.8`` +:ref:`float` **physics/2d/solver/default_contact_bias** = ``0.8`` :ref:`🔗` Default solver bias for all physics contacts. Defines how much bodies react to enforce contact separation. See :ref:`PhysicsServer2D.SPACE_PARAM_CONTACT_DEFAULT_BIAS`. @@ -9178,7 +9180,7 @@ Individual shapes can have a specific bias value (see :ref:`Shape2D.custom_solve .. rst-class:: classref-property -:ref:`int` **physics/2d/solver/solver_iterations** = ``16`` +:ref:`int` **physics/2d/solver/solver_iterations** = ``16`` :ref:`🔗` Number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance. See :ref:`PhysicsServer2D.SPACE_PARAM_SOLVER_ITERATIONS`. @@ -9190,7 +9192,7 @@ Number of solver iterations for all contacts and constraints. The greater the nu .. rst-class:: classref-property -:ref:`float` **physics/2d/time_before_sleep** = ``0.5`` +:ref:`float` **physics/2d/time_before_sleep** = ``0.5`` :ref:`🔗` Time (in seconds) of inactivity before which a 2D physics body will put to sleep. See :ref:`PhysicsServer2D.SPACE_PARAM_BODY_TIME_TO_SLEEP`. @@ -9202,7 +9204,7 @@ Time (in seconds) of inactivity before which a 2D physics body will put to sleep .. rst-class:: classref-property -:ref:`float` **physics/3d/default_angular_damp** = ``0.1`` +:ref:`float` **physics/3d/default_angular_damp** = ``0.1`` :ref:`🔗` The default rotational motion damping in 3D. Damping is used to gradually slow down physical objects over time. RigidBodies will fall back to this value when combining their own damping values and no area damping value is present. @@ -9222,7 +9224,7 @@ During each physics tick, Godot will multiply the angular velocity of RigidBodie .. rst-class:: classref-property -:ref:`float` **physics/3d/default_gravity** = ``9.8`` +:ref:`float` **physics/3d/default_gravity** = ``9.8`` :ref:`🔗` The default gravity strength in 3D (in meters per second squared). @@ -9251,7 +9253,7 @@ The default gravity strength in 3D (in meters per second squared). .. rst-class:: classref-property -:ref:`Vector3` **physics/3d/default_gravity_vector** = ``Vector3(0, -1, 0)`` +:ref:`Vector3` **physics/3d/default_gravity_vector** = ``Vector3(0, -1, 0)`` :ref:`🔗` The default gravity direction in 3D. @@ -9280,7 +9282,7 @@ The default gravity direction in 3D. .. rst-class:: classref-property -:ref:`float` **physics/3d/default_linear_damp** = ``0.1`` +:ref:`float` **physics/3d/default_linear_damp** = ``0.1`` :ref:`🔗` The default linear motion damping in 3D. Damping is used to gradually slow down physical objects over time. RigidBodies will fall back to this value when combining their own damping values and no area damping value is present. @@ -9300,7 +9302,7 @@ During each physics tick, Godot will multiply the linear velocity of RigidBodies .. rst-class:: classref-property -:ref:`String` **physics/3d/physics_engine** = ``"DEFAULT"`` +:ref:`String` **physics/3d/physics_engine** = ``"DEFAULT"`` :ref:`🔗` Sets which physics engine to use for 3D physics. @@ -9314,7 +9316,7 @@ Sets which physics engine to use for 3D physics. .. rst-class:: classref-property -:ref:`bool` **physics/3d/run_on_separate_thread** = ``false`` +:ref:`bool` **physics/3d/run_on_separate_thread** = ``false`` :ref:`🔗` If ``true``, the 3D physics server runs on a separate thread, making better use of multi-core CPUs. If ``false``, the 3D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process. @@ -9326,7 +9328,7 @@ If ``true``, the 3D physics server runs on a separate thread, making better use .. rst-class:: classref-property -:ref:`float` **physics/3d/sleep_threshold_angular** = ``0.139626`` +:ref:`float` **physics/3d/sleep_threshold_angular** = ``0.139626`` :ref:`🔗` Threshold angular velocity under which a 3D physics body will be considered inactive. See :ref:`PhysicsServer3D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD`. @@ -9338,7 +9340,7 @@ Threshold angular velocity under which a 3D physics body will be considered inac .. rst-class:: classref-property -:ref:`float` **physics/3d/sleep_threshold_linear** = ``0.1`` +:ref:`float` **physics/3d/sleep_threshold_linear** = ``0.1`` :ref:`🔗` Threshold linear velocity under which a 3D physics body will be considered inactive. See :ref:`PhysicsServer3D.SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD`. @@ -9350,7 +9352,7 @@ Threshold linear velocity under which a 3D physics body will be considered inact .. rst-class:: classref-property -:ref:`float` **physics/3d/solver/contact_max_allowed_penetration** = ``0.01`` +:ref:`float` **physics/3d/solver/contact_max_allowed_penetration** = ``0.01`` :ref:`🔗` Maximum distance a shape can penetrate another shape before it is considered a collision. See :ref:`PhysicsServer3D.SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION`. @@ -9362,7 +9364,7 @@ Maximum distance a shape can penetrate another shape before it is considered a c .. rst-class:: classref-property -:ref:`float` **physics/3d/solver/contact_max_separation** = ``0.05`` +:ref:`float` **physics/3d/solver/contact_max_separation** = ``0.05`` :ref:`🔗` Maximum distance a shape can be from another before they are considered separated and the contact is discarded. See :ref:`PhysicsServer3D.SPACE_PARAM_CONTACT_MAX_SEPARATION`. @@ -9374,7 +9376,7 @@ Maximum distance a shape can be from another before they are considered separate .. rst-class:: classref-property -:ref:`float` **physics/3d/solver/contact_recycle_radius** = ``0.01`` +:ref:`float` **physics/3d/solver/contact_recycle_radius** = ``0.01`` :ref:`🔗` Maximum distance a pair of bodies has to move before their collision status has to be recalculated. See :ref:`PhysicsServer3D.SPACE_PARAM_CONTACT_RECYCLE_RADIUS`. @@ -9386,7 +9388,7 @@ Maximum distance a pair of bodies has to move before their collision status has .. rst-class:: classref-property -:ref:`float` **physics/3d/solver/default_contact_bias** = ``0.8`` +:ref:`float` **physics/3d/solver/default_contact_bias** = ``0.8`` :ref:`🔗` Default solver bias for all physics contacts. Defines how much bodies react to enforce contact separation. See :ref:`PhysicsServer3D.SPACE_PARAM_CONTACT_DEFAULT_BIAS`. @@ -9400,7 +9402,7 @@ Individual shapes can have a specific bias value (see :ref:`Shape3D.custom_solve .. rst-class:: classref-property -:ref:`int` **physics/3d/solver/solver_iterations** = ``16`` +:ref:`int` **physics/3d/solver/solver_iterations** = ``16`` :ref:`🔗` Number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance. See :ref:`PhysicsServer3D.SPACE_PARAM_SOLVER_ITERATIONS`. @@ -9412,7 +9414,7 @@ Number of solver iterations for all contacts and constraints. The greater the nu .. rst-class:: classref-property -:ref:`float` **physics/3d/time_before_sleep** = ``0.5`` +:ref:`float` **physics/3d/time_before_sleep** = ``0.5`` :ref:`🔗` Time (in seconds) of inactivity before which a 3D physics body will put to sleep. See :ref:`PhysicsServer3D.SPACE_PARAM_BODY_TIME_TO_SLEEP`. @@ -9424,7 +9426,7 @@ Time (in seconds) of inactivity before which a 3D physics body will put to sleep .. rst-class:: classref-property -:ref:`bool` **physics/common/enable_object_picking** = ``true`` +:ref:`bool` **physics/common/enable_object_picking** = ``true`` :ref:`🔗` Enables :ref:`Viewport.physics_object_picking` on the root viewport. @@ -9436,7 +9438,7 @@ Enables :ref:`Viewport.physics_object_picking` **physics/common/max_physics_steps_per_frame** = ``8`` +:ref:`int` **physics/common/max_physics_steps_per_frame** = ``8`` :ref:`🔗` Controls the maximum number of physics steps that can be simulated each rendered frame. The default value is tuned to avoid "spiral of death" situations where expensive physics simulations trigger more expensive simulations indefinitely. However, the game will appear to slow down if the rendering FPS is less than ``1 / max_physics_steps_per_frame`` of :ref:`physics/common/physics_ticks_per_second`. This occurs even if ``delta`` is consistently used in physics calculations. To avoid this, increase :ref:`physics/common/max_physics_steps_per_frame` if you have increased :ref:`physics/common/physics_ticks_per_second` significantly above its default value. @@ -9450,7 +9452,7 @@ Controls the maximum number of physics steps that can be simulated each rendered .. rst-class:: classref-property -:ref:`bool` **physics/common/physics_interpolation** = ``false`` +:ref:`bool` **physics/common/physics_interpolation** = ``false`` :ref:`🔗` If ``true``, the renderer will interpolate the transforms of physics objects between the last two transforms, so that smooth motion is seen even when physics ticks do not coincide with rendered frames. See also :ref:`Node.physics_interpolation_mode` and :ref:`Node.reset_physics_interpolation`. @@ -9468,7 +9470,7 @@ If ``true``, the renderer will interpolate the transforms of physics objects bet .. rst-class:: classref-property -:ref:`float` **physics/common/physics_jitter_fix** = ``0.5`` +:ref:`float` **physics/common/physics_jitter_fix** = ``0.5`` :ref:`🔗` Controls how much physics ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of in-game clock and real clock, but allows smoothing out framerate jitters. The default value of 0.5 should be good enough for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. @@ -9484,7 +9486,7 @@ Controls how much physics ticks are synchronized with real time. For 0 or less, .. rst-class:: classref-property -:ref:`int` **physics/common/physics_ticks_per_second** = ``60`` +:ref:`int` **physics/common/physics_ticks_per_second** = ``60`` :ref:`🔗` The number of fixed iterations per second. This controls how often physics simulation and :ref:`Node._physics_process` methods are run. See also :ref:`application/run/max_fps`. @@ -9500,7 +9502,7 @@ The number of fixed iterations per second. This controls how often physics simul .. rst-class:: classref-property -:ref:`int` **rendering/2d/sdf/oversize** = ``1`` +:ref:`int` **rendering/2d/sdf/oversize** = ``1`` :ref:`🔗` Controls how much of the original viewport size should be covered by the 2D signed distance field. This SDF can be sampled in :ref:`CanvasItem` shaders and is used for :ref:`GPUParticles2D` collision. Higher values allow portions of occluders located outside the viewport to still be taken into account in the generated signed distance field, at the cost of performance. If you notice particles falling through :ref:`LightOccluder2D`\ s as the occluders leave the viewport, increase this setting. @@ -9516,7 +9518,7 @@ The percentage specified is added on each axis and on both sides. For example, w .. rst-class:: classref-property -:ref:`int` **rendering/2d/sdf/scale** = ``1`` +:ref:`int` **rendering/2d/sdf/scale** = ``1`` :ref:`🔗` The resolution scale to use for the 2D signed distance field. Higher values lead to a more precise and more stable signed distance field as the camera moves, at the cost of performance. The default value (50%) renders at half the resolution of the viewport size on each axis, which means the SDF is generated with 25% of the viewport's pixel count. @@ -9530,7 +9532,7 @@ The resolution scale to use for the 2D signed distance field. Higher values lead .. rst-class:: classref-property -:ref:`int` **rendering/2d/shadow_atlas/size** = ``2048`` +:ref:`int` **rendering/2d/shadow_atlas/size** = ``2048`` :ref:`🔗` The size of the 2D shadow atlas in pixels. Higher values result in more precise :ref:`Light2D` shadows, at the cost of performance and video memory usage. The specified value is rounded up to the nearest power of 2. @@ -9544,7 +9546,7 @@ The size of the 2D shadow atlas in pixels. Higher values result in more precise .. rst-class:: classref-property -:ref:`bool` **rendering/2d/snap/snap_2d_transforms_to_pixel** = ``false`` +:ref:`bool` **rendering/2d/snap/snap_2d_transforms_to_pixel** = ``false`` :ref:`🔗` If ``true``, :ref:`CanvasItem` nodes will internally snap to full pixels. Useful for low-resolution pixel art games. Their position can still be sub-pixel, but the decimals will not have effect as the position is rounded. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. @@ -9562,7 +9564,7 @@ If ``true``, :ref:`CanvasItem` nodes will internally snap to f .. rst-class:: classref-property -:ref:`bool` **rendering/2d/snap/snap_2d_vertices_to_pixel** = ``false`` +:ref:`bool` **rendering/2d/snap/snap_2d_vertices_to_pixel** = ``false`` :ref:`🔗` If ``true``, vertices of :ref:`CanvasItem` nodes will snap to full pixels. Useful for low-resolution pixel art games. Only affects the final vertex positions, not the transforms. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. @@ -9580,7 +9582,7 @@ If ``true``, vertices of :ref:`CanvasItem` nodes will snap to .. rst-class:: classref-property -:ref:`int` **rendering/anti_aliasing/quality/msaa_2d** = ``0`` +:ref:`int` **rendering/anti_aliasing/quality/msaa_2d** = ``0`` :ref:`🔗` Sets the number of MSAA samples to use for 2D/Canvas rendering (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, especially integrated graphics due to their limited memory bandwidth. This has no effect on shader-induced aliasing or texture aliasing. @@ -9594,7 +9596,7 @@ Sets the number of MSAA samples to use for 2D/Canvas rendering (as a power of tw .. rst-class:: classref-property -:ref:`int` **rendering/anti_aliasing/quality/msaa_3d** = ``0`` +:ref:`int` **rendering/anti_aliasing/quality/msaa_3d** = ``0`` :ref:`🔗` Sets the number of MSAA samples to use for 3D rendering (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, especially integrated graphics due to their limited memory bandwidth. See also :ref:`rendering/scaling_3d/mode` for supersampling, which provides higher quality but is much more expensive. This has no effect on shader-induced aliasing or texture aliasing. @@ -9608,7 +9610,7 @@ Sets the number of MSAA samples to use for 3D rendering (as a power of two). MSA .. rst-class:: classref-property -:ref:`int` **rendering/anti_aliasing/quality/screen_space_aa** = ``0`` +:ref:`int` **rendering/anti_aliasing/quality/screen_space_aa** = ``0`` :ref:`🔗` Sets the screen-space antialiasing mode for the default screen :ref:`Viewport`. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry. The blurriness is partially counteracted by automatically using a negative mipmap LOD bias (see :ref:`rendering/textures/default_filters/texture_mipmap_bias`). @@ -9624,7 +9626,7 @@ Another way to combat specular aliasing is to enable :ref:`rendering/anti_aliasi .. rst-class:: classref-property -:ref:`bool` **rendering/anti_aliasing/quality/use_debanding** = ``false`` +:ref:`bool` **rendering/anti_aliasing/quality/use_debanding** = ``false`` :ref:`🔗` If ``true``, uses a fast post-processing filter to make banding significantly less visible in 3D. 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode` is :ref:`Environment.BG_CANVAS`. @@ -9640,7 +9642,7 @@ In some cases, debanding may introduce a slightly noticeable dithering pattern. .. rst-class:: classref-property -:ref:`bool` **rendering/anti_aliasing/quality/use_taa** = ``false`` +:ref:`bool` **rendering/anti_aliasing/quality/use_taa** = ``false`` :ref:`🔗` Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport`. TAA works by jittering the camera and accumulating the images of the last rendered frames, motion vector rendering is used to account for camera and object motion. Enabling TAA can make the image blurrier, which is partially counteracted by automatically using a negative mipmap LOD bias (see :ref:`rendering/textures/default_filters/texture_mipmap_bias`). @@ -9656,7 +9658,7 @@ Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport` **rendering/anti_aliasing/screen_space_roughness_limiter/amount** = ``0.25`` +:ref:`float` **rendering/anti_aliasing/screen_space_roughness_limiter/amount** = ``0.25`` :ref:`🔗` **Note:** This property is only read when the project starts. To control the screen-space roughness limiter at runtime, call :ref:`RenderingServer.screen_space_roughness_limiter_set_active` instead. @@ -9668,7 +9670,7 @@ Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport` **rendering/anti_aliasing/screen_space_roughness_limiter/enabled** = ``true`` +:ref:`bool` **rendering/anti_aliasing/screen_space_roughness_limiter/enabled** = ``true`` :ref:`🔗` If ``true``, enables a spatial filter to limit roughness in areas with high-frequency detail. This can help reduce specular aliasing to an extent, though not as much as enabling :ref:`rendering/anti_aliasing/quality/use_taa`. This filter has a small performance cost, so consider disabling it if it doesn't benefit your scene noticeably. @@ -9684,7 +9686,7 @@ If ``true``, enables a spatial filter to limit roughness in areas with high-freq .. rst-class:: classref-property -:ref:`float` **rendering/anti_aliasing/screen_space_roughness_limiter/limit** = ``0.18`` +:ref:`float` **rendering/anti_aliasing/screen_space_roughness_limiter/limit** = ``0.18`` :ref:`🔗` **Note:** This property is only read when the project starts. To control the screen-space roughness limiter at runtime, call :ref:`RenderingServer.screen_space_roughness_limiter_set_active` instead. @@ -9696,7 +9698,7 @@ If ``true``, enables a spatial filter to limit roughness in areas with high-freq .. rst-class:: classref-property -:ref:`int` **rendering/camera/depth_of_field/depth_of_field_bokeh_quality** = ``1`` +:ref:`int` **rendering/camera/depth_of_field/depth_of_field_bokeh_quality** = ``1`` :ref:`🔗` Sets the quality of the depth of field effect. Higher quality takes more samples, which is slower but looks smoother. @@ -9708,7 +9710,7 @@ Sets the quality of the depth of field effect. Higher quality takes more samples .. rst-class:: classref-property -:ref:`int` **rendering/camera/depth_of_field/depth_of_field_bokeh_shape** = ``1`` +:ref:`int` **rendering/camera/depth_of_field/depth_of_field_bokeh_shape** = ``1`` :ref:`🔗` Sets the depth of field shape. Can be Box, Hexagon, or Circle. Box is the fastest. Circle is the most realistic, but also the most expensive to compute. @@ -9720,7 +9722,7 @@ Sets the depth of field shape. Can be Box, Hexagon, or Circle. Box is the fastes .. rst-class:: classref-property -:ref:`bool` **rendering/camera/depth_of_field/depth_of_field_use_jitter** = ``false`` +:ref:`bool` **rendering/camera/depth_of_field/depth_of_field_use_jitter** = ``false`` :ref:`🔗` If ``true``, jitters DOF samples to make effect slightly blurrier and hide lines created from low sample rates. This can result in a slightly grainy appearance when used with a low number of samples. @@ -9732,7 +9734,7 @@ If ``true``, jitters DOF samples to make effect slightly blurrier and hide lines .. rst-class:: classref-property -:ref:`String` **rendering/driver/depth_prepass/disable_for_vendors** = ``"PowerVR,Mali,Adreno,Apple"`` +:ref:`String` **rendering/driver/depth_prepass/disable_for_vendors** = ``"PowerVR,Mali,Adreno,Apple"`` :ref:`🔗` Disables :ref:`rendering/driver/depth_prepass/enable` conditionally for certain vendors. By default, disables the depth prepass for mobile devices as mobile devices do not benefit from the depth prepass due to their unique architecture. @@ -9744,7 +9746,7 @@ Disables :ref:`rendering/driver/depth_prepass/enable` **rendering/driver/depth_prepass/enable** = ``true`` +:ref:`bool` **rendering/driver/depth_prepass/enable** = ``true`` :ref:`🔗` If ``true``, performs a previous depth pass before rendering 3D materials. This increases performance significantly in scenes with high overdraw, when complex materials and lighting are used. However, in scenes with few occluded surfaces, the depth prepass may reduce performance. If your game is viewed from a fixed angle that makes it easy to avoid overdraw (such as top-down or side-scrolling perspective), consider disabling the depth prepass to improve performance. This setting can be changed at run-time to optimize performance depending on the scene currently being viewed. @@ -9758,7 +9760,7 @@ If ``true``, performs a previous depth pass before rendering 3D materials. This .. rst-class:: classref-property -:ref:`int` **rendering/driver/threads/thread_model** = ``1`` +:ref:`int` **rendering/driver/threads/thread_model** = ``1`` :ref:`🔗` **Experimental:** This setting has several known bugs which can lead to crashing, especially when using particles or resizing the window. Not recommended for use in production at this stage. @@ -9772,7 +9774,7 @@ The thread model to use for rendering. Rendering on a thread may improve perform .. rst-class:: classref-property -:ref:`Color` **rendering/environment/defaults/default_clear_color** = ``Color(0.3, 0.3, 0.3, 1)`` +:ref:`Color` **rendering/environment/defaults/default_clear_color** = ``Color(0.3, 0.3, 0.3, 1)`` :ref:`🔗` Default background clear color. Overridable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`RenderingServer.set_default_clear_color`. @@ -9784,7 +9786,7 @@ Default background clear color. Overridable per :ref:`Viewport` .. rst-class:: classref-property -:ref:`String` **rendering/environment/defaults/default_environment** = ``""`` +:ref:`String` **rendering/environment/defaults/default_environment** = ``""`` :ref:`🔗` :ref:`Environment` that will be used as a fallback environment in case a scene does not specify its own environment. The default environment is loaded in at scene load time regardless of whether you have set an environment or not. If you do not rely on the fallback environment, you do not need to set this property. @@ -9796,7 +9798,7 @@ Default background clear color. Overridable per :ref:`Viewport` .. rst-class:: classref-property -:ref:`int` **rendering/environment/glow/upscale_mode** = ``1`` +:ref:`int` **rendering/environment/glow/upscale_mode** = ``1`` :ref:`🔗` Sets how the glow effect is upscaled before being copied onto the screen. Linear is faster, but looks blocky. Bicubic is slower but looks smooth. @@ -9808,7 +9810,7 @@ Sets how the glow effect is upscaled before being copied onto the screen. Linear .. rst-class:: classref-property -:ref:`int` **rendering/environment/glow/upscale_mode.mobile** = ``0`` +:ref:`int` **rendering/environment/glow/upscale_mode.mobile** = ``0`` :ref:`🔗` Lower-end override for :ref:`rendering/environment/glow/upscale_mode` on mobile devices, due to performance concerns or driver support. @@ -9820,7 +9822,7 @@ Lower-end override for :ref:`rendering/environment/glow/upscale_mode` **rendering/environment/screen_space_reflection/roughness_quality** = ``1`` +:ref:`int` **rendering/environment/screen_space_reflection/roughness_quality** = ``1`` :ref:`🔗` Sets the quality for rough screen-space reflections. Turning off will make all screen space reflections sharp, while higher values make rough reflections look better. @@ -9832,7 +9834,7 @@ Sets the quality for rough screen-space reflections. Turning off will make all s .. rst-class:: classref-property -:ref:`float` **rendering/environment/ssao/adaptive_target** = ``0.5`` +:ref:`float` **rendering/environment/ssao/adaptive_target** = ``0.5`` :ref:`🔗` Quality target to use when :ref:`rendering/environment/ssao/quality` is set to ``Ultra``. A value of ``0.0`` provides a quality and speed similar to ``Medium`` while a value of ``1.0`` provides much higher quality than any of the other settings at the cost of performance. @@ -9844,7 +9846,7 @@ Quality target to use when :ref:`rendering/environment/ssao/quality` **rendering/environment/ssao/blur_passes** = ``2`` +:ref:`int` **rendering/environment/ssao/blur_passes** = ``2`` :ref:`🔗` Number of blur passes to use when computing screen-space ambient occlusion. A higher number will result in a smoother look, but will be slower to compute and will have less high-frequency detail. @@ -9856,7 +9858,7 @@ Number of blur passes to use when computing screen-space ambient occlusion. A hi .. rst-class:: classref-property -:ref:`float` **rendering/environment/ssao/fadeout_from** = ``50.0`` +:ref:`float` **rendering/environment/ssao/fadeout_from** = ``50.0`` :ref:`🔗` Distance at which the screen-space ambient occlusion effect starts to fade out. Use this hide ambient occlusion at great distances. @@ -9868,7 +9870,7 @@ Distance at which the screen-space ambient occlusion effect starts to fade out. .. rst-class:: classref-property -:ref:`float` **rendering/environment/ssao/fadeout_to** = ``300.0`` +:ref:`float` **rendering/environment/ssao/fadeout_to** = ``300.0`` :ref:`🔗` Distance at which the screen-space ambient occlusion is fully faded out. Use this hide ambient occlusion at great distances. @@ -9880,7 +9882,7 @@ Distance at which the screen-space ambient occlusion is fully faded out. Use thi .. rst-class:: classref-property -:ref:`bool` **rendering/environment/ssao/half_size** = ``true`` +:ref:`bool` **rendering/environment/ssao/half_size** = ``true`` :ref:`🔗` If ``true``, screen-space ambient occlusion will be rendered at half size and then upscaled before being added to the scene. This is significantly faster but may miss small details. If ``false``, screen-space ambient occlusion will be rendered at full size. @@ -9892,7 +9894,7 @@ If ``true``, screen-space ambient occlusion will be rendered at half size and th .. rst-class:: classref-property -:ref:`int` **rendering/environment/ssao/quality** = ``2`` +:ref:`int` **rendering/environment/ssao/quality** = ``2`` :ref:`🔗` Sets the quality of the screen-space ambient occlusion effect. Higher values take more samples and so will result in better quality, at the cost of performance. Setting to ``Ultra`` will use the :ref:`rendering/environment/ssao/adaptive_target` setting. @@ -9904,7 +9906,7 @@ Sets the quality of the screen-space ambient occlusion effect. Higher values tak .. rst-class:: classref-property -:ref:`float` **rendering/environment/ssil/adaptive_target** = ``0.5`` +:ref:`float` **rendering/environment/ssil/adaptive_target** = ``0.5`` :ref:`🔗` Quality target to use when :ref:`rendering/environment/ssil/quality` is set to ``Ultra``. A value of ``0.0`` provides a quality and speed similar to ``Medium`` while a value of ``1.0`` provides much higher quality than any of the other settings at the cost of performance. When using the adaptive target, the performance cost scales with the complexity of the scene. @@ -9916,7 +9918,7 @@ Quality target to use when :ref:`rendering/environment/ssil/quality` **rendering/environment/ssil/blur_passes** = ``4`` +:ref:`int` **rendering/environment/ssil/blur_passes** = ``4`` :ref:`🔗` Number of blur passes to use when computing screen-space indirect lighting. A higher number will result in a smoother look, but will be slower to compute and will have less high-frequency detail. @@ -9928,7 +9930,7 @@ Number of blur passes to use when computing screen-space indirect lighting. A hi .. rst-class:: classref-property -:ref:`float` **rendering/environment/ssil/fadeout_from** = ``50.0`` +:ref:`float` **rendering/environment/ssil/fadeout_from** = ``50.0`` :ref:`🔗` Distance at which the screen-space indirect lighting effect starts to fade out. Use this hide screen-space indirect lighting at great distances. @@ -9940,7 +9942,7 @@ Distance at which the screen-space indirect lighting effect starts to fade out. .. rst-class:: classref-property -:ref:`float` **rendering/environment/ssil/fadeout_to** = ``300.0`` +:ref:`float` **rendering/environment/ssil/fadeout_to** = ``300.0`` :ref:`🔗` Distance at which the screen-space indirect lighting is fully faded out. Use this hide screen-space indirect lighting at great distances. @@ -9952,7 +9954,7 @@ Distance at which the screen-space indirect lighting is fully faded out. Use thi .. rst-class:: classref-property -:ref:`bool` **rendering/environment/ssil/half_size** = ``true`` +:ref:`bool` **rendering/environment/ssil/half_size** = ``true`` :ref:`🔗` If ``true``, screen-space indirect lighting will be rendered at half size and then upscaled before being added to the scene. This is significantly faster but may miss small details and may result in some objects appearing to glow at their edges. @@ -9964,7 +9966,7 @@ If ``true``, screen-space indirect lighting will be rendered at half size and th .. rst-class:: classref-property -:ref:`int` **rendering/environment/ssil/quality** = ``2`` +:ref:`int` **rendering/environment/ssil/quality** = ``2`` :ref:`🔗` Sets the quality of the screen-space indirect lighting effect. Higher values take more samples and so will result in better quality, at the cost of performance. Setting to ``Ultra`` will use the :ref:`rendering/environment/ssil/adaptive_target` setting. @@ -9976,7 +9978,7 @@ Sets the quality of the screen-space indirect lighting effect. Higher values tak .. rst-class:: classref-property -:ref:`float` **rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale** = ``0.01`` +:ref:`float` **rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale** = ``0.01`` :ref:`🔗` Scales the depth over which the subsurface scattering effect is applied. A high value may allow light to scatter into a part of the mesh or another mesh that is close in screen space but far in depth. See also :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_scale`. @@ -9990,7 +9992,7 @@ Scales the depth over which the subsurface scattering effect is applied. A high .. rst-class:: classref-property -:ref:`int` **rendering/environment/subsurface_scattering/subsurface_scattering_quality** = ``1`` +:ref:`int` **rendering/environment/subsurface_scattering/subsurface_scattering_quality** = ``1`` :ref:`🔗` Sets the quality of the subsurface scattering effect. Higher values are slower but look nicer. This affects the rendering of materials that have :ref:`BaseMaterial3D.subsurf_scatter_enabled` set to ``true``, along with :ref:`ShaderMaterial`\ s that set ``SSS_STRENGTH``. @@ -10004,7 +10006,7 @@ Sets the quality of the subsurface scattering effect. Higher values are slower b .. rst-class:: classref-property -:ref:`float` **rendering/environment/subsurface_scattering/subsurface_scattering_scale** = ``0.05`` +:ref:`float` **rendering/environment/subsurface_scattering/subsurface_scattering_scale** = ``0.05`` :ref:`🔗` Scales the distance over which samples are taken for subsurface scattering effect. Changing this does not impact performance, but higher values will result in significant artifacts as the samples will become obviously spread out. A lower value results in a smaller spread of scattered light. See also :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale`. @@ -10018,7 +10020,7 @@ Scales the distance over which samples are taken for subsurface scattering effec .. rst-class:: classref-property -:ref:`int` **rendering/environment/volumetric_fog/use_filter** = ``1`` +:ref:`int` **rendering/environment/volumetric_fog/use_filter** = ``1`` :ref:`🔗` 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. @@ -10030,7 +10032,7 @@ Enables filtering of the volumetric fog effect prior to integration. This substa .. rst-class:: classref-property -:ref:`int` **rendering/environment/volumetric_fog/volume_depth** = ``64`` +:ref:`int` **rendering/environment/volumetric_fog/volume_depth** = ``64`` :ref:`🔗` 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. See also :ref:`Environment.volumetric_fog_length`. @@ -10042,7 +10044,7 @@ Number of slices to use along the depth of the froxel buffer for volumetric fog. .. rst-class:: classref-property -:ref:`int` **rendering/environment/volumetric_fog/volume_size** = ``64`` +:ref:`int` **rendering/environment/volumetric_fog/volume_size** = ``64`` :ref:`🔗` 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. @@ -10054,7 +10056,7 @@ Base size used to determine size of froxel buffer in the camera X-axis and Y-axi .. rst-class:: classref-property -:ref:`String` **rendering/gl_compatibility/driver** +:ref:`String` **rendering/gl_compatibility/driver** :ref:`🔗` Sets the driver to be used by the renderer when using the Compatibility renderer. This property can not be edited directly, instead, set the driver using the platform-specific overrides. @@ -10066,7 +10068,7 @@ Sets the driver to be used by the renderer when using the Compatibility renderer .. rst-class:: classref-property -:ref:`String` **rendering/gl_compatibility/driver.android** +:ref:`String` **rendering/gl_compatibility/driver.android** :ref:`🔗` Android override for :ref:`rendering/gl_compatibility/driver`. @@ -10078,7 +10080,7 @@ Android override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.ios** +:ref:`String` **rendering/gl_compatibility/driver.ios** :ref:`🔗` iOS override for :ref:`rendering/gl_compatibility/driver`. @@ -10090,7 +10092,7 @@ iOS override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.linuxbsd** +:ref:`String` **rendering/gl_compatibility/driver.linuxbsd** :ref:`🔗` LinuxBSD override for :ref:`rendering/gl_compatibility/driver`. @@ -10102,7 +10104,7 @@ LinuxBSD override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.macos** +:ref:`String` **rendering/gl_compatibility/driver.macos** :ref:`🔗` macOS override for :ref:`rendering/gl_compatibility/driver`. @@ -10114,7 +10116,7 @@ macOS override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.web** +:ref:`String` **rendering/gl_compatibility/driver.web** :ref:`🔗` Web override for :ref:`rendering/gl_compatibility/driver`. @@ -10126,7 +10128,7 @@ Web override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/driver.windows** +:ref:`String` **rendering/gl_compatibility/driver.windows** :ref:`🔗` Windows override for :ref:`rendering/gl_compatibility/driver`. @@ -10138,7 +10140,7 @@ Windows override for :ref:`rendering/gl_compatibility/driver` **rendering/gl_compatibility/fallback_to_angle** = ``true`` +:ref:`bool` **rendering/gl_compatibility/fallback_to_angle** = ``true`` :ref:`🔗` If ``true``, the compatibility renderer will fall back to ANGLE if native OpenGL is not supported or the device is listed in :ref:`rendering/gl_compatibility/force_angle_on_devices`. @@ -10152,7 +10154,7 @@ If ``true``, the compatibility renderer will fall back to ANGLE if native OpenGL .. rst-class:: classref-property -:ref:`bool` **rendering/gl_compatibility/fallback_to_gles** = ``true`` +:ref:`bool` **rendering/gl_compatibility/fallback_to_gles** = ``true`` :ref:`🔗` If ``true``, the compatibility renderer will fall back to OpenGLES if desktop OpenGL is not supported. @@ -10166,7 +10168,7 @@ If ``true``, the compatibility renderer will fall back to OpenGLES if desktop Op .. rst-class:: classref-property -:ref:`bool` **rendering/gl_compatibility/fallback_to_native** = ``true`` +:ref:`bool` **rendering/gl_compatibility/fallback_to_native** = ``true`` :ref:`🔗` If ``true``, the compatibility renderer will fall back to native OpenGL if ANGLE over Metal is not supported. @@ -10180,7 +10182,7 @@ If ``true``, the compatibility renderer will fall back to native OpenGL if ANGLE .. rst-class:: classref-property -:ref:`Array` **rendering/gl_compatibility/force_angle_on_devices** +:ref:`Array` **rendering/gl_compatibility/force_angle_on_devices** :ref:`🔗` An :ref:`Array` of devices which should always use the ANGLE renderer. @@ -10196,7 +10198,7 @@ Each entry is a :ref:`Dictionary` with the following keys: ``v .. rst-class:: classref-property -:ref:`int` **rendering/gl_compatibility/item_buffer_size** = ``16384`` +:ref:`int` **rendering/gl_compatibility/item_buffer_size** = ``16384`` :ref:`🔗` Maximum number of canvas items commands that can be drawn in a single viewport update. If more render commands are issued they will be ignored. Decreasing this limit may improve performance on bandwidth limited devices. Increase this limit if you find that not all objects are being drawn in a frame. @@ -10208,7 +10210,7 @@ Maximum number of canvas items commands that can be drawn in a single viewport u .. rst-class:: classref-property -:ref:`bool` **rendering/gl_compatibility/nvidia_disable_threaded_optimization** = ``true`` +:ref:`bool` **rendering/gl_compatibility/nvidia_disable_threaded_optimization** = ``true`` :ref:`🔗` If ``true``, disables the threaded optimization feature from the NVIDIA drivers, which are known to cause stuttering in most OpenGL applications. @@ -10222,7 +10224,7 @@ If ``true``, disables the threaded optimization feature from the NVIDIA drivers, .. rst-class:: classref-property -:ref:`bool` **rendering/global_illumination/gi/use_half_resolution** = ``false`` +:ref:`bool` **rendering/global_illumination/gi/use_half_resolution** = ``false`` :ref:`🔗` If ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment.sdfgi_enabled`) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. :ref:`LightmapGI` rendering is not affected by this setting. @@ -10236,7 +10238,7 @@ If ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment. .. rst-class:: classref-property -:ref:`int` **rendering/global_illumination/sdfgi/frames_to_converge** = ``5`` +:ref:`int` **rendering/global_illumination/sdfgi/frames_to_converge** = ``5`` :ref:`🔗` The number of frames to use for converging signed distance field global illumination. Higher values lead to a less noisy result, at the cost of taking a longer time to fully converge. This means the scene's global illumination will be too dark for a longer period of time, especially when the camera moves fast. The actual convergence speed depends on rendered framerate. For example, with the default setting of 30 frames, rendering at 60 FPS will make SDFGI fully converge after 0.5 seconds. See also :ref:`rendering/global_illumination/sdfgi/frames_to_update_lights` and :ref:`rendering/global_illumination/sdfgi/probe_ray_count`. @@ -10250,7 +10252,7 @@ The number of frames to use for converging signed distance field global illumina .. rst-class:: classref-property -:ref:`int` **rendering/global_illumination/sdfgi/frames_to_update_lights** = ``2`` +:ref:`int` **rendering/global_illumination/sdfgi/frames_to_update_lights** = ``2`` :ref:`🔗` The number of frames over which dynamic lights should be updated in signed distance field global illumination. Higher values take more time to update indirect lighting coming from dynamic lights, but result in better performance when many dynamic lights are present. See also :ref:`rendering/global_illumination/sdfgi/frames_to_converge` and :ref:`rendering/global_illumination/sdfgi/probe_ray_count`. @@ -10266,7 +10268,7 @@ The number of frames over which dynamic lights should be updated in signed dista .. rst-class:: classref-property -:ref:`int` **rendering/global_illumination/sdfgi/probe_ray_count** = ``1`` +:ref:`int` **rendering/global_illumination/sdfgi/probe_ray_count** = ``1`` :ref:`🔗` The number of rays to throw per frame when computing signed distance field global illumination. Higher values lead to a less noisy result, at the cost of performance. See also :ref:`rendering/global_illumination/sdfgi/frames_to_converge` and :ref:`rendering/global_illumination/sdfgi/frames_to_update_lights`. @@ -10280,7 +10282,7 @@ The number of rays to throw per frame when computing signed distance field globa .. rst-class:: classref-property -:ref:`int` **rendering/global_illumination/voxel_gi/quality** = ``0`` +:ref:`int` **rendering/global_illumination/voxel_gi/quality** = ``0`` :ref:`🔗` The VoxelGI quality to use. High quality leads to more precise lighting and better reflections, but is slower to render. This setting does not affect the baked data and doesn't require baking the :ref:`VoxelGI` again to apply. @@ -10294,7 +10296,7 @@ The VoxelGI quality to use. High quality leads to more precise lighting and bett .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_performance/max_rays_per_pass** = ``32`` +:ref:`int` **rendering/lightmapping/bake_performance/max_rays_per_pass** = ``32`` :ref:`🔗` The maximum number of rays that can be thrown per pass when baking lightmaps with :ref:`LightmapGI`. Depending on the scene, adjusting this value may result in higher GPU utilization when baking lightmaps, leading to faster bake times. @@ -10306,7 +10308,7 @@ The maximum number of rays that can be thrown per pass when baking lightmaps wit .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_performance/max_rays_per_probe_pass** = ``64`` +:ref:`int` **rendering/lightmapping/bake_performance/max_rays_per_probe_pass** = ``64`` :ref:`🔗` The maximum number of rays that can be thrown per pass when baking dynamic object lighting in :ref:`LightmapProbe`\ s with :ref:`LightmapGI`. Depending on the scene, adjusting this value may result in higher GPU utilization when baking lightmaps, leading to faster bake times. @@ -10318,7 +10320,7 @@ The maximum number of rays that can be thrown per pass when baking dynamic objec .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_performance/region_size** = ``512`` +:ref:`int` **rendering/lightmapping/bake_performance/region_size** = ``512`` :ref:`🔗` The region size to use when baking lightmaps with :ref:`LightmapGI`. @@ -10330,7 +10332,7 @@ The region size to use when baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/bake_quality/high_quality_probe_ray_count** = ``512`` +:ref:`int` **rendering/lightmapping/bake_quality/high_quality_probe_ray_count** = ``512`` :ref:`🔗` The number of rays to use for baking dynamic object lighting in :ref:`LightmapProbe`\ s when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_HIGH`. @@ -10342,7 +10344,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/high_quality_ray_count** = ``512`` +:ref:`int` **rendering/lightmapping/bake_quality/high_quality_ray_count** = ``512`` :ref:`🔗` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_HIGH`. @@ -10354,7 +10356,7 @@ The number of rays to use for baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/bake_quality/low_quality_probe_ray_count** = ``64`` +:ref:`int` **rendering/lightmapping/bake_quality/low_quality_probe_ray_count** = ``64`` :ref:`🔗` The number of rays to use for baking dynamic object lighting in :ref:`LightmapProbe`\ s when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_LOW`. @@ -10366,7 +10368,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/low_quality_ray_count** = ``32`` +:ref:`int` **rendering/lightmapping/bake_quality/low_quality_ray_count** = ``32`` :ref:`🔗` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_LOW`. @@ -10378,7 +10380,7 @@ The number of rays to use for baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/bake_quality/medium_quality_probe_ray_count** = ``256`` +:ref:`int` **rendering/lightmapping/bake_quality/medium_quality_probe_ray_count** = ``256`` :ref:`🔗` The number of rays to use for baking dynamic object lighting in :ref:`LightmapProbe`\ s when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_MEDIUM`. @@ -10390,7 +10392,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/medium_quality_ray_count** = ``128`` +:ref:`int` **rendering/lightmapping/bake_quality/medium_quality_ray_count** = ``128`` :ref:`🔗` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_MEDIUM`. @@ -10402,7 +10404,7 @@ The number of rays to use for baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count** = ``2048`` +:ref:`int` **rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count** = ``2048`` :ref:`🔗` The number of rays to use for baking dynamic object lighting in :ref:`LightmapProbe`\ s when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_ULTRA`. @@ -10414,7 +10416,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/ultra_quality_ray_count** = ``2048`` +:ref:`int` **rendering/lightmapping/bake_quality/ultra_quality_ray_count** = ``2048`` :ref:`🔗` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_ULTRA`. @@ -10426,7 +10428,7 @@ The number of rays to use for baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/denoising/denoiser** = ``0`` +:ref:`int` **rendering/lightmapping/denoising/denoiser** = ``0`` :ref:`🔗` Denoiser tool used for denoising lightmaps. @@ -10450,7 +10452,7 @@ If no GPU acceleration is configured on the system, multi-threaded CPU-based den .. rst-class:: classref-property -:ref:`float` **rendering/lightmapping/primitive_meshes/texel_size** = ``0.2`` +:ref:`float` **rendering/lightmapping/primitive_meshes/texel_size** = ``0.2`` :ref:`🔗` The texel_size that is used to calculate the :ref:`Mesh.lightmap_size_hint` on :ref:`PrimitiveMesh` resources if :ref:`PrimitiveMesh.add_uv2` is enabled. @@ -10462,7 +10464,7 @@ The texel_size that is used to calculate the :ref:`Mesh.lightmap_size_hint` **rendering/lightmapping/probe_capture/update_speed** = ``15`` +:ref:`float` **rendering/lightmapping/probe_capture/update_speed** = ``15`` :ref:`🔗` The framerate-independent update speed when representing dynamic object lighting from :ref:`LightmapProbe`\ s. Higher values make dynamic object lighting update faster. Higher values can prevent fast-moving objects from having "outdated" indirect lighting displayed on them, at the cost of possible flickering when an object moves from a bright area to a shaded area. @@ -10474,7 +10476,7 @@ The framerate-independent update speed when representing dynamic object lighting .. rst-class:: classref-property -:ref:`bool` **rendering/lights_and_shadows/directional_shadow/16_bits** = ``true`` +:ref:`bool` **rendering/lights_and_shadows/directional_shadow/16_bits** = ``true`` :ref:`🔗` Use 16 bits for the directional shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. @@ -10486,7 +10488,7 @@ Use 16 bits for the directional shadow depth map. Enabling this results in shado .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/directional_shadow/size** = ``4096`` +:ref:`int` **rendering/lights_and_shadows/directional_shadow/size** = ``4096`` :ref:`🔗` The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value is rounded up to the nearest power of 2. @@ -10498,7 +10500,7 @@ The directional shadow's size in pixels. Higher values will result in sharper sh .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/directional_shadow/size.mobile** = ``2048`` +:ref:`int` **rendering/lights_and_shadows/directional_shadow/size.mobile** = ``2048`` :ref:`🔗` Lower-end override for :ref:`rendering/lights_and_shadows/directional_shadow/size` on mobile devices, due to performance concerns or driver support. @@ -10510,7 +10512,7 @@ Lower-end override for :ref:`rendering/lights_and_shadows/directional_shadow/siz .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality** = ``2`` +:ref:`int` **rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality** = ``2`` :ref:`🔗` 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. @@ -10526,7 +10528,7 @@ Quality setting for shadows cast by :ref:`DirectionalLight3D` **rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality.mobile** = ``0`` +:ref:`int` **rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality.mobile** = ``0`` :ref:`🔗` Lower-end override for :ref:`rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality` on mobile devices, due to performance concerns or driver support. @@ -10538,7 +10540,7 @@ Lower-end override for :ref:`rendering/lights_and_shadows/directional_shadow/sof .. rst-class:: classref-property -:ref:`bool` **rendering/lights_and_shadows/positional_shadow/atlas_16_bits** = ``true`` +:ref:`bool` **rendering/lights_and_shadows/positional_shadow/atlas_16_bits** = ``true`` :ref:`🔗` Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. @@ -10550,7 +10552,7 @@ Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv** = ``2`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv** = ``2`` :ref:`🔗` Subdivision quadrant size for shadow mapping. See shadow mapping documentation. @@ -10562,7 +10564,7 @@ Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv** = ``2`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv** = ``2`` :ref:`🔗` Subdivision quadrant size for shadow mapping. See shadow mapping documentation. @@ -10574,7 +10576,7 @@ Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv** = ``3`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv** = ``3`` :ref:`🔗` Subdivision quadrant size for shadow mapping. See shadow mapping documentation. @@ -10586,7 +10588,7 @@ Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv** = ``4`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv** = ``4`` :ref:`🔗` Subdivision quadrant size for shadow mapping. See shadow mapping documentation. @@ -10598,7 +10600,7 @@ Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size** = ``4096`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size** = ``4096`` :ref:`🔗` Size for shadow atlas (used for OmniLights and SpotLights). See documentation. @@ -10610,7 +10612,7 @@ Size for shadow atlas (used for OmniLights and SpotLights). See documentation. .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size.mobile** = ``2048`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size.mobile** = ``2048`` :ref:`🔗` Lower-end override for :ref:`rendering/lights_and_shadows/positional_shadow/atlas_size` on mobile devices, due to performance concerns or driver support. @@ -10622,7 +10624,7 @@ Lower-end override for :ref:`rendering/lights_and_shadows/positional_shadow/atla .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality** = ``2`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality** = ``2`` :ref:`🔗` 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. @@ -10638,7 +10640,7 @@ Quality setting for shadows cast by :ref:`OmniLight3D`\ s and .. rst-class:: classref-property -:ref:`int` **rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality.mobile** = ``0`` +:ref:`int` **rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality.mobile** = ``0`` :ref:`🔗` Lower-end override for :ref:`rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality` on mobile devices, due to performance concerns or driver support. @@ -10650,7 +10652,7 @@ Lower-end override for :ref:`rendering/lights_and_shadows/positional_shadow/soft .. rst-class:: classref-property -:ref:`bool` **rendering/lights_and_shadows/tighter_shadow_caster_culling** = ``true`` +:ref:`bool` **rendering/lights_and_shadows/tighter_shadow_caster_culling** = ``true`` :ref:`🔗` If ``true``, items that cannot cast shadows into the view frustum will not be rendered into shadow maps. @@ -10664,7 +10666,7 @@ This can increase performance. .. rst-class:: classref-property -:ref:`bool` **rendering/lights_and_shadows/use_physical_light_units** = ``false`` +:ref:`bool` **rendering/lights_and_shadows/use_physical_light_units** = ``false`` :ref:`🔗` Enables the use of physically based units for light sources. Physically based units tend to be much larger than the arbitrary units used by Godot, but they can be used to match lighting within Godot to real-world lighting. Due to the large dynamic range of lighting conditions present in nature, Godot bakes exposure into the various lighting quantities before rendering. Most light sources bake exposure automatically at run time based on the active :ref:`CameraAttributes` resource, but :ref:`LightmapGI` and :ref:`VoxelGI` require a :ref:`CameraAttributes` resource to be set at bake time to reduce the dynamic range. At run time, Godot will automatically reconcile the baked exposure with the active exposure to ensure lighting remains consistent. @@ -10676,7 +10678,7 @@ Enables the use of physically based units for light sources. Physically based un .. rst-class:: classref-property -:ref:`float` **rendering/limits/cluster_builder/max_clustered_elements** = ``512`` +:ref:`float` **rendering/limits/cluster_builder/max_clustered_elements** = ``512`` :ref:`🔗` The maximum number of clustered elements (:ref:`OmniLight3D` + :ref:`SpotLight3D` + :ref:`Decal` + :ref:`ReflectionProbe`) that can be rendered at once in the camera view. If there are more clustered elements present in the camera view, some of them will not be rendered (leading to pop-in during camera movement). Enabling distance fade on lights and decals (:ref:`Light3D.distance_fade_enabled`, :ref:`Decal.distance_fade_enabled`) can help avoid reaching this limit. @@ -10692,7 +10694,7 @@ Decreasing this value may improve GPU performance on certain setups, even if the .. rst-class:: classref-property -:ref:`int` **rendering/limits/global_shader_variables/buffer_size** = ``65536`` +:ref:`int` **rendering/limits/global_shader_variables/buffer_size** = ``65536`` :ref:`🔗` .. container:: contribute @@ -10706,7 +10708,7 @@ Decreasing this value may improve GPU performance on certain setups, even if the .. rst-class:: classref-property -:ref:`int` **rendering/limits/opengl/max_lights_per_object** = ``8`` +:ref:`int` **rendering/limits/opengl/max_lights_per_object** = ``8`` :ref:`🔗` Max number of omnilights and spotlights renderable per object. At the default value of 8, this means that each surface can be affected by up to 8 omnilights and 8 spotlights. This is further limited by hardware support and :ref:`rendering/limits/opengl/max_renderable_lights`. Setting this low will slightly reduce memory usage, may decrease shader compile times, and may result in faster rendering on low-end, mobile, or web devices. @@ -10720,7 +10722,7 @@ Max number of omnilights and spotlights renderable per object. At the default va .. rst-class:: classref-property -:ref:`int` **rendering/limits/opengl/max_renderable_elements** = ``65536`` +:ref:`int` **rendering/limits/opengl/max_renderable_elements** = ``65536`` :ref:`🔗` Max number of elements renderable in a frame. If more elements than this are visible per frame, they will not be drawn. Keep in mind elements refer to mesh surfaces and not meshes themselves. Setting this low will slightly reduce memory usage and may decrease shader compile times, particularly on web. For most uses, the default value is suitable, but consider lowering as much as possible on web export. @@ -10734,7 +10736,7 @@ Max number of elements renderable in a frame. If more elements than this are vis .. rst-class:: classref-property -:ref:`int` **rendering/limits/opengl/max_renderable_lights** = ``32`` +:ref:`int` **rendering/limits/opengl/max_renderable_lights** = ``32`` :ref:`🔗` Max number of positional lights renderable in a frame. If more lights than this number are used, they will be ignored. Setting this low will slightly reduce memory usage and may decrease shader compile times, particularly on web. For most uses, the default value is suitable, but consider lowering as much as possible on web export. @@ -10748,7 +10750,7 @@ Max number of positional lights renderable in a frame. If more lights than this .. rst-class:: classref-property -:ref:`int` **rendering/limits/spatial_indexer/threaded_cull_minimum_instances** = ``1000`` +:ref:`int` **rendering/limits/spatial_indexer/threaded_cull_minimum_instances** = ``1000`` :ref:`🔗` The minimum number of instances that must be present in a scene to enable culling computations on multiple threads. If a scene has fewer instances than this number, culling is done on a single thread. @@ -10760,7 +10762,7 @@ The minimum number of instances that must be present in a scene to enable cullin .. rst-class:: classref-property -:ref:`int` **rendering/limits/spatial_indexer/update_iterations_per_frame** = ``10`` +:ref:`int` **rendering/limits/spatial_indexer/update_iterations_per_frame** = ``10`` :ref:`🔗` .. container:: contribute @@ -10774,7 +10776,7 @@ The minimum number of instances that must be present in a scene to enable cullin .. rst-class:: classref-property -:ref:`float` **rendering/limits/time/time_rollover_secs** = ``3600`` +:ref:`float` **rendering/limits/time/time_rollover_secs** = ``3600`` :ref:`🔗` .. container:: contribute @@ -10788,7 +10790,7 @@ The minimum number of instances that must be present in a scene to enable cullin .. rst-class:: classref-property -:ref:`float` **rendering/mesh_lod/lod_change/threshold_pixels** = ``1.0`` +:ref:`float` **rendering/mesh_lod/lod_change/threshold_pixels** = ``1.0`` :ref:`🔗` The automatic LOD bias to use for meshes rendered within the :ref:`ReflectionProbe`. Higher values will use less detailed versions of meshes that have LOD variations generated. If set to ``0.0``, automatic LOD is disabled. Increase :ref:`rendering/mesh_lod/lod_change/threshold_pixels` to improve performance at the cost of geometry detail. @@ -10804,7 +10806,7 @@ The automatic LOD bias to use for meshes rendered within the :ref:`ReflectionPro .. rst-class:: classref-property -:ref:`int` **rendering/occlusion_culling/bvh_build_quality** = ``2`` +:ref:`int` **rendering/occlusion_culling/bvh_build_quality** = ``2`` :ref:`🔗` The `Bounding Volume Hierarchy `__ quality to use when rendering the occlusion culling buffer. Higher values will result in more accurate occlusion culling, at the cost of higher CPU usage. See also :ref:`rendering/occlusion_culling/occlusion_rays_per_thread`. @@ -10818,7 +10820,7 @@ The `Bounding Volume Hierarchy ` **rendering/occlusion_culling/jitter_projection** = ``true`` +:ref:`bool` **rendering/occlusion_culling/jitter_projection** = ``true`` :ref:`🔗` If ``true``, the projection used for rendering the occlusion buffer will be jittered. This can help prevent objects being incorrectly culled when visible through small gaps. @@ -10830,7 +10832,7 @@ If ``true``, the projection used for rendering the occlusion buffer will be jitt .. rst-class:: classref-property -:ref:`int` **rendering/occlusion_culling/occlusion_rays_per_thread** = ``512`` +:ref:`int` **rendering/occlusion_culling/occlusion_rays_per_thread** = ``512`` :ref:`🔗` The number of occlusion rays traced per CPU thread. Higher values will result in more accurate occlusion culling, at the cost of higher CPU usage. The occlusion culling buffer's pixel count is roughly equal to ``occlusion_rays_per_thread * number_of_logical_cpu_cores``, so it will depend on the system's CPU. Therefore, CPUs with fewer cores will use a lower resolution to attempt keeping performance costs even across devices. See also :ref:`rendering/occlusion_culling/bvh_build_quality`. @@ -10844,7 +10846,7 @@ The number of occlusion rays traced per CPU thread. Higher values will result in .. rst-class:: classref-property -:ref:`bool` **rendering/occlusion_culling/use_occlusion_culling** = ``false`` +:ref:`bool` **rendering/occlusion_culling/use_occlusion_culling** = ``false`` :ref:`🔗` If ``true``, :ref:`OccluderInstance3D` nodes will be usable for occlusion culling in 3D in the root viewport. In custom viewports, :ref:`Viewport.use_occlusion_culling` must be set to ``true`` instead. @@ -10860,7 +10862,7 @@ If ``true``, :ref:`OccluderInstance3D` nodes will be u .. rst-class:: classref-property -:ref:`int` **rendering/reflections/reflection_atlas/reflection_count** = ``64`` +:ref:`int` **rendering/reflections/reflection_atlas/reflection_count** = ``64`` :ref:`🔗` Number of cubemaps to store in the reflection atlas. The number of :ref:`ReflectionProbe`\ s in a scene will be limited by this amount. A higher number requires more VRAM. @@ -10872,7 +10874,7 @@ Number of cubemaps to store in the reflection atlas. The number of :ref:`Reflect .. rst-class:: classref-property -:ref:`int` **rendering/reflections/reflection_atlas/reflection_size** = ``256`` +:ref:`int` **rendering/reflections/reflection_atlas/reflection_size** = ``256`` :ref:`🔗` Size of cubemap faces for :ref:`ReflectionProbe`\ s. A higher number requires more VRAM and may make reflection probe updating slower. @@ -10884,7 +10886,7 @@ Size of cubemap faces for :ref:`ReflectionProbe`\ s. A hi .. rst-class:: classref-property -:ref:`int` **rendering/reflections/reflection_atlas/reflection_size.mobile** = ``128`` +:ref:`int` **rendering/reflections/reflection_atlas/reflection_size.mobile** = ``128`` :ref:`🔗` Lower-end override for :ref:`rendering/reflections/reflection_atlas/reflection_size` on mobile devices, due to performance concerns or driver support. @@ -10896,7 +10898,7 @@ Lower-end override for :ref:`rendering/reflections/reflection_atlas/reflection_s .. rst-class:: classref-property -:ref:`bool` **rendering/reflections/sky_reflections/fast_filter_high_quality** = ``false`` +:ref:`bool` **rendering/reflections/sky_reflections/fast_filter_high_quality** = ``false`` :ref:`🔗` Use a higher quality variant of the fast filtering algorithm. Significantly slower than using default quality, but results in smoother reflections. Should only be used when the scene is especially detailed. @@ -10908,7 +10910,7 @@ Use a higher quality variant of the fast filtering algorithm. Significantly slow .. rst-class:: classref-property -:ref:`int` **rendering/reflections/sky_reflections/ggx_samples** = ``32`` +:ref:`int` **rendering/reflections/sky_reflections/ggx_samples** = ``32`` :ref:`🔗` Sets the number of samples to take when using importance sampling for :ref:`Sky`\ s and :ref:`ReflectionProbe`\ s. A higher value will result in smoother, higher quality reflections, but increases time to calculate radiance maps. In general, fewer samples are needed for simpler, low dynamic range environments while more samples are needed for HDR environments and environments with a high level of detail. @@ -10920,7 +10922,7 @@ Sets the number of samples to take when using importance sampling for :ref:`Sky< .. rst-class:: classref-property -:ref:`int` **rendering/reflections/sky_reflections/ggx_samples.mobile** = ``16`` +:ref:`int` **rendering/reflections/sky_reflections/ggx_samples.mobile** = ``16`` :ref:`🔗` Lower-end override for :ref:`rendering/reflections/sky_reflections/ggx_samples` on mobile devices, due to performance concerns or driver support. @@ -10932,7 +10934,7 @@ Lower-end override for :ref:`rendering/reflections/sky_reflections/ggx_samples` **rendering/reflections/sky_reflections/roughness_layers** = ``8`` +:ref:`int` **rendering/reflections/sky_reflections/roughness_layers** = ``8`` :ref:`🔗` Limits the number of layers to use in radiance maps when using importance sampling. A lower number will be slightly faster and take up less VRAM. @@ -10944,7 +10946,7 @@ Limits the number of layers to use in radiance maps when using importance sampli .. rst-class:: classref-property -:ref:`bool` **rendering/reflections/sky_reflections/texture_array_reflections** = ``true`` +:ref:`bool` **rendering/reflections/sky_reflections/texture_array_reflections** = ``true`` :ref:`🔗` If ``true``, uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise and upscaling artifacts on reflections, but is significantly slower to compute and uses :ref:`rendering/reflections/sky_reflections/roughness_layers` times more memory. @@ -10956,7 +10958,7 @@ If ``true``, uses texture arrays instead of mipmaps for reflection probes and pa .. rst-class:: classref-property -:ref:`bool` **rendering/reflections/sky_reflections/texture_array_reflections.mobile** = ``false`` +:ref:`bool` **rendering/reflections/sky_reflections/texture_array_reflections.mobile** = ``false`` :ref:`🔗` Lower-end override for :ref:`rendering/reflections/sky_reflections/texture_array_reflections` on mobile devices, due to performance concerns or driver support. @@ -10968,7 +10970,7 @@ Lower-end override for :ref:`rendering/reflections/sky_reflections/texture_array .. rst-class:: classref-property -:ref:`String` **rendering/renderer/rendering_method** = ``"forward_plus"`` +:ref:`String` **rendering/renderer/rendering_method** = ``"forward_plus"`` :ref:`🔗` Sets the renderer that will be used by the project. Options are: @@ -10986,7 +10988,7 @@ Sets the renderer that will be used by the project. Options are: .. rst-class:: classref-property -:ref:`String` **rendering/renderer/rendering_method.mobile** = ``"mobile"`` +:ref:`String` **rendering/renderer/rendering_method.mobile** = ``"mobile"`` :ref:`🔗` Override for :ref:`rendering/renderer/rendering_method` on mobile devices. @@ -10998,7 +11000,7 @@ Override for :ref:`rendering/renderer/rendering_method` **rendering/renderer/rendering_method.web** = ``"gl_compatibility"`` +:ref:`String` **rendering/renderer/rendering_method.web** = ``"gl_compatibility"`` :ref:`🔗` Override for :ref:`rendering/renderer/rendering_method` on web. @@ -11010,7 +11012,7 @@ Override for :ref:`rendering/renderer/rendering_method` **rendering/rendering_device/d3d12/agility_sdk_version** = ``613`` +:ref:`int` **rendering/rendering_device/d3d12/agility_sdk_version** = ``613`` :ref:`🔗` Version code of the `Direct3D 12 Agility SDK `__ to use (``D3D12SDKVersion``). This must match the *minor* version that is installed next to the editor binary and in the export templates directory for the current editor version. For example, if you have ``1.613.3`` installed, you need to input ``613`` here. @@ -11022,7 +11024,7 @@ Version code of the `Direct3D 12 Agility SDK ` **rendering/rendering_device/d3d12/max_misc_descriptors_per_frame** = ``512`` +:ref:`int` **rendering/rendering_device/d3d12/max_misc_descriptors_per_frame** = ``512`` :ref:`🔗` The number of entries in the miscellaneous descriptors heap the Direct3D 12 rendering driver uses each frame, used for various operations like clearing a texture. @@ -11036,7 +11038,7 @@ Depending on the complexity of scenes, this value may be lowered or may need to .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/d3d12/max_resource_descriptors_per_frame** = ``16384`` +:ref:`int` **rendering/rendering_device/d3d12/max_resource_descriptors_per_frame** = ``16384`` :ref:`🔗` The number of entries in the resource descriptors heap the Direct3D 12 rendering driver uses each frame, used for most rendering operations. @@ -11050,7 +11052,7 @@ Depending on the complexity of scenes, this value may be lowered or may need to .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame** = ``1024`` +:ref:`int` **rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame** = ``1024`` :ref:`🔗` The number of entries in the sampler descriptors heap the Direct3D 12 rendering driver uses each frame, used for most rendering operations. @@ -11064,7 +11066,7 @@ Depending on the complexity of scenes, this value may be lowered or may need to .. rst-class:: classref-property -:ref:`String` **rendering/rendering_device/driver** +:ref:`String` **rendering/rendering_device/driver** :ref:`🔗` Sets the driver to be used by the renderer when using a RenderingDevice-based renderer like the clustered renderer or the mobile renderer. This property can not be edited directly, instead, set the driver using the platform-specific overrides. @@ -11076,7 +11078,7 @@ Sets the driver to be used by the renderer when using a RenderingDevice-based re .. rst-class:: classref-property -:ref:`String` **rendering/rendering_device/driver.android** +:ref:`String` **rendering/rendering_device/driver.android** :ref:`🔗` Android override for :ref:`rendering/rendering_device/driver`. @@ -11088,7 +11090,7 @@ Android override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.ios** +:ref:`String` **rendering/rendering_device/driver.ios** :ref:`🔗` iOS override for :ref:`rendering/rendering_device/driver`. @@ -11100,7 +11102,7 @@ iOS override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.linuxbsd** +:ref:`String` **rendering/rendering_device/driver.linuxbsd** :ref:`🔗` LinuxBSD override for :ref:`rendering/rendering_device/driver`. @@ -11112,7 +11114,7 @@ LinuxBSD override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.macos** +:ref:`String` **rendering/rendering_device/driver.macos** :ref:`🔗` macOS override for :ref:`rendering/rendering_device/driver`. @@ -11124,7 +11126,7 @@ macOS override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/driver.windows** +:ref:`String` **rendering/rendering_device/driver.windows** :ref:`🔗` Windows override for :ref:`rendering/rendering_device/driver`. @@ -11136,7 +11138,7 @@ Windows override for :ref:`rendering/rendering_device/driver` **rendering/rendering_device/pipeline_cache/enable** = ``true`` +:ref:`bool` **rendering/rendering_device/pipeline_cache/enable** = ``true`` :ref:`🔗` Enable the pipeline cache that is saved to disk if the graphics API supports it. @@ -11150,7 +11152,7 @@ Enable the pipeline cache that is saved to disk if the graphics API supports it. .. rst-class:: classref-property -:ref:`float` **rendering/rendering_device/pipeline_cache/save_chunk_size_mb** = ``3.0`` +:ref:`float` **rendering/rendering_device/pipeline_cache/save_chunk_size_mb** = ``3.0`` :ref:`🔗` Determines at which interval pipeline cache is saved to disk. The lower the value, the more often it is saved. @@ -11162,7 +11164,7 @@ Determines at which interval pipeline cache is saved to disk. The lower the valu .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/staging_buffer/block_size_kb** = ``256`` +:ref:`int` **rendering/rendering_device/staging_buffer/block_size_kb** = ``256`` :ref:`🔗` .. container:: contribute @@ -11176,7 +11178,7 @@ Determines at which interval pipeline cache is saved to disk. The lower the valu .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/staging_buffer/max_size_mb** = ``128`` +:ref:`int` **rendering/rendering_device/staging_buffer/max_size_mb** = ``128`` :ref:`🔗` .. container:: contribute @@ -11190,7 +11192,7 @@ Determines at which interval pipeline cache is saved to disk. The lower the valu .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/staging_buffer/texture_upload_region_size_px** = ``64`` +:ref:`int` **rendering/rendering_device/staging_buffer/texture_upload_region_size_px** = ``64`` :ref:`🔗` .. container:: contribute @@ -11204,7 +11206,7 @@ Determines at which interval pipeline cache is saved to disk. The lower the valu .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/vsync/frame_queue_size** = ``2`` +:ref:`int` **rendering/rendering_device/vsync/frame_queue_size** = ``2`` :ref:`🔗` The number of frames to track on the CPU side before stalling to wait for the GPU. @@ -11220,7 +11222,7 @@ Try the `V-Sync Simulator `__, an .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/vsync/swapchain_image_count** = ``3`` +:ref:`int` **rendering/rendering_device/vsync/swapchain_image_count** = ``3`` :ref:`🔗` The number of images the swapchain will consist of (back buffers + front buffer). @@ -11244,7 +11246,7 @@ Try the `V-Sync Simulator `__, an .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/vulkan/max_descriptors_per_pool** = ``64`` +:ref:`int` **rendering/rendering_device/vulkan/max_descriptors_per_pool** = ``64`` :ref:`🔗` .. container:: contribute @@ -11258,7 +11260,7 @@ Try the `V-Sync Simulator `__, an .. rst-class:: classref-property -:ref:`float` **rendering/scaling_3d/fsr_sharpness** = ``0.2`` +:ref:`float` **rendering/scaling_3d/fsr_sharpness** = ``0.2`` :ref:`🔗` Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. @@ -11270,7 +11272,7 @@ Determines how sharp the upscaled image will be when using the FSR upscaling mod .. rst-class:: classref-property -:ref:`int` **rendering/scaling_3d/mode** = ``0`` +:ref:`int` **rendering/scaling_3d/mode** = ``0`` :ref:`🔗` Sets the scaling 3D mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially-aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. On particularly low-end GPUs, the added cost of FSR may not be worth it (compared to using bilinear scaling with a slightly higher resolution scale to match performance). @@ -11284,7 +11286,7 @@ Sets the scaling 3D mode. Bilinear scaling renders at different resolution to ei .. rst-class:: classref-property -:ref:`float` **rendering/scaling_3d/scale** = ``1.0`` +:ref:`float` **rendering/scaling_3d/scale** = ``1.0`` :ref:`🔗` Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`rendering/scaling_3d/mode` to scale the output image to the full viewport size. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`rendering/anti_aliasing/quality/msaa_3d` for multi-sample antialiasing, which is significantly cheaper but only smooths the edges of polygons. @@ -11296,7 +11298,7 @@ Scales the 3D render buffer based on the viewport size uses an image filter spec .. rst-class:: classref-property -:ref:`bool` **rendering/shader_compiler/shader_cache/compress** = ``true`` +:ref:`bool` **rendering/shader_compiler/shader_cache/compress** = ``true`` :ref:`🔗` .. container:: contribute @@ -11310,7 +11312,7 @@ Scales the 3D render buffer based on the viewport size uses an image filter spec .. rst-class:: classref-property -:ref:`bool` **rendering/shader_compiler/shader_cache/enabled** = ``true`` +:ref:`bool` **rendering/shader_compiler/shader_cache/enabled** = ``true`` :ref:`🔗` Enable the shader cache, which stores compiled shaders to disk to prevent stuttering from shader compilation the next time the shader is needed. @@ -11322,7 +11324,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. rst-class:: classref-property -:ref:`bool` **rendering/shader_compiler/shader_cache/strip_debug** = ``false`` +:ref:`bool` **rendering/shader_compiler/shader_cache/strip_debug** = ``false`` :ref:`🔗` .. container:: contribute @@ -11336,7 +11338,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. rst-class:: classref-property -:ref:`bool` **rendering/shader_compiler/shader_cache/strip_debug.release** = ``true`` +:ref:`bool` **rendering/shader_compiler/shader_cache/strip_debug.release** = ``true`` :ref:`🔗` .. container:: contribute @@ -11350,7 +11352,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. rst-class:: classref-property -:ref:`bool` **rendering/shader_compiler/shader_cache/use_zstd_compression** = ``true`` +:ref:`bool` **rendering/shader_compiler/shader_cache/use_zstd_compression** = ``true`` :ref:`🔗` .. container:: contribute @@ -11364,7 +11366,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. rst-class:: classref-property -:ref:`bool` **rendering/shading/overrides/force_lambert_over_burley** = ``false`` +:ref:`bool` **rendering/shading/overrides/force_lambert_over_burley** = ``false`` :ref:`🔗` If ``true``, uses faster but lower-quality Lambert material lighting model instead of Burley. @@ -11376,7 +11378,7 @@ If ``true``, uses faster but lower-quality Lambert material lighting model inste .. rst-class:: classref-property -:ref:`bool` **rendering/shading/overrides/force_lambert_over_burley.mobile** = ``true`` +:ref:`bool` **rendering/shading/overrides/force_lambert_over_burley.mobile** = ``true`` :ref:`🔗` Lower-end override for :ref:`rendering/shading/overrides/force_lambert_over_burley` on mobile devices, due to performance concerns or driver support. @@ -11388,7 +11390,7 @@ Lower-end override for :ref:`rendering/shading/overrides/force_lambert_over_burl .. rst-class:: classref-property -:ref:`bool` **rendering/shading/overrides/force_vertex_shading** = ``false`` +:ref:`bool` **rendering/shading/overrides/force_vertex_shading** = ``false`` :ref:`🔗` If ``true``, forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. @@ -11402,7 +11404,7 @@ If ``true``, forces vertex shading for all rendering. This can increase performa .. rst-class:: classref-property -:ref:`bool` **rendering/shading/overrides/force_vertex_shading.mobile** = ``true`` +:ref:`bool` **rendering/shading/overrides/force_vertex_shading.mobile** = ``true`` :ref:`🔗` Lower-end override for :ref:`rendering/shading/overrides/force_vertex_shading` on mobile devices, due to performance concerns or driver support. @@ -11416,7 +11418,7 @@ Lower-end override for :ref:`rendering/shading/overrides/force_vertex_shading` **rendering/textures/canvas_textures/default_texture_filter** = ``1`` +:ref:`int` **rendering/textures/canvas_textures/default_texture_filter** = ``1`` :ref:`🔗` The default texture filtering mode to use on :ref:`CanvasItem`\ s. @@ -11430,7 +11432,7 @@ The default texture filtering mode to use on :ref:`CanvasItem` .. rst-class:: classref-property -:ref:`int` **rendering/textures/canvas_textures/default_texture_repeat** = ``0`` +:ref:`int` **rendering/textures/canvas_textures/default_texture_repeat** = ``0`` :ref:`🔗` The default texture repeating mode to use on :ref:`CanvasItem`\ s. @@ -11442,7 +11444,7 @@ The default texture repeating mode to use on :ref:`CanvasItem` .. rst-class:: classref-property -:ref:`int` **rendering/textures/decals/filter** = ``3`` +:ref:`int` **rendering/textures/decals/filter** = ``3`` :ref:`🔗` The filtering quality to use for :ref:`Decal` nodes. When using one of the anisotropic filtering modes, the anisotropic filtering level is controlled by :ref:`rendering/textures/default_filters/anisotropic_filtering_level`. @@ -11454,7 +11456,7 @@ The filtering quality to use for :ref:`Decal` nodes. When using one .. rst-class:: classref-property -:ref:`int` **rendering/textures/default_filters/anisotropic_filtering_level** = ``2`` +:ref:`int` **rendering/textures/default_filters/anisotropic_filtering_level** = ``2`` :ref:`🔗` Sets the maximum number of samples to take when using anisotropic filtering on textures (as a power of two). A higher sample count will result in sharper textures at oblique angles, but is more expensive to compute. A value of ``0`` forcibly disables anisotropic filtering, even on materials where it is enabled. @@ -11472,7 +11474,7 @@ The anisotropic filtering level also affects decals and light projectors if they .. rst-class:: classref-property -:ref:`float` **rendering/textures/default_filters/texture_mipmap_bias** = ``0.0`` +:ref:`float` **rendering/textures/default_filters/texture_mipmap_bias** = ``0.0`` :ref:`🔗` Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). @@ -11488,7 +11490,7 @@ Enabling temporal antialiasing (:ref:`rendering/anti_aliasing/quality/use_taa` **rendering/textures/default_filters/use_nearest_mipmap_filter** = ``false`` +:ref:`bool` **rendering/textures/default_filters/use_nearest_mipmap_filter** = ``false`` :ref:`🔗` If ``true``, uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If ``false``, linear mipmap filtering (also called "trilinear filtering") is used. @@ -11502,7 +11504,7 @@ If ``true``, uses nearest-neighbor mipmap filtering when using mipmaps (also cal .. rst-class:: classref-property -:ref:`int` **rendering/textures/light_projectors/filter** = ``3`` +:ref:`int` **rendering/textures/light_projectors/filter** = ``3`` :ref:`🔗` The filtering quality to use for :ref:`OmniLight3D` and :ref:`SpotLight3D` projectors. When using one of the anisotropic filtering modes, the anisotropic filtering level is controlled by :ref:`rendering/textures/default_filters/anisotropic_filtering_level`. @@ -11514,7 +11516,7 @@ The filtering quality to use for :ref:`OmniLight3D` and :ref: .. rst-class:: classref-property -:ref:`bool` **rendering/textures/lossless_compression/force_png** = ``false`` +:ref:`bool` **rendering/textures/lossless_compression/force_png** = ``false`` :ref:`🔗` If ``true``, the texture importer will import lossless textures using the PNG format. Otherwise, it will default to using WebP. @@ -11526,7 +11528,7 @@ If ``true``, the texture importer will import lossless textures using the PNG fo .. rst-class:: classref-property -:ref:`bool` **rendering/textures/vram_compression/import_etc2_astc** = ``false`` +:ref:`bool` **rendering/textures/vram_compression/import_etc2_astc** = ``false`` :ref:`🔗` If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm for lower quality textures and normal maps and Adaptable Scalable Texture Compression algorithm for high quality textures (in 4×4 block size). @@ -11542,7 +11544,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the .. rst-class:: classref-property -:ref:`bool` **rendering/textures/vram_compression/import_s3tc_bptc** = ``false`` +:ref:`bool` **rendering/textures/vram_compression/import_s3tc_bptc** = ``false`` :ref:`🔗` If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm (DXT1-5) for lower quality textures and the BPTC algorithm (BC6H and BC7) for high quality textures. This algorithm is only supported on PC desktop platforms and consoles. @@ -11558,7 +11560,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the .. rst-class:: classref-property -:ref:`int` **rendering/textures/webp_compression/compression_method** = ``2`` +:ref:`int` **rendering/textures/webp_compression/compression_method** = ``2`` :ref:`🔗` The default compression method for WebP. Affects both lossy and lossless WebP. A higher value results in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression method. Supported values are 0 to 6. Note that compression methods above 4 are very slow and offer very little savings. @@ -11570,7 +11572,7 @@ The default compression method for WebP. Affects both lossy and lossless WebP. A .. rst-class:: classref-property -:ref:`float` **rendering/textures/webp_compression/lossless_compression_factor** = ``25`` +:ref:`float` **rendering/textures/webp_compression/lossless_compression_factor** = ``25`` :ref:`🔗` The default compression factor for lossless WebP. Decompression speed is mostly unaffected by the compression factor. Supported values are 0 to 100. @@ -11582,7 +11584,7 @@ The default compression factor for lossless WebP. Decompression speed is mostly .. rst-class:: classref-property -:ref:`bool` **rendering/viewport/hdr_2d** = ``false`` +:ref:`bool` **rendering/viewport/hdr_2d** = ``false`` :ref:`🔗` If ``true``, enables :ref:`Viewport.use_hdr_2d` on the root viewport. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow). @@ -11594,7 +11596,7 @@ If ``true``, enables :ref:`Viewport.use_hdr_2d` **rendering/viewport/transparent_background** = ``false`` +:ref:`bool` **rendering/viewport/transparent_background** = ``false`` :ref:`🔗` If ``true``, enables :ref:`Viewport.transparent_bg` on the root viewport. This allows per-pixel transparency to be effective after also enabling :ref:`display/window/size/transparent` and :ref:`display/window/per_pixel_transparency/allowed`. @@ -11606,7 +11608,7 @@ If ``true``, enables :ref:`Viewport.transparent_bg` **rendering/vrs/mode** = ``0`` +:ref:`int` **rendering/vrs/mode** = ``0`` :ref:`🔗` Set the default Variable Rate Shading (VRS) mode for the main viewport. See :ref:`Viewport.vrs_mode` to change this at runtime, and :ref:`VRSMode` for possible values. @@ -11618,7 +11620,7 @@ Set the default Variable Rate Shading (VRS) mode for the main viewport. See :ref .. rst-class:: classref-property -:ref:`String` **rendering/vrs/texture** = ``""`` +:ref:`String` **rendering/vrs/texture** = ``""`` :ref:`🔗` If :ref:`rendering/vrs/mode` is set to **Texture**, this is the path to default texture loaded as the VRS image. @@ -11645,7 +11647,7 @@ The texture *must* use a lossless compression format so that colors can be match .. rst-class:: classref-property -:ref:`float` **threading/worker_pool/low_priority_thread_ratio** = ``0.3`` +:ref:`float` **threading/worker_pool/low_priority_thread_ratio** = ``0.3`` :ref:`🔗` The ratio of :ref:`WorkerThreadPool`'s threads that will be reserved for low-priority tasks. For example, if 10 threads are available and this value is set to ``0.3``, 3 of the worker threads will be reserved for low-priority tasks. The actual value won't exceed the number of CPU cores minus one, and if possible, at least one worker thread will be dedicated to low-priority tasks. @@ -11657,7 +11659,7 @@ The ratio of :ref:`WorkerThreadPool`'s threads that will .. rst-class:: classref-property -:ref:`int` **threading/worker_pool/max_threads** = ``-1`` +:ref:`int` **threading/worker_pool/max_threads** = ``-1`` :ref:`🔗` Maximum number of threads to be used by :ref:`WorkerThreadPool`. Value of ``-1`` means no limit. @@ -11669,7 +11671,7 @@ Maximum number of threads to be used by :ref:`WorkerThreadPool` **xr/openxr/default_action_map** = ``"res://openxr_action_map.tres"`` +:ref:`String` **xr/openxr/default_action_map** = ``"res://openxr_action_map.tres"`` :ref:`🔗` Action map configuration to load by default. @@ -11681,7 +11683,7 @@ Action map configuration to load by default. .. rst-class:: classref-property -:ref:`bool` **xr/openxr/enabled** = ``false`` +:ref:`bool` **xr/openxr/enabled** = ``false`` :ref:`🔗` If ``true``, Godot will setup and initialize OpenXR on startup. @@ -11693,7 +11695,7 @@ If ``true``, Godot will setup and initialize OpenXR on startup. .. rst-class:: classref-property -:ref:`int` **xr/openxr/environment_blend_mode** = ``"0"`` +:ref:`int` **xr/openxr/environment_blend_mode** = ``"0"`` :ref:`🔗` Specify how OpenXR should blend in the environment. This is specific to certain AR and passthrough devices where camera images are blended in by the XR compositor. @@ -11705,7 +11707,7 @@ Specify how OpenXR should blend in the environment. This is specific to certain .. rst-class:: classref-property -:ref:`bool` **xr/openxr/extensions/eye_gaze_interaction** = ``false`` +:ref:`bool` **xr/openxr/extensions/eye_gaze_interaction** = ``false`` :ref:`🔗` Specify whether to enable eye tracking for this project. Depending on the platform, additional export configuration may be needed. @@ -11717,7 +11719,7 @@ Specify whether to enable eye tracking for this project. Depending on the platfo .. rst-class:: classref-property -:ref:`bool` **xr/openxr/extensions/hand_interaction_profile** = ``false`` +:ref:`bool` **xr/openxr/extensions/hand_interaction_profile** = ``false`` :ref:`🔗` If true the hand interaction profile extension will be activated if supported by the platform. @@ -11729,7 +11731,7 @@ If true the hand interaction profile extension will be activated if supported by .. rst-class:: classref-property -:ref:`bool` **xr/openxr/extensions/hand_tracking** = ``true`` +:ref:`bool` **xr/openxr/extensions/hand_tracking** = ``true`` :ref:`🔗` If true we enable the hand tracking extension if available. @@ -11741,7 +11743,7 @@ If true we enable the hand tracking extension if available. .. rst-class:: classref-property -:ref:`int` **xr/openxr/form_factor** = ``"0"`` +:ref:`int` **xr/openxr/form_factor** = ``"0"`` :ref:`🔗` Specify whether OpenXR should be configured for an HMD or a hand held device. @@ -11753,7 +11755,7 @@ Specify whether OpenXR should be configured for an HMD or a hand held device. .. rst-class:: classref-property -:ref:`bool` **xr/openxr/foveation_dynamic** = ``false`` +:ref:`bool` **xr/openxr/foveation_dynamic** = ``false`` :ref:`🔗` If true and foveation is supported, will automatically adjust foveation level based on framerate up to the level set on :ref:`xr/openxr/foveation_level`. @@ -11767,7 +11769,7 @@ If true and foveation is supported, will automatically adjust foveation level ba .. rst-class:: classref-property -:ref:`int` **xr/openxr/foveation_level** = ``"0"`` +:ref:`int` **xr/openxr/foveation_level** = ``"0"`` :ref:`🔗` Applied foveation level if supported: 0 = off, 1 = low, 2 = medium, 3 = high. @@ -11781,7 +11783,7 @@ Applied foveation level if supported: 0 = off, 1 = low, 2 = medium, 3 = high. .. rst-class:: classref-property -:ref:`int` **xr/openxr/reference_space** = ``"1"`` +:ref:`int` **xr/openxr/reference_space** = ``"1"`` :ref:`🔗` Specify the default reference space. @@ -11793,7 +11795,7 @@ Specify the default reference space. .. rst-class:: classref-property -:ref:`bool` **xr/openxr/startup_alert** = ``true`` +:ref:`bool` **xr/openxr/startup_alert** = ``true`` :ref:`🔗` If ``true``, Godot will display an alert modal when OpenXR initialization fails on startup. @@ -11805,7 +11807,7 @@ If ``true``, Godot will display an alert modal when OpenXR initialization fails .. rst-class:: classref-property -:ref:`bool` **xr/openxr/submit_depth_buffer** = ``false`` +:ref:`bool` **xr/openxr/submit_depth_buffer** = ``false`` :ref:`🔗` If ``true``, OpenXR will manage the depth buffer and use the depth buffer for advanced reprojection provided this is supported by the XR runtime. Note that some rendering features in Godot can't be used with this feature. @@ -11817,7 +11819,7 @@ If ``true``, OpenXR will manage the depth buffer and use the depth buffer for ad .. rst-class:: classref-property -:ref:`int` **xr/openxr/view_configuration** = ``"1"`` +:ref:`int` **xr/openxr/view_configuration** = ``"1"`` :ref:`🔗` Specify the view configuration with which to configure OpenXR setting up either Mono or Stereo rendering. @@ -11829,7 +11831,7 @@ Specify the view configuration with which to configure OpenXR setting up either .. rst-class:: classref-property -:ref:`bool` **xr/shaders/enabled** = ``false`` +:ref:`bool` **xr/shaders/enabled** = ``false`` :ref:`🔗` If ``true``, Godot will compile shaders required for XR. @@ -11846,7 +11848,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_property_info**\ (\ hint\: :ref:`Dictionary`\ ) +|void| **add_property_info**\ (\ hint\: :ref:`Dictionary`\ ) :ref:`🔗` Adds a custom property info to a property. The dictionary must contain: @@ -11898,7 +11900,7 @@ Adds a custom property info to a property. The dictionary must contain: .. rst-class:: classref-method -|void| **clear**\ (\ name\: :ref:`String`\ ) +|void| **clear**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Clears the whole configuration (not recommended, may break things). @@ -11910,7 +11912,7 @@ Clears the whole configuration (not recommended, may break things). .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_global_class_list**\ (\ ) +:ref:`Array`\[:ref:`Dictionary`\] **get_global_class_list**\ (\ ) :ref:`🔗` Returns an :ref:`Array` of registered global classes. Each global class is represented as a :ref:`Dictionary` that contains the following entries: @@ -11934,7 +11936,7 @@ Returns an :ref:`Array` of registered global classes. Each global c .. rst-class:: classref-method -:ref:`int` **get_order**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **get_order**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the order of a configuration value (influences when saved to the config file). @@ -11946,7 +11948,7 @@ Returns the order of a configuration value (influences when saved to the config .. rst-class:: classref-method -:ref:`Variant` **get_setting**\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| +:ref:`Variant` **get_setting**\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| :ref:`🔗` Returns the value of the setting identified by ``name``. If the setting doesn't exist and ``default_value`` is specified, the value of ``default_value`` is returned. Otherwise, ``null`` is returned. @@ -11977,7 +11979,7 @@ Returns the value of the setting identified by ``name``. If the setting doesn't .. rst-class:: classref-method -:ref:`Variant` **get_setting_with_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_setting_with_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Similar to :ref:`get_setting`, but applies feature tag overrides if any exists and is valid. @@ -12008,7 +12010,7 @@ Then the overridden setting will be returned instead if the project is running o .. rst-class:: classref-method -:ref:`String` **globalize_path**\ (\ path\: :ref:`String`\ ) |const| +:ref:`String` **globalize_path**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Returns the absolute, native OS path corresponding to the localized ``path`` (starting with ``res://`` or ``user://``). The returned path will vary depending on the operating system and user preferences. See :doc:`File paths in Godot projects <../tutorials/io/data_paths>` to see what those paths convert to. See also :ref:`localize_path`. @@ -12036,7 +12038,7 @@ Returns the absolute, native OS path corresponding to the localized ``path`` (st .. rst-class:: classref-method -:ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| +:ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if a configuration value is present. @@ -12048,7 +12050,7 @@ Returns ``true`` if a configuration value is present. .. rst-class:: classref-method -:ref:`bool` **load_resource_pack**\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) +:ref:`bool` **load_resource_pack**\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) :ref:`🔗` Loads the contents of the .pck or .zip file specified by ``pack`` into the resource filesystem (``res://``). Returns ``true`` on success. @@ -12064,7 +12066,7 @@ Loads the contents of the .pck or .zip file specified by ``pack`` into the resou .. rst-class:: classref-method -:ref:`String` **localize_path**\ (\ path\: :ref:`String`\ ) |const| +:ref:`String` **localize_path**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` Returns the localized path (starting with ``res://``) corresponding to the absolute, native OS ``path``. See also :ref:`globalize_path`. @@ -12076,7 +12078,7 @@ Returns the localized path (starting with ``res://``) corresponding to the absol .. rst-class:: classref-method -:ref:`Error` **save**\ (\ ) +:ref:`Error` **save**\ (\ ) :ref:`🔗` Saves the configuration to the ``project.godot`` file. @@ -12090,7 +12092,7 @@ Saves the configuration to the ``project.godot`` file. .. rst-class:: classref-method -:ref:`Error` **save_custom**\ (\ file\: :ref:`String`\ ) +:ref:`Error` **save_custom**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Saves the configuration to a custom file. The file extension must be ``.godot`` (to save in text-based :ref:`ConfigFile` format) or ``.binary`` (to save in binary format). You can also save ``override.cfg`` file, which is also text, but can be used in exported projects unlike other formats. @@ -12102,7 +12104,7 @@ Saves the configuration to a custom file. The file extension must be ``.godot`` .. rst-class:: classref-method -|void| **set_as_basic**\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) +|void| **set_as_basic**\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) :ref:`🔗` Defines if the specified setting is considered basic or advanced. Basic settings will always be shown in the project settings. Advanced settings will only be shown if the user enables the "Advanced Settings" option. @@ -12114,7 +12116,7 @@ Defines if the specified setting is considered basic or advanced. Basic settings .. rst-class:: classref-method -|void| **set_as_internal**\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) +|void| **set_as_internal**\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) :ref:`🔗` Defines if the specified setting is considered internal. An internal setting won't show up in the Project Settings dialog. This is mostly useful for addons that need to store their own internal settings without exposing them directly to the user. @@ -12126,7 +12128,7 @@ Defines if the specified setting is considered internal. An internal setting won .. rst-class:: classref-method -|void| **set_initial_value**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_initial_value**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the specified setting's initial value. This is the value the setting reverts to. @@ -12138,7 +12140,7 @@ Sets the specified setting's initial value. This is the value the setting revert .. rst-class:: classref-method -|void| **set_order**\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) +|void| **set_order**\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) :ref:`🔗` Sets the order of a configuration value (influences when saved to the config file). @@ -12150,7 +12152,7 @@ Sets the order of a configuration value (influences when saved to the config fil .. rst-class:: classref-method -|void| **set_restart_if_changed**\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) +|void| **set_restart_if_changed**\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) :ref:`🔗` Sets whether a setting requires restarting the editor to properly take effect. @@ -12164,7 +12166,7 @@ Sets whether a setting requires restarting the editor to properly take effect. .. rst-class:: classref-method -|void| **set_setting**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_setting**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the value of a setting. diff --git a/classes/class_propertytweener.rst b/classes/class_propertytweener.rst index 71530dc3fd3..966125b95f8 100644 --- a/classes/class_propertytweener.rst +++ b/classes/class_propertytweener.rst @@ -60,7 +60,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PropertyTweener` **as_relative**\ (\ ) +:ref:`PropertyTweener` **as_relative**\ (\ ) :ref:`🔗` When called, the final value will be used as a relative value instead. @@ -79,7 +79,7 @@ When called, the final value will be used as a relative value instead. .. rst-class:: classref-method -:ref:`PropertyTweener` **from**\ (\ value\: :ref:`Variant`\ ) +:ref:`PropertyTweener` **from**\ (\ value\: :ref:`Variant`\ ) :ref:`🔗` Sets a custom initial value to the **PropertyTweener**. @@ -98,7 +98,7 @@ Sets a custom initial value to the **PropertyTweener**. .. rst-class:: classref-method -:ref:`PropertyTweener` **from_current**\ (\ ) +:ref:`PropertyTweener` **from_current**\ (\ ) :ref:`🔗` Makes the **PropertyTweener** use the current property value (i.e. at the time of creating this **PropertyTweener**) as a starting point. This is equivalent of using :ref:`from` with the current value. These two calls will do the same: @@ -115,7 +115,7 @@ Makes the **PropertyTweener** use the current property value (i.e. at the time o .. rst-class:: classref-method -:ref:`PropertyTweener` **set_custom_interpolator**\ (\ interpolator_method\: :ref:`Callable`\ ) +:ref:`PropertyTweener` **set_custom_interpolator**\ (\ interpolator_method\: :ref:`Callable`\ ) :ref:`🔗` Allows interpolating the value with a custom easing function. The provided ``interpolator_method`` will be called with a value ranging from ``0.0`` to ``1.0`` and is expected to return a value within the same range (values outside the range can be used for overshoot). The return value of the method is then used for interpolation between initial and final value. Note that the parameter passed to the method is still subject to the tweener's own easing. @@ -141,7 +141,7 @@ Allows interpolating the value with a custom easing function. The provided ``int .. rst-class:: classref-method -:ref:`PropertyTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) +:ref:`PropertyTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) :ref:`🔗` Sets the time in seconds after which the **PropertyTweener** will start interpolating. By default there's no delay. @@ -153,7 +153,7 @@ Sets the time in seconds after which the **PropertyTweener** will start interpol .. rst-class:: classref-method -:ref:`PropertyTweener` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) +:ref:`PropertyTweener` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) :ref:`🔗` Sets the type of used easing from :ref:`EaseType`. If not set, the default easing is used from the :ref:`Tween` that contains this Tweener. @@ -165,7 +165,7 @@ Sets the type of used easing from :ref:`EaseType`. If not s .. rst-class:: classref-method -:ref:`PropertyTweener` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) +:ref:`PropertyTweener` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) :ref:`🔗` Sets the type of used transition from :ref:`TransitionType`. If not set, the default transition is used from the :ref:`Tween` that contains this Tweener. diff --git a/classes/class_quadoccluder3d.rst b/classes/class_quadoccluder3d.rst index c6ba2ed1ad0..d9dfed4fb9f 100644 --- a/classes/class_quadoccluder3d.rst +++ b/classes/class_quadoccluder3d.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **size** = ``Vector2(1, 1)`` +:ref:`Vector2` **size** = ``Vector2(1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 8315acfb6db..74064a5d598 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -183,7 +183,7 @@ Constants .. rst-class:: classref-constant -**IDENTITY** = ``Quaternion(0, 0, 0, 1)`` +**IDENTITY** = ``Quaternion(0, 0, 0, 1)`` :ref:`🔗` The identity quaternion, representing no rotation. This has the same rotation as :ref:`Basis.IDENTITY`. @@ -202,7 +202,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **w** = ``1.0`` +:ref:`float` **w** = ``1.0`` :ref:`🔗` W component of the quaternion. This is the "real" part. @@ -216,7 +216,7 @@ W component of the quaternion. This is the "real" part. .. rst-class:: classref-property -:ref:`float` **x** = ``0.0`` +:ref:`float` **x** = ``0.0`` :ref:`🔗` X component of the quaternion. This is the value along the "imaginary" ``i`` axis. @@ -230,7 +230,7 @@ X component of the quaternion. This is the value along the "imaginary" ``i`` axi .. rst-class:: classref-property -:ref:`float` **y** = ``0.0`` +:ref:`float` **y** = ``0.0`` :ref:`🔗` Y component of the quaternion. This is the value along the "imaginary" ``j`` axis. @@ -244,7 +244,7 @@ Y component of the quaternion. This is the value along the "imaginary" ``j`` axi .. rst-class:: classref-property -:ref:`float` **z** = ``0.0`` +:ref:`float` **z** = ``0.0`` :ref:`🔗` Z component of the quaternion. This is the value along the "imaginary" ``k`` axis. @@ -263,7 +263,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion**\ (\ ) +:ref:`Quaternion` **Quaternion**\ (\ ) :ref:`🔗` Constructs a **Quaternion** identical to the :ref:`IDENTITY`. @@ -334,7 +334,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **angle_to**\ (\ to\: :ref:`Quaternion`\ ) |const| +:ref:`float` **angle_to**\ (\ to\: :ref:`Quaternion`\ ) |const| :ref:`🔗` Returns the angle between this quaternion and ``to``. This is the magnitude of the angle you would need to rotate by to get from one to the other. @@ -348,7 +348,7 @@ Returns the angle between this quaternion and ``to``. This is the magnitude of t .. rst-class:: classref-method -:ref:`float` **dot**\ (\ with\: :ref:`Quaternion`\ ) |const| +:ref:`float` **dot**\ (\ with\: :ref:`Quaternion`\ ) |const| :ref:`🔗` Returns the dot product between this quaternion and ``with``. @@ -362,7 +362,7 @@ This is equivalent to ``(quat.x * with.x) + (quat.y * with.y) + (quat.z * with.z .. rst-class:: classref-method -:ref:`Quaternion` **exp**\ (\ ) |const| +:ref:`Quaternion` **exp**\ (\ ) |const| :ref:`🔗` Returns the exponential of this quaternion. The rotation axis of the result is the normalized rotation axis of this quaternion, the angle of the result is the length of the vector part of this quaternion. @@ -374,7 +374,7 @@ Returns the exponential of this quaternion. The rotation axis of the result is t .. rst-class:: classref-method -:ref:`Quaternion` **from_euler**\ (\ euler\: :ref:`Vector3`\ ) |static| +:ref:`Quaternion` **from_euler**\ (\ euler\: :ref:`Vector3`\ ) |static| :ref:`🔗` Constructs a new **Quaternion** from the given :ref:`Vector3` of `Euler angles `__, in radians. This method always uses the YXZ convention (:ref:`@GlobalScope.EULER_ORDER_YXZ`). @@ -386,7 +386,7 @@ Constructs a new **Quaternion** from the given :ref:`Vector3` of .. rst-class:: classref-method -:ref:`float` **get_angle**\ (\ ) |const| +:ref:`float` **get_angle**\ (\ ) |const| :ref:`🔗` Returns the angle of the rotation represented by this quaternion. @@ -400,7 +400,7 @@ Returns the angle of the rotation represented by this quaternion. .. rst-class:: classref-method -:ref:`Vector3` **get_axis**\ (\ ) |const| +:ref:`Vector3` **get_axis**\ (\ ) |const| :ref:`🔗` Returns the rotation axis of the rotation represented by this quaternion. @@ -412,7 +412,7 @@ Returns the rotation axis of the rotation represented by this quaternion. .. rst-class:: classref-method -:ref:`Vector3` **get_euler**\ (\ order\: :ref:`int` = 2\ ) |const| +:ref:`Vector3` **get_euler**\ (\ order\: :ref:`int` = 2\ ) |const| :ref:`🔗` Returns this quaternion's rotation as a :ref:`Vector3` of `Euler angles `__, in radians. @@ -426,7 +426,7 @@ The order of each consecutive rotation can be changed with ``order`` (see :ref:` .. rst-class:: classref-method -:ref:`Quaternion` **inverse**\ (\ ) |const| +:ref:`Quaternion` **inverse**\ (\ ) |const| :ref:`🔗` Returns the inverse version of this quaternion, inverting the sign of every component except :ref:`w`. @@ -438,7 +438,7 @@ Returns the inverse version of this quaternion, inverting the sign of every comp .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Quaternion`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Quaternion`\ ) |const| :ref:`🔗` Returns ``true`` if this quaternion and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -450,7 +450,7 @@ Returns ``true`` if this quaternion and ``to`` are approximately equal, by runni .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this quaternion is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -462,7 +462,7 @@ Returns ``true`` if this quaternion is finite, by calling :ref:`@GlobalScope.is_ .. rst-class:: classref-method -:ref:`bool` **is_normalized**\ (\ ) |const| +:ref:`bool` **is_normalized**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this quaternion is normalized. See also :ref:`normalized`. @@ -474,7 +474,7 @@ Returns ``true`` if this quaternion is normalized. See also :ref:`normalized` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns this quaternion's length, also called magnitude. @@ -486,7 +486,7 @@ Returns this quaternion's length, also called magnitude. .. rst-class:: classref-method -:ref:`float` **length_squared**\ (\ ) |const| +:ref:`float` **length_squared**\ (\ ) |const| :ref:`🔗` Returns this quaternion's length, squared. @@ -500,7 +500,7 @@ Returns this quaternion's length, squared. .. rst-class:: classref-method -:ref:`Quaternion` **log**\ (\ ) |const| +:ref:`Quaternion` **log**\ (\ ) |const| :ref:`🔗` Returns the logarithm of this quaternion. Multiplies this quaternion's rotation axis by its rotation angle, and stores the result in the returned quaternion's vector part (:ref:`x`, :ref:`y`, and :ref:`z`). The returned quaternion's real part (:ref:`w`) is always ``0.0``. @@ -512,7 +512,7 @@ Returns the logarithm of this quaternion. Multiplies this quaternion's rotation .. rst-class:: classref-method -:ref:`Quaternion` **normalized**\ (\ ) |const| +:ref:`Quaternion` **normalized**\ (\ ) |const| :ref:`🔗` Returns a copy of this quaternion, normalized so that its length is ``1.0``. See also :ref:`is_normalized`. @@ -524,7 +524,7 @@ Returns a copy of this quaternion, normalized so that its length is ``1.0``. See .. rst-class:: classref-method -:ref:`Quaternion` **slerp**\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| +:ref:`Quaternion` **slerp**\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a spherical-linear interpolation with the ``to`` quaternion, given a ``weight`` and returns the result. Both this quaternion and ``to`` must be normalized. @@ -536,7 +536,7 @@ Performs a spherical-linear interpolation with the ``to`` quaternion, given a `` .. rst-class:: classref-method -:ref:`Quaternion` **slerpni**\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| +:ref:`Quaternion` **slerpni**\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a spherical-linear interpolation with the ``to`` quaternion, given a ``weight`` and returns the result. Unlike :ref:`slerp`, this method does not check if the rotation path is smaller than 90 degrees. Both this quaternion and ``to`` must be normalized. @@ -548,7 +548,7 @@ Performs a spherical-linear interpolation with the ``to`` quaternion, given a `` .. rst-class:: classref-method -:ref:`Quaternion` **spherical_cubic_interpolate**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| +:ref:`Quaternion` **spherical_cubic_interpolate**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a spherical cubic interpolation between quaternions ``pre_a``, this vector, ``b``, and ``post_b``, by the given amount ``weight``. @@ -560,7 +560,7 @@ Performs a spherical cubic interpolation between quaternions ``pre_a``, this vec .. rst-class:: classref-method -:ref:`Quaternion` **spherical_cubic_interpolate_in_time**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| +:ref:`Quaternion` **spherical_cubic_interpolate_in_time**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` Performs a spherical cubic interpolation between quaternions ``pre_a``, this vector, ``b``, and ``post_b``, by the given amount ``weight``. @@ -579,7 +579,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Quaternion`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Returns ``true`` if the components of both quaternions are not exactly equal. @@ -593,7 +593,7 @@ Returns ``true`` if the components of both quaternions are not exactly equal. .. rst-class:: classref-operator -:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Composes (multiplies) two quaternions. This rotates the ``right`` quaternion (the child) by this quaternion (the parent). @@ -605,7 +605,7 @@ Composes (multiplies) two quaternions. This rotates the ``right`` quaternion (th .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Rotates (multiplies) the ``right`` vector by this quaternion, returning a :ref:`Vector3`. @@ -617,7 +617,7 @@ Rotates (multiplies) the ``right`` vector by this quaternion, returning a :ref:` .. rst-class:: classref-operator -:ref:`Quaternion` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Quaternion** by the right :ref:`float` value. @@ -631,7 +631,7 @@ This operation is not meaningful on its own, but it can be used as a part of a l .. rst-class:: classref-operator -:ref:`Quaternion` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Quaternion** by the right :ref:`int` value. @@ -645,7 +645,7 @@ This operation is not meaningful on its own, but it can be used as a part of a l .. rst-class:: classref-operator -:ref:`Quaternion` **operator +**\ (\ right\: :ref:`Quaternion`\ ) +:ref:`Quaternion` **operator +**\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Adds each component of the left **Quaternion** to the right **Quaternion**. @@ -659,7 +659,7 @@ This operation is not meaningful on its own, but it can be used as a part of a l .. rst-class:: classref-operator -:ref:`Quaternion` **operator -**\ (\ right\: :ref:`Quaternion`\ ) +:ref:`Quaternion` **operator -**\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Subtracts each component of the left **Quaternion** by the right **Quaternion**. @@ -673,7 +673,7 @@ This operation is not meaningful on its own, but it can be used as a part of a l .. rst-class:: classref-operator -:ref:`Quaternion` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Quaternion` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Quaternion** by the right :ref:`float` value. @@ -687,7 +687,7 @@ This operation is not meaningful on its own, but it can be used as a part of a l .. rst-class:: classref-operator -:ref:`Quaternion` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Quaternion` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Quaternion** by the right :ref:`int` value. @@ -701,7 +701,7 @@ This operation is not meaningful on its own, but it can be used as a part of a l .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Quaternion`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Returns ``true`` if the components of both quaternions are exactly equal. @@ -715,7 +715,7 @@ Returns ``true`` if the components of both quaternions are exactly equal. .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Accesses each component of this quaternion by their index. @@ -729,7 +729,7 @@ Index ``0`` is the same as :ref:`x`, index ``1`` is .. rst-class:: classref-operator -:ref:`Quaternion` **operator unary+**\ (\ ) +:ref:`Quaternion` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -741,7 +741,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Quaternion` **operator unary-**\ (\ ) +:ref:`Quaternion` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Quaternion**. This is the same as multiplying all components by ``-1``. This operation results in a quaternion that represents the same rotation. diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index c6b0c8957d4..00a050eddfa 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -89,7 +89,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **seed** = ``0`` +:ref:`int` **seed** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -118,7 +118,7 @@ Initializes the random number generator state based on the given seed value. A g .. rst-class:: classref-property -:ref:`int` **state** = ``0`` +:ref:`int` **state** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -153,7 +153,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **rand_weighted**\ (\ weights\: :ref:`PackedFloat32Array`\ ) +:ref:`int` **rand_weighted**\ (\ weights\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Returns a random index with non-uniform weights. Prints an error and returns ``-1`` if the array is empty. @@ -181,7 +181,7 @@ Returns a random index with non-uniform weights. Prints an error and returns ``- .. rst-class:: classref-method -:ref:`float` **randf**\ (\ ) +:ref:`float` **randf**\ (\ ) :ref:`🔗` Returns a pseudo-random float between ``0.0`` and ``1.0`` (inclusive). @@ -193,7 +193,7 @@ Returns a pseudo-random float between ``0.0`` and ``1.0`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randf_range**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) +:ref:`float` **randf_range**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) :ref:`🔗` Returns a pseudo-random float between ``from`` and ``to`` (inclusive). @@ -205,7 +205,7 @@ Returns a pseudo-random float between ``from`` and ``to`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randfn**\ (\ mean\: :ref:`float` = 0.0, deviation\: :ref:`float` = 1.0\ ) +:ref:`float` **randfn**\ (\ mean\: :ref:`float` = 0.0, deviation\: :ref:`float` = 1.0\ ) :ref:`🔗` Returns a `normally-distributed `__, pseudo-random floating-point number from the specified ``mean`` and a standard ``deviation``. This is also known as a Gaussian distribution. @@ -219,7 +219,7 @@ Returns a `normally-distributed ` **randi**\ (\ ) +:ref:`int` **randi**\ (\ ) :ref:`🔗` Returns a pseudo-random 32-bit unsigned integer between ``0`` and ``4294967295`` (inclusive). @@ -231,7 +231,7 @@ Returns a pseudo-random 32-bit unsigned integer between ``0`` and ``4294967295`` .. rst-class:: classref-method -:ref:`int` **randi_range**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) +:ref:`int` **randi_range**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) :ref:`🔗` Returns a pseudo-random 32-bit signed integer between ``from`` and ``to`` (inclusive). @@ -243,7 +243,7 @@ Returns a pseudo-random 32-bit signed integer between ``from`` and ``to`` (inclu .. rst-class:: classref-method -|void| **randomize**\ (\ ) +|void| **randomize**\ (\ ) :ref:`🔗` Sets up a time-based seed for this **RandomNumberGenerator** instance. Unlike the :ref:`@GlobalScope` random number generation functions, different **RandomNumberGenerator** instances can use different seeds. diff --git a/classes/class_range.rst b/classes/class_range.rst index e06c1badf74..bd6d50ae582 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -86,7 +86,7 @@ Signals .. rst-class:: classref-signal -**changed**\ (\ ) +**changed**\ (\ ) :ref:`🔗` Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. @@ -98,7 +98,7 @@ Emitted when :ref:`min_value`, :ref:`max_value`\ ) +**value_changed**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Emitted when :ref:`value` changes. When used on a :ref:`Slider`, this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to :ref:`value_changed`, consider using a *debouncing* :ref:`Timer` to call the function less often. @@ -117,7 +117,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_greater** = ``false`` +:ref:`bool` **allow_greater** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,7 +134,7 @@ If ``true``, :ref:`value` may be greater than :ref:` .. rst-class:: classref-property -:ref:`bool` **allow_lesser** = ``false`` +:ref:`bool` **allow_lesser** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ If ``true``, :ref:`value` may be less than :ref:`min .. rst-class:: classref-property -:ref:`bool` **exp_edit** = ``false`` +:ref:`bool` **exp_edit** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ If ``true``, and :ref:`min_value` is greater tha .. rst-class:: classref-property -:ref:`float` **max_value** = ``100.0`` +:ref:`float` **max_value** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ Maximum value. Range is clamped if :ref:`value` is g .. rst-class:: classref-property -:ref:`float` **min_value** = ``0.0`` +:ref:`float` **min_value** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ Minimum value. Range is clamped if :ref:`value` is l .. rst-class:: classref-property -:ref:`float` **page** = ``0.0`` +:ref:`float` **page** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length .. rst-class:: classref-property -:ref:`float` **ratio** +:ref:`float` **ratio** :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ The value mapped between 0 and 1. .. rst-class:: classref-property -:ref:`bool` **rounded** = ``false`` +:ref:`bool` **rounded** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -253,7 +253,7 @@ If ``true``, :ref:`value` will always be rounded to .. rst-class:: classref-property -:ref:`float` **step** = ``0.01`` +:ref:`float` **step** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -270,7 +270,7 @@ If greater than 0, :ref:`value` will always be round .. rst-class:: classref-property -:ref:`float` **value** = ``0.0`` +:ref:`float` **value** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_value_changed**\ (\ new_value\: :ref:`float`\ ) |virtual| +|void| **_value_changed**\ (\ new_value\: :ref:`float`\ ) |virtual| :ref:`🔗` Called when the **Range**'s value is changed (following the same conditions as :ref:`value_changed`). @@ -304,7 +304,7 @@ Called when the **Range**'s value is changed (following the same conditions as : .. rst-class:: classref-method -|void| **set_value_no_signal**\ (\ value\: :ref:`float`\ ) +|void| **set_value_no_signal**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Sets the **Range**'s current value to the specified ``value``, without emitting the :ref:`value_changed` signal. @@ -316,7 +316,7 @@ Sets the **Range**'s current value to the specified ``value``, without emitting .. rst-class:: classref-method -|void| **share**\ (\ with\: :ref:`Node`\ ) +|void| **share**\ (\ with\: :ref:`Node`\ ) :ref:`🔗` Binds two **Range**\ s together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. @@ -328,7 +328,7 @@ Binds two **Range**\ s together along with any ranges previously grouped with ei .. rst-class:: classref-method -|void| **unshare**\ (\ ) +|void| **unshare**\ (\ ) :ref:`🔗` Stops the **Range** from sharing its member variables with any other. diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 9d7b4f9eb49..6d770a5bfb1 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -109,7 +109,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -126,7 +126,7 @@ If ``true``, collisions with :ref:`Area2D`\ s will be reported. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -143,7 +143,7 @@ If ``true``, collisions with :ref:`PhysicsBody2D`\ s will b .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -160,7 +160,7 @@ The ray's collision mask. Only objects in at least one collision layer enabled i .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -177,7 +177,7 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property -:ref:`bool` **exclude_parent** = ``true`` +:ref:`bool` **exclude_parent** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -194,7 +194,7 @@ If ``true``, the parent node will be excluded from collision detection. .. rst-class:: classref-property -:ref:`bool` **hit_from_inside** = ``false`` +:ref:`bool` **hit_from_inside** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -211,7 +211,7 @@ If ``true``, the ray will detect a hit when starting inside shapes. In this case .. rst-class:: classref-property -:ref:`Vector2` **target_position** = ``Vector2(0, 50)`` +:ref:`Vector2` **target_position** = ``Vector2(0, 50)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -233,7 +233,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) +|void| **add_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) :ref:`🔗` Adds a collision exception so the ray does not report collisions with the specified :ref:`CollisionObject2D` node. @@ -245,7 +245,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. @@ -257,7 +257,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -|void| **clear_exceptions**\ (\ ) +|void| **clear_exceptions**\ (\ ) :ref:`🔗` Removes all collision exceptions for this ray. @@ -269,7 +269,7 @@ Removes all collision exceptions for this ray. .. rst-class:: classref-method -|void| **force_raycast_update**\ (\ ) +|void| **force_raycast_update**\ (\ ) :ref:`🔗` Updates the collision information for the ray immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the ray or its parent has changed state. @@ -283,7 +283,7 @@ Updates the collision information for the ray immediately, without waiting for t .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ ) |const| +:ref:`Object` **get_collider**\ (\ ) |const| :ref:`🔗` Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -295,7 +295,7 @@ Returns the first object that the ray intersects, or ``null`` if no object is in .. rst-class:: classref-method -:ref:`RID` **get_collider_rid**\ (\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the first object that the ray intersects, or an empty :ref:`RID` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -307,7 +307,7 @@ Returns the :ref:`RID` of the first object that the ray intersects, o .. rst-class:: classref-method -:ref:`int` **get_collider_shape**\ (\ ) |const| +:ref:`int` **get_collider_shape**\ (\ ) |const| :ref:`🔗` Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -340,7 +340,7 @@ To get the intersected shape node, for a :ref:`CollisionObject2D` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -352,7 +352,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal**\ (\ ) |const| +:ref:`Vector2` **get_collision_normal**\ (\ ) |const| :ref:`🔗` 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``. @@ -366,7 +366,7 @@ Returns the normal of the intersecting object's shape at the collision point, or .. rst-class:: classref-method -:ref:`Vector2` **get_collision_point**\ (\ ) |const| +:ref:`Vector2` **get_collision_point**\ (\ ) |const| :ref:`🔗` Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. @@ -380,7 +380,7 @@ Returns the collision point at which the ray intersects the closest object, in t .. rst-class:: classref-method -:ref:`bool` **is_colliding**\ (\ ) |const| +:ref:`bool` **is_colliding**\ (\ ) |const| :ref:`🔗` Returns whether any object is intersecting with the ray's vector (considering the vector length). @@ -392,7 +392,7 @@ Returns whether any object is intersecting with the ray's vector (considering th .. rst-class:: classref-method -|void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) :ref:`🔗` Removes a collision exception so the ray does report collisions with the specified :ref:`CollisionObject2D` node. @@ -404,7 +404,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. @@ -416,7 +416,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_raycast3d.rst b/classes/class_raycast3d.rst index 6e2f089a5ee..4ce605303f0 100644 --- a/classes/class_raycast3d.rst +++ b/classes/class_raycast3d.rst @@ -119,7 +119,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -136,7 +136,7 @@ If ``true``, collisions with :ref:`Area3D`\ s will be reported. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -153,7 +153,7 @@ If ``true``, collisions with :ref:`PhysicsBody3D`\ s will b .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -170,7 +170,7 @@ The ray's collision mask. Only objects in at least one collision layer enabled i .. rst-class:: classref-property -:ref:`Color` **debug_shape_custom_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **debug_shape_custom_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ If set to ``Color(0.0, 0.0, 0.0)`` (by default), the color set in :ref:`ProjectS .. rst-class:: classref-property -:ref:`int` **debug_shape_thickness** = ``2`` +:ref:`int` **debug_shape_thickness** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ If set to ``1``, a line is used as the debug shape. Otherwise, a truncated pyram .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property -:ref:`bool` **exclude_parent** = ``true`` +:ref:`bool` **exclude_parent** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -240,7 +240,7 @@ If ``true``, collisions will be ignored for this RayCast3D's immediate parent. .. rst-class:: classref-property -:ref:`bool` **hit_back_faces** = ``true`` +:ref:`bool` **hit_back_faces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -257,7 +257,7 @@ If ``true``, the ray will hit back faces with concave polygon shapes with back f .. rst-class:: classref-property -:ref:`bool` **hit_from_inside** = ``false`` +:ref:`bool` **hit_from_inside** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -274,7 +274,7 @@ If ``true``, the ray will detect a hit when starting inside shapes. In this case .. rst-class:: classref-property -:ref:`Vector3` **target_position** = ``Vector3(0, -1, 0)`` +:ref:`Vector3` **target_position** = ``Vector3(0, -1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -296,7 +296,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) +|void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) :ref:`🔗` Adds a collision exception so the ray does not report collisions with the specified :ref:`CollisionObject3D` node. @@ -308,7 +308,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. @@ -320,7 +320,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -|void| **clear_exceptions**\ (\ ) +|void| **clear_exceptions**\ (\ ) :ref:`🔗` Removes all collision exceptions for this ray. @@ -332,7 +332,7 @@ Removes all collision exceptions for this ray. .. rst-class:: classref-method -|void| **force_raycast_update**\ (\ ) +|void| **force_raycast_update**\ (\ ) :ref:`🔗` Updates the collision information for the ray immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the ray or its parent has changed state. @@ -346,7 +346,7 @@ Updates the collision information for the ray immediately, without waiting for t .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ ) |const| +:ref:`Object` **get_collider**\ (\ ) |const| :ref:`🔗` Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -358,7 +358,7 @@ Returns the first object that the ray intersects, or ``null`` if no object is in .. rst-class:: classref-method -:ref:`RID` **get_collider_rid**\ (\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the first object that the ray intersects, or an empty :ref:`RID` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -370,7 +370,7 @@ Returns the :ref:`RID` of the first object that the ray intersects, o .. rst-class:: classref-method -:ref:`int` **get_collider_shape**\ (\ ) |const| +:ref:`int` **get_collider_shape**\ (\ ) |const| :ref:`🔗` Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -403,7 +403,7 @@ To get the intersected shape node, for a :ref:`CollisionObject3D` **get_collision_face_index**\ (\ ) |const| +:ref:`int` **get_collision_face_index**\ (\ ) |const| :ref:`🔗` Returns the collision object's face index at the collision point, or ``-1`` if the shape intersecting the ray is not a :ref:`ConcavePolygonShape3D`. @@ -415,7 +415,7 @@ Returns the collision object's face index at the collision point, or ``-1`` if t .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -427,7 +427,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal**\ (\ ) |const| +:ref:`Vector3` **get_collision_normal**\ (\ ) |const| :ref:`🔗` 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``. @@ -441,7 +441,7 @@ Returns the normal of the intersecting object's shape at the collision point, or .. rst-class:: classref-method -:ref:`Vector3` **get_collision_point**\ (\ ) |const| +:ref:`Vector3` **get_collision_point**\ (\ ) |const| :ref:`🔗` Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. @@ -455,7 +455,7 @@ Returns the collision point at which the ray intersects the closest object, in t .. rst-class:: classref-method -:ref:`bool` **is_colliding**\ (\ ) |const| +:ref:`bool` **is_colliding**\ (\ ) |const| :ref:`🔗` Returns whether any object is intersecting with the ray's vector (considering the vector length). @@ -467,7 +467,7 @@ Returns whether any object is intersecting with the ray's vector (considering th .. rst-class:: classref-method -|void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) :ref:`🔗` Removes a collision exception so the ray does report collisions with the specified :ref:`CollisionObject3D` node. @@ -479,7 +479,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. @@ -491,7 +491,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_rdattachmentformat.rst b/classes/class_rdattachmentformat.rst index c0cdc528458..60636ddeb11 100644 --- a/classes/class_rdattachmentformat.rst +++ b/classes/class_rdattachmentformat.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`DataFormat` **format** = ``36`` +:ref:`DataFormat` **format** = ``36`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ The attachment's data format. .. rst-class:: classref-property -:ref:`TextureSamples` **samples** = ``0`` +:ref:`TextureSamples` **samples** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -84,7 +84,7 @@ The number of samples used when sampling the attachment. .. rst-class:: classref-property -:ref:`int` **usage_flags** = ``0`` +:ref:`int` **usage_flags** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdframebufferpass.rst b/classes/class_rdframebufferpass.rst index c3f25b56bfc..44b9d828ae6 100644 --- a/classes/class_rdframebufferpass.rst +++ b/classes/class_rdframebufferpass.rst @@ -58,7 +58,7 @@ Constants .. rst-class:: classref-constant -**ATTACHMENT_UNUSED** = ``-1`` +**ATTACHMENT_UNUSED** = ``-1`` :ref:`🔗` Attachment is unused. @@ -75,7 +75,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **color_attachments** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **color_attachments** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ Color attachments in order starting from 0. If this attachment is not used by th .. rst-class:: classref-property -:ref:`int` **depth_attachment** = ``-1`` +:ref:`int` **depth_attachment** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is require .. rst-class:: classref-property -:ref:`PackedInt32Array` **input_attachments** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **input_attachments** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Used for multipass framebuffers (more than one render pass). Converts an attachm .. rst-class:: classref-property -:ref:`PackedInt32Array` **preserve_attachments** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **preserve_attachments** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ Attachments to preserve in this pass (otherwise they are erased). .. rst-class:: classref-property -:ref:`PackedInt32Array` **resolve_attachments** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **resolve_attachments** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdpipelinecolorblendstate.rst b/classes/class_rdpipelinecolorblendstate.rst index 5892e7cfc81..681b7128dff 100644 --- a/classes/class_rdpipelinecolorblendstate.rst +++ b/classes/class_rdpipelinecolorblendstate.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array`\[:ref:`RDPipelineColorBlendStateAttachment`\] **attachments** = ``[]`` +:ref:`Array`\[:ref:`RDPipelineColorBlendStateAttachment`\] **attachments** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ The attachments that are blended together. .. rst-class:: classref-property -:ref:`Color` **blend_constant** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **blend_constant** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ The constant color to blend with. See also :ref:`RenderingDevice.draw_list_set_b .. rst-class:: classref-property -:ref:`bool` **enable_logic_op** = ``false`` +:ref:`bool` **enable_logic_op** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ If ``true``, performs the logic operation defined in :ref:`logic_op` **logic_op** = ``0`` +:ref:`LogicOperation` **logic_op** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdpipelinecolorblendstateattachment.rst b/classes/class_rdpipelinecolorblendstateattachment.rst index dd7f0829c20..43bde5d4272 100644 --- a/classes/class_rdpipelinecolorblendstateattachment.rst +++ b/classes/class_rdpipelinecolorblendstateattachment.rst @@ -145,7 +145,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BlendOperation` **alpha_blend_op** = ``0`` +:ref:`BlendOperation` **alpha_blend_op** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -162,7 +162,7 @@ The blend mode to use for the alpha channel. .. rst-class:: classref-property -:ref:`BlendOperation` **color_blend_op** = ``0`` +:ref:`BlendOperation` **color_blend_op** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ The blend mode to use for the red/green/blue color channels. .. rst-class:: classref-property -:ref:`BlendFactor` **dst_alpha_blend_factor** = ``0`` +:ref:`BlendFactor` **dst_alpha_blend_factor** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ Controls how the blend factor for the alpha channel is determined based on the d .. rst-class:: classref-property -:ref:`BlendFactor` **dst_color_blend_factor** = ``0`` +:ref:`BlendFactor` **dst_color_blend_factor** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ Controls how the blend factor for the color channels is determined based on the .. rst-class:: classref-property -:ref:`bool` **enable_blend** = ``false`` +:ref:`bool` **enable_blend** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ If ``true``, performs blending between the source and destination according to t .. rst-class:: classref-property -:ref:`BlendFactor` **src_alpha_blend_factor** = ``0`` +:ref:`BlendFactor` **src_alpha_blend_factor** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -247,7 +247,7 @@ Controls how the blend factor for the alpha channel is determined based on the s .. rst-class:: classref-property -:ref:`BlendFactor` **src_color_blend_factor** = ``0`` +:ref:`BlendFactor` **src_color_blend_factor** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -264,7 +264,7 @@ Controls how the blend factor for the color channels is determined based on the .. rst-class:: classref-property -:ref:`bool` **write_a** = ``true`` +:ref:`bool` **write_a** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -281,7 +281,7 @@ If ``true``, writes the new alpha channel to the final result. .. rst-class:: classref-property -:ref:`bool` **write_b** = ``true`` +:ref:`bool` **write_b** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +298,7 @@ If ``true``, writes the new blue color channel to the final result. .. rst-class:: classref-property -:ref:`bool` **write_g** = ``true`` +:ref:`bool` **write_g** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -315,7 +315,7 @@ If ``true``, writes the new green color channel to the final result. .. rst-class:: classref-property -:ref:`bool` **write_r** = ``true`` +:ref:`bool` **write_r** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -337,7 +337,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_as_mix**\ (\ ) +|void| **set_as_mix**\ (\ ) :ref:`🔗` Convenience method to perform standard mix blending with straight (non-premultiplied) alpha. This sets :ref:`enable_blend` to ``true``, :ref:`src_color_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_SRC_ALPHA`, :ref:`dst_color_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`, :ref:`src_alpha_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_SRC_ALPHA` and :ref:`dst_alpha_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`. diff --git a/classes/class_rdpipelinedepthstencilstate.rst b/classes/class_rdpipelinedepthstencilstate.rst index 912cf1e5cda..cdbac617152 100644 --- a/classes/class_rdpipelinedepthstencilstate.rst +++ b/classes/class_rdpipelinedepthstencilstate.rst @@ -86,7 +86,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CompareOperator` **back_op_compare** = ``7`` +:ref:`CompareOperator` **back_op_compare** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ The method used for comparing the previous back stencil value and :ref:`back_op_ .. rst-class:: classref-property -:ref:`int` **back_op_compare_mask** = ``0`` +:ref:`int` **back_op_compare_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ Selects which bits from the back stencil value will be compared. .. rst-class:: classref-property -:ref:`StencilOperation` **back_op_depth_fail** = ``1`` +:ref:`StencilOperation` **back_op_depth_fail** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ The operation to perform on the stencil buffer for back pixels that pass the ste .. rst-class:: classref-property -:ref:`StencilOperation` **back_op_fail** = ``1`` +:ref:`StencilOperation` **back_op_fail** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ The operation to perform on the stencil buffer for back pixels that fail the ste .. rst-class:: classref-property -:ref:`StencilOperation` **back_op_pass** = ``1`` +:ref:`StencilOperation` **back_op_pass** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ The operation to perform on the stencil buffer for back pixels that pass the ste .. rst-class:: classref-property -:ref:`int` **back_op_reference** = ``0`` +:ref:`int` **back_op_reference** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ The value the previous back stencil value will be compared to. .. rst-class:: classref-property -:ref:`int` **back_op_write_mask** = ``0`` +:ref:`int` **back_op_write_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ Selects which bits from the back stencil value will be changed. .. rst-class:: classref-property -:ref:`CompareOperator` **depth_compare_operator** = ``7`` +:ref:`CompareOperator` **depth_compare_operator** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ The method used for comparing the previous and current depth values. .. rst-class:: classref-property -:ref:`float` **depth_range_max** = ``0.0`` +:ref:`float` **depth_range_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ The maximum depth that returns true for :ref:`enable_depth_range` **depth_range_min** = ``0.0`` +:ref:`float` **depth_range_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -256,7 +256,7 @@ The minimum depth that returns true for :ref:`enable_depth_range` **enable_depth_range** = ``false`` +:ref:`bool` **enable_depth_range** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -273,7 +273,7 @@ If ``true``, each depth value will be tested to see if it is between :ref:`depth .. rst-class:: classref-property -:ref:`bool` **enable_depth_test** = ``false`` +:ref:`bool` **enable_depth_test** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl .. rst-class:: classref-property -:ref:`bool` **enable_depth_write** = ``false`` +:ref:`bool` **enable_depth_write** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -307,7 +307,7 @@ If ``true``, writes to the depth buffer whenever the depth test returns true. On .. rst-class:: classref-property -:ref:`bool` **enable_stencil** = ``false`` +:ref:`bool` **enable_stencil** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -324,7 +324,7 @@ If ``true``, enables stencil testing. There are separate stencil buffers for fro .. rst-class:: classref-property -:ref:`CompareOperator` **front_op_compare** = ``7`` +:ref:`CompareOperator` **front_op_compare** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -341,7 +341,7 @@ The method used for comparing the previous front stencil value and :ref:`front_o .. rst-class:: classref-property -:ref:`int` **front_op_compare_mask** = ``0`` +:ref:`int` **front_op_compare_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -358,7 +358,7 @@ Selects which bits from the front stencil value will be compared. .. rst-class:: classref-property -:ref:`StencilOperation` **front_op_depth_fail** = ``1`` +:ref:`StencilOperation` **front_op_depth_fail** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ The operation to perform on the stencil buffer for front pixels that pass the st .. rst-class:: classref-property -:ref:`StencilOperation` **front_op_fail** = ``1`` +:ref:`StencilOperation` **front_op_fail** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ The operation to perform on the stencil buffer for front pixels that fail the st .. rst-class:: classref-property -:ref:`StencilOperation` **front_op_pass** = ``1`` +:ref:`StencilOperation` **front_op_pass** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -409,7 +409,7 @@ The operation to perform on the stencil buffer for front pixels that pass the st .. rst-class:: classref-property -:ref:`int` **front_op_reference** = ``0`` +:ref:`int` **front_op_reference** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -426,7 +426,7 @@ The value the previous front stencil value will be compared to. .. rst-class:: classref-property -:ref:`int` **front_op_write_mask** = ``0`` +:ref:`int` **front_op_write_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdpipelinemultisamplestate.rst b/classes/class_rdpipelinemultisamplestate.rst index 26ad77d7091..6dc1add8512 100644 --- a/classes/class_rdpipelinemultisamplestate.rst +++ b/classes/class_rdpipelinemultisamplestate.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **enable_alpha_to_coverage** = ``false`` +:ref:`bool` **enable_alpha_to_coverage** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ If ``true``, alpha to coverage is enabled. This generates a temporary coverage v .. rst-class:: classref-property -:ref:`bool` **enable_alpha_to_one** = ``false`` +:ref:`bool` **enable_alpha_to_one** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ If ``true``, alpha is forced to either ``0.0`` or ``1.0``. This allows hardening .. rst-class:: classref-property -:ref:`bool` **enable_sample_shading** = ``false`` +:ref:`bool` **enable_sample_shading** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ If ``true``, enables per-sample shading which replaces MSAA by SSAA. This provid .. rst-class:: classref-property -:ref:`float` **min_sample_shading** = ``0.0`` +:ref:`float` **min_sample_shading** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ The multiplier of :ref:`sample_count` **sample_count** = ``0`` +:ref:`TextureSamples` **sample_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ The number of MSAA samples (or SSAA samples if :ref:`enable_sample_shading`\[:ref:`int`\] **sample_masks** = ``[]`` +:ref:`Array`\[:ref:`int`\] **sample_masks** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdpipelinerasterizationstate.rst b/classes/class_rdpipelinerasterizationstate.rst index 28ace994469..415ab1e7d7c 100644 --- a/classes/class_rdpipelinerasterizationstate.rst +++ b/classes/class_rdpipelinerasterizationstate.rst @@ -66,7 +66,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PolygonCullMode` **cull_mode** = ``0`` +:ref:`PolygonCullMode` **cull_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -83,7 +83,7 @@ The cull mode to use when drawing polygons, which determines whether front faces .. rst-class:: classref-property -:ref:`float` **depth_bias_clamp** = ``0.0`` +:ref:`float` **depth_bias_clamp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -100,7 +100,7 @@ A limit for how much each depth value can be offset. If negative, it serves as a .. rst-class:: classref-property -:ref:`float` **depth_bias_constant_factor** = ``0.0`` +:ref:`float` **depth_bias_constant_factor** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -117,7 +117,7 @@ A constant offset added to each depth value. Applied after :ref:`depth_bias_slop .. rst-class:: classref-property -:ref:`bool` **depth_bias_enabled** = ``false`` +:ref:`bool` **depth_bias_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,7 +134,7 @@ If ``true``, each generated depth value will by offset by some amount. The speci .. rst-class:: classref-property -:ref:`float` **depth_bias_slope_factor** = ``0.0`` +:ref:`float` **depth_bias_slope_factor** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ A constant scale applied to the slope of each polygons' depth. Applied before :r .. rst-class:: classref-property -:ref:`bool` **discard_primitives** = ``false`` +:ref:`bool` **discard_primitives** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ If ``true``, primitives are discarded immediately before the rasterization stage .. rst-class:: classref-property -:ref:`bool` **enable_depth_clamp** = ``false`` +:ref:`bool` **enable_depth_clamp** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ If ``true``, clamps depth values according to the minimum and maximum depth of t .. rst-class:: classref-property -:ref:`PolygonFrontFace` **front_face** = ``0`` +:ref:`PolygonFrontFace` **front_face** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ The winding order to use to determine which face of a triangle is considered its .. rst-class:: classref-property -:ref:`float` **line_width** = ``1.0`` +:ref:`float` **line_width** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -219,7 +219,7 @@ The line width to use when drawing lines (in pixels). Thick lines may not be sup .. rst-class:: classref-property -:ref:`int` **patch_control_points** = ``1`` +:ref:`int` **patch_control_points** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ The number of control points to use when drawing a patch with tessellation enabl .. rst-class:: classref-property -:ref:`bool` **wireframe** = ``false`` +:ref:`bool` **wireframe** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdpipelinespecializationconstant.rst b/classes/class_rdpipelinespecializationconstant.rst index ec8e7c416db..fc39ef45335 100644 --- a/classes/class_rdpipelinespecializationconstant.rst +++ b/classes/class_rdpipelinespecializationconstant.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **constant_id** = ``0`` +:ref:`int` **constant_id** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ The identifier of the specialization constant. This is a value starting from ``0 .. rst-class:: classref-property -:ref:`Variant` **value** +:ref:`Variant` **value** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdsamplerstate.rst b/classes/class_rdsamplerstate.rst index bfd1f3b890a..b27506a0360 100644 --- a/classes/class_rdsamplerstate.rst +++ b/classes/class_rdsamplerstate.rst @@ -74,7 +74,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **anisotropy_max** = ``1.0`` +:ref:`float` **anisotropy_max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ If :ref:`anisotropy_max` is ``1.0` .. rst-class:: classref-property -:ref:`SamplerBorderColor` **border_color** = ``2`` +:ref:`SamplerBorderColor` **border_color** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ The border color that will be returned when sampling outside the sampler's bound .. rst-class:: classref-property -:ref:`CompareOperator` **compare_op** = ``7`` +:ref:`CompareOperator` **compare_op** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ The compare operation to use. Only effective if :ref:`enable_compare` **enable_compare** = ``false`` +:ref:`bool` **enable_compare** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ If ``true``, returned values will be based on the comparison operation defined i .. rst-class:: classref-property -:ref:`float` **lod_bias** = ``0.0`` +:ref:`float` **lod_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ The mipmap LOD bias to use. Positive values will make the sampler blurrier at a .. rst-class:: classref-property -:ref:`SamplerFilter` **mag_filter** = ``0`` +:ref:`SamplerFilter` **mag_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ The sampler's magnification filter. It is the filtering method used when samplin .. rst-class:: classref-property -:ref:`float` **max_lod** = ``1e+20`` +:ref:`float` **max_lod** = ``1e+20`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ The maximum mipmap LOD bias to display (lowest resolution). Only effective if th .. rst-class:: classref-property -:ref:`SamplerFilter` **min_filter** = ``0`` +:ref:`SamplerFilter` **min_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ The sampler's minification filter. It is the filtering method used when sampling .. rst-class:: classref-property -:ref:`float` **min_lod** = ``0.0`` +:ref:`float` **min_lod** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -229,7 +229,7 @@ The minimum mipmap LOD bias to display (highest resolution). Only effective if t .. rst-class:: classref-property -:ref:`SamplerFilter` **mip_filter** = ``0`` +:ref:`SamplerFilter` **mip_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -246,7 +246,7 @@ The filtering method to use for mipmaps. .. rst-class:: classref-property -:ref:`SamplerRepeatMode` **repeat_u** = ``2`` +:ref:`SamplerRepeatMode` **repeat_u** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -263,7 +263,7 @@ The repeat mode to use along the U axis of UV coordinates. This affects the retu .. rst-class:: classref-property -:ref:`SamplerRepeatMode` **repeat_v** = ``2`` +:ref:`SamplerRepeatMode` **repeat_v** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -280,7 +280,7 @@ The repeat mode to use along the V axis of UV coordinates. This affects the retu .. rst-class:: classref-property -:ref:`SamplerRepeatMode` **repeat_w** = ``2`` +:ref:`SamplerRepeatMode` **repeat_w** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -297,7 +297,7 @@ The repeat mode to use along the W axis of UV coordinates. This affects the retu .. rst-class:: classref-property -:ref:`bool` **unnormalized_uvw** = ``false`` +:ref:`bool` **unnormalized_uvw** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -314,7 +314,7 @@ If ``true``, the texture will be sampled with coordinates ranging from 0 to the .. rst-class:: classref-property -:ref:`bool` **use_anisotropy** = ``false`` +:ref:`bool` **use_anisotropy** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdshaderfile.rst b/classes/class_rdshaderfile.rst index ef3435416e9..1ae5bbc8c26 100644 --- a/classes/class_rdshaderfile.rst +++ b/classes/class_rdshaderfile.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **base_error** = ``""`` +:ref:`String` **base_error** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RDShaderSPIRV` **get_spirv**\ (\ version\: :ref:`StringName` = &""\ ) |const| +:ref:`RDShaderSPIRV` **get_spirv**\ (\ version\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns the SPIR-V intermediate representation for the specified shader ``version``. @@ -98,7 +98,7 @@ Returns the SPIR-V intermediate representation for the specified shader ``versio .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **get_version_list**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **get_version_list**\ (\ ) |const| :ref:`🔗` Returns the list of compiled versions for this shader. @@ -110,7 +110,7 @@ Returns the list of compiled versions for this shader. .. rst-class:: classref-method -|void| **set_bytecode**\ (\ bytecode\: :ref:`RDShaderSPIRV`, version\: :ref:`StringName` = &""\ ) +|void| **set_bytecode**\ (\ bytecode\: :ref:`RDShaderSPIRV`, version\: :ref:`StringName` = &""\ ) :ref:`🔗` Sets the SPIR-V ``bytecode`` that will be compiled for the specified ``version``. diff --git a/classes/class_rdshadersource.rst b/classes/class_rdshadersource.rst index 9439bce24d9..a0110a34cce 100644 --- a/classes/class_rdshadersource.rst +++ b/classes/class_rdshadersource.rst @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ShaderLanguage` **language** = ``0`` +:ref:`ShaderLanguage` **language** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -89,7 +89,7 @@ The language the shader is written in. .. rst-class:: classref-property -:ref:`String` **source_compute** = ``""`` +:ref:`String` **source_compute** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -106,7 +106,7 @@ Source code for the shader's compute stage. .. rst-class:: classref-property -:ref:`String` **source_fragment** = ``""`` +:ref:`String` **source_fragment** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Source code for the shader's fragment stage. .. rst-class:: classref-property -:ref:`String` **source_tesselation_control** = ``""`` +:ref:`String` **source_tesselation_control** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ Source code for the shader's tessellation control stage. .. rst-class:: classref-property -:ref:`String` **source_tesselation_evaluation** = ``""`` +:ref:`String` **source_tesselation_evaluation** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ Source code for the shader's tessellation evaluation stage. .. rst-class:: classref-property -:ref:`String` **source_vertex** = ``""`` +:ref:`String` **source_vertex** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| +:ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| :ref:`🔗` Returns source code for the specified shader ``stage``. Equivalent to getting one of :ref:`source_compute`, :ref:`source_fragment`, :ref:`source_tesselation_control`, :ref:`source_tesselation_evaluation` or :ref:`source_vertex`. @@ -191,7 +191,7 @@ Returns source code for the specified shader ``stage``. Equivalent to getting on .. rst-class:: classref-method -|void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) +|void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) :ref:`🔗` Sets ``source`` code for the specified shader ``stage``. Equivalent to setting one of :ref:`source_compute`, :ref:`source_fragment`, :ref:`source_tesselation_control`, :ref:`source_tesselation_evaluation` or :ref:`source_vertex`. diff --git a/classes/class_rdshaderspirv.rst b/classes/class_rdshaderspirv.rst index 0b8b16a9224..a5039f778f7 100644 --- a/classes/class_rdshaderspirv.rst +++ b/classes/class_rdshaderspirv.rst @@ -84,7 +84,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedByteArray` **bytecode_compute** = ``PackedByteArray()`` +:ref:`PackedByteArray` **bytecode_compute** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ The SPIR-V bytecode for the compute shader stage. .. rst-class:: classref-property -:ref:`PackedByteArray` **bytecode_fragment** = ``PackedByteArray()`` +:ref:`PackedByteArray` **bytecode_fragment** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ The SPIR-V bytecode for the fragment shader stage. .. rst-class:: classref-property -:ref:`PackedByteArray` **bytecode_tesselation_control** = ``PackedByteArray()`` +:ref:`PackedByteArray` **bytecode_tesselation_control** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ The SPIR-V bytecode for the tessellation control shader stage. .. rst-class:: classref-property -:ref:`PackedByteArray` **bytecode_tesselation_evaluation** = ``PackedByteArray()`` +:ref:`PackedByteArray` **bytecode_tesselation_evaluation** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -160,7 +160,7 @@ The SPIR-V bytecode for the tessellation evaluation shader stage. .. rst-class:: classref-property -:ref:`PackedByteArray` **bytecode_vertex** = ``PackedByteArray()`` +:ref:`PackedByteArray` **bytecode_vertex** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -179,7 +179,7 @@ The SPIR-V bytecode for the vertex shader stage. .. rst-class:: classref-property -:ref:`String` **compile_error_compute** = ``""`` +:ref:`String` **compile_error_compute** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ The compilation error message for the compute shader stage (set by the SPIR-V co .. rst-class:: classref-property -:ref:`String` **compile_error_fragment** = ``""`` +:ref:`String` **compile_error_fragment** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ The compilation error message for the fragment shader stage (set by the SPIR-V c .. rst-class:: classref-property -:ref:`String` **compile_error_tesselation_control** = ``""`` +:ref:`String` **compile_error_tesselation_control** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ The compilation error message for the tessellation control shader stage (set by .. rst-class:: classref-property -:ref:`String` **compile_error_tesselation_evaluation** = ``""`` +:ref:`String` **compile_error_tesselation_evaluation** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -247,7 +247,7 @@ The compilation error message for the tessellation evaluation shader stage (set .. rst-class:: classref-property -:ref:`String` **compile_error_vertex** = ``""`` +:ref:`String` **compile_error_vertex** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -269,7 +269,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| +:ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| :ref:`🔗` Equivalent to getting one of :ref:`bytecode_compute`, :ref:`bytecode_fragment`, :ref:`bytecode_tesselation_control`, :ref:`bytecode_tesselation_evaluation`, :ref:`bytecode_vertex`. @@ -281,7 +281,7 @@ Equivalent to getting one of :ref:`bytecode_compute` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| +:ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| :ref:`🔗` Returns the compilation error message for the given shader ``stage``. Equivalent to getting one of :ref:`compile_error_compute`, :ref:`compile_error_fragment`, :ref:`compile_error_tesselation_control`, :ref:`compile_error_tesselation_evaluation`, :ref:`compile_error_vertex`. @@ -293,7 +293,7 @@ Returns the compilation error message for the given shader ``stage``. Equivalent .. rst-class:: classref-method -|void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) +|void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sets the SPIR-V ``bytecode`` for the given shader ``stage``. Equivalent to setting one of :ref:`bytecode_compute`, :ref:`bytecode_fragment`, :ref:`bytecode_tesselation_control`, :ref:`bytecode_tesselation_evaluation`, :ref:`bytecode_vertex`. @@ -305,7 +305,7 @@ Sets the SPIR-V ``bytecode`` for the given shader ``stage``. Equivalent to setti .. rst-class:: classref-method -|void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) +|void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) :ref:`🔗` Sets the compilation error message for the given shader ``stage`` to ``compile_error``. Equivalent to setting one of :ref:`compile_error_compute`, :ref:`compile_error_fragment`, :ref:`compile_error_tesselation_control`, :ref:`compile_error_tesselation_evaluation`, :ref:`compile_error_vertex`. diff --git a/classes/class_rdtextureformat.rst b/classes/class_rdtextureformat.rst index 0543aaff289..622f9d21305 100644 --- a/classes/class_rdtextureformat.rst +++ b/classes/class_rdtextureformat.rst @@ -76,7 +76,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **array_layers** = ``1`` +:ref:`int` **array_layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ The number of layers in the texture. Only relevant for 2D texture arrays. .. rst-class:: classref-property -:ref:`int` **depth** = ``1`` +:ref:`int` **depth** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ The texture's depth (in pixels). This is always ``1`` for 2D textures. .. rst-class:: classref-property -:ref:`DataFormat` **format** = ``8`` +:ref:`DataFormat` **format** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ The texture's pixel data format. .. rst-class:: classref-property -:ref:`int` **height** = ``1`` +:ref:`int` **height** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ The texture's height (in pixels). .. rst-class:: classref-property -:ref:`int` **mipmaps** = ``1`` +:ref:`int` **mipmaps** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ The number of mipmaps available in the texture. .. rst-class:: classref-property -:ref:`TextureSamples` **samples** = ``0`` +:ref:`TextureSamples` **samples** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -178,7 +178,7 @@ The number of samples used when sampling the texture. .. rst-class:: classref-property -:ref:`TextureType` **texture_type** = ``1`` +:ref:`TextureType` **texture_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -195,7 +195,7 @@ The texture type. .. rst-class:: classref-property -|bitfield|\[:ref:`TextureUsageBits`\] **usage_bits** = ``0`` +|bitfield|\[:ref:`TextureUsageBits`\] **usage_bits** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -212,7 +212,7 @@ The texture's usage bits, which determine what can be done using the texture. .. rst-class:: classref-property -:ref:`int` **width** = ``1`` +:ref:`int` **width** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_shareable_format**\ (\ format\: :ref:`DataFormat`\ ) +|void| **add_shareable_format**\ (\ format\: :ref:`DataFormat`\ ) :ref:`🔗` .. container:: contribute @@ -248,7 +248,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **remove_shareable_format**\ (\ format\: :ref:`DataFormat`\ ) +|void| **remove_shareable_format**\ (\ format\: :ref:`DataFormat`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_rdtextureview.rst b/classes/class_rdtextureview.rst index 34a0f3523b1..9b20f88cf5f 100644 --- a/classes/class_rdtextureview.rst +++ b/classes/class_rdtextureview.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`DataFormat` **format_override** = ``218`` +:ref:`DataFormat` **format_override** = ``218`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ Optional override for the data format to return sampled values in. The default v .. rst-class:: classref-property -:ref:`TextureSwizzle` **swizzle_a** = ``6`` +:ref:`TextureSwizzle` **swizzle_a** = ``6`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ The channel to sample when sampling the alpha channel. .. rst-class:: classref-property -:ref:`TextureSwizzle` **swizzle_b** = ``5`` +:ref:`TextureSwizzle` **swizzle_b** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The channel to sample when sampling the blue color channel. .. rst-class:: classref-property -:ref:`TextureSwizzle` **swizzle_g** = ``4`` +:ref:`TextureSwizzle` **swizzle_g** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ The channel to sample when sampling the green color channel. .. rst-class:: classref-property -:ref:`TextureSwizzle` **swizzle_r** = ``3`` +:ref:`TextureSwizzle` **swizzle_r** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rduniform.rst b/classes/class_rduniform.rst index 036c4426858..e9f8c6f7cd9 100644 --- a/classes/class_rduniform.rst +++ b/classes/class_rduniform.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **binding** = ``0`` +:ref:`int` **binding** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -81,7 +81,7 @@ The uniform's binding. .. rst-class:: classref-property -:ref:`UniformType` **uniform_type** = ``3`` +:ref:`UniformType` **uniform_type** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_id**\ (\ id\: :ref:`RID`\ ) +|void| **add_id**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` Binds the given id to the uniform. The data associated with the id is then used when the uniform is passed to a shader. @@ -115,7 +115,7 @@ Binds the given id to the uniform. The data associated with the id is then used .. rst-class:: classref-method -|void| **clear_ids**\ (\ ) +|void| **clear_ids**\ (\ ) :ref:`🔗` Unbinds all ids currently bound to the uniform. @@ -127,7 +127,7 @@ Unbinds all ids currently bound to the uniform. .. rst-class:: classref-method -:ref:`Array`\[:ref:`RID`\] **get_ids**\ (\ ) |const| +:ref:`Array`\[:ref:`RID`\] **get_ids**\ (\ ) |const| :ref:`🔗` Returns an array of all ids currently bound to the uniform. diff --git a/classes/class_rdvertexattribute.rst b/classes/class_rdvertexattribute.rst index ce2ec934e57..40e7d5b67f6 100644 --- a/classes/class_rdvertexattribute.rst +++ b/classes/class_rdvertexattribute.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`DataFormat` **format** = ``218`` +:ref:`DataFormat` **format** = ``218`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`VertexFrequency` **frequency** = ``0`` +:ref:`VertexFrequency` **frequency** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -92,7 +92,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **location** = ``0`` +:ref:`int` **location** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **offset** = ``0`` +:ref:`int` **offset** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **stride** = ``0`` +:ref:`int` **stride** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 2f8ad717179..65d11ae327c 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -145,7 +145,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **end** = ``Vector2(0, 0)`` +:ref:`Vector2` **end** = ``Vector2(0, 0)`` :ref:`🔗` The ending point. This is usually the bottom-right corner of the rectangle, and is equivalent to ``position + size``. Setting this point affects the :ref:`size`. @@ -157,7 +157,7 @@ The ending point. This is usually the bottom-right corner of the rectangle, and .. rst-class:: classref-property -:ref:`Vector2` **position** = ``Vector2(0, 0)`` +:ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` The origin point. This is usually the top-left corner of the rectangle. @@ -169,7 +169,7 @@ The origin point. This is usually the top-left corner of the rectangle. .. rst-class:: classref-property -:ref:`Vector2` **size** = ``Vector2(0, 0)`` +:ref:`Vector2` **size** = ``Vector2(0, 0)`` :ref:`🔗` The rectangle's width and height, starting from :ref:`position`. Setting this value also affects the :ref:`end` point. @@ -188,7 +188,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Rect2` **Rect2**\ (\ ) +:ref:`Rect2` **Rect2**\ (\ ) :ref:`🔗` Constructs a **Rect2** with its :ref:`position` and :ref:`size` set to :ref:`Vector2.ZERO`. @@ -245,7 +245,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **abs**\ (\ ) |const| +:ref:`Rect2` **abs**\ (\ ) |const| :ref:`🔗` Returns a **Rect2** equivalent to this rectangle, with its width and height modified to be non-negative values, and with its :ref:`position` being the top-left corner of the rectangle. @@ -274,7 +274,7 @@ Returns a **Rect2** equivalent to this rectangle, with its width and height modi .. rst-class:: classref-method -:ref:`bool` **encloses**\ (\ b\: :ref:`Rect2`\ ) |const| +:ref:`bool` **encloses**\ (\ b\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle *completely* encloses the ``b`` rectangle. @@ -286,7 +286,7 @@ Returns ``true`` if this rectangle *completely* encloses the ``b`` rectangle. .. rst-class:: classref-method -:ref:`Rect2` **expand**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`Rect2` **expand**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a copy of this rectangle expanded to align the edges with the given ``to`` point, if necessary. @@ -317,7 +317,7 @@ Returns a copy of this rectangle expanded to align the edges with the given ``to .. rst-class:: classref-method -:ref:`float` **get_area**\ (\ ) |const| +:ref:`float` **get_area**\ (\ ) |const| :ref:`🔗` Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See also :ref:`has_area`. @@ -329,7 +329,7 @@ Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See als .. rst-class:: classref-method -:ref:`Vector2` **get_center**\ (\ ) |const| +:ref:`Vector2` **get_center**\ (\ ) |const| :ref:`🔗` Returns the center point of the rectangle. This is the same as ``position + (size / 2.0)``. @@ -341,7 +341,7 @@ Returns the center point of the rectangle. This is the same as ``position + (siz .. rst-class:: classref-method -:ref:`Rect2` **grow**\ (\ amount\: :ref:`float`\ ) |const| +:ref:`Rect2` **grow**\ (\ amount\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this rectangle extended on all sides by the given ``amount``. A negative ``amount`` shrinks the rectangle instead. See also :ref:`grow_individual` and :ref:`grow_side`. @@ -368,7 +368,7 @@ Returns a copy of this rectangle extended on all sides by the given ``amount``. .. rst-class:: classref-method -:ref:`Rect2` **grow_individual**\ (\ left\: :ref:`float`, top\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`\ ) |const| +:ref:`Rect2` **grow_individual**\ (\ left\: :ref:`float`, top\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bottom`` sides extended by the given amounts. Negative values shrink the sides, instead. See also :ref:`grow` and :ref:`grow_side`. @@ -380,7 +380,7 @@ Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bo .. rst-class:: classref-method -:ref:`Rect2` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`float`\ ) |const| +:ref:`Rect2` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this rectangle with its ``side`` extended by the given ``amount`` (see :ref:`Side` constants). A negative ``amount`` shrinks the rectangle, instead. See also :ref:`grow` and :ref:`grow_individual`. @@ -392,7 +392,7 @@ Returns a copy of this rectangle with its ``side`` extended by the given ``amoun .. rst-class:: classref-method -:ref:`bool` **has_area**\ (\ ) |const| +:ref:`bool` **has_area**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle has positive width and height. See also :ref:`get_area`. @@ -404,7 +404,7 @@ Returns ``true`` if this rectangle has positive width and height. See also :ref: .. rst-class:: classref-method -:ref:`bool` **has_point**\ (\ point\: :ref:`Vector2`\ ) |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true`` if the rectangle contains the given ``point``. By convention, points on the right and bottom edges are **not** included. @@ -418,7 +418,7 @@ Returns ``true`` if the rectangle contains the given ``point``. By convention, p .. rst-class:: classref-method -:ref:`Rect2` **intersection**\ (\ b\: :ref:`Rect2`\ ) |const| +:ref:`Rect2` **intersection**\ (\ b\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns the intersection between this rectangle and ``b``. If the rectangles do not intersect, returns an empty **Rect2**. @@ -451,7 +451,7 @@ Returns the intersection between this rectangle and ``b``. If the rectangles do .. rst-class:: classref-method -:ref:`bool` **intersects**\ (\ b\: :ref:`Rect2`, include_borders\: :ref:`bool` = false\ ) |const| +:ref:`bool` **intersects**\ (\ b\: :ref:`Rect2`, include_borders\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges of both rectangles are excluded, unless ``include_borders`` is ``true``. @@ -463,7 +463,7 @@ Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ rect\: :ref:`Rect2`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle and ``rect`` are approximately equal, by calling :ref:`Vector2.is_equal_approx` on the :ref:`position` and the :ref:`size`. @@ -475,7 +475,7 @@ Returns ``true`` if this rectangle and ``rect`` are approximately equal, by call .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle's values are finite, by calling :ref:`Vector2.is_finite` on the :ref:`position` and the :ref:`size`. @@ -487,7 +487,7 @@ Returns ``true`` if this rectangle's values are finite, by calling :ref:`Vector2 .. rst-class:: classref-method -:ref:`Rect2` **merge**\ (\ b\: :ref:`Rect2`\ ) |const| +:ref:`Rect2` **merge**\ (\ b\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns a **Rect2** that encloses both this rectangle and ``b`` around the edges. See also :ref:`encloses`. @@ -504,7 +504,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2`\ ) :ref:`🔗` Returns ``true`` if the :ref:`position` or :ref:`size` of both rectangles are not equal. @@ -518,7 +518,7 @@ Returns ``true`` if the :ref:`position` or :ref:` .. rst-class:: classref-operator -:ref:`Rect2` **operator ***\ (\ right\: :ref:`Transform2D`\ ) +:ref:`Rect2` **operator ***\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Rect2** by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -534,7 +534,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2`\ ) :ref:`🔗` Returns ``true`` if both :ref:`position` and :ref:`size` of the rectangles are exactly equal, respectively. diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index 61d6795e035..16e8d465649 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -137,7 +137,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2i` **end** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **end** = ``Vector2i(0, 0)`` :ref:`🔗` The ending point. This is usually the bottom-right corner of the rectangle, and is equivalent to ``position + size``. Setting this point affects the :ref:`size`. @@ -149,7 +149,7 @@ The ending point. This is usually the bottom-right corner of the rectangle, and .. rst-class:: classref-property -:ref:`Vector2i` **position** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **position** = ``Vector2i(0, 0)`` :ref:`🔗` The origin point. This is usually the top-left corner of the rectangle. @@ -161,7 +161,7 @@ The origin point. This is usually the top-left corner of the rectangle. .. rst-class:: classref-property -:ref:`Vector2i` **size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **size** = ``Vector2i(0, 0)`` :ref:`🔗` The rectangle's width and height, starting from :ref:`position`. Setting this value also affects the :ref:`end` point. @@ -180,7 +180,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Rect2i` **Rect2i**\ (\ ) +:ref:`Rect2i` **Rect2i**\ (\ ) :ref:`🔗` Constructs a **Rect2i** with its :ref:`position` and :ref:`size` set to :ref:`Vector2i.ZERO`. @@ -237,7 +237,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2i` **abs**\ (\ ) |const| +:ref:`Rect2i` **abs**\ (\ ) |const| :ref:`🔗` Returns a **Rect2i** equivalent to this rectangle, with its width and height modified to be non-negative values, and with its :ref:`position` being the top-left corner of the rectangle. @@ -266,7 +266,7 @@ Returns a **Rect2i** equivalent to this rectangle, with its width and height mod .. rst-class:: classref-method -:ref:`bool` **encloses**\ (\ b\: :ref:`Rect2i`\ ) |const| +:ref:`bool` **encloses**\ (\ b\: :ref:`Rect2i`\ ) |const| :ref:`🔗` Returns ``true`` if this **Rect2i** completely encloses another one. @@ -278,7 +278,7 @@ Returns ``true`` if this **Rect2i** completely encloses another one. .. rst-class:: classref-method -:ref:`Rect2i` **expand**\ (\ to\: :ref:`Vector2i`\ ) |const| +:ref:`Rect2i` **expand**\ (\ to\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns a copy of this rectangle expanded to align the edges with the given ``to`` point, if necessary. @@ -309,7 +309,7 @@ Returns a copy of this rectangle expanded to align the edges with the given ``to .. rst-class:: classref-method -:ref:`int` **get_area**\ (\ ) |const| +:ref:`int` **get_area**\ (\ ) |const| :ref:`🔗` Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See also :ref:`has_area`. @@ -321,7 +321,7 @@ Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See als .. rst-class:: classref-method -:ref:`Vector2i` **get_center**\ (\ ) |const| +:ref:`Vector2i` **get_center**\ (\ ) |const| :ref:`🔗` Returns the center point of the rectangle. This is the same as ``position + (size / 2)``. @@ -335,7 +335,7 @@ Returns the center point of the rectangle. This is the same as ``position + (siz .. rst-class:: classref-method -:ref:`Rect2i` **grow**\ (\ amount\: :ref:`int`\ ) |const| +:ref:`Rect2i` **grow**\ (\ amount\: :ref:`int`\ ) |const| :ref:`🔗` Returns a copy of this rectangle extended on all sides by the given ``amount``. A negative ``amount`` shrinks the rectangle instead. See also :ref:`grow_individual` and :ref:`grow_side`. @@ -362,7 +362,7 @@ Returns a copy of this rectangle extended on all sides by the given ``amount``. .. rst-class:: classref-method -:ref:`Rect2i` **grow_individual**\ (\ left\: :ref:`int`, top\: :ref:`int`, right\: :ref:`int`, bottom\: :ref:`int`\ ) |const| +:ref:`Rect2i` **grow_individual**\ (\ left\: :ref:`int`, top\: :ref:`int`, right\: :ref:`int`, bottom\: :ref:`int`\ ) |const| :ref:`🔗` Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bottom`` sides extended by the given amounts. Negative values shrink the sides, instead. See also :ref:`grow` and :ref:`grow_side`. @@ -374,7 +374,7 @@ Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bo .. rst-class:: classref-method -:ref:`Rect2i` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`int`\ ) |const| +:ref:`Rect2i` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`int`\ ) |const| :ref:`🔗` Returns a copy of this rectangle with its ``side`` extended by the given ``amount`` (see :ref:`Side` constants). A negative ``amount`` shrinks the rectangle, instead. See also :ref:`grow` and :ref:`grow_individual`. @@ -386,7 +386,7 @@ Returns a copy of this rectangle with its ``side`` extended by the given ``amoun .. rst-class:: classref-method -:ref:`bool` **has_area**\ (\ ) |const| +:ref:`bool` **has_area**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle has positive width and height. See also :ref:`get_area`. @@ -398,7 +398,7 @@ Returns ``true`` if this rectangle has positive width and height. See also :ref: .. rst-class:: classref-method -:ref:`bool` **has_point**\ (\ point\: :ref:`Vector2i`\ ) |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns ``true`` if the rectangle contains the given ``point``. By convention, points on the right and bottom edges are **not** included. @@ -412,7 +412,7 @@ Returns ``true`` if the rectangle contains the given ``point``. By convention, p .. rst-class:: classref-method -:ref:`Rect2i` **intersection**\ (\ b\: :ref:`Rect2i`\ ) |const| +:ref:`Rect2i` **intersection**\ (\ b\: :ref:`Rect2i`\ ) |const| :ref:`🔗` Returns the intersection between this rectangle and ``b``. If the rectangles do not intersect, returns an empty **Rect2i**. @@ -445,7 +445,7 @@ Returns the intersection between this rectangle and ``b``. If the rectangles do .. rst-class:: classref-method -:ref:`bool` **intersects**\ (\ b\: :ref:`Rect2i`\ ) |const| +:ref:`bool` **intersects**\ (\ b\: :ref:`Rect2i`\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges of both rectangles are excluded. @@ -457,7 +457,7 @@ Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges .. rst-class:: classref-method -:ref:`Rect2i` **merge**\ (\ b\: :ref:`Rect2i`\ ) |const| +:ref:`Rect2i` **merge**\ (\ b\: :ref:`Rect2i`\ ) |const| :ref:`🔗` Returns a **Rect2i** that encloses both this rectangle and ``b`` around the edges. See also :ref:`encloses`. @@ -474,7 +474,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2i`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2i`\ ) :ref:`🔗` Returns ``true`` if the :ref:`position` or :ref:`size` of both rectangles are not equal. @@ -486,7 +486,7 @@ Returns ``true`` if the :ref:`position` or :ref: .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2i`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2i`\ ) :ref:`🔗` Returns ``true`` if both :ref:`position` and :ref:`size` of the rectangles are equal, respectively. diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 9d28e458ca0..941b35d5a54 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -57,7 +57,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **size** = ``Vector2(20, 20)`` +:ref:`Vector2` **size** = ``Vector2(20, 20)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 5bcc99ad89d..b7e993b8f0a 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_reference_count**\ (\ ) |const| +:ref:`int` **get_reference_count**\ (\ ) |const| :ref:`🔗` Returns the current reference count. @@ -81,7 +81,7 @@ Returns the current reference count. .. rst-class:: classref-method -:ref:`bool` **init_ref**\ (\ ) +:ref:`bool` **init_ref**\ (\ ) :ref:`🔗` Initializes the internal reference counter. Use this only if you really know what you are doing. @@ -95,7 +95,7 @@ Returns whether the initialization was successful. .. rst-class:: classref-method -:ref:`bool` **reference**\ (\ ) +:ref:`bool` **reference**\ (\ ) :ref:`🔗` Increments the internal reference counter. Use this only if you really know what you are doing. @@ -109,7 +109,7 @@ Returns ``true`` if the increment was successful, ``false`` otherwise. .. rst-class:: classref-method -:ref:`bool` **unreference**\ (\ ) +:ref:`bool` **unreference**\ (\ ) :ref:`🔗` Decrements the internal reference counter. Use this only if you really know what you are doing. diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index e6a75188add..7f0adfa020f 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **border_color** = ``Color(1, 0, 0, 1)`` +:ref:`Color` **border_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ Sets the border color of the **ReferenceRect**. .. rst-class:: classref-property -:ref:`float` **border_width** = ``1.0`` +:ref:`float` **border_width** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -84,7 +84,7 @@ Sets the border width of the **ReferenceRect**. The border grows both inwards an .. rst-class:: classref-property -:ref:`bool` **editor_only** = ``true`` +:ref:`bool` **editor_only** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 327e60a7a92..237adc3ec81 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -90,7 +90,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **UpdateMode**: +enum **UpdateMode**: :ref:`🔗` .. _class_ReflectionProbe_constant_UPDATE_ONCE: @@ -116,7 +116,7 @@ Update the probe every frame. This provides better results for fast-moving dynam .. rst-class:: classref-enumeration -enum **AmbientMode**: +enum **AmbientMode**: :ref:`🔗` .. _class_ReflectionProbe_constant_AMBIENT_DISABLED: @@ -155,7 +155,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **ambient_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **ambient_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ The custom ambient color to use within the **ReflectionProbe**'s box defined by .. rst-class:: classref-property -:ref:`float` **ambient_color_energy** = ``1.0`` +:ref:`float` **ambient_color_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ The custom ambient color energy to use within the **ReflectionProbe**'s box defi .. rst-class:: classref-property -:ref:`AmbientMode` **ambient_mode** = ``1`` +:ref:`AmbientMode` **ambient_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ The ambient color to use within the **ReflectionProbe**'s box defined by its :re .. rst-class:: classref-property -:ref:`bool` **box_projection** = ``false`` +:ref:`bool` **box_projection** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ If ``true``, enables box projection. This makes reflections look more correct in .. rst-class:: classref-property -:ref:`int` **cull_mask** = ``1048575`` +:ref:`int` **cull_mask** = ``1048575`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -244,7 +244,7 @@ This can also be used to prevent an object from reflecting upon itself (for inst .. rst-class:: classref-property -:ref:`bool` **enable_shadows** = ``false`` +:ref:`bool` **enable_shadows** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -261,7 +261,7 @@ If ``true``, computes shadows in the reflection probe. This makes the reflection .. rst-class:: classref-property -:ref:`float` **intensity** = ``1.0`` +:ref:`float` **intensity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -278,7 +278,7 @@ Defines the reflection intensity. Intensity modulates the strength of the reflec .. rst-class:: classref-property -:ref:`bool` **interior** = ``false`` +:ref:`bool` **interior** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -295,7 +295,7 @@ If ``true``, reflections will ignore sky contribution. .. rst-class:: classref-property -:ref:`float` **max_distance** = ``0.0`` +:ref:`float` **max_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -314,7 +314,7 @@ The maximum distance away from the **ReflectionProbe** an object can be before i .. rst-class:: classref-property -:ref:`float` **mesh_lod_threshold** = ``1.0`` +:ref:`float` **mesh_lod_threshold** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -333,7 +333,7 @@ The automatic LOD bias to use for meshes rendered within the **ReflectionProbe** .. rst-class:: classref-property -:ref:`Vector3` **origin_offset** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **origin_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -350,7 +350,7 @@ Sets the origin offset to be used when this **ReflectionProbe** is in :ref:`box_ .. rst-class:: classref-property -:ref:`int` **reflection_mask** = ``1048575`` +:ref:`int` **reflection_mask** = ``1048575`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -367,7 +367,7 @@ Sets the reflection mask which determines what objects have reflections applied .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(20, 20, 20)`` +:ref:`Vector3` **size** = ``Vector3(20, 20, 20)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -386,7 +386,7 @@ The size of the reflection probe. The larger the size, the more space covered by .. rst-class:: classref-property -:ref:`UpdateMode` **update_mode** = ``0`` +:ref:`UpdateMode` **update_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 8fee18f0e5c..57368a09e3c 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` This method resets the state of the object, as if it was freshly created. Namely, it unassigns the regular expression of this object. @@ -130,7 +130,7 @@ This method resets the state of the object, as if it was freshly created. Namely .. rst-class:: classref-method -:ref:`Error` **compile**\ (\ pattern\: :ref:`String`\ ) +:ref:`Error` **compile**\ (\ pattern\: :ref:`String`\ ) :ref:`🔗` Compiles and assign the search pattern to use. Returns :ref:`@GlobalScope.OK` if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned. @@ -142,7 +142,7 @@ Compiles and assign the search pattern to use. Returns :ref:`@GlobalScope.OK` **create_from_string**\ (\ pattern\: :ref:`String`\ ) |static| +:ref:`RegEx` **create_from_string**\ (\ pattern\: :ref:`String`\ ) |static| :ref:`🔗` Creates and compiles a new **RegEx** object. @@ -154,7 +154,7 @@ Creates and compiles a new **RegEx** object. .. rst-class:: classref-method -:ref:`int` **get_group_count**\ (\ ) |const| +:ref:`int` **get_group_count**\ (\ ) |const| :ref:`🔗` Returns the number of capturing groups in compiled pattern. @@ -166,7 +166,7 @@ Returns the number of capturing groups in compiled pattern. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_names**\ (\ ) |const| +:ref:`PackedStringArray` **get_names**\ (\ ) |const| :ref:`🔗` Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. @@ -178,7 +178,7 @@ Returns an array of names of named capturing groups in the compiled pattern. The .. rst-class:: classref-method -:ref:`String` **get_pattern**\ (\ ) |const| +:ref:`String` **get_pattern**\ (\ ) |const| :ref:`🔗` Returns the original search pattern that was compiled. @@ -190,7 +190,7 @@ Returns the original search pattern that was compiled. .. rst-class:: classref-method -:ref:`bool` **is_valid**\ (\ ) |const| +:ref:`bool` **is_valid**\ (\ ) |const| :ref:`🔗` Returns whether this object has a valid search pattern assigned. @@ -202,7 +202,7 @@ Returns whether this object has a valid search pattern assigned. .. rst-class:: classref-method -:ref:`RegExMatch` **search**\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| +:ref:`RegExMatch` **search**\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching result if found, otherwise ``null``. @@ -216,7 +216,7 @@ The region to search within can be specified with ``offset`` and ``end``. This i .. rst-class:: classref-method -:ref:`Array`\[:ref:`RegExMatch`\] **search_all**\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| +:ref:`Array`\[:ref:`RegExMatch`\] **search_all**\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found, an empty array is returned instead. @@ -230,7 +230,7 @@ The region to search within can be specified with ``offset`` and ``end``. This i .. rst-class:: classref-method -:ref:`String` **sub**\ (\ subject\: :ref:`String`, replacement\: :ref:`String`, all\: :ref:`bool` = false, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| +:ref:`String` **sub**\ (\ subject\: :ref:`String`, replacement\: :ref:`String`, all\: :ref:`bool` = false, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| :ref:`🔗` Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``$1`` and ``$name`` are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index bdd12eaeffa..9237e156b30 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Dictionary` **names** = ``{}`` +:ref:`Dictionary` **names** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -84,7 +84,7 @@ A dictionary of named groups and its corresponding group number. Only groups tha .. rst-class:: classref-property -:ref:`PackedStringArray` **strings** = ``PackedStringArray()`` +:ref:`PackedStringArray` **strings** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ An :ref:`Array` of the match and its capturing groups. .. rst-class:: classref-property -:ref:`String` **subject** = ``""`` +:ref:`String` **subject** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_end**\ (\ name\: :ref:`Variant` = 0\ ) |const| +:ref:`int` **get_end**\ (\ name\: :ref:`Variant` = 0\ ) |const| :ref:`🔗` Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -137,7 +137,7 @@ Returns -1 if the group did not match or doesn't exist. .. rst-class:: classref-method -:ref:`int` **get_group_count**\ (\ ) |const| +:ref:`int` **get_group_count**\ (\ ) |const| :ref:`🔗` Returns the number of capturing groups. @@ -149,7 +149,7 @@ Returns the number of capturing groups. .. rst-class:: classref-method -:ref:`int` **get_start**\ (\ name\: :ref:`Variant` = 0\ ) |const| +:ref:`int` **get_start**\ (\ name\: :ref:`Variant` = 0\ ) |const| :ref:`🔗` Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -163,7 +163,7 @@ Returns -1 if the group did not match or doesn't exist. .. rst-class:: classref-method -:ref:`String` **get_string**\ (\ name\: :ref:`Variant` = 0\ ) |const| +:ref:`String` **get_string**\ (\ name\: :ref:`Variant` = 0\ ) |const| :ref:`🔗` Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 3b5af833ea8..7ffe32e0a97 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **remote_path** = ``NodePath("")`` +:ref:`NodePath` **remote_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,7 +85,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr .. rst-class:: classref-property -:ref:`bool` **update_position** = ``true`` +:ref:`bool` **update_position** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ If ``true``, the remote node's position is updated. .. rst-class:: classref-property -:ref:`bool` **update_rotation** = ``true`` +:ref:`bool` **update_rotation** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -119,7 +119,7 @@ If ``true``, the remote node's rotation is updated. .. rst-class:: classref-property -:ref:`bool` **update_scale** = ``true`` +:ref:`bool` **update_scale** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -136,7 +136,7 @@ If ``true``, the remote node's scale is updated. .. rst-class:: classref-property -:ref:`bool` **use_global_coordinates** = ``true`` +:ref:`bool` **use_global_coordinates** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -158,7 +158,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **force_update_cache**\ (\ ) +|void| **force_update_cache**\ (\ ) :ref:`🔗` **RemoteTransform2D** caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache` forces it to update the cache again. diff --git a/classes/class_remotetransform3d.rst b/classes/class_remotetransform3d.rst index 4e088aaa574..552885263f9 100644 --- a/classes/class_remotetransform3d.rst +++ b/classes/class_remotetransform3d.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **remote_path** = ``NodePath("")`` +:ref:`NodePath` **remote_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,7 +85,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr .. rst-class:: classref-property -:ref:`bool` **update_position** = ``true`` +:ref:`bool` **update_position** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ If ``true``, the remote node's position is updated. .. rst-class:: classref-property -:ref:`bool` **update_rotation** = ``true`` +:ref:`bool` **update_rotation** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -119,7 +119,7 @@ If ``true``, the remote node's rotation is updated. .. rst-class:: classref-property -:ref:`bool` **update_scale** = ``true`` +:ref:`bool` **update_scale** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -136,7 +136,7 @@ If ``true``, the remote node's scale is updated. .. rst-class:: classref-property -:ref:`bool` **use_global_coordinates** = ``true`` +:ref:`bool` **use_global_coordinates** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -158,7 +158,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **force_update_cache**\ (\ ) +|void| **force_update_cache**\ (\ ) :ref:`🔗` **RemoteTransform3D** caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache` forces it to update the cache again. diff --git a/classes/class_renderdata.rst b/classes/class_renderdata.rst index 1a212ce20fd..93637848228 100644 --- a/classes/class_renderdata.rst +++ b/classes/class_renderdata.rst @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_camera_attributes**\ (\ ) |const| +:ref:`RID` **get_camera_attributes**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the camera attributes object in the :ref:`RenderingServer` being used to render this viewport. @@ -68,7 +68,7 @@ Returns the :ref:`RID` of the camera attributes object in the :ref:`R .. rst-class:: classref-method -:ref:`RID` **get_environment**\ (\ ) |const| +:ref:`RID` **get_environment**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the environments object in the :ref:`RenderingServer` being used to render this viewport. @@ -80,7 +80,7 @@ Returns the :ref:`RID` of the environments object in the :ref:`Render .. rst-class:: classref-method -:ref:`RenderSceneBuffers` **get_render_scene_buffers**\ (\ ) |const| +:ref:`RenderSceneBuffers` **get_render_scene_buffers**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RenderSceneBuffers` object managing the scene buffers for rendering this viewport. @@ -92,7 +92,7 @@ Returns the :ref:`RenderSceneBuffers` object managing .. rst-class:: classref-method -:ref:`RenderSceneData` **get_render_scene_data**\ (\ ) |const| +:ref:`RenderSceneData` **get_render_scene_data**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RenderSceneData` object managing this frames scene data. diff --git a/classes/class_renderdataextension.rst b/classes/class_renderdataextension.rst index a8facc71d95..c90e048a60a 100644 --- a/classes/class_renderdataextension.rst +++ b/classes/class_renderdataextension.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_get_camera_attributes**\ (\ ) |virtual| |const| +:ref:`RID` **_get_camera_attributes**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the :ref:`RID` for the implementations camera attributes object. @@ -64,7 +64,7 @@ Implement this in GDExtension to return the :ref:`RID` for the implem .. rst-class:: classref-method -:ref:`RID` **_get_environment**\ (\ ) |virtual| |const| +:ref:`RID` **_get_environment**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -78,7 +78,7 @@ Implement this in GDExtension to return the :ref:`RID` for the implem .. rst-class:: classref-method -:ref:`RenderSceneBuffers` **_get_render_scene_buffers**\ (\ ) |virtual| |const| +:ref:`RenderSceneBuffers` **_get_render_scene_buffers**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the :ref:`RID` of the implementations environment object. @@ -90,7 +90,7 @@ Implement this in GDExtension to return the :ref:`RID` of the impleme .. rst-class:: classref-method -:ref:`RenderSceneData` **_get_render_scene_data**\ (\ ) |virtual| |const| +:ref:`RenderSceneData` **_get_render_scene_data**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the implementations :ref:`RenderSceneDataExtension` object. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 973064ab1a7..bb7434a72d5 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -255,7 +255,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DeviceType**: +enum **DeviceType**: :ref:`🔗` .. _class_RenderingDevice_constant_DEVICE_TYPE_OTHER: @@ -313,7 +313,7 @@ Represents the size of the :ref:`DeviceType` en .. rst-class:: classref-enumeration -enum **DriverResource**: +enum **DriverResource**: :ref:`🔗` .. _class_RenderingDevice_constant_DRIVER_RESOURCE_LOGICAL_DEVICE: @@ -573,7 +573,7 @@ Buffer of any kind of (storage, vertex, etc.). .. rst-class:: classref-enumeration -enum **DataFormat**: +enum **DataFormat**: :ref:`🔗` .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4_UNORM_PACK8: @@ -2337,7 +2337,7 @@ Represents the size of the :ref:`DataFormat` en .. rst-class:: classref-enumeration -flags **BarrierMask**: +flags **BarrierMask**: :ref:`🔗` .. _class_RenderingDevice_constant_BARRIER_MASK_VERTEX: @@ -2403,7 +2403,7 @@ No barrier for any type. .. rst-class:: classref-enumeration -enum **TextureType**: +enum **TextureType**: :ref:`🔗` .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D: @@ -2477,7 +2477,7 @@ Represents the size of the :ref:`TextureType` .. rst-class:: classref-enumeration -enum **TextureSamples**: +enum **TextureSamples**: :ref:`🔗` .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_1: @@ -2551,7 +2551,7 @@ Represents the size of the :ref:`TextureSamples` .. _class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT: @@ -2641,7 +2641,7 @@ Texture can be used as a `input attachment ` .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_IDENTITY: @@ -2715,7 +2715,7 @@ Represents the size of the :ref:`TextureSwizzle` .. _class_RenderingDevice_constant_TEXTURE_SLICE_2D: @@ -2749,7 +2749,7 @@ Cubemap texture slice. .. rst-class:: classref-enumeration -enum **SamplerFilter**: +enum **SamplerFilter**: :ref:`🔗` .. _class_RenderingDevice_constant_SAMPLER_FILTER_NEAREST: @@ -2775,7 +2775,7 @@ Bilinear sampler filtering. Sampling at higher resolutions than the source will .. rst-class:: classref-enumeration -enum **SamplerRepeatMode**: +enum **SamplerRepeatMode**: :ref:`🔗` .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_REPEAT: @@ -2833,7 +2833,7 @@ Represents the size of the :ref:`SamplerRepeatMode` .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK: @@ -2899,7 +2899,7 @@ Represents the size of the :ref:`SamplerBorderColor` .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_VERTEX: @@ -2925,7 +2925,7 @@ Vertex attribute addressing is a function of the instance index. This is used to .. rst-class:: classref-enumeration -enum **IndexBufferFormat**: +enum **IndexBufferFormat**: :ref:`🔗` .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT16: @@ -2951,7 +2951,7 @@ Index buffer in 32-bit unsigned integer format. This limits the maximum index th .. rst-class:: classref-enumeration -flags **StorageBufferUsage**: +flags **StorageBufferUsage**: :ref:`🔗` .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT: @@ -2973,7 +2973,7 @@ flags **StorageBufferUsage**: .. rst-class:: classref-enumeration -enum **UniformType**: +enum **UniformType**: :ref:`🔗` .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER: @@ -3071,7 +3071,7 @@ Represents the size of the :ref:`UniformType` .. rst-class:: classref-enumeration -enum **RenderPrimitive**: +enum **RenderPrimitive**: :ref:`🔗` .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_POINTS: @@ -3187,7 +3187,7 @@ Represents the size of the :ref:`RenderPrimitive` .. _class_RenderingDevice_constant_POLYGON_CULL_DISABLED: @@ -3221,7 +3221,7 @@ Use polygon backface culling (faces pointing away from the camera are hidden). .. rst-class:: classref-enumeration -enum **PolygonFrontFace**: +enum **PolygonFrontFace**: :ref:`🔗` .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_CLOCKWISE: @@ -3247,7 +3247,7 @@ Counter-clockwise winding order to determine which face of a polygon is its fron .. rst-class:: classref-enumeration -enum **StencilOperation**: +enum **StencilOperation**: :ref:`🔗` .. _class_RenderingDevice_constant_STENCIL_OP_KEEP: @@ -3329,7 +3329,7 @@ Represents the size of the :ref:`StencilOperation` .. _class_RenderingDevice_constant_COMPARE_OP_NEVER: @@ -3411,7 +3411,7 @@ Represents the size of the :ref:`CompareOperator` .. _class_RenderingDevice_constant_LOGIC_OP_CLEAR: @@ -3557,7 +3557,7 @@ Represents the size of the :ref:`LogicOperation` .. _class_RenderingDevice_constant_BLEND_FACTOR_ZERO: @@ -3727,7 +3727,7 @@ Represents the size of the :ref:`BlendFactor` .. rst-class:: classref-enumeration -enum **BlendOperation**: +enum **BlendOperation**: :ref:`🔗` .. _class_RenderingDevice_constant_BLEND_OP_ADD: @@ -3785,7 +3785,7 @@ Represents the size of the :ref:`BlendOperation` .. _class_RenderingDevice_constant_DYNAMIC_STATE_LINE_WIDTH: @@ -3871,7 +3871,7 @@ Allows dynamically changing the depth bias. .. rst-class:: classref-enumeration -enum **InitialAction**: +enum **InitialAction**: :ref:`🔗` .. _class_RenderingDevice_constant_INITIAL_ACTION_LOAD: @@ -3963,7 +3963,7 @@ Represents the size of the :ref:`InitialAction` .. _class_RenderingDevice_constant_FINAL_ACTION_STORE: @@ -4017,7 +4017,7 @@ Represents the size of the :ref:`FinalAction` .. rst-class:: classref-enumeration -enum **ShaderStage**: +enum **ShaderStage**: :ref:`🔗` .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX: @@ -4115,7 +4115,7 @@ Compute shader stage bit (see also :ref:`SHADER_STAGE_COMPUTE` .. _class_RenderingDevice_constant_SHADER_LANGUAGE_GLSL: @@ -4141,7 +4141,7 @@ Microsoft's High-Level Shading Language (used natively by Direct3D, but can also .. rst-class:: classref-enumeration -enum **PipelineSpecializationConstantType**: +enum **PipelineSpecializationConstantType**: :ref:`🔗` .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL: @@ -4175,7 +4175,7 @@ Floating-point specialization constant. .. rst-class:: classref-enumeration -enum **Limit**: +enum **Limit**: :ref:`🔗` .. _class_RenderingDevice_constant_LIMIT_MAX_BOUND_UNIFORM_SETS: @@ -4481,7 +4481,7 @@ Maximum viewport height (in pixels). .. rst-class:: classref-enumeration -enum **MemoryType**: +enum **MemoryType**: :ref:`🔗` .. _class_RenderingDevice_constant_MEMORY_TEXTURES: @@ -4520,7 +4520,7 @@ Constants .. rst-class:: classref-constant -**INVALID_ID** = ``-1`` +**INVALID_ID** = ``-1`` :ref:`🔗` Returned by functions that return an ID if a value is invalid. @@ -4528,7 +4528,7 @@ Returned by functions that return an ID if a value is invalid. .. rst-class:: classref-constant -**INVALID_FORMAT_ID** = ``-1`` +**INVALID_FORMAT_ID** = ``-1`` :ref:`🔗` Returned by functions that return a format ID if a value is invalid. @@ -4545,7 +4545,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **barrier**\ (\ from\: |bitfield|\[:ref:`BarrierMask`\] = 32767, to\: |bitfield|\[:ref:`BarrierMask`\] = 32767\ ) +|void| **barrier**\ (\ from\: |bitfield|\[:ref:`BarrierMask`\] = 32767, to\: |bitfield|\[:ref:`BarrierMask`\] = 32767\ ) :ref:`🔗` **Deprecated:** Barriers are automatically inserted by RenderingDevice. @@ -4559,7 +4559,7 @@ This method does nothing. .. rst-class:: classref-method -:ref:`Error` **buffer_clear**\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`\ ) +:ref:`Error` **buffer_clear**\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`\ ) :ref:`🔗` Clears the contents of the ``buffer``, clearing ``size_bytes`` bytes, starting at ``offset``. @@ -4581,7 +4581,7 @@ Prints an error if: .. rst-class:: classref-method -:ref:`Error` **buffer_copy**\ (\ src_buffer\: :ref:`RID`, dst_buffer\: :ref:`RID`, src_offset\: :ref:`int`, dst_offset\: :ref:`int`, size\: :ref:`int`\ ) +:ref:`Error` **buffer_copy**\ (\ src_buffer\: :ref:`RID`, dst_buffer\: :ref:`RID`, src_offset\: :ref:`int`, dst_offset\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` Copies ``size`` bytes from the ``src_buffer`` at ``src_offset`` into ``dst_buffer`` at ``dst_offset``. @@ -4601,7 +4601,7 @@ Prints an error if: .. rst-class:: classref-method -:ref:`PackedByteArray` **buffer_get_data**\ (\ buffer\: :ref:`RID`, offset_bytes\: :ref:`int` = 0, size_bytes\: :ref:`int` = 0\ ) +:ref:`PackedByteArray` **buffer_get_data**\ (\ buffer\: :ref:`RID`, offset_bytes\: :ref:`int` = 0, size_bytes\: :ref:`int` = 0\ ) :ref:`🔗` Returns a copy of the data of the specified ``buffer``, optionally ``offset_bytes`` and ``size_bytes`` can be set to copy only a portion of the buffer. @@ -4613,7 +4613,7 @@ Returns a copy of the data of the specified ``buffer``, optionally ``offset_byte .. rst-class:: classref-method -:ref:`Error` **buffer_update**\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +:ref:`Error` **buffer_update**\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Updates a region of ``size_bytes`` bytes, starting at ``offset``, in the buffer, with the specified ``data``. @@ -4633,7 +4633,7 @@ Prints an error if: .. rst-class:: classref-method -|void| **capture_timestamp**\ (\ name\: :ref:`String`\ ) +|void| **capture_timestamp**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Creates a timestamp marker with the specified ``name``. This is used for performance reporting with the :ref:`get_captured_timestamp_cpu_time`, :ref:`get_captured_timestamp_gpu_time` and :ref:`get_captured_timestamp_name` methods. @@ -4645,7 +4645,7 @@ Creates a timestamp marker with the specified ``name``. This is used for perform .. rst-class:: classref-method -|void| **compute_list_add_barrier**\ (\ compute_list\: :ref:`int`\ ) +|void| **compute_list_add_barrier**\ (\ compute_list\: :ref:`int`\ ) :ref:`🔗` Raises a Vulkan compute barrier in the specified ``compute_list``. @@ -4657,7 +4657,7 @@ Raises a Vulkan compute barrier in the specified ``compute_list``. .. rst-class:: classref-method -:ref:`int` **compute_list_begin**\ (\ ) +:ref:`int` **compute_list_begin**\ (\ ) :ref:`🔗` Starts a list of compute commands created with the ``compute_*`` methods. The returned value should be passed to other ``compute_list_*`` functions. @@ -4689,7 +4689,7 @@ A simple compute operation might look like this (code is not a complete example) .. rst-class:: classref-method -|void| **compute_list_bind_compute_pipeline**\ (\ compute_list\: :ref:`int`, compute_pipeline\: :ref:`RID`\ ) +|void| **compute_list_bind_compute_pipeline**\ (\ compute_list\: :ref:`int`, compute_pipeline\: :ref:`RID`\ ) :ref:`🔗` Tells the GPU what compute pipeline to use when processing the compute list. If the shader has changed since the last time this function was called, Godot will unbind all descriptor sets and will re-bind them inside :ref:`compute_list_dispatch`. @@ -4701,7 +4701,7 @@ Tells the GPU what compute pipeline to use when processing the compute list. If .. rst-class:: classref-method -|void| **compute_list_bind_uniform_set**\ (\ compute_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) +|void| **compute_list_bind_uniform_set**\ (\ compute_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) :ref:`🔗` Binds the ``uniform_set`` to this ``compute_list``. Godot ensures that all textures in the uniform set have the correct Vulkan access masks. If Godot had to change access masks of textures, it will raise a Vulkan image memory barrier. @@ -4713,7 +4713,7 @@ Binds the ``uniform_set`` to this ``compute_list``. Godot ensures that all textu .. rst-class:: classref-method -|void| **compute_list_dispatch**\ (\ compute_list\: :ref:`int`, x_groups\: :ref:`int`, y_groups\: :ref:`int`, z_groups\: :ref:`int`\ ) +|void| **compute_list_dispatch**\ (\ compute_list\: :ref:`int`, x_groups\: :ref:`int`, y_groups\: :ref:`int`, z_groups\: :ref:`int`\ ) :ref:`🔗` Submits the compute list for processing on the GPU. This is the compute equivalent to :ref:`draw_list_draw`. @@ -4725,7 +4725,7 @@ Submits the compute list for processing on the GPU. This is the compute equivale .. rst-class:: classref-method -|void| **compute_list_dispatch_indirect**\ (\ compute_list\: :ref:`int`, buffer\: :ref:`RID`, offset\: :ref:`int`\ ) +|void| **compute_list_dispatch_indirect**\ (\ compute_list\: :ref:`int`, buffer\: :ref:`RID`, offset\: :ref:`int`\ ) :ref:`🔗` Submits the compute list for processing on the GPU with the given group counts stored in the ``buffer`` at ``offset``. Buffer must have been created with :ref:`STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT` flag. @@ -4737,7 +4737,7 @@ Submits the compute list for processing on the GPU with the given group counts s .. rst-class:: classref-method -|void| **compute_list_end**\ (\ ) +|void| **compute_list_end**\ (\ ) :ref:`🔗` Finishes a list of compute commands created with the ``compute_*`` methods. @@ -4749,7 +4749,7 @@ Finishes a list of compute commands created with the ``compute_*`` methods. .. rst-class:: classref-method -|void| **compute_list_set_push_constant**\ (\ compute_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) +|void| **compute_list_set_push_constant**\ (\ compute_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) :ref:`🔗` Sets the push constant data to ``buffer`` for the specified ``compute_list``. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in ``size_bytes`` (this can be obtained by calling the :ref:`PackedByteArray.size` method on the passed ``buffer``). @@ -4761,7 +4761,7 @@ Sets the push constant data to ``buffer`` for the specified ``compute_list``. Th .. rst-class:: classref-method -:ref:`RID` **compute_pipeline_create**\ (\ shader\: :ref:`RID`, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) +:ref:`RID` **compute_pipeline_create**\ (\ shader\: :ref:`RID`, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) :ref:`🔗` Creates a new compute pipeline. It can be accessed with the RID that is returned. @@ -4775,7 +4775,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **compute_pipeline_is_valid**\ (\ compute_pipeline\: :ref:`RID`\ ) +:ref:`bool` **compute_pipeline_is_valid**\ (\ compute_pipeline\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` RID is valid, ``false`` otherwise. @@ -4787,7 +4787,7 @@ Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` R .. rst-class:: classref-method -:ref:`RenderingDevice` **create_local_device**\ (\ ) +:ref:`RenderingDevice` **create_local_device**\ (\ ) :ref:`🔗` Create a new local **RenderingDevice**. This is most useful for performing compute operations on the GPU independently from the rest of the engine. @@ -4799,7 +4799,7 @@ Create a new local **RenderingDevice**. This is most useful for performing compu .. rst-class:: classref-method -|void| **draw_command_begin_label**\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) +|void| **draw_command_begin_label**\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) :ref:`🔗` Create a command buffer debug label region that can be displayed in third-party tools such as `RenderDoc `__. All regions must be ended with a :ref:`draw_command_end_label` call. When viewed from the linear series of submissions to a single queue, calls to :ref:`draw_command_begin_label` and :ref:`draw_command_end_label` must be matched and balanced. @@ -4813,7 +4813,7 @@ The ``VK_EXT_DEBUG_UTILS_EXTENSION_NAME`` Vulkan extension must be available and .. rst-class:: classref-method -|void| **draw_command_end_label**\ (\ ) +|void| **draw_command_end_label**\ (\ ) :ref:`🔗` Ends the command buffer debug label region started by a :ref:`draw_command_begin_label` call. @@ -4825,7 +4825,7 @@ Ends the command buffer debug label region started by a :ref:`draw_command_begin .. rst-class:: classref-method -|void| **draw_command_insert_label**\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) +|void| **draw_command_insert_label**\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) :ref:`🔗` **Deprecated:** Inserting labels no longer applies due to command reordering. @@ -4839,7 +4839,7 @@ This method does nothing. .. rst-class:: classref-method -:ref:`int` **draw_list_begin**\ (\ framebuffer\: :ref:`RID`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) +:ref:`int` **draw_list_begin**\ (\ framebuffer\: :ref:`RID`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) :ref:`🔗` Starts a list of raster drawing commands created with the ``draw_*`` methods. The returned value should be passed to other ``draw_list_*`` functions. @@ -4874,7 +4874,7 @@ A simple drawing operation might look like this (code is not a complete example) .. rst-class:: classref-method -:ref:`int` **draw_list_begin_for_screen**\ (\ screen\: :ref:`int` = 0, clear_color\: :ref:`Color` = Color(0, 0, 0, 1)\ ) +:ref:`int` **draw_list_begin_for_screen**\ (\ screen\: :ref:`int` = 0, clear_color\: :ref:`Color` = Color(0, 0, 0, 1)\ ) :ref:`🔗` High-level variant of :ref:`draw_list_begin`, with the parameters automatically being adjusted for drawing onto the window specified by the ``screen`` ID. @@ -4888,7 +4888,7 @@ High-level variant of :ref:`draw_list_begin` **draw_list_begin_split**\ (\ framebuffer\: :ref:`RID`, splits\: :ref:`int`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), storage_textures\: :ref:`Array`\[:ref:`RID`\] = []\ ) +:ref:`PackedInt64Array` **draw_list_begin_split**\ (\ framebuffer\: :ref:`RID`, splits\: :ref:`int`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), storage_textures\: :ref:`Array`\[:ref:`RID`\] = []\ ) :ref:`🔗` **Deprecated:** Split draw lists are used automatically by RenderingDevice. @@ -4902,7 +4902,7 @@ This method does nothing and always returns an empty :ref:`PackedInt64Array`, index_array\: :ref:`RID`\ ) +|void| **draw_list_bind_index_array**\ (\ draw_list\: :ref:`int`, index_array\: :ref:`RID`\ ) :ref:`🔗` Binds ``index_array`` to the specified ``draw_list``. @@ -4914,7 +4914,7 @@ Binds ``index_array`` to the specified ``draw_list``. .. rst-class:: classref-method -|void| **draw_list_bind_render_pipeline**\ (\ draw_list\: :ref:`int`, render_pipeline\: :ref:`RID`\ ) +|void| **draw_list_bind_render_pipeline**\ (\ draw_list\: :ref:`int`, render_pipeline\: :ref:`RID`\ ) :ref:`🔗` Binds ``render_pipeline`` to the specified ``draw_list``. @@ -4926,7 +4926,7 @@ Binds ``render_pipeline`` to the specified ``draw_list``. .. rst-class:: classref-method -|void| **draw_list_bind_uniform_set**\ (\ draw_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) +|void| **draw_list_bind_uniform_set**\ (\ draw_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) :ref:`🔗` Binds ``uniform_set`` to the specified ``draw_list``. A ``set_index`` must also be specified, which is an identifier starting from ``0`` that must match the one expected by the draw list. @@ -4938,7 +4938,7 @@ Binds ``uniform_set`` to the specified ``draw_list``. A ``set_index`` must also .. rst-class:: classref-method -|void| **draw_list_bind_vertex_array**\ (\ draw_list\: :ref:`int`, vertex_array\: :ref:`RID`\ ) +|void| **draw_list_bind_vertex_array**\ (\ draw_list\: :ref:`int`, vertex_array\: :ref:`RID`\ ) :ref:`🔗` Binds ``vertex_array`` to the specified ``draw_list``. @@ -4950,7 +4950,7 @@ Binds ``vertex_array`` to the specified ``draw_list``. .. rst-class:: classref-method -|void| **draw_list_disable_scissor**\ (\ draw_list\: :ref:`int`\ ) +|void| **draw_list_disable_scissor**\ (\ draw_list\: :ref:`int`\ ) :ref:`🔗` Removes and disables the scissor rectangle for the specified ``draw_list``. See also :ref:`draw_list_enable_scissor`. @@ -4962,7 +4962,7 @@ Removes and disables the scissor rectangle for the specified ``draw_list``. See .. rst-class:: classref-method -|void| **draw_list_draw**\ (\ draw_list\: :ref:`int`, use_indices\: :ref:`bool`, instances\: :ref:`int`, procedural_vertex_count\: :ref:`int` = 0\ ) +|void| **draw_list_draw**\ (\ draw_list\: :ref:`int`, use_indices\: :ref:`bool`, instances\: :ref:`int`, procedural_vertex_count\: :ref:`int` = 0\ ) :ref:`🔗` Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to :ref:`compute_list_dispatch`. @@ -4974,7 +4974,7 @@ Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to .. rst-class:: classref-method -|void| **draw_list_enable_scissor**\ (\ draw_list\: :ref:`int`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) +|void| **draw_list_enable_scissor**\ (\ draw_list\: :ref:`int`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) :ref:`🔗` Creates a scissor rectangle and enables it for the specified ``draw_list``. Scissor rectangles are used for clipping by discarding fragments that fall outside a specified rectangular portion of the screen. See also :ref:`draw_list_disable_scissor`. @@ -4988,7 +4988,7 @@ Creates a scissor rectangle and enables it for the specified ``draw_list``. Scis .. rst-class:: classref-method -|void| **draw_list_end**\ (\ ) +|void| **draw_list_end**\ (\ ) :ref:`🔗` Finishes a list of raster drawing commands created with the ``draw_*`` methods. @@ -5000,7 +5000,7 @@ Finishes a list of raster drawing commands created with the ``draw_*`` methods. .. rst-class:: classref-method -|void| **draw_list_set_blend_constants**\ (\ draw_list\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **draw_list_set_blend_constants**\ (\ draw_list\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets blend constants for the specified ``draw_list`` to ``color``. Blend constants are used only if the graphics pipeline is created with :ref:`DYNAMIC_STATE_BLEND_CONSTANTS` flag set. @@ -5012,7 +5012,7 @@ Sets blend constants for the specified ``draw_list`` to ``color``. Blend constan .. rst-class:: classref-method -|void| **draw_list_set_push_constant**\ (\ draw_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) +|void| **draw_list_set_push_constant**\ (\ draw_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) :ref:`🔗` Sets the push constant data to ``buffer`` for the specified ``draw_list``. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in ``size_bytes`` (this can be obtained by calling the :ref:`PackedByteArray.size` method on the passed ``buffer``). @@ -5024,7 +5024,7 @@ Sets the push constant data to ``buffer`` for the specified ``draw_list``. The s .. rst-class:: classref-method -:ref:`int` **draw_list_switch_to_next_pass**\ (\ ) +:ref:`int` **draw_list_switch_to_next_pass**\ (\ ) :ref:`🔗` Switches to the next draw pass. @@ -5036,7 +5036,7 @@ Switches to the next draw pass. .. rst-class:: classref-method -:ref:`PackedInt64Array` **draw_list_switch_to_next_pass_split**\ (\ splits\: :ref:`int`\ ) +:ref:`PackedInt64Array` **draw_list_switch_to_next_pass_split**\ (\ splits\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Split draw lists are used automatically by RenderingDevice. @@ -5050,7 +5050,7 @@ This method does nothing and always returns an empty :ref:`PackedInt64Array` **framebuffer_create**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) +:ref:`RID` **framebuffer_create**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) :ref:`🔗` Creates a new framebuffer. It can be accessed with the RID that is returned. @@ -5064,7 +5064,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **framebuffer_create_empty**\ (\ size\: :ref:`Vector2i`, samples\: :ref:`TextureSamples` = 0, validate_with_format\: :ref:`int` = -1\ ) +:ref:`RID` **framebuffer_create_empty**\ (\ size\: :ref:`Vector2i`, samples\: :ref:`TextureSamples` = 0, validate_with_format\: :ref:`int` = -1\ ) :ref:`🔗` Creates a new empty framebuffer. It can be accessed with the RID that is returned. @@ -5078,7 +5078,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **framebuffer_create_multipass**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) +:ref:`RID` **framebuffer_create_multipass**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) :ref:`🔗` Creates a new multipass framebuffer. It can be accessed with the RID that is returned. @@ -5092,7 +5092,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`int` **framebuffer_format_create**\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], view_count\: :ref:`int` = 1\ ) +:ref:`int` **framebuffer_format_create**\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], view_count\: :ref:`int` = 1\ ) :ref:`🔗` Creates a new framebuffer format with the specified ``attachments`` and ``view_count``. Returns the new framebuffer's unique framebuffer format ID. @@ -5106,7 +5106,7 @@ If ``view_count`` is greater than or equal to ``2``, enables multiview which is .. rst-class:: classref-method -:ref:`int` **framebuffer_format_create_empty**\ (\ samples\: :ref:`TextureSamples` = 0\ ) +:ref:`int` **framebuffer_format_create_empty**\ (\ samples\: :ref:`TextureSamples` = 0\ ) :ref:`🔗` Creates a new empty framebuffer format with the specified number of ``samples`` and returns its ID. @@ -5118,7 +5118,7 @@ Creates a new empty framebuffer format with the specified number of ``samples`` .. rst-class:: classref-method -:ref:`int` **framebuffer_format_create_multipass**\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], view_count\: :ref:`int` = 1\ ) +:ref:`int` **framebuffer_format_create_multipass**\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], view_count\: :ref:`int` = 1\ ) :ref:`🔗` Creates a multipass framebuffer format with the specified ``attachments``, ``passes`` and ``view_count`` and returns its ID. If ``view_count`` is greater than or equal to ``2``, enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension. @@ -5130,7 +5130,7 @@ Creates a multipass framebuffer format with the specified ``attachments``, ``pas .. rst-class:: classref-method -:ref:`TextureSamples` **framebuffer_format_get_texture_samples**\ (\ format\: :ref:`int`, render_pass\: :ref:`int` = 0\ ) +:ref:`TextureSamples` **framebuffer_format_get_texture_samples**\ (\ format\: :ref:`int`, render_pass\: :ref:`int` = 0\ ) :ref:`🔗` Returns the number of texture samples used for the given framebuffer ``format`` ID (returned by :ref:`framebuffer_get_format`). @@ -5142,7 +5142,7 @@ Returns the number of texture samples used for the given framebuffer ``format`` .. rst-class:: classref-method -:ref:`int` **framebuffer_get_format**\ (\ framebuffer\: :ref:`RID`\ ) +:ref:`int` **framebuffer_get_format**\ (\ framebuffer\: :ref:`RID`\ ) :ref:`🔗` Returns the format ID of the framebuffer specified by the ``framebuffer`` RID. This ID is guaranteed to be unique for the same formats and does not need to be freed. @@ -5154,7 +5154,7 @@ Returns the format ID of the framebuffer specified by the ``framebuffer`` RID. T .. rst-class:: classref-method -:ref:`bool` **framebuffer_is_valid**\ (\ framebuffer\: :ref:`RID`\ ) |const| +:ref:`bool` **framebuffer_is_valid**\ (\ framebuffer\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is valid, ``false`` otherwise. @@ -5166,7 +5166,7 @@ Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is vali .. rst-class:: classref-method -|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Tries to free an object in the RenderingDevice. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingDevice directly. @@ -5178,7 +5178,7 @@ Tries to free an object in the RenderingDevice. To avoid memory leaks, this shou .. rst-class:: classref-method -|void| **full_barrier**\ (\ ) +|void| **full_barrier**\ (\ ) :ref:`🔗` **Deprecated:** Barriers are automatically inserted by RenderingDevice. @@ -5192,7 +5192,7 @@ This method does nothing. .. rst-class:: classref-method -:ref:`int` **get_captured_timestamp_cpu_time**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_captured_timestamp_cpu_time**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the timestamp in CPU time for the rendering step specified by ``index`` (in microseconds since the engine started). See also :ref:`get_captured_timestamp_gpu_time` and :ref:`capture_timestamp`. @@ -5204,7 +5204,7 @@ Returns the timestamp in CPU time for the rendering step specified by ``index`` .. rst-class:: classref-method -:ref:`int` **get_captured_timestamp_gpu_time**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_captured_timestamp_gpu_time**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the timestamp in GPU time for the rendering step specified by ``index`` (in microseconds since the engine started). See also :ref:`get_captured_timestamp_cpu_time` and :ref:`capture_timestamp`. @@ -5216,7 +5216,7 @@ Returns the timestamp in GPU time for the rendering step specified by ``index`` .. rst-class:: classref-method -:ref:`String` **get_captured_timestamp_name**\ (\ index\: :ref:`int`\ ) |const| +:ref:`String` **get_captured_timestamp_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the timestamp's name for the rendering step specified by ``index``. See also :ref:`capture_timestamp`. @@ -5228,7 +5228,7 @@ Returns the timestamp's name for the rendering step specified by ``index``. See .. rst-class:: classref-method -:ref:`int` **get_captured_timestamps_count**\ (\ ) |const| +:ref:`int` **get_captured_timestamps_count**\ (\ ) |const| :ref:`🔗` Returns the total number of timestamps (rendering steps) available for profiling. @@ -5240,7 +5240,7 @@ Returns the total number of timestamps (rendering steps) available for profiling .. rst-class:: classref-method -:ref:`int` **get_captured_timestamps_frame**\ (\ ) |const| +:ref:`int` **get_captured_timestamps_frame**\ (\ ) |const| :ref:`🔗` Returns the index of the last frame rendered that has rendering timestamps available for querying. @@ -5252,7 +5252,7 @@ Returns the index of the last frame rendered that has rendering timestamps avail .. rst-class:: classref-method -:ref:`String` **get_device_name**\ (\ ) |const| +:ref:`String` **get_device_name**\ (\ ) |const| :ref:`🔗` Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equivalent to :ref:`RenderingServer.get_video_adapter_name`. See also :ref:`get_device_vendor_name`. @@ -5264,7 +5264,7 @@ Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equiv .. rst-class:: classref-method -:ref:`String` **get_device_pipeline_cache_uuid**\ (\ ) |const| +:ref:`String` **get_device_pipeline_cache_uuid**\ (\ ) |const| :ref:`🔗` Returns the universally unique identifier for the pipeline cache. This is used to cache shader files on disk, which avoids shader recompilations on subsequent engine runs. This UUID varies depending on the graphics card model, but also the driver version. Therefore, updating graphics drivers will invalidate the shader cache. @@ -5276,7 +5276,7 @@ Returns the universally unique identifier for the pipeline cache. This is used t .. rst-class:: classref-method -:ref:`String` **get_device_vendor_name**\ (\ ) |const| +:ref:`String` **get_device_vendor_name**\ (\ ) |const| :ref:`🔗` Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent to :ref:`RenderingServer.get_video_adapter_vendor`. See also :ref:`get_device_name`. @@ -5288,7 +5288,7 @@ Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent .. rst-class:: classref-method -:ref:`int` **get_driver_resource**\ (\ resource\: :ref:`DriverResource`, rid\: :ref:`RID`, index\: :ref:`int`\ ) +:ref:`int` **get_driver_resource**\ (\ resource\: :ref:`DriverResource`, rid\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` Returns the unique identifier of the driver ``resource`` for the specified ``rid``. Some driver resource types ignore the specified ``rid`` (see :ref:`DriverResource` descriptions). ``index`` is always ignored but must be specified anyway. @@ -5300,7 +5300,7 @@ Returns the unique identifier of the driver ``resource`` for the specified ``rid .. rst-class:: classref-method -:ref:`int` **get_frame_delay**\ (\ ) |const| +:ref:`int` **get_frame_delay**\ (\ ) |const| :ref:`🔗` Returns the frame count kept by the graphics API. Higher values result in higher input lag, but with more consistent throughput. For the main **RenderingDevice**, frames are cycled (usually 3 with triple-buffered V-Sync enabled). However, local **RenderingDevice**\ s only have 1 frame. @@ -5312,7 +5312,7 @@ Returns the frame count kept by the graphics API. Higher values result in higher .. rst-class:: classref-method -:ref:`int` **get_memory_usage**\ (\ type\: :ref:`MemoryType`\ ) |const| +:ref:`int` **get_memory_usage**\ (\ type\: :ref:`MemoryType`\ ) |const| :ref:`🔗` Returns the memory usage in bytes corresponding to the given ``type``. When using Vulkan, these statistics are calculated by `Vulkan Memory Allocator `__. @@ -5324,7 +5324,7 @@ Returns the memory usage in bytes corresponding to the given ``type``. When usin .. rst-class:: classref-method -:ref:`RID` **index_array_create**\ (\ index_buffer\: :ref:`RID`, index_offset\: :ref:`int`, index_count\: :ref:`int`\ ) +:ref:`RID` **index_array_create**\ (\ index_buffer\: :ref:`RID`, index_offset\: :ref:`int`, index_count\: :ref:`int`\ ) :ref:`🔗` Creates a new index array. It can be accessed with the RID that is returned. @@ -5338,7 +5338,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **index_buffer_create**\ (\ size_indices\: :ref:`int`, format\: :ref:`IndexBufferFormat`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_restart_indices\: :ref:`bool` = false\ ) +:ref:`RID` **index_buffer_create**\ (\ size_indices\: :ref:`int`, format\: :ref:`IndexBufferFormat`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_restart_indices\: :ref:`bool` = false\ ) :ref:`🔗` Creates a new index buffer. It can be accessed with the RID that is returned. @@ -5352,7 +5352,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`int` **limit_get**\ (\ limit\: :ref:`Limit`\ ) |const| +:ref:`int` **limit_get**\ (\ limit\: :ref:`Limit`\ ) |const| :ref:`🔗` Returns the value of the specified ``limit``. This limit varies depending on the current graphics hardware (and sometimes the driver version). If the given limit is exceeded, rendering errors will occur. @@ -5366,7 +5366,7 @@ Limits for various graphics hardware can be found in the `Vulkan Hardware Databa .. rst-class:: classref-method -:ref:`RID` **render_pipeline_create**\ (\ shader\: :ref:`RID`, framebuffer_format\: :ref:`int`, vertex_format\: :ref:`int`, primitive\: :ref:`RenderPrimitive`, rasterization_state\: :ref:`RDPipelineRasterizationState`, multisample_state\: :ref:`RDPipelineMultisampleState`, stencil_state\: :ref:`RDPipelineDepthStencilState`, color_blend_state\: :ref:`RDPipelineColorBlendState`, dynamic_state_flags\: |bitfield|\[:ref:`PipelineDynamicStateFlags`\] = 0, for_render_pass\: :ref:`int` = 0, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) +:ref:`RID` **render_pipeline_create**\ (\ shader\: :ref:`RID`, framebuffer_format\: :ref:`int`, vertex_format\: :ref:`int`, primitive\: :ref:`RenderPrimitive`, rasterization_state\: :ref:`RDPipelineRasterizationState`, multisample_state\: :ref:`RDPipelineMultisampleState`, stencil_state\: :ref:`RDPipelineDepthStencilState`, color_blend_state\: :ref:`RDPipelineColorBlendState`, dynamic_state_flags\: |bitfield|\[:ref:`PipelineDynamicStateFlags`\] = 0, for_render_pass\: :ref:`int` = 0, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) :ref:`🔗` Creates a new render pipeline. It can be accessed with the RID that is returned. @@ -5380,7 +5380,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **render_pipeline_is_valid**\ (\ render_pipeline\: :ref:`RID`\ ) +:ref:`bool` **render_pipeline_is_valid**\ (\ render_pipeline\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID is valid, ``false`` otherwise. @@ -5392,7 +5392,7 @@ Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID .. rst-class:: classref-method -:ref:`RID` **sampler_create**\ (\ state\: :ref:`RDSamplerState`\ ) +:ref:`RID` **sampler_create**\ (\ state\: :ref:`RDSamplerState`\ ) :ref:`🔗` Creates a new sampler. It can be accessed with the RID that is returned. @@ -5406,7 +5406,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **sampler_is_format_supported_for_filter**\ (\ format\: :ref:`DataFormat`, sampler_filter\: :ref:`SamplerFilter`\ ) |const| +:ref:`bool` **sampler_is_format_supported_for_filter**\ (\ format\: :ref:`DataFormat`, sampler_filter\: :ref:`SamplerFilter`\ ) |const| :ref:`🔗` Returns ``true`` if implementation supports using a texture of ``format`` with the given ``sampler_filter``. @@ -5418,7 +5418,7 @@ Returns ``true`` if implementation supports using a texture of ``format`` with t .. rst-class:: classref-method -:ref:`int` **screen_get_framebuffer_format**\ (\ screen\: :ref:`int` = 0\ ) |const| +:ref:`int` **screen_get_framebuffer_format**\ (\ screen\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the framebuffer format of the given screen. @@ -5432,7 +5432,7 @@ Returns the framebuffer format of the given screen. .. rst-class:: classref-method -:ref:`int` **screen_get_height**\ (\ screen\: :ref:`int` = 0\ ) |const| +:ref:`int` **screen_get_height**\ (\ screen\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the window height matching the graphics API context for the given window ID (in pixels). Despite the parameter being named ``screen``, this returns the *window* size. See also :ref:`screen_get_width`. @@ -5446,7 +5446,7 @@ Returns the window height matching the graphics API context for the given window .. rst-class:: classref-method -:ref:`int` **screen_get_width**\ (\ screen\: :ref:`int` = 0\ ) |const| +:ref:`int` **screen_get_width**\ (\ screen\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the window width matching the graphics API context for the given window ID (in pixels). Despite the parameter being named ``screen``, this returns the *window* size. See also :ref:`screen_get_height`. @@ -5460,7 +5460,7 @@ Returns the window width matching the graphics API context for the given window .. rst-class:: classref-method -|void| **set_resource_name**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) +|void| **set_resource_name**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` Sets the resource name for ``id`` to ``name``. This is used for debugging with third-party tools such as `RenderDoc `__. @@ -5476,7 +5476,7 @@ The following types of resources can be named: texture, sampler, vertex buffer, .. rst-class:: classref-method -:ref:`PackedByteArray` **shader_compile_binary_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) +:ref:`PackedByteArray` **shader_compile_binary_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) :ref:`🔗` Compiles a binary shader from ``spirv_data`` and returns the compiled binary data as a :ref:`PackedByteArray`. This compiled shader is specific to the GPU model and driver version used; it will not work on different GPU models or even different driver versions. See also :ref:`shader_compile_spirv_from_source`. @@ -5490,7 +5490,7 @@ Compiles a binary shader from ``spirv_data`` and returns the compiled binary dat .. rst-class:: classref-method -:ref:`RDShaderSPIRV` **shader_compile_spirv_from_source**\ (\ shader_source\: :ref:`RDShaderSource`, allow_cache\: :ref:`bool` = true\ ) +:ref:`RDShaderSPIRV` **shader_compile_spirv_from_source**\ (\ shader_source\: :ref:`RDShaderSource`, allow_cache\: :ref:`bool` = true\ ) :ref:`🔗` Compiles a SPIR-V from the shader source code in ``shader_source`` and returns the SPIR-V as a :ref:`RDShaderSPIRV`. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using :ref:`shader_compile_binary_from_spirv`. @@ -5504,7 +5504,7 @@ If ``allow_cache`` is ``true``, make use of the shader cache generated by Godot. .. rst-class:: classref-method -:ref:`RID` **shader_create_from_bytecode**\ (\ binary_data\: :ref:`PackedByteArray`, placeholder_rid\: :ref:`RID` = RID()\ ) +:ref:`RID` **shader_create_from_bytecode**\ (\ binary_data\: :ref:`PackedByteArray`, placeholder_rid\: :ref:`RID` = RID()\ ) :ref:`🔗` Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned. @@ -5518,7 +5518,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **shader_create_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) +:ref:`RID` **shader_create_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) :ref:`🔗` Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned. @@ -5532,7 +5532,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **shader_create_placeholder**\ (\ ) +:ref:`RID` **shader_create_placeholder**\ (\ ) :ref:`🔗` Create a placeholder RID by allocating an RID without initializing it for use in :ref:`shader_create_from_bytecode`. This allows you to create an RID for a shader and pass it around, but defer compiling the shader to a later time. @@ -5544,7 +5544,7 @@ Create a placeholder RID by allocating an RID without initializing it for use in .. rst-class:: classref-method -:ref:`int` **shader_get_vertex_input_attribute_mask**\ (\ shader\: :ref:`RID`\ ) +:ref:`int` **shader_get_vertex_input_attribute_mask**\ (\ shader\: :ref:`RID`\ ) :ref:`🔗` Returns the internal vertex input mask. Internally, the vertex input mask is an unsigned integer consisting of the locations (specified in GLSL via. ``layout(location = ...)``) of the input variables (specified in GLSL by the ``in`` keyword). @@ -5556,7 +5556,7 @@ Returns the internal vertex input mask. Internally, the vertex input mask is an .. rst-class:: classref-method -:ref:`RID` **storage_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), usage\: |bitfield|\[:ref:`StorageBufferUsage`\] = 0\ ) +:ref:`RID` **storage_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), usage\: |bitfield|\[:ref:`StorageBufferUsage`\] = 0\ ) :ref:`🔗` Creates a `storage buffer `__ with the specified ``data`` and ``usage``. It can be accessed with the RID that is returned. @@ -5570,7 +5570,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -|void| **submit**\ (\ ) +|void| **submit**\ (\ ) :ref:`🔗` Pushes the frame setup and draw command buffers then marks the local device as currently processing (which allows calling :ref:`sync`). @@ -5584,7 +5584,7 @@ Pushes the frame setup and draw command buffers then marks the local device as c .. rst-class:: classref-method -|void| **sync**\ (\ ) +|void| **sync**\ (\ ) :ref:`🔗` Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost. @@ -5600,7 +5600,7 @@ Forces a synchronization between the CPU and GPU, which may be required in certa .. rst-class:: classref-method -:ref:`RID` **texture_buffer_create**\ (\ size_bytes\: :ref:`int`, format\: :ref:`DataFormat`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) +:ref:`RID` **texture_buffer_create**\ (\ size_bytes\: :ref:`int`, format\: :ref:`DataFormat`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) :ref:`🔗` Creates a new texture buffer. It can be accessed with the RID that is returned. @@ -5614,7 +5614,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`Error` **texture_clear**\ (\ texture\: :ref:`RID`, color\: :ref:`Color`, base_mipmap\: :ref:`int`, mipmap_count\: :ref:`int`, base_layer\: :ref:`int`, layer_count\: :ref:`int`\ ) +:ref:`Error` **texture_clear**\ (\ texture\: :ref:`RID`, color\: :ref:`Color`, base_mipmap\: :ref:`int`, mipmap_count\: :ref:`int`, base_layer\: :ref:`int`, layer_count\: :ref:`int`\ ) :ref:`🔗` Clears the specified ``texture`` by replacing all of its pixels with the specified ``color``. ``base_mipmap`` and ``mipmap_count`` determine which mipmaps of the texture are affected by this clear operation, while ``base_layer`` and ``layer_count`` determine which layers of a 3D texture (or texture array) are affected by this clear operation. For 2D textures (which only have one layer by design), ``base_layer`` must be ``0`` and ``layer_count`` must be ``1``. @@ -5628,7 +5628,7 @@ Clears the specified ``texture`` by replacing all of its pixels with the specifi .. rst-class:: classref-method -:ref:`Error` **texture_copy**\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`, from_pos\: :ref:`Vector3`, to_pos\: :ref:`Vector3`, size\: :ref:`Vector3`, src_mipmap\: :ref:`int`, dst_mipmap\: :ref:`int`, src_layer\: :ref:`int`, dst_layer\: :ref:`int`\ ) +:ref:`Error` **texture_copy**\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`, from_pos\: :ref:`Vector3`, to_pos\: :ref:`Vector3`, size\: :ref:`Vector3`, src_mipmap\: :ref:`int`, dst_mipmap\: :ref:`int`, src_layer\: :ref:`int`, dst_layer\: :ref:`int`\ ) :ref:`🔗` Copies the ``from_texture`` to ``to_texture`` with the specified ``from_pos``, ``to_pos`` and ``size`` coordinates. The Z axis of the ``from_pos``, ``to_pos`` and ``size`` must be ``0`` for 2-dimensional textures. Source and destination mipmaps/layers must also be specified, with these parameters being ``0`` for textures without mipmaps or single-layer textures. Returns :ref:`@GlobalScope.OK` if the texture copy was successful or :ref:`@GlobalScope.ERR_INVALID_PARAMETER` otherwise. @@ -5650,7 +5650,7 @@ Copies the ``from_texture`` to ``to_texture`` with the specified ``from_pos``, ` .. rst-class:: classref-method -:ref:`RID` **texture_create**\ (\ format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, data\: :ref:`Array`\[:ref:`PackedByteArray`\] = []\ ) +:ref:`RID` **texture_create**\ (\ format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, data\: :ref:`Array`\[:ref:`PackedByteArray`\] = []\ ) :ref:`🔗` Creates a new texture. It can be accessed with the RID that is returned. @@ -5666,7 +5666,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) +:ref:`RID` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) :ref:`🔗` Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, ``format``, ``samples``, ``usage_flags``, ``width``, ``height``, ``depth``, and ``layers``. This can be used to allow Godot to render onto foreign images. @@ -5678,7 +5678,7 @@ Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, .. rst-class:: classref-method -:ref:`RID` **texture_create_shared**\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`\ ) +:ref:`RID` **texture_create_shared**\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`\ ) :ref:`🔗` Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``. @@ -5690,7 +5690,7 @@ Creates a shared texture using the specified ``view`` and the texture informatio .. rst-class:: classref-method -:ref:`RID` **texture_create_shared_from_slice**\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`, layer\: :ref:`int`, mipmap\: :ref:`int`, mipmaps\: :ref:`int` = 1, slice_type\: :ref:`TextureSliceType` = 0\ ) +:ref:`RID` **texture_create_shared_from_slice**\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`, layer\: :ref:`int`, mipmap\: :ref:`int`, mipmaps\: :ref:`int` = 1, slice_type\: :ref:`TextureSliceType` = 0\ ) :ref:`🔗` Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``'s ``layer`` and ``mipmap``. The number of included mipmaps from the original texture can be controlled using the ``mipmaps`` parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use :ref:`texture_create_shared`\ @@ -5706,7 +5706,7 @@ For 2D textures (which only have one layer), ``layer`` must be ``0``. .. rst-class:: classref-method -:ref:`PackedByteArray` **texture_get_data**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) +:ref:`PackedByteArray` **texture_get_data**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) :ref:`🔗` Returns the ``texture`` data for the specified ``layer`` as raw binary data. For 2D textures (which only have one layer), ``layer`` must be ``0``. @@ -5722,7 +5722,7 @@ Returns the ``texture`` data for the specified ``layer`` as raw binary data. For .. rst-class:: classref-method -:ref:`RDTextureFormat` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) +:ref:`RDTextureFormat` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) :ref:`🔗` Returns the data format used to create this texture. @@ -5734,7 +5734,7 @@ Returns the data format used to create this texture. .. rst-class:: classref-method -:ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`\ ) +:ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`\ ) :ref:`🔗` **Deprecated:** Use :ref:`get_driver_resource` with :ref:`DRIVER_RESOURCE_TEXTURE` instead. @@ -5750,7 +5750,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. rst-class:: classref-method -:ref:`bool` **texture_is_format_supported_for_usage**\ (\ format\: :ref:`DataFormat`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\]\ ) |const| +:ref:`bool` **texture_is_format_supported_for_usage**\ (\ format\: :ref:`DataFormat`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\]\ ) |const| :ref:`🔗` Returns ``true`` if the specified ``format`` is supported for the given ``usage_flags``, ``false`` otherwise. @@ -5762,7 +5762,7 @@ Returns ``true`` if the specified ``format`` is supported for the given ``usage_ .. rst-class:: classref-method -:ref:`bool` **texture_is_shared**\ (\ texture\: :ref:`RID`\ ) +:ref:`bool` **texture_is_shared**\ (\ texture\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RDTextureView`. @@ -5774,7 +5774,7 @@ Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RD .. rst-class:: classref-method -:ref:`bool` **texture_is_valid**\ (\ texture\: :ref:`RID`\ ) +:ref:`bool` **texture_is_valid**\ (\ texture\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the ``texture`` is valid, ``false`` otherwise. @@ -5786,7 +5786,7 @@ Returns ``true`` if the ``texture`` is valid, ``false`` otherwise. .. rst-class:: classref-method -:ref:`Error` **texture_resolve_multisample**\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`\ ) +:ref:`Error` **texture_resolve_multisample**\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`\ ) :ref:`🔗` Resolves the ``from_texture`` texture onto ``to_texture`` with multisample antialiasing enabled. This must be used when rendering a framebuffer for MSAA to work. Returns :ref:`@GlobalScope.OK` if successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER` otherwise. @@ -5812,7 +5812,7 @@ Resolves the ``from_texture`` texture onto ``to_texture`` with multisample antia .. rst-class:: classref-method -:ref:`Error` **texture_update**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +:ref:`Error` **texture_update**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Updates texture data with new data, replacing the previous data in place. The updated texture data must have the same dimensions and format. For 2D textures (which only have one layer), ``layer`` must be ``0``. Returns :ref:`@GlobalScope.OK` if the update was successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER` otherwise. @@ -5830,7 +5830,7 @@ Updates texture data with new data, replacing the previous data in place. The up .. rst-class:: classref-method -:ref:`RID` **uniform_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) +:ref:`RID` **uniform_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) :ref:`🔗` Creates a new uniform buffer. It can be accessed with the RID that is returned. @@ -5844,7 +5844,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **uniform_set_create**\ (\ uniforms\: :ref:`Array`\[:ref:`RDUniform`\], shader\: :ref:`RID`, shader_set\: :ref:`int`\ ) +:ref:`RID` **uniform_set_create**\ (\ uniforms\: :ref:`Array`\[:ref:`RDUniform`\], shader\: :ref:`RID`, shader_set\: :ref:`int`\ ) :ref:`🔗` Creates a new uniform set. It can be accessed with the RID that is returned. @@ -5858,7 +5858,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **uniform_set_is_valid**\ (\ uniform_set\: :ref:`RID`\ ) +:ref:`bool` **uniform_set_is_valid**\ (\ uniform_set\: :ref:`RID`\ ) :ref:`🔗` Checks if the ``uniform_set`` is valid, i.e. is owned. @@ -5870,7 +5870,7 @@ Checks if the ``uniform_set`` is valid, i.e. is owned. .. rst-class:: classref-method -:ref:`RID` **vertex_array_create**\ (\ vertex_count\: :ref:`int`, vertex_format\: :ref:`int`, src_buffers\: :ref:`Array`\[:ref:`RID`\], offsets\: :ref:`PackedInt64Array` = PackedInt64Array()\ ) +:ref:`RID` **vertex_array_create**\ (\ vertex_count\: :ref:`int`, vertex_format\: :ref:`int`, src_buffers\: :ref:`Array`\[:ref:`RID`\], offsets\: :ref:`PackedInt64Array` = PackedInt64Array()\ ) :ref:`🔗` Creates a vertex array based on the specified buffers. Optionally, ``offsets`` (in bytes) may be defined for each buffer. @@ -5882,7 +5882,7 @@ Creates a vertex array based on the specified buffers. Optionally, ``offsets`` ( .. rst-class:: classref-method -:ref:`RID` **vertex_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_as_storage\: :ref:`bool` = false\ ) +:ref:`RID` **vertex_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_as_storage\: :ref:`bool` = false\ ) :ref:`🔗` It can be accessed with the RID that is returned. @@ -5896,7 +5896,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`int` **vertex_format_create**\ (\ vertex_descriptions\: :ref:`Array`\[:ref:`RDVertexAttribute`\]\ ) +:ref:`int` **vertex_format_create**\ (\ vertex_descriptions\: :ref:`Array`\[:ref:`RDVertexAttribute`\]\ ) :ref:`🔗` Creates a new vertex format with the specified ``vertex_descriptions``. Returns a unique vertex format ID corresponding to the newly created vertex format. diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index d89eaad8bfb..21fd6d7b8fc 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -1063,7 +1063,7 @@ Signals .. rst-class:: classref-signal -**frame_post_draw**\ (\ ) +**frame_post_draw**\ (\ ) :ref:`🔗` Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports. @@ -1075,7 +1075,7 @@ Emitted at the end of the frame, after the RenderingServer has finished updating .. rst-class:: classref-signal -**frame_pre_draw**\ (\ ) +**frame_pre_draw**\ (\ ) :ref:`🔗` Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports. @@ -1092,7 +1092,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TextureLayeredType**: +enum **TextureLayeredType**: :ref:`🔗` .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY: @@ -1126,7 +1126,7 @@ Array of cubemap textures (see :ref:`CubemapArray`). .. rst-class:: classref-enumeration -enum **CubeMapLayer**: +enum **CubeMapLayer**: :ref:`🔗` .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT: @@ -1184,7 +1184,7 @@ Back face of a :ref:`Cubemap`. .. rst-class:: classref-enumeration -enum **ShaderMode**: +enum **ShaderMode**: :ref:`🔗` .. _class_RenderingServer_constant_SHADER_SPATIAL: @@ -1242,7 +1242,7 @@ Represents the size of the :ref:`ShaderMode` en .. rst-class:: classref-enumeration -enum **ArrayType**: +enum **ArrayType**: :ref:`🔗` .. _class_RenderingServer_constant_ARRAY_VERTEX: @@ -1364,7 +1364,7 @@ Represents the size of the :ref:`ArrayType` enum .. rst-class:: classref-enumeration -enum **ArrayCustomFormat**: +enum **ArrayCustomFormat**: :ref:`🔗` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM: @@ -1446,7 +1446,7 @@ Represents the size of the :ref:`ArrayCustomFormat` .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX: @@ -1760,7 +1760,7 @@ Flag used to isolate the bits used for mesh version after using :ref:`ARRAY_FLAG .. rst-class:: classref-enumeration -enum **PrimitiveType**: +enum **PrimitiveType**: :ref:`🔗` .. _class_RenderingServer_constant_PRIMITIVE_POINTS: @@ -1818,7 +1818,7 @@ Represents the size of the :ref:`PrimitiveType` .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED: @@ -1844,7 +1844,7 @@ Blend shapes are relative to base weight. .. rst-class:: classref-enumeration -enum **MultimeshTransformFormat**: +enum **MultimeshTransformFormat**: :ref:`🔗` .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D: @@ -1870,7 +1870,7 @@ Use :ref:`Transform3D` to store MultiMesh transform. .. rst-class:: classref-enumeration -enum **LightProjectorFilter**: +enum **LightProjectorFilter**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST: @@ -1928,7 +1928,7 @@ Linear filter for light projectors (use for non-pixel art light projectors). Ani .. rst-class:: classref-enumeration -enum **LightType**: +enum **LightType**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL: @@ -1962,7 +1962,7 @@ Spot light (see :ref:`SpotLight3D`). .. rst-class:: classref-enumeration -enum **LightParam**: +enum **LightParam**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY: @@ -2152,7 +2152,7 @@ Represents the size of the :ref:`LightParam` en .. rst-class:: classref-enumeration -enum **LightBakeMode**: +enum **LightBakeMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED: @@ -2186,7 +2186,7 @@ Light is taken into account in dynamic baking (:ref:`VoxelGI` and .. rst-class:: classref-enumeration -enum **LightOmniShadowMode**: +enum **LightOmniShadowMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID: @@ -2212,7 +2212,7 @@ Use a cubemap shadow map for omni lights. Slower but better quality than dual pa .. rst-class:: classref-enumeration -enum **LightDirectionalShadowMode**: +enum **LightDirectionalShadowMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL: @@ -2246,7 +2246,7 @@ Use 4 splits for shadow projection when using directional light. .. rst-class:: classref-enumeration -enum **LightDirectionalSkyMode**: +enum **LightDirectionalSkyMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY: @@ -2280,7 +2280,7 @@ Only use DirectionalLight3D in sky rendering. .. rst-class:: classref-enumeration -enum **ShadowQuality**: +enum **ShadowQuality**: :ref:`🔗` .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD: @@ -2348,7 +2348,7 @@ Represents the size of the :ref:`ShadowQuality` .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE: @@ -2374,7 +2374,7 @@ Reflection probe will update each frame. This mode is necessary to capture movin .. rst-class:: classref-enumeration -enum **ReflectionProbeAmbientMode**: +enum **ReflectionProbeAmbientMode**: :ref:`🔗` .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED: @@ -2408,7 +2408,7 @@ Apply custom ambient lighting inside the reflection probe's box defined by its s .. rst-class:: classref-enumeration -enum **DecalTexture**: +enum **DecalTexture**: :ref:`🔗` .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO: @@ -2458,7 +2458,7 @@ Represents the size of the :ref:`DecalTexture .. rst-class:: classref-enumeration -enum **DecalFilter**: +enum **DecalFilter**: :ref:`🔗` .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST: @@ -2516,7 +2516,7 @@ Linear filter for decals (use for non-pixel art decals). Anisotropic mipmaps are .. rst-class:: classref-enumeration -enum **VoxelGIQuality**: +enum **VoxelGIQuality**: :ref:`🔗` .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW: @@ -2542,7 +2542,7 @@ High :ref:`VoxelGI` rendering quality using 6 cones. .. rst-class:: classref-enumeration -enum **ParticlesMode**: +enum **ParticlesMode**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_MODE_2D: @@ -2568,7 +2568,7 @@ enum **ParticlesMode**: .. rst-class:: classref-enumeration -enum **ParticlesTransformAlign**: +enum **ParticlesTransformAlign**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED: @@ -2626,7 +2626,7 @@ enum **ParticlesTransformAlign**: .. rst-class:: classref-enumeration -enum **ParticlesDrawOrder**: +enum **ParticlesDrawOrder**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX: @@ -2668,7 +2668,7 @@ Sort particles based on their distance to the camera. .. rst-class:: classref-enumeration -enum **ParticlesCollisionType**: +enum **ParticlesCollisionType**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT: @@ -2762,7 +2762,7 @@ enum **ParticlesCollisionType**: .. rst-class:: classref-enumeration -enum **ParticlesCollisionHeightfieldResolution**: +enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256: @@ -2852,7 +2852,7 @@ Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution` .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID: @@ -2910,7 +2910,7 @@ Represents the size of the :ref:`FogVolumeShape` .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR: @@ -2952,7 +2952,7 @@ Represents the size of the :ref:`ViewportScaling3DMode` .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED: @@ -3002,7 +3002,7 @@ Always update the viewport's render target. .. rst-class:: classref-enumeration -enum **ViewportClearMode**: +enum **ViewportClearMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS: @@ -3036,7 +3036,7 @@ Clear the viewport's render target on the next frame, then switch to :ref:`VIEWP .. rst-class:: classref-enumeration -enum **ViewportEnvironmentMode**: +enum **ViewportEnvironmentMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED: @@ -3078,7 +3078,7 @@ Represents the size of the :ref:`ViewportEnvironmentMode` .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT: @@ -3128,7 +3128,7 @@ Represents the size of the :ref:`ViewportSDFOversize` .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT: @@ -3170,7 +3170,7 @@ Represents the size of the :ref:`ViewportSDFScale` .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED: @@ -3220,7 +3220,7 @@ Represents the size of the :ref:`ViewportMSAA .. rst-class:: classref-enumeration -enum **ViewportScreenSpaceAA**: +enum **ViewportScreenSpaceAA**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED: @@ -3254,7 +3254,7 @@ Represents the size of the :ref:`ViewportScreenSpaceAA` .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW: @@ -3288,7 +3288,7 @@ High occlusion culling BVH build quality (as defined by Embree). Results in the .. rst-class:: classref-enumeration -enum **ViewportRenderInfo**: +enum **ViewportRenderInfo**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME: @@ -3330,7 +3330,7 @@ Represents the size of the :ref:`ViewportRenderInfo` .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE: @@ -3372,7 +3372,7 @@ Represents the size of the :ref:`ViewportRenderInfoType` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED: @@ -3604,7 +3604,7 @@ Internal buffer is drawn instead of regular scene so you can see the per-pixel o .. rst-class:: classref-enumeration -enum **ViewportVRSMode**: +enum **ViewportVRSMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED: @@ -3646,7 +3646,7 @@ Represents the size of the :ref:`ViewportVRSMode` .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED: @@ -3688,7 +3688,7 @@ Represents the size of the :ref:`ViewportVRSUpdateMode` .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC: @@ -3732,7 +3732,7 @@ Uses the fast filtering algorithm to process the radiance map. In general this r .. rst-class:: classref-enumeration -enum **CompositorEffectFlags**: +enum **CompositorEffectFlags**: :ref:`🔗` .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR: @@ -3782,7 +3782,7 @@ The rendering effect requires specular data to be separated out (Forward+ only). .. rst-class:: classref-enumeration -enum **CompositorEffectCallbackType**: +enum **CompositorEffectCallbackType**: :ref:`🔗` .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE: @@ -3844,7 +3844,7 @@ The callback is called after our transparent rendering pass, but before any buil .. rst-class:: classref-enumeration -enum **EnvironmentBG**: +enum **EnvironmentBG**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR: @@ -3910,7 +3910,7 @@ Represents the size of the :ref:`EnvironmentBG` .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG: @@ -3952,7 +3952,7 @@ Gather ambient light from the :ref:`Sky` regardless of what the backg .. rst-class:: classref-enumeration -enum **EnvironmentReflectionSource**: +enum **EnvironmentReflectionSource**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG: @@ -3986,7 +3986,7 @@ Use the :ref:`Sky` for reflections regardless of what the background .. rst-class:: classref-enumeration -enum **EnvironmentGlowBlendMode**: +enum **EnvironmentGlowBlendMode**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE: @@ -4036,7 +4036,7 @@ Mixes the glow with the underlying color to avoid increasing brightness as much .. rst-class:: classref-enumeration -enum **EnvironmentFogMode**: +enum **EnvironmentFogMode**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_FOG_MODE_EXPONENTIAL: @@ -4062,7 +4062,7 @@ Use a simple fog model defined by start and end positions and a custom curve. Wh .. rst-class:: classref-enumeration -enum **EnvironmentToneMapper**: +enum **EnvironmentToneMapper**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR: @@ -4106,7 +4106,7 @@ Use the Academy Color Encoding System tonemapper. ACES is slightly more expensiv .. rst-class:: classref-enumeration -enum **EnvironmentSSRRoughnessQuality**: +enum **EnvironmentSSRRoughnessQuality**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED: @@ -4148,7 +4148,7 @@ High quality of roughness filter for screen-space reflections. This is the slowe .. rst-class:: classref-enumeration -enum **EnvironmentSSAOQuality**: +enum **EnvironmentSSAOQuality**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW: @@ -4198,7 +4198,7 @@ Highest quality screen-space ambient occlusion. Uses the adaptive target setting .. rst-class:: classref-enumeration -enum **EnvironmentSSILQuality**: +enum **EnvironmentSSILQuality**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW: @@ -4248,7 +4248,7 @@ Highest quality screen-space indirect lighting. Uses the adaptive target setting .. rst-class:: classref-enumeration -enum **EnvironmentSDFGIYScale**: +enum **EnvironmentSDFGIYScale**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT: @@ -4282,7 +4282,7 @@ Use 100% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be as tall a .. rst-class:: classref-enumeration -enum **EnvironmentSDFGIRayCount**: +enum **EnvironmentSDFGIRayCount**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4: @@ -4356,7 +4356,7 @@ Represents the size of the :ref:`EnvironmentSDFGIRayCount` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES: @@ -4422,7 +4422,7 @@ Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME: @@ -4480,7 +4480,7 @@ Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight` .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED: @@ -4522,7 +4522,7 @@ High subsurface scattering quality. This has the highest GPU requirements. .. rst-class:: classref-enumeration -enum **DOFBokehShape**: +enum **DOFBokehShape**: :ref:`🔗` .. _class_RenderingServer_constant_DOF_BOKEH_BOX: @@ -4556,7 +4556,7 @@ Calculates DOF blur using a circle shaped filter. Best quality and most realisti .. rst-class:: classref-enumeration -enum **DOFBlurQuality**: +enum **DOFBlurQuality**: :ref:`🔗` .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW: @@ -4598,7 +4598,7 @@ Highest quality DOF blur. Results in the smoothest looking blur by taking the mo .. rst-class:: classref-enumeration -enum **InstanceType**: +enum **InstanceType**: :ref:`🔗` .. _class_RenderingServer_constant_INSTANCE_NONE: @@ -4728,7 +4728,7 @@ A combination of the flags of geometry instances (mesh, multimesh, immediate and .. rst-class:: classref-enumeration -enum **InstanceFlags**: +enum **InstanceFlags**: :ref:`🔗` .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT: @@ -4778,7 +4778,7 @@ Represents the size of the :ref:`InstanceFlags` .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF: @@ -4820,7 +4820,7 @@ Only render the shadows from the object. The object itself will not be drawn. .. rst-class:: classref-enumeration -enum **VisibilityRangeFadeMode**: +enum **VisibilityRangeFadeMode**: :ref:`🔗` .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED: @@ -4854,7 +4854,7 @@ Fade-in the given instance's dependencies when reaching its visibility range lim .. rst-class:: classref-enumeration -enum **BakeChannels**: +enum **BakeChannels**: :ref:`🔗` .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA: @@ -4896,7 +4896,7 @@ Index of :ref:`Image` in array of :ref:`Image`\ s retu .. rst-class:: classref-enumeration -enum **CanvasTextureChannel**: +enum **CanvasTextureChannel**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE: @@ -4930,7 +4930,7 @@ Specular map canvas texture (:ref:`CanvasTexture.specular_texture` .. _class_RenderingServer_constant_NINE_PATCH_STRETCH: @@ -4964,7 +4964,7 @@ The nine patch gets filled with tiles where needed and stretches them a bit if n .. rst-class:: classref-enumeration -enum **CanvasItemTextureFilter**: +enum **CanvasItemTextureFilter**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT: @@ -5046,7 +5046,7 @@ Max value for :ref:`CanvasItemTextureFilter` .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT: @@ -5096,7 +5096,7 @@ Max value for :ref:`CanvasItemTextureRepeat` .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED: @@ -5142,7 +5142,7 @@ Parent is used for clipping child, but parent is also drawn underneath child as .. rst-class:: classref-enumeration -enum **CanvasLightMode**: +enum **CanvasLightMode**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT: @@ -5168,7 +5168,7 @@ enum **CanvasLightMode**: .. rst-class:: classref-enumeration -enum **CanvasLightBlendMode**: +enum **CanvasLightBlendMode**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD: @@ -5202,7 +5202,7 @@ The light adds color depending on transparency. .. rst-class:: classref-enumeration -enum **CanvasLightShadowFilter**: +enum **CanvasLightShadowFilter**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE: @@ -5244,7 +5244,7 @@ Max value of the :ref:`CanvasLightShadowFilter` .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED: @@ -5278,7 +5278,7 @@ Culling of the canvas occluder is counterclockwise. .. rst-class:: classref-enumeration -enum **GlobalShaderParameterType**: +enum **GlobalShaderParameterType**: :ref:`🔗` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL: @@ -5520,7 +5520,7 @@ Represents the size of the :ref:`GlobalShaderParameterType` .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME: @@ -5578,7 +5578,7 @@ Video memory used (in bytes). When using the Forward+ or mobile rendering backen .. rst-class:: classref-enumeration -enum **Features**: +enum **Features**: :ref:`🔗` .. _class_RenderingServer_constant_FEATURE_SHADERS: @@ -5613,7 +5613,7 @@ Constants .. rst-class:: classref-constant -**NO_INDEX_ARRAY** = ``-1`` +**NO_INDEX_ARRAY** = ``-1`` :ref:`🔗` Marks an error that shows that the index array is empty. @@ -5621,7 +5621,7 @@ Marks an error that shows that the index array is empty. .. rst-class:: classref-constant -**ARRAY_WEIGHTS_SIZE** = ``4`` +**ARRAY_WEIGHTS_SIZE** = ``4`` :ref:`🔗` Number of weights/bones per vertex. @@ -5629,7 +5629,7 @@ Number of weights/bones per vertex. .. rst-class:: classref-constant -**CANVAS_ITEM_Z_MIN** = ``-4096`` +**CANVAS_ITEM_Z_MIN** = ``-4096`` :ref:`🔗` The minimum Z-layer for canvas items. @@ -5637,7 +5637,7 @@ The minimum Z-layer for canvas items. .. rst-class:: classref-constant -**CANVAS_ITEM_Z_MAX** = ``4096`` +**CANVAS_ITEM_Z_MAX** = ``4096`` :ref:`🔗` The maximum Z-layer for canvas items. @@ -5645,7 +5645,7 @@ The maximum Z-layer for canvas items. .. rst-class:: classref-constant -**MAX_GLOW_LEVELS** = ``7`` +**MAX_GLOW_LEVELS** = ``7`` :ref:`🔗` The maximum number of glow levels that can be used with the glow post-processing effect. @@ -5653,7 +5653,7 @@ The maximum number of glow levels that can be used with the glow post-processing .. rst-class:: classref-constant -**MAX_CURSORS** = ``8`` +**MAX_CURSORS** = ``8`` :ref:`🔗` **Deprecated:** This constant is not used by the engine. @@ -5663,15 +5663,23 @@ The maximum number of glow levels that can be used with the glow post-processing .. rst-class:: classref-constant -**MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` +**MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` :ref:`🔗` The maximum number of directional lights that can be rendered at a given time in 2D. +.. _class_RenderingServer_constant_MAX_MESH_SURFACES: + +.. rst-class:: classref-constant + +**MAX_MESH_SURFACES** = ``256`` :ref:`🔗` + +The maximum number of surfaces a mesh can have. + .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN: .. rst-class:: classref-constant -**MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` +**MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` :ref:`🔗` The minimum renderpriority of all materials. @@ -5679,7 +5687,7 @@ The minimum renderpriority of all materials. .. rst-class:: classref-constant -**MATERIAL_RENDER_PRIORITY_MAX** = ``127`` +**MATERIAL_RENDER_PRIORITY_MAX** = ``127`` :ref:`🔗` The maximum renderpriority of all materials. @@ -5687,7 +5695,7 @@ The maximum renderpriority of all materials. .. rst-class:: classref-constant -**ARRAY_CUSTOM_COUNT** = ``4`` +**ARRAY_CUSTOM_COUNT** = ``4`` :ref:`🔗` The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`, :ref:`ARRAY_CUSTOM1`, :ref:`ARRAY_CUSTOM2`, :ref:`ARRAY_CUSTOM3`). @@ -5695,7 +5703,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0` .. container:: contribute @@ -5707,7 +5715,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0` .. container:: contribute @@ -5719,7 +5727,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0` .. container:: contribute @@ -5731,7 +5739,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0` .. container:: contribute @@ -5743,7 +5751,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0` .. container:: contribute @@ -5764,7 +5772,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **render_loop_enabled** +:ref:`bool` **render_loop_enabled** :ref:`🔗` .. rst-class:: classref-property-setget @@ -5786,7 +5794,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Image`\] **bake_render_uv2**\ (\ base\: :ref:`RID`, material_overrides\: :ref:`Array`\[:ref:`RID`\], image_size\: :ref:`Vector2i`\ ) +:ref:`Array`\[:ref:`Image`\] **bake_render_uv2**\ (\ base\: :ref:`RID`, material_overrides\: :ref:`Array`\[:ref:`RID`\], image_size\: :ref:`Vector2i`\ ) :ref:`🔗` Bakes the material data of the Mesh passed in the ``base`` parameter with optional ``material_overrides`` to a set of :ref:`Image`\ s of size ``image_size``. Returns an array of :ref:`Image`\ s containing material properties as specified in :ref:`BakeChannels`. @@ -5798,7 +5806,7 @@ Bakes the material data of the Mesh passed in the ``base`` parameter with option .. rst-class:: classref-method -|void| **call_on_render_thread**\ (\ callable\: :ref:`Callable`\ ) +|void| **call_on_render_thread**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` As the RenderingServer actual logic may run on an separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as :ref:`RenderingDevice` and similar RD classes), push a callable via this function so it will be executed on the render thread. @@ -5810,7 +5818,7 @@ As the RenderingServer actual logic may run on an separate thread, accessing its .. rst-class:: classref-method -:ref:`RID` **camera_attributes_create**\ (\ ) +:ref:`RID` **camera_attributes_create**\ (\ ) :ref:`🔗` Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_attributes_`` RenderingServer functions. @@ -5826,7 +5834,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **camera_attributes_set_auto_exposure**\ (\ camera_attributes\: :ref:`RID`, enable\: :ref:`bool`, min_sensitivity\: :ref:`float`, max_sensitivity\: :ref:`float`, speed\: :ref:`float`, scale\: :ref:`float`\ ) +|void| **camera_attributes_set_auto_exposure**\ (\ camera_attributes\: :ref:`RID`, enable\: :ref:`bool`, min_sensitivity\: :ref:`float`, max_sensitivity\: :ref:`float`, speed\: :ref:`float`, scale\: :ref:`float`\ ) :ref:`🔗` Sets the parameters to use with the auto-exposure effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributes` and :ref:`CameraAttributesPractical`. @@ -5838,7 +5846,7 @@ Sets the parameters to use with the auto-exposure effect. These parameters take .. rst-class:: classref-method -|void| **camera_attributes_set_dof_blur**\ (\ camera_attributes\: :ref:`RID`, far_enable\: :ref:`bool`, far_distance\: :ref:`float`, far_transition\: :ref:`float`, near_enable\: :ref:`bool`, near_distance\: :ref:`float`, near_transition\: :ref:`float`, amount\: :ref:`float`\ ) +|void| **camera_attributes_set_dof_blur**\ (\ camera_attributes\: :ref:`RID`, far_enable\: :ref:`bool`, far_distance\: :ref:`float`, far_transition\: :ref:`float`, near_enable\: :ref:`bool`, near_distance\: :ref:`float`, near_transition\: :ref:`float`, amount\: :ref:`float`\ ) :ref:`🔗` Sets the parameters to use with the DOF blur effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributesPractical`. @@ -5850,7 +5858,7 @@ Sets the parameters to use with the DOF blur effect. These parameters take on th .. rst-class:: classref-method -|void| **camera_attributes_set_dof_blur_bokeh_shape**\ (\ shape\: :ref:`DOFBokehShape`\ ) +|void| **camera_attributes_set_dof_blur_bokeh_shape**\ (\ shape\: :ref:`DOFBokehShape`\ ) :ref:`🔗` Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see :ref:`DOFBokehShape`. @@ -5862,7 +5870,7 @@ Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve .. rst-class:: classref-method -|void| **camera_attributes_set_dof_blur_quality**\ (\ quality\: :ref:`DOFBlurQuality`, use_jitter\: :ref:`bool`\ ) +|void| **camera_attributes_set_dof_blur_quality**\ (\ quality\: :ref:`DOFBlurQuality`, use_jitter\: :ref:`bool`\ ) :ref:`🔗` Sets the quality level of the DOF blur effect to one of the options in :ref:`DOFBlurQuality`. ``use_jitter`` can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy. @@ -5874,7 +5882,7 @@ Sets the quality level of the DOF blur effect to one of the options in :ref:`DOF .. rst-class:: classref-method -|void| **camera_attributes_set_exposure**\ (\ camera_attributes\: :ref:`RID`, multiplier\: :ref:`float`, normalization\: :ref:`float`\ ) +|void| **camera_attributes_set_exposure**\ (\ camera_attributes\: :ref:`RID`, multiplier\: :ref:`float`, normalization\: :ref:`float`\ ) :ref:`🔗` Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene. @@ -5900,7 +5908,7 @@ The exposure value can be calculated from aperture (in f-stops), shutter speed ( .. rst-class:: classref-method -:ref:`RID` **camera_create**\ (\ ) +:ref:`RID` **camera_create**\ (\ ) :ref:`🔗` Creates a 3D camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_*`` RenderingServer functions. @@ -5916,7 +5924,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID`, effects\: :ref:`RID`\ ) +|void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID`, effects\: :ref:`RID`\ ) :ref:`🔗` Sets the camera_attributes created with :ref:`camera_attributes_create` to the given camera. @@ -5928,7 +5936,7 @@ Sets the camera_attributes created with :ref:`camera_attributes_create`, compositor\: :ref:`RID`\ ) +|void| **camera_set_compositor**\ (\ camera\: :ref:`RID`, compositor\: :ref:`RID`\ ) :ref:`🔗` Sets the compositor used by this camera. Equivalent to :ref:`Camera3D.compositor`. @@ -5940,7 +5948,7 @@ Sets the compositor used by this camera. Equivalent to :ref:`Camera3D.compositor .. rst-class:: classref-method -|void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to :ref:`Camera3D.cull_mask`. @@ -5952,7 +5960,7 @@ Sets the cull mask associated with this camera. The cull mask describes which 3D .. rst-class:: classref-method -|void| **camera_set_environment**\ (\ camera\: :ref:`RID`, env\: :ref:`RID`\ ) +|void| **camera_set_environment**\ (\ camera\: :ref:`RID`, env\: :ref:`RID`\ ) :ref:`🔗` Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment`. @@ -5964,7 +5972,7 @@ Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environme .. rst-class:: classref-method -|void| **camera_set_frustum**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) +|void| **camera_set_frustum**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects. @@ -5976,7 +5984,7 @@ Sets camera to use frustum projection. This mode allows adjusting the ``offset`` .. rst-class:: classref-method -|void| **camera_set_orthogonal**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) +|void| **camera_set_orthogonal**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. @@ -5988,7 +5996,7 @@ Sets camera to use orthogonal projection, also known as orthographic projection. .. rst-class:: classref-method -|void| **camera_set_perspective**\ (\ camera\: :ref:`RID`, fovy_degrees\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) +|void| **camera_set_perspective**\ (\ camera\: :ref:`RID`, fovy_degrees\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away. @@ -6000,7 +6008,7 @@ Sets camera to use perspective projection. Objects on the screen becomes smaller .. rst-class:: classref-method -|void| **camera_set_transform**\ (\ camera\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) +|void| **camera_set_transform**\ (\ camera\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets :ref:`Transform3D` of camera. @@ -6012,7 +6020,7 @@ Sets :ref:`Transform3D` of camera. .. rst-class:: classref-method -|void| **camera_set_use_vertical_aspect**\ (\ camera\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **camera_set_use_vertical_aspect**\ (\ camera\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:`Camera3D.KEEP_WIDTH`. If ``false``, preserves the vertical aspect ratio which is equivalent to :ref:`Camera3D.KEEP_HEIGHT`. @@ -6024,7 +6032,7 @@ If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:` .. rst-class:: classref-method -:ref:`RID` **canvas_create**\ (\ ) +:ref:`RID` **canvas_create**\ (\ ) :ref:`🔗` Creates a canvas and returns the assigned :ref:`RID`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_*`` RenderingServer functions. @@ -6040,7 +6048,7 @@ Canvas has no :ref:`Resource` or :ref:`Node` equival .. rst-class:: classref-method -|void| **canvas_item_add_animation_slice**\ (\ item\: :ref:`RID`, animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) +|void| **canvas_item_add_animation_slice**\ (\ item\: :ref:`RID`, animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) :ref:`🔗` Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. @@ -6052,7 +6060,7 @@ Subsequent drawing commands will be ignored unless they fall within the specifie .. rst-class:: classref-method -|void| **canvas_item_add_circle**\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) +|void| **canvas_item_add_circle**\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a circle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_circle`. @@ -6064,7 +6072,7 @@ Draws a circle on the :ref:`CanvasItem` pointed to by the ``it .. rst-class:: classref-method -|void| **canvas_item_add_clip_ignore**\ (\ item\: :ref:`RID`, ignore\: :ref:`bool`\ ) +|void| **canvas_item_add_clip_ignore**\ (\ item\: :ref:`RID`, ignore\: :ref:`bool`\ ) :ref:`🔗` If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false. @@ -6076,7 +6084,7 @@ If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item .. rst-class:: classref-method -|void| **canvas_item_add_lcd_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`\ ) +|void| **canvas_item_add_lcd_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`\ ) :ref:`🔗` See also :ref:`CanvasItem.draw_lcd_texture_rect_region`. @@ -6088,7 +6096,7 @@ See also :ref:`CanvasItem.draw_lcd_texture_rect_region`, from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **canvas_item_add_line**\ (\ item\: :ref:`RID`, from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a line on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_line`. @@ -6100,7 +6108,7 @@ Draws a line on the :ref:`CanvasItem` pointed to by the ``item .. rst-class:: classref-method -|void| **canvas_item_add_mesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1), texture\: :ref:`RID` = RID()\ ) +|void| **canvas_item_add_mesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1), texture\: :ref:`RID` = RID()\ ) :ref:`🔗` Draws a mesh created with :ref:`mesh_create` with given ``transform``, ``modulate`` color, and ``texture``. This is used internally by :ref:`MeshInstance2D`. @@ -6112,7 +6120,7 @@ Draws a mesh created with :ref:`mesh_create`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, px_range\: :ref:`float` = 1.0, scale\: :ref:`float` = 1.0\ ) +|void| **canvas_item_add_msdf_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, px_range\: :ref:`float` = 1.0, scale\: :ref:`float` = 1.0\ ) :ref:`🔗` See also :ref:`CanvasItem.draw_msdf_texture_rect_region`. @@ -6124,7 +6132,7 @@ See also :ref:`CanvasItem.draw_msdf_texture_rect_region`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **canvas_item_add_multiline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a 2D multiline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_multiline` and :ref:`CanvasItem.draw_multiline_colors`. @@ -6136,7 +6144,7 @@ Draws a 2D multiline on the :ref:`CanvasItem` pointed to by th .. rst-class:: classref-method -|void| **canvas_item_add_multimesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, texture\: :ref:`RID` = RID()\ ) +|void| **canvas_item_add_multimesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, texture\: :ref:`RID` = RID()\ ) :ref:`🔗` Draws a 2D :ref:`MultiMesh` on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_multimesh`. @@ -6148,7 +6156,7 @@ Draws a 2D :ref:`MultiMesh` on the :ref:`CanvasItem`, rect\: :ref:`Rect2`, source\: :ref:`Rect2`, texture\: :ref:`RID`, topleft\: :ref:`Vector2`, bottomright\: :ref:`Vector2`, x_axis_mode\: :ref:`NinePatchAxisMode` = 0, y_axis_mode\: :ref:`NinePatchAxisMode` = 0, draw_center\: :ref:`bool` = true, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) +|void| **canvas_item_add_nine_patch**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, source\: :ref:`Rect2`, texture\: :ref:`RID`, topleft\: :ref:`Vector2`, bottomright\: :ref:`Vector2`, x_axis_mode\: :ref:`NinePatchAxisMode` = 0, y_axis_mode\: :ref:`NinePatchAxisMode` = 0, draw_center\: :ref:`bool` = true, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` Draws a nine-patch rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. @@ -6160,7 +6168,7 @@ Draws a nine-patch rectangle on the :ref:`CanvasItem` pointed .. rst-class:: classref-method -|void| **canvas_item_add_particles**\ (\ item\: :ref:`RID`, particles\: :ref:`RID`, texture\: :ref:`RID`\ ) +|void| **canvas_item_add_particles**\ (\ item\: :ref:`RID`, particles\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` Draws particles on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. @@ -6172,7 +6180,7 @@ Draws particles on the :ref:`CanvasItem` pointed to by the ``i .. rst-class:: classref-method -|void| **canvas_item_add_polygon**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`RID` = RID()\ ) +|void| **canvas_item_add_polygon**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`RID` = RID()\ ) :ref:`🔗` Draws a 2D polygon on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. If you need more flexibility (such as being able to use bones), use :ref:`canvas_item_add_triangle_array` instead. See also :ref:`CanvasItem.draw_polygon`. @@ -6184,7 +6192,7 @@ Draws a 2D polygon on the :ref:`CanvasItem` pointed to by the .. rst-class:: classref-method -|void| **canvas_item_add_polyline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) +|void| **canvas_item_add_polyline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_polyline` and :ref:`CanvasItem.draw_polyline_colors`. @@ -6196,7 +6204,7 @@ Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the .. rst-class:: classref-method -|void| **canvas_item_add_primitive**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`RID`\ ) +|void| **canvas_item_add_primitive**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`RID`\ ) :ref:`🔗` Draws a 2D primitive on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_primitive`. @@ -6208,7 +6216,7 @@ Draws a 2D primitive on the :ref:`CanvasItem` pointed to by th .. rst-class:: classref-method -|void| **canvas_item_add_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) +|void| **canvas_item_add_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws a rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_rect`. @@ -6220,7 +6228,7 @@ Draws a rectangle on the :ref:`CanvasItem` pointed to by the ` .. rst-class:: classref-method -|void| **canvas_item_add_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_item_add_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets a :ref:`Transform2D` that will be used to transform subsequent canvas item commands. @@ -6232,7 +6240,7 @@ Sets a :ref:`Transform2D` that will be used to transform subs .. rst-class:: classref-method -|void| **canvas_item_add_texture_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, tile\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) +|void| **canvas_item_add_texture_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, tile\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) :ref:`🔗` Draws a 2D textured rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_texture_rect` and :ref:`Texture2D.draw_rect`. @@ -6244,7 +6252,7 @@ Draws a 2D textured rectangle on the :ref:`CanvasItem` pointed .. rst-class:: classref-method -|void| **canvas_item_add_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) +|void| **canvas_item_add_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) :ref:`🔗` Draws the specified region of a 2D textured rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_texture_rect_region` and :ref:`Texture2D.draw_rect_region`. @@ -6256,7 +6264,7 @@ Draws the specified region of a 2D textured rectangle on the :ref:`CanvasItem`, indices\: :ref:`PackedInt32Array`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), bones\: :ref:`PackedInt32Array` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array` = PackedFloat32Array(), texture\: :ref:`RID` = RID(), count\: :ref:`int` = -1\ ) +|void| **canvas_item_add_triangle_array**\ (\ item\: :ref:`RID`, indices\: :ref:`PackedInt32Array`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), bones\: :ref:`PackedInt32Array` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array` = PackedFloat32Array(), texture\: :ref:`RID` = RID(), count\: :ref:`int` = -1\ ) :ref:`🔗` Draws a triangle array on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. This is internally used by :ref:`Line2D` and :ref:`StyleBoxFlat` for rendering. :ref:`canvas_item_add_triangle_array` is highly flexible, but more complex to use than :ref:`canvas_item_add_polygon`. @@ -6270,7 +6278,7 @@ Draws a triangle array on the :ref:`CanvasItem` pointed to by .. rst-class:: classref-method -|void| **canvas_item_clear**\ (\ item\: :ref:`RID`\ ) +|void| **canvas_item_clear**\ (\ item\: :ref:`RID`\ ) :ref:`🔗` Clears the :ref:`CanvasItem` and removes all commands in it. @@ -6282,7 +6290,7 @@ Clears the :ref:`CanvasItem` and removes all commands in it. .. rst-class:: classref-method -:ref:`RID` **canvas_item_create**\ (\ ) +:ref:`RID` **canvas_item_create**\ (\ ) :ref:`🔗` Creates a new CanvasItem instance and returns its :ref:`RID`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_item_*`` RenderingServer functions. @@ -6298,7 +6306,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **canvas_item_reset_physics_interpolation**\ (\ item\: :ref:`RID`\ ) +|void| **canvas_item_reset_physics_interpolation**\ (\ item\: :ref:`RID`\ ) :ref:`🔗` Prevents physics interpolation for the current physics tick. @@ -6312,7 +6320,7 @@ This is useful when moving a canvas item to a new location, to give an instantan .. rst-class:: classref-method -|void| **canvas_item_set_canvas_group_mode**\ (\ item\: :ref:`RID`, mode\: :ref:`CanvasGroupMode`, clear_margin\: :ref:`float` = 5.0, fit_empty\: :ref:`bool` = false, fit_margin\: :ref:`float` = 0.0, blur_mipmaps\: :ref:`bool` = false\ ) +|void| **canvas_item_set_canvas_group_mode**\ (\ item\: :ref:`RID`, mode\: :ref:`CanvasGroupMode`, clear_margin\: :ref:`float` = 5.0, fit_empty\: :ref:`bool` = false, fit_margin\: :ref:`float` = 0.0, blur_mipmaps\: :ref:`bool` = false\ ) :ref:`🔗` Sets the canvas group mode used during 2D rendering for the canvas item specified by the ``item`` RID. For faster but more limited clipping, use :ref:`canvas_item_set_clip` instead. @@ -6326,7 +6334,7 @@ Sets the canvas group mode used during 2D rendering for the canvas item specifie .. rst-class:: classref-method -|void| **canvas_item_set_clip**\ (\ item\: :ref:`RID`, clip\: :ref:`bool`\ ) +|void| **canvas_item_set_clip**\ (\ item\: :ref:`RID`, clip\: :ref:`bool`\ ) :ref:`🔗` If ``clip`` is ``true``, makes the canvas item specified by the ``item`` RID not draw anything outside of its rect's coordinates. This clipping is fast, but works only with axis-aligned rectangles. This means that rotation is ignored by the clipping rectangle. For more advanced clipping shapes, use :ref:`canvas_item_set_canvas_group_mode` instead. @@ -6340,7 +6348,7 @@ If ``clip`` is ``true``, makes the canvas item specified by the ``item`` RID not .. rst-class:: classref-method -|void| **canvas_item_set_copy_to_backbuffer**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`, rect\: :ref:`Rect2`\ ) +|void| **canvas_item_set_copy_to_backbuffer**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`, rect\: :ref:`Rect2`\ ) :ref:`🔗` Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. @@ -6352,7 +6360,7 @@ Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. .. rst-class:: classref-method -|void| **canvas_item_set_custom_rect**\ (\ item\: :ref:`RID`, use_custom_rect\: :ref:`bool`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) +|void| **canvas_item_set_custom_rect**\ (\ item\: :ref:`RID`, use_custom_rect\: :ref:`bool`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) :ref:`🔗` If ``use_custom_rect`` is ``true``, sets the custom visibility rectangle (used for culling) to ``rect`` for the canvas item specified by ``item``. Setting a custom visibility rect can reduce CPU load when drawing lots of 2D instances. If ``use_custom_rect`` is ``false``, automatically computes a visibility rectangle based on the canvas item's draw commands. @@ -6364,7 +6372,7 @@ If ``use_custom_rect`` is ``true``, sets the custom visibility rectangle (used f .. rst-class:: classref-method -|void| **canvas_item_set_default_texture_filter**\ (\ item\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) +|void| **canvas_item_set_default_texture_filter**\ (\ item\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` Sets the default texture filter mode for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.texture_filter`. @@ -6376,7 +6384,7 @@ Sets the default texture filter mode for the canvas item specified by the ``item .. rst-class:: classref-method -|void| **canvas_item_set_default_texture_repeat**\ (\ item\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) +|void| **canvas_item_set_default_texture_repeat**\ (\ item\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` Sets the default texture repeat mode for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.texture_repeat`. @@ -6388,7 +6396,7 @@ Sets the default texture repeat mode for the canvas item specified by the ``item .. rst-class:: classref-method -|void| **canvas_item_set_distance_field_mode**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_item_set_distance_field_mode**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, enables multichannel signed distance field rendering mode for the canvas item specified by the ``item`` RID. This is meant to be used for font rendering, or with specially generated images using `msdfgen `__. @@ -6400,7 +6408,7 @@ If ``enabled`` is ``true``, enables multichannel signed distance field rendering .. rst-class:: classref-method -|void| **canvas_item_set_draw_behind_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_item_set_draw_behind_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, draws the canvas item specified by the ``item`` RID behind its parent. Equivalent to :ref:`CanvasItem.show_behind_parent`. @@ -6412,7 +6420,7 @@ If ``enabled`` is ``true``, draws the canvas item specified by the ``item`` RID .. rst-class:: classref-method -|void| **canvas_item_set_draw_index**\ (\ item\: :ref:`RID`, index\: :ref:`int`\ ) +|void| **canvas_item_set_draw_index**\ (\ item\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` Sets the index for the :ref:`CanvasItem`. @@ -6424,7 +6432,7 @@ Sets the index for the :ref:`CanvasItem`. .. rst-class:: classref-method -|void| **canvas_item_set_interpolated**\ (\ item\: :ref:`RID`, interpolated\: :ref:`bool`\ ) +|void| **canvas_item_set_interpolated**\ (\ item\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` If ``interpolated`` is ``true``, turns on physics interpolation for the canvas item. @@ -6436,7 +6444,7 @@ If ``interpolated`` is ``true``, turns on physics interpolation for the canvas i .. rst-class:: classref-method -|void| **canvas_item_set_light_mask**\ (\ item\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **canvas_item_set_light_mask**\ (\ item\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask`. @@ -6448,7 +6456,7 @@ Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equiv .. rst-class:: classref-method -|void| **canvas_item_set_material**\ (\ item\: :ref:`RID`, material\: :ref:`RID`\ ) +|void| **canvas_item_set_material**\ (\ item\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material`. @@ -6460,7 +6468,7 @@ Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equiva .. rst-class:: classref-method -|void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Multiplies the color of the canvas item specified by the ``item`` RID, while affecting its children. See also :ref:`canvas_item_set_self_modulate`. Equivalent to :ref:`CanvasItem.modulate`. @@ -6472,7 +6480,7 @@ Multiplies the color of the canvas item specified by the ``item`` RID, while aff .. rst-class:: classref-method -|void| **canvas_item_set_parent**\ (\ item\: :ref:`RID`, parent\: :ref:`RID`\ ) +|void| **canvas_item_set_parent**\ (\ item\: :ref:`RID`, parent\: :ref:`RID`\ ) :ref:`🔗` Sets a parent :ref:`CanvasItem` to the :ref:`CanvasItem`. The item will inherit transform, modulation and visibility from its parent, like :ref:`CanvasItem` nodes in the scene tree. @@ -6484,7 +6492,7 @@ Sets a parent :ref:`CanvasItem` to the :ref:`CanvasItem`, color\: :ref:`Color`\ ) +|void| **canvas_item_set_self_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Multiplies the color of the canvas item specified by the ``item`` RID, without affecting its children. See also :ref:`canvas_item_set_modulate`. Equivalent to :ref:`CanvasItem.self_modulate`. @@ -6496,7 +6504,7 @@ Multiplies the color of the canvas item specified by the ``item`` RID, without a .. rst-class:: classref-method -|void| **canvas_item_set_sort_children_by_y**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_item_set_sort_children_by_y**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, child nodes with the lowest Y position are drawn before those with a higher Y position. Y-sorting only affects children that inherit from the canvas item specified by the ``item`` RID, not the canvas item itself. Equivalent to :ref:`CanvasItem.y_sort_enabled`. @@ -6508,7 +6516,7 @@ If ``enabled`` is ``true``, child nodes with the lowest Y position are drawn bef .. rst-class:: classref-method -|void| **canvas_item_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_item_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the ``transform`` of the canvas item specified by the ``item`` RID. This affects where and how the item will be drawn. Child canvas items' transforms are multiplied by their parent's transform. Equivalent to :ref:`Node2D.transform`. @@ -6520,7 +6528,7 @@ Sets the ``transform`` of the canvas item specified by the ``item`` RID. This af .. rst-class:: classref-method -|void| **canvas_item_set_use_parent_material**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_item_set_use_parent_material**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets if the :ref:`CanvasItem` uses its parent's material. @@ -6532,7 +6540,7 @@ Sets if the :ref:`CanvasItem` uses its parent's material. .. rst-class:: classref-method -|void| **canvas_item_set_visibility_layer**\ (\ item\: :ref:`RID`, visibility_layer\: :ref:`int`\ ) +|void| **canvas_item_set_visibility_layer**\ (\ item\: :ref:`RID`, visibility_layer\: :ref:`int`\ ) :ref:`🔗` Sets the rendering visibility layer associated with this :ref:`CanvasItem`. Only :ref:`Viewport` nodes with a matching rendering mask will render this :ref:`CanvasItem`. @@ -6544,7 +6552,7 @@ Sets the rendering visibility layer associated with this :ref:`CanvasItem`, enable\: :ref:`bool`, area\: :ref:`Rect2`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) +|void| **canvas_item_set_visibility_notifier**\ (\ item\: :ref:`RID`, enable\: :ref:`bool`, area\: :ref:`Rect2`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) :ref:`🔗` Sets the given :ref:`CanvasItem` as visibility notifier. ``area`` defines the area of detecting visibility. ``enter_callable`` is called when the :ref:`CanvasItem` enters the screen, ``exit_callable`` is called when the :ref:`CanvasItem` exits the screen. If ``enable`` is ``false``, the item will no longer function as notifier. @@ -6558,7 +6566,7 @@ This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D`, visible\: :ref:`bool`\ ) +|void| **canvas_item_set_visible**\ (\ item\: :ref:`RID`, visible\: :ref:`bool`\ ) :ref:`🔗` Sets the visibility of the :ref:`CanvasItem`. @@ -6570,7 +6578,7 @@ Sets the visibility of the :ref:`CanvasItem`. .. rst-class:: classref-method -|void| **canvas_item_set_z_as_relative_to_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_item_set_z_as_relative_to_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If this is enabled, the Z index of the parent will be added to the children's Z index. @@ -6582,7 +6590,7 @@ If this is enabled, the Z index of the parent will be added to the children's Z .. rst-class:: classref-method -|void| **canvas_item_set_z_index**\ (\ item\: :ref:`RID`, z_index\: :ref:`int`\ ) +|void| **canvas_item_set_z_index**\ (\ item\: :ref:`RID`, z_index\: :ref:`int`\ ) :ref:`🔗` Sets the :ref:`CanvasItem`'s Z index, i.e. its draw order (lower indexes are drawn first). @@ -6594,7 +6602,7 @@ Sets the :ref:`CanvasItem`'s Z index, i.e. its draw order (low .. rst-class:: classref-method -|void| **canvas_item_transform_physics_interpolation**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_item_transform_physics_interpolation**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Transforms both the current and previous stored transform for a canvas item. @@ -6608,7 +6616,7 @@ This allows transforming a canvas item without creating a "glitch" in the interp .. rst-class:: classref-method -|void| **canvas_light_attach_to_canvas**\ (\ light\: :ref:`RID`, canvas\: :ref:`RID`\ ) +|void| **canvas_light_attach_to_canvas**\ (\ light\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` Attaches the canvas light to the canvas. Removes it from its previous canvas. @@ -6620,7 +6628,7 @@ Attaches the canvas light to the canvas. Removes it from its previous canvas. .. rst-class:: classref-method -:ref:`RID` **canvas_light_create**\ (\ ) +:ref:`RID` **canvas_light_create**\ (\ ) :ref:`🔗` Creates a canvas light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_*`` RenderingServer functions. @@ -6636,7 +6644,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **canvas_light_occluder_attach_to_canvas**\ (\ occluder\: :ref:`RID`, canvas\: :ref:`RID`\ ) +|void| **canvas_light_occluder_attach_to_canvas**\ (\ occluder\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` Attaches a light occluder to the canvas. Removes it from its previous canvas. @@ -6648,7 +6656,7 @@ Attaches a light occluder to the canvas. Removes it from its previous canvas. .. rst-class:: classref-method -:ref:`RID` **canvas_light_occluder_create**\ (\ ) +:ref:`RID` **canvas_light_occluder_create**\ (\ ) :ref:`🔗` Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_occluder_*`` RenderingServer functions. @@ -6664,7 +6672,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **canvas_light_occluder_reset_physics_interpolation**\ (\ occluder\: :ref:`RID`\ ) +|void| **canvas_light_occluder_reset_physics_interpolation**\ (\ occluder\: :ref:`RID`\ ) :ref:`🔗` Prevents physics interpolation for the current physics tick. @@ -6678,7 +6686,7 @@ This is useful when moving an occluder to a new location, to give an instantaneo .. rst-class:: classref-method -|void| **canvas_light_occluder_set_as_sdf_collision**\ (\ occluder\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **canvas_light_occluder_set_as_sdf_collision**\ (\ occluder\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -6692,7 +6700,7 @@ This is useful when moving an occluder to a new location, to give an instantaneo .. rst-class:: classref-method -|void| **canvas_light_occluder_set_enabled**\ (\ occluder\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_light_occluder_set_enabled**\ (\ occluder\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables light occluder. @@ -6704,7 +6712,7 @@ Enables or disables light occluder. .. rst-class:: classref-method -|void| **canvas_light_occluder_set_interpolated**\ (\ occluder\: :ref:`RID`, interpolated\: :ref:`bool`\ ) +|void| **canvas_light_occluder_set_interpolated**\ (\ occluder\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` If ``interpolated`` is ``true``, turns on physics interpolation for the light occluder. @@ -6716,7 +6724,7 @@ If ``interpolated`` is ``true``, turns on physics interpolation for the light oc .. rst-class:: classref-method -|void| **canvas_light_occluder_set_light_mask**\ (\ occluder\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **canvas_light_occluder_set_light_mask**\ (\ occluder\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` The light mask. See :ref:`LightOccluder2D` for more information on light masks. @@ -6728,7 +6736,7 @@ The light mask. See :ref:`LightOccluder2D` for more infor .. rst-class:: classref-method -|void| **canvas_light_occluder_set_polygon**\ (\ occluder\: :ref:`RID`, polygon\: :ref:`RID`\ ) +|void| **canvas_light_occluder_set_polygon**\ (\ occluder\: :ref:`RID`, polygon\: :ref:`RID`\ ) :ref:`🔗` Sets a light occluder's polygon. @@ -6740,7 +6748,7 @@ Sets a light occluder's polygon. .. rst-class:: classref-method -|void| **canvas_light_occluder_set_transform**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_light_occluder_set_transform**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets a light occluder's :ref:`Transform2D`. @@ -6752,7 +6760,7 @@ Sets a light occluder's :ref:`Transform2D`. .. rst-class:: classref-method -|void| **canvas_light_occluder_transform_physics_interpolation**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_light_occluder_transform_physics_interpolation**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Transforms both the current and previous stored transform for a light occluder. @@ -6766,7 +6774,7 @@ This allows transforming an occluder without creating a "glitch" in the interpol .. rst-class:: classref-method -|void| **canvas_light_reset_physics_interpolation**\ (\ light\: :ref:`RID`\ ) +|void| **canvas_light_reset_physics_interpolation**\ (\ light\: :ref:`RID`\ ) :ref:`🔗` Prevents physics interpolation for the current physics tick. @@ -6780,7 +6788,7 @@ This is useful when moving a canvas item to a new location, to give an instantan .. rst-class:: classref-method -|void| **canvas_light_set_blend_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightBlendMode`\ ) +|void| **canvas_light_set_blend_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightBlendMode`\ ) :ref:`🔗` Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode` for options. Equivalent to :ref:`Light2D.blend_mode`. @@ -6792,7 +6800,7 @@ Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode`, color\: :ref:`Color`\ ) +|void| **canvas_light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color for a light. @@ -6804,7 +6812,7 @@ Sets the color for a light. .. rst-class:: classref-method -|void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables a canvas light. @@ -6816,7 +6824,7 @@ Enables or disables a canvas light. .. rst-class:: classref-method -|void| **canvas_light_set_energy**\ (\ light\: :ref:`RID`, energy\: :ref:`float`\ ) +|void| **canvas_light_set_energy**\ (\ light\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` Sets a canvas light's energy. @@ -6828,7 +6836,7 @@ Sets a canvas light's energy. .. rst-class:: classref-method -|void| **canvas_light_set_height**\ (\ light\: :ref:`RID`, height\: :ref:`float`\ ) +|void| **canvas_light_set_height**\ (\ light\: :ref:`RID`, height\: :ref:`float`\ ) :ref:`🔗` Sets a canvas light's height. @@ -6840,7 +6848,7 @@ Sets a canvas light's height. .. rst-class:: classref-method -|void| **canvas_light_set_interpolated**\ (\ light\: :ref:`RID`, interpolated\: :ref:`bool`\ ) +|void| **canvas_light_set_interpolated**\ (\ light\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` If ``interpolated`` is ``true``, turns on physics interpolation for the canvas light. @@ -6852,7 +6860,7 @@ If ``interpolated`` is ``true``, turns on physics interpolation for the canvas l .. rst-class:: classref-method -|void| **canvas_light_set_item_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **canvas_light_set_item_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` The light mask. See :ref:`LightOccluder2D` for more information on light masks. @@ -6864,7 +6872,7 @@ The light mask. See :ref:`LightOccluder2D` for more infor .. rst-class:: classref-method -|void| **canvas_light_set_item_shadow_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **canvas_light_set_item_shadow_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` The binary mask used to determine which layers this canvas light's shadows affects. See :ref:`LightOccluder2D` for more information on light masks. @@ -6876,7 +6884,7 @@ The binary mask used to determine which layers this canvas light's shadows affec .. rst-class:: classref-method -|void| **canvas_light_set_layer_range**\ (\ light\: :ref:`RID`, min_layer\: :ref:`int`, max_layer\: :ref:`int`\ ) +|void| **canvas_light_set_layer_range**\ (\ light\: :ref:`RID`, min_layer\: :ref:`int`, max_layer\: :ref:`int`\ ) :ref:`🔗` The layer range that gets rendered with this light. @@ -6888,7 +6896,7 @@ The layer range that gets rendered with this light. .. rst-class:: classref-method -|void| **canvas_light_set_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightMode`\ ) +|void| **canvas_light_set_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightMode`\ ) :ref:`🔗` The mode of the light, see :ref:`CanvasLightMode` constants. @@ -6900,7 +6908,7 @@ The mode of the light, see :ref:`CanvasLightMode`, color\: :ref:`Color`\ ) +|void| **canvas_light_set_shadow_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color of the canvas light's shadow. @@ -6912,7 +6920,7 @@ Sets the color of the canvas light's shadow. .. rst-class:: classref-method -|void| **canvas_light_set_shadow_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **canvas_light_set_shadow_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables the canvas light's shadow. @@ -6924,7 +6932,7 @@ Enables or disables the canvas light's shadow. .. rst-class:: classref-method -|void| **canvas_light_set_shadow_filter**\ (\ light\: :ref:`RID`, filter\: :ref:`CanvasLightShadowFilter`\ ) +|void| **canvas_light_set_shadow_filter**\ (\ light\: :ref:`RID`, filter\: :ref:`CanvasLightShadowFilter`\ ) :ref:`🔗` Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter` constants. @@ -6936,7 +6944,7 @@ Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter`, smooth\: :ref:`float`\ ) +|void| **canvas_light_set_shadow_smooth**\ (\ light\: :ref:`RID`, smooth\: :ref:`float`\ ) :ref:`🔗` Smoothens the shadow. The lower, the smoother. @@ -6948,7 +6956,7 @@ Smoothens the shadow. The lower, the smoother. .. rst-class:: classref-method -|void| **canvas_light_set_texture**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) +|void| **canvas_light_set_texture**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` Sets the texture to be used by a :ref:`PointLight2D`. Equivalent to :ref:`PointLight2D.texture`. @@ -6960,7 +6968,7 @@ Sets the texture to be used by a :ref:`PointLight2D`. Equiva .. rst-class:: classref-method -|void| **canvas_light_set_texture_offset**\ (\ light\: :ref:`RID`, offset\: :ref:`Vector2`\ ) +|void| **canvas_light_set_texture_offset**\ (\ light\: :ref:`RID`, offset\: :ref:`Vector2`\ ) :ref:`🔗` Sets the offset of a :ref:`PointLight2D`'s texture. Equivalent to :ref:`PointLight2D.offset`. @@ -6972,7 +6980,7 @@ Sets the offset of a :ref:`PointLight2D`'s texture. Equivale .. rst-class:: classref-method -|void| **canvas_light_set_texture_scale**\ (\ light\: :ref:`RID`, scale\: :ref:`float`\ ) +|void| **canvas_light_set_texture_scale**\ (\ light\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` Sets the scale factor of a :ref:`PointLight2D`'s texture. Equivalent to :ref:`PointLight2D.texture_scale`. @@ -6984,7 +6992,7 @@ Sets the scale factor of a :ref:`PointLight2D`'s texture. Eq .. rst-class:: classref-method -|void| **canvas_light_set_transform**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_light_set_transform**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the canvas light's :ref:`Transform2D`. @@ -6996,7 +7004,7 @@ Sets the canvas light's :ref:`Transform2D`. .. rst-class:: classref-method -|void| **canvas_light_set_z_range**\ (\ light\: :ref:`RID`, min_z\: :ref:`int`, max_z\: :ref:`int`\ ) +|void| **canvas_light_set_z_range**\ (\ light\: :ref:`RID`, min_z\: :ref:`int`, max_z\: :ref:`int`\ ) :ref:`🔗` Sets the Z range of objects that will be affected by this light. Equivalent to :ref:`Light2D.range_z_min` and :ref:`Light2D.range_z_max`. @@ -7008,7 +7016,7 @@ Sets the Z range of objects that will be affected by this light. Equivalent to : .. rst-class:: classref-method -|void| **canvas_light_transform_physics_interpolation**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **canvas_light_transform_physics_interpolation**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Transforms both the current and previous stored transform for a canvas light. @@ -7022,7 +7030,7 @@ This allows transforming a light without creating a "glitch" in the interpolatio .. rst-class:: classref-method -:ref:`RID` **canvas_occluder_polygon_create**\ (\ ) +:ref:`RID` **canvas_occluder_polygon_create**\ (\ ) :ref:`🔗` Creates a new light occluder polygon and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_occluder_polygon_*`` RenderingServer functions. @@ -7038,7 +7046,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **canvas_occluder_polygon_set_cull_mode**\ (\ occluder_polygon\: :ref:`RID`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) +|void| **canvas_occluder_polygon_set_cull_mode**\ (\ occluder_polygon\: :ref:`RID`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) :ref:`🔗` Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode` constants. @@ -7050,7 +7058,7 @@ Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode`, shape\: :ref:`PackedVector2Array`, closed\: :ref:`bool`\ ) +|void| **canvas_occluder_polygon_set_shape**\ (\ occluder_polygon\: :ref:`RID`, shape\: :ref:`PackedVector2Array`, closed\: :ref:`bool`\ ) :ref:`🔗` Sets the shape of the occluder polygon. @@ -7062,7 +7070,7 @@ Sets the shape of the occluder polygon. .. rst-class:: classref-method -|void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool`\ ) +|void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -7076,7 +7084,7 @@ Sets the shape of the occluder polygon. .. rst-class:: classref-method -|void| **canvas_set_item_mirroring**\ (\ canvas\: :ref:`RID`, item\: :ref:`RID`, mirroring\: :ref:`Vector2`\ ) +|void| **canvas_set_item_mirroring**\ (\ canvas\: :ref:`RID`, item\: :ref:`RID`, mirroring\: :ref:`Vector2`\ ) :ref:`🔗` A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. @@ -7088,7 +7096,7 @@ A copy of the canvas item will be drawn with a local offset of the mirroring :re .. rst-class:: classref-method -|void| **canvas_set_item_repeat**\ (\ item\: :ref:`RID`, repeat_size\: :ref:`Vector2`, repeat_times\: :ref:`int`\ ) +|void| **canvas_set_item_repeat**\ (\ item\: :ref:`RID`, repeat_size\: :ref:`Vector2`, repeat_times\: :ref:`int`\ ) :ref:`🔗` A copy of the canvas item will be drawn with a local offset of the ``repeat_size`` by the number of times of the ``repeat_times``. As the ``repeat_times`` increases, the copies will spread away from the origin texture. @@ -7100,7 +7108,7 @@ A copy of the canvas item will be drawn with a local offset of the ``repeat_size .. rst-class:: classref-method -|void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Modulates all colors in the given canvas. @@ -7112,7 +7120,7 @@ Modulates all colors in the given canvas. .. rst-class:: classref-method -|void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int`\ ) +|void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int`\ ) :ref:`🔗` Sets the :ref:`ProjectSettings.rendering/2d/shadow_atlas/size` to use for :ref:`Light2D` shadow rendering (in pixels). The value is rounded up to the nearest power of 2. @@ -7124,7 +7132,7 @@ Sets the :ref:`ProjectSettings.rendering/2d/shadow_atlas/size` **canvas_texture_create**\ (\ ) +:ref:`RID` **canvas_texture_create**\ (\ ) :ref:`🔗` Creates a canvas texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_texture_*`` RenderingServer functions. @@ -7140,7 +7148,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **canvas_texture_set_channel**\ (\ canvas_texture\: :ref:`RID`, channel\: :ref:`CanvasTextureChannel`, texture\: :ref:`RID`\ ) +|void| **canvas_texture_set_channel**\ (\ canvas_texture\: :ref:`RID`, channel\: :ref:`CanvasTextureChannel`, texture\: :ref:`RID`\ ) :ref:`🔗` Sets the ``channel``'s ``texture`` for the canvas texture specified by the ``canvas_texture`` RID. Equivalent to :ref:`CanvasTexture.diffuse_texture`, :ref:`CanvasTexture.normal_texture` and :ref:`CanvasTexture.specular_texture`. @@ -7152,7 +7160,7 @@ Sets the ``channel``'s ``texture`` for the canvas texture specified by the ``can .. rst-class:: classref-method -|void| **canvas_texture_set_shading_parameters**\ (\ canvas_texture\: :ref:`RID`, base_color\: :ref:`Color`, shininess\: :ref:`float`\ ) +|void| **canvas_texture_set_shading_parameters**\ (\ canvas_texture\: :ref:`RID`, base_color\: :ref:`Color`, shininess\: :ref:`float`\ ) :ref:`🔗` Sets the ``base_color`` and ``shininess`` to use for the canvas texture specified by the ``canvas_texture`` RID. Equivalent to :ref:`CanvasTexture.specular_color` and :ref:`CanvasTexture.specular_shininess`. @@ -7164,7 +7172,7 @@ Sets the ``base_color`` and ``shininess`` to use for the canvas texture specifie .. rst-class:: classref-method -|void| **canvas_texture_set_texture_filter**\ (\ canvas_texture\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) +|void| **canvas_texture_set_texture_filter**\ (\ canvas_texture\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID. @@ -7176,7 +7184,7 @@ Sets the texture ``filter`` mode to use for the canvas texture specified by the .. rst-class:: classref-method -|void| **canvas_texture_set_texture_repeat**\ (\ canvas_texture\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) +|void| **canvas_texture_set_texture_repeat**\ (\ canvas_texture\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID. @@ -7188,7 +7196,7 @@ Sets the texture ``repeat`` mode to use for the canvas texture specified by the .. rst-class:: classref-method -:ref:`RID` **compositor_create**\ (\ ) +:ref:`RID` **compositor_create**\ (\ ) :ref:`🔗` Creates a new compositor and adds it to the RenderingServer. It can be accessed with the RID that is returned. @@ -7202,7 +7210,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`RID` **compositor_effect_create**\ (\ ) +:ref:`RID` **compositor_effect_create**\ (\ ) :ref:`🔗` Creates a new rendering effect and adds it to the RenderingServer. It can be accessed with the RID that is returned. @@ -7216,7 +7224,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **compositor_effect_set_callback**\ (\ effect\: :ref:`RID`, callback_type\: :ref:`CompositorEffectCallbackType`, callback\: :ref:`Callable`\ ) +|void| **compositor_effect_set_callback**\ (\ effect\: :ref:`RID`, callback_type\: :ref:`CompositorEffectCallbackType`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the callback type (``callback_type``) and callback method(``callback``) for this rendering effect. @@ -7228,7 +7236,7 @@ Sets the callback type (``callback_type``) and callback method(``callback``) for .. rst-class:: classref-method -|void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables/disables this rendering effect. @@ -7240,7 +7248,7 @@ Enables/disables this rendering effect. .. rst-class:: classref-method -|void| **compositor_effect_set_flag**\ (\ effect\: :ref:`RID`, flag\: :ref:`CompositorEffectFlags`, set\: :ref:`bool`\ ) +|void| **compositor_effect_set_flag**\ (\ effect\: :ref:`RID`, flag\: :ref:`CompositorEffectFlags`, set\: :ref:`bool`\ ) :ref:`🔗` Sets the flag (``flag``) for this rendering effect to ``true`` or ``false`` (``set``). @@ -7252,7 +7260,7 @@ Sets the flag (``flag``) for this rendering effect to ``true`` or ``false`` (``s .. rst-class:: classref-method -|void| **compositor_set_compositor_effects**\ (\ compositor\: :ref:`RID`, effects\: :ref:`Array`\[:ref:`RID`\]\ ) +|void| **compositor_set_compositor_effects**\ (\ compositor\: :ref:`RID`, effects\: :ref:`Array`\[:ref:`RID`\]\ ) :ref:`🔗` Sets the compositor effects for the specified compositor RID. ``effects`` should be an array containing RIDs created with :ref:`compositor_effect_create`. @@ -7264,7 +7272,7 @@ Sets the compositor effects for the specified compositor RID. ``effects`` should .. rst-class:: classref-method -:ref:`RenderingDevice` **create_local_rendering_device**\ (\ ) |const| +:ref:`RenderingDevice` **create_local_rendering_device**\ (\ ) |const| :ref:`🔗` Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice. @@ -7278,7 +7286,7 @@ Creates a RenderingDevice that can be used to do draw and compute operations on .. rst-class:: classref-method -:ref:`Rect2` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID`\ ) +:ref:`Rect2` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID`\ ) :ref:`🔗` Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling. @@ -7292,7 +7300,7 @@ Returns the bounding rectangle for a canvas item in local space, as calculated b .. rst-class:: classref-method -:ref:`RID` **decal_create**\ (\ ) +:ref:`RID` **decal_create**\ (\ ) :ref:`🔗` Creates a decal and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``decal_*`` RenderingServer functions. @@ -7310,7 +7318,7 @@ To place in a scene, attach this decal to an instance using :ref:`instance_set_b .. rst-class:: classref-method -|void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID`, albedo_mix\: :ref:`float`\ ) +|void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID`, albedo_mix\: :ref:`float`\ ) :ref:`🔗` Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix`. @@ -7322,7 +7330,7 @@ Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent .. rst-class:: classref-method -|void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask`. @@ -7334,7 +7342,7 @@ Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent t .. rst-class:: classref-method -|void| **decal_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, length\: :ref:`float`\ ) +|void| **decal_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, length\: :ref:`float`\ ) :ref:`🔗` Sets the distance fade parameters in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.distance_fade_enabled`, :ref:`Decal.distance_fade_begin` and :ref:`Decal.distance_fade_length`. @@ -7346,7 +7354,7 @@ Sets the distance fade parameters in the decal specified by the ``decal`` RID. E .. rst-class:: classref-method -|void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID`, energy\: :ref:`float`\ ) +|void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy`. @@ -7358,7 +7366,7 @@ Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equiva .. rst-class:: classref-method -|void| **decal_set_fade**\ (\ decal\: :ref:`RID`, above\: :ref:`float`, below\: :ref:`float`\ ) +|void| **decal_set_fade**\ (\ decal\: :ref:`RID`, above\: :ref:`float`, below\: :ref:`float`\ ) :ref:`🔗` Sets the upper fade (``above``) and lower fade (``below``) in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.upper_fade` and :ref:`Decal.lower_fade`. @@ -7370,7 +7378,7 @@ Sets the upper fade (``above``) and lower fade (``below``) in the decal specifie .. rst-class:: classref-method -|void| **decal_set_modulate**\ (\ decal\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **decal_set_modulate**\ (\ decal\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate`. @@ -7382,7 +7390,7 @@ Sets the color multiplier in the decal specified by the ``decal`` RID to ``color .. rst-class:: classref-method -|void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID`, fade\: :ref:`float`\ ) +|void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID`, fade\: :ref:`float`\ ) :ref:`🔗` Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade`. @@ -7394,7 +7402,7 @@ Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent .. rst-class:: classref-method -|void| **decal_set_size**\ (\ decal\: :ref:`RID`, size\: :ref:`Vector3`\ ) +|void| **decal_set_size**\ (\ decal\: :ref:`RID`, size\: :ref:`Vector3`\ ) :ref:`🔗` Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size`. @@ -7406,7 +7414,7 @@ Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :re .. rst-class:: classref-method -|void| **decal_set_texture**\ (\ decal\: :ref:`RID`, type\: :ref:`DecalTexture`, texture\: :ref:`RID`\ ) +|void| **decal_set_texture**\ (\ decal\: :ref:`RID`, type\: :ref:`DecalTexture`, texture\: :ref:`RID`\ ) :ref:`🔗` Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture`. @@ -7418,7 +7426,7 @@ Sets the ``texture`` in the given texture ``type`` slot for the specified decal. .. rst-class:: classref-method -|void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter`\ ) +|void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter`\ ) :ref:`🔗` Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis. @@ -7430,7 +7438,7 @@ Sets the texture ``filter`` mode to use when rendering decals. This parameter is .. rst-class:: classref-method -:ref:`RID` **directional_light_create**\ (\ ) +:ref:`RID` **directional_light_create**\ (\ ) :ref:`🔗` Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions. @@ -7448,7 +7456,7 @@ To place in a scene, attach this directional light to an instance using :ref:`in .. rst-class:: classref-method -|void| **directional_shadow_atlas_set_size**\ (\ size\: :ref:`int`, is_16bits\: :ref:`bool`\ ) +|void| **directional_shadow_atlas_set_size**\ (\ size\: :ref:`int`, is_16bits\: :ref:`bool`\ ) :ref:`🔗` Sets the ``size`` of the directional light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/size`. This parameter is global and cannot be set on a per-viewport basis. @@ -7460,7 +7468,7 @@ Sets the ``size`` of the directional light shadows in 3D. See also :ref:`Project .. rst-class:: classref-method -|void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) +|void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) :ref:`🔗` Sets the filter ``quality`` for directional light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality`. This parameter is global and cannot be set on a per-viewport basis. @@ -7472,7 +7480,7 @@ Sets the filter ``quality`` for directional light shadows in 3D. See also :ref:` .. rst-class:: classref-method -:ref:`Image` **environment_bake_panorama**\ (\ environment\: :ref:`RID`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) +:ref:`Image` **environment_bake_panorama**\ (\ environment\: :ref:`RID`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Generates and returns an :ref:`Image` containing the radiance map for the specified ``environment`` RID's sky. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`sky_bake_panorama`. @@ -7488,7 +7496,7 @@ Generates and returns an :ref:`Image` containing the radiance map f .. rst-class:: classref-method -:ref:`RID` **environment_create**\ (\ ) +:ref:`RID` **environment_create**\ (\ ) :ref:`🔗` Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``environment_*`` RenderingServer functions. @@ -7504,7 +7512,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool`\ ) +|void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` If ``enable`` is ``true``, enables bicubic upscaling for glow which improves quality at the cost of performance. Equivalent to :ref:`ProjectSettings.rendering/environment/glow/upscale_mode`. @@ -7516,7 +7524,7 @@ If ``enable`` is ``true``, enables bicubic upscaling for glow which improves qua .. rst-class:: classref-method -|void| **environment_set_adjustment**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) +|void| **environment_set_adjustment**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) :ref:`🔗` Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment` for more details. @@ -7528,7 +7536,7 @@ Sets the values to be used with the "adjustments" post-process effect. See :ref: .. rst-class:: classref-method -|void| **environment_set_ambient_light**\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contibution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) +|void| **environment_set_ambient_light**\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contibution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) :ref:`🔗` Sets the values to be used for ambient light rendering. See :ref:`Environment` for more details. @@ -7540,7 +7548,7 @@ Sets the values to be used for ambient light rendering. See :ref:`Environment`, bg\: :ref:`EnvironmentBG`\ ) +|void| **environment_set_background**\ (\ env\: :ref:`RID`, bg\: :ref:`EnvironmentBG`\ ) :ref:`🔗` Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode`. @@ -7552,7 +7560,7 @@ Sets the environment's background mode. Equivalent to :ref:`Environment.backgrou .. rst-class:: classref-method -|void| **environment_set_bg_color**\ (\ env\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **environment_set_bg_color**\ (\ env\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Color displayed for clear areas of the scene. Only effective if using the :ref:`ENV_BG_COLOR` background mode. @@ -7564,7 +7572,7 @@ Color displayed for clear areas of the scene. Only effective if using the :ref:` .. rst-class:: classref-method -|void| **environment_set_bg_energy**\ (\ env\: :ref:`RID`, multiplier\: :ref:`float`, exposure_value\: :ref:`float`\ ) +|void| **environment_set_bg_energy**\ (\ env\: :ref:`RID`, multiplier\: :ref:`float`, exposure_value\: :ref:`float`\ ) :ref:`🔗` Sets the intensity of the background color. @@ -7576,7 +7584,7 @@ Sets the intensity of the background color. .. rst-class:: classref-method -|void| **environment_set_canvas_max_layer**\ (\ env\: :ref:`RID`, max_layer\: :ref:`int`\ ) +|void| **environment_set_canvas_max_layer**\ (\ env\: :ref:`RID`, max_layer\: :ref:`int`\ ) :ref:`🔗` Sets the maximum layer to use if using Canvas background mode. @@ -7588,7 +7596,7 @@ Sets the maximum layer to use if using Canvas background mode. .. rst-class:: classref-method -|void| **environment_set_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) +|void| **environment_set_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) :ref:`🔗` Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment` for more information. @@ -7600,7 +7608,7 @@ Configures fog for the specified environment RID. See ``fog_*`` properties in :r .. rst-class:: classref-method -|void| **environment_set_glow**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) +|void| **environment_set_glow**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) :ref:`🔗` Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment` for more information. @@ -7612,7 +7620,7 @@ Configures glow for the specified environment RID. See ``glow_*`` properties in .. rst-class:: classref-method -|void| **environment_set_sdfgi**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) +|void| **environment_set_sdfgi**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) :ref:`🔗` Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment` for more information. @@ -7624,7 +7632,7 @@ Configures signed distance field global illumination for the specified environme .. rst-class:: classref-method -|void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge`\ ) +|void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge`\ ) :ref:`🔗` Sets the number of frames to use for converging signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_converge`. @@ -7636,7 +7644,7 @@ Sets the number of frames to use for converging signed distance field global ill .. rst-class:: classref-method -|void| **environment_set_sdfgi_frames_to_update_light**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight`\ ) +|void| **environment_set_sdfgi_frames_to_update_light**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight`\ ) :ref:`🔗` Sets the update speed for dynamic lights' indirect lighting when computing signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights`. @@ -7648,7 +7656,7 @@ Sets the update speed for dynamic lights' indirect lighting when computing signe .. rst-class:: classref-method -|void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount`\ ) +|void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount`\ ) :ref:`🔗` Sets the number of rays to throw per frame when computing signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/probe_ray_count`. @@ -7660,7 +7668,7 @@ Sets the number of rays to throw per frame when computing signed distance field .. rst-class:: classref-method -|void| **environment_set_sky**\ (\ env\: :ref:`RID`, sky\: :ref:`RID`\ ) +|void| **environment_set_sky**\ (\ env\: :ref:`RID`, sky\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`Sky` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.sky`. @@ -7672,7 +7680,7 @@ Sets the :ref:`Sky` to be used as the environment's background when u .. rst-class:: classref-method -|void| **environment_set_sky_custom_fov**\ (\ env\: :ref:`RID`, scale\: :ref:`float`\ ) +|void| **environment_set_sky_custom_fov**\ (\ env\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` Sets a custom field of view for the background :ref:`Sky`. Equivalent to :ref:`Environment.sky_custom_fov`. @@ -7684,7 +7692,7 @@ Sets a custom field of view for the background :ref:`Sky`. Equivalent .. rst-class:: classref-method -|void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID`, orientation\: :ref:`Basis`\ ) +|void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID`, orientation\: :ref:`Basis`\ ) :ref:`🔗` Sets the rotation of the background :ref:`Sky` expressed as a :ref:`Basis`. Equivalent to :ref:`Environment.sky_rotation`, where the rotation vector is used to construct the :ref:`Basis`. @@ -7696,7 +7704,7 @@ Sets the rotation of the background :ref:`Sky` expressed as a :ref:`B .. rst-class:: classref-method -|void| **environment_set_ssao**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, radius\: :ref:`float`, intensity\: :ref:`float`, power\: :ref:`float`, detail\: :ref:`float`, horizon\: :ref:`float`, sharpness\: :ref:`float`, light_affect\: :ref:`float`, ao_channel_affect\: :ref:`float`\ ) +|void| **environment_set_ssao**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, radius\: :ref:`float`, intensity\: :ref:`float`, power\: :ref:`float`, detail\: :ref:`float`, horizon\: :ref:`float`, sharpness\: :ref:`float`, light_affect\: :ref:`float`, ao_channel_affect\: :ref:`float`\ ) :ref:`🔗` Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment` for more details. @@ -7708,7 +7716,7 @@ Sets the variables to be used with the screen-space ambient occlusion (SSAO) pos .. rst-class:: classref-method -|void| **environment_set_ssao_quality**\ (\ quality\: :ref:`EnvironmentSSAOQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) +|void| **environment_set_ssao_quality**\ (\ quality\: :ref:`EnvironmentSSAOQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) :ref:`🔗` Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment` for more details. @@ -7720,7 +7728,7 @@ Sets the quality level of the screen-space ambient occlusion (SSAO) post-process .. rst-class:: classref-method -|void| **environment_set_ssil_quality**\ (\ quality\: :ref:`EnvironmentSSILQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) +|void| **environment_set_ssil_quality**\ (\ quality\: :ref:`EnvironmentSSILQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) :ref:`🔗` Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment` for more details. @@ -7732,7 +7740,7 @@ Sets the quality level of the screen-space indirect lighting (SSIL) post-process .. rst-class:: classref-method -|void| **environment_set_ssr**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, max_steps\: :ref:`int`, fade_in\: :ref:`float`, fade_out\: :ref:`float`, depth_tolerance\: :ref:`float`\ ) +|void| **environment_set_ssr**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, max_steps\: :ref:`int`, fade_in\: :ref:`float`, fade_out\: :ref:`float`, depth_tolerance\: :ref:`float`\ ) :ref:`🔗` Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment` for more details. @@ -7744,7 +7752,7 @@ Sets the variables to be used with the screen-space reflections (SSR) post-proce .. rst-class:: classref-method -|void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality`\ ) +|void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality`\ ) :ref:`🔗` .. container:: contribute @@ -7758,7 +7766,7 @@ Sets the variables to be used with the screen-space reflections (SSR) post-proce .. rst-class:: classref-method -|void| **environment_set_tonemap**\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) +|void| **environment_set_tonemap**\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) :ref:`🔗` Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment` for more details. @@ -7770,7 +7778,7 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` .. rst-class:: classref-method -|void| **environment_set_volumetric_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) +|void| **environment_set_volumetric_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) :ref:`🔗` Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment` for more details. @@ -7782,7 +7790,7 @@ Sets the variables to be used with the volumetric fog post-process effect. See : .. rst-class:: classref-method -|void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool`\ ) +|void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. @@ -7794,7 +7802,7 @@ Enables filtering of the volumetric fog scattering buffer. This results in much .. rst-class:: classref-method -|void| **environment_set_volumetric_fog_volume_size**\ (\ size\: :ref:`int`, depth\: :ref:`int`\ ) +|void| **environment_set_volumetric_fog_volume_size**\ (\ size\: :ref:`int`, depth\: :ref:`int`\ ) :ref:`🔗` 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. @@ -7806,7 +7814,7 @@ Sets the resolution of the volumetric fog's froxel buffer. ``size`` is modified .. rst-class:: classref-method -:ref:`RID` **fog_volume_create**\ (\ ) +:ref:`RID` **fog_volume_create**\ (\ ) :ref:`🔗` Creates a new fog volume and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``fog_volume_*`` RenderingServer functions. @@ -7822,7 +7830,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID`, material\: :ref:`RID`\ ) +|void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` Sets the :ref:`Material` of the fog volume. Can be either a :ref:`FogMaterial` or a custom :ref:`ShaderMaterial`. @@ -7834,7 +7842,7 @@ Sets the :ref:`Material` of the fog volume. Can be either a :ref .. rst-class:: classref-method -|void| **fog_volume_set_shape**\ (\ fog_volume\: :ref:`RID`, shape\: :ref:`FogVolumeShape`\ ) +|void| **fog_volume_set_shape**\ (\ fog_volume\: :ref:`RID`, shape\: :ref:`FogVolumeShape`\ ) :ref:`🔗` Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_CONE`, :ref:`FOG_VOLUME_SHAPE_CYLINDER`, :ref:`FOG_VOLUME_SHAPE_BOX` or :ref:`FOG_VOLUME_SHAPE_WORLD`. @@ -7846,7 +7854,7 @@ Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, size\: :ref:`Vector3`\ ) +|void| **fog_volume_set_size**\ (\ fog_volume\: :ref:`RID`, size\: :ref:`Vector3`\ ) :ref:`🔗` Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_CONE`, :ref:`FOG_VOLUME_SHAPE_CYLINDER` or :ref:`FOG_VOLUME_SHAPE_BOX`. @@ -7858,7 +7866,7 @@ Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID` = true, frame_step\: :ref:`float` = 0.0\ ) +|void| **force_draw**\ (\ swap_buffers\: :ref:`bool` = true, frame_step\: :ref:`float` = 0.0\ ) :ref:`🔗` Forces redrawing of all viewports at once. Must be called from the main thread. @@ -7870,7 +7878,7 @@ Forces redrawing of all viewports at once. Must be called from the main thread. .. rst-class:: classref-method -|void| **force_sync**\ (\ ) +|void| **force_sync**\ (\ ) :ref:`🔗` Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost. @@ -7882,7 +7890,7 @@ Forces a synchronization between the CPU and GPU, which may be required in certa .. rst-class:: classref-method -|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Tries to free an object in the RenderingServer. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingServer directly. @@ -7894,7 +7902,7 @@ Tries to free an object in the RenderingServer. To avoid memory leaks, this shou .. rst-class:: classref-method -:ref:`Color` **get_default_clear_color**\ (\ ) +:ref:`Color` **get_default_clear_color**\ (\ ) :ref:`🔗` Returns the default clear color which is used when a specific clear color has not been selected. See also :ref:`set_default_clear_color`. @@ -7906,7 +7914,7 @@ Returns the default clear color which is used when a specific clear color has no .. rst-class:: classref-method -:ref:`float` **get_frame_setup_time_cpu**\ (\ ) |const| +:ref:`float` **get_frame_setup_time_cpu**\ (\ ) |const| :ref:`🔗` Returns the time taken to setup rendering on the CPU in milliseconds. This value is shared across all viewports and does *not* require :ref:`viewport_set_measure_render_time` to be enabled on a viewport to be queried. See also :ref:`viewport_get_measured_render_time_cpu`. @@ -7918,7 +7926,7 @@ Returns the time taken to setup rendering on the CPU in milliseconds. This value .. rst-class:: classref-method -:ref:`RenderingDevice` **get_rendering_device**\ (\ ) |const| +:ref:`RenderingDevice` **get_rendering_device**\ (\ ) |const| :ref:`🔗` Returns the global RenderingDevice. @@ -7932,7 +7940,7 @@ Returns the global RenderingDevice. .. rst-class:: classref-method -:ref:`int` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo`\ ) +:ref:`int` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo`\ ) :ref:`🔗` Returns a statistic about the rendering engine which can be used for performance profiling. See :ref:`RenderingInfo` for a list of values that can be queried. See also :ref:`viewport_get_render_info`, which returns information specific to a viewport. @@ -7956,7 +7964,7 @@ Returns a statistic about the rendering engine which can be used for performance .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_shader_parameter_list**\ (\ shader\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_shader_parameter_list**\ (\ shader\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the parameters of a shader. @@ -7968,7 +7976,7 @@ Returns the parameters of a shader. .. rst-class:: classref-method -:ref:`RID` **get_test_cube**\ (\ ) +:ref:`RID` **get_test_cube**\ (\ ) :ref:`🔗` Returns the RID of the test cube. This mesh will be created and returned on the first call to :ref:`get_test_cube`, then it will be cached for subsequent calls. See also :ref:`make_sphere_mesh`. @@ -7980,7 +7988,7 @@ Returns the RID of the test cube. This mesh will be created and returned on the .. rst-class:: classref-method -:ref:`RID` **get_test_texture**\ (\ ) +:ref:`RID` **get_test_texture**\ (\ ) :ref:`🔗` Returns the RID of a 256×256 texture with a testing pattern on it (in :ref:`Image.FORMAT_RGB8` format). This texture will be created and returned on the first call to :ref:`get_test_texture`, then it will be cached for subsequent calls. See also :ref:`get_white_texture`. @@ -8000,7 +8008,7 @@ Example of getting the test texture and applying it to a :ref:`Sprite2D` **get_video_adapter_api_version**\ (\ ) |const| +:ref:`String` **get_video_adapter_api_version**\ (\ ) |const| :ref:`🔗` Returns the version of the graphics video adapter *currently in use* (e.g. "1.2.189" for Vulkan, "3.3.0 NVIDIA 510.60.02" for OpenGL). This version may be different from the actual latest version supported by the hardware, as Godot may not always request the latest version. See also :ref:`OS.get_video_adapter_driver_info`. @@ -8014,7 +8022,7 @@ Returns the version of the graphics video adapter *currently in use* (e.g. "1.2. .. rst-class:: classref-method -:ref:`String` **get_video_adapter_name**\ (\ ) |const| +:ref:`String` **get_video_adapter_name**\ (\ ) |const| :ref:`🔗` Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). @@ -8030,7 +8038,7 @@ Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). .. rst-class:: classref-method -:ref:`DeviceType` **get_video_adapter_type**\ (\ ) |const| +:ref:`DeviceType` **get_video_adapter_type**\ (\ ) |const| :ref:`🔗` Returns the type of the video adapter. Since dedicated graphics cards from a given generation will *usually* be significantly faster than integrated graphics made in the same generation, the device type can be used as a basis for automatic graphics settings adjustment. However, this is not always true, so make sure to provide users with a way to manually override graphics settings. @@ -8044,7 +8052,7 @@ Returns the type of the video adapter. Since dedicated graphics cards from a giv .. rst-class:: classref-method -:ref:`String` **get_video_adapter_vendor**\ (\ ) |const| +:ref:`String` **get_video_adapter_vendor**\ (\ ) |const| :ref:`🔗` Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). @@ -8058,7 +8066,7 @@ Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). .. rst-class:: classref-method -:ref:`RID` **get_white_texture**\ (\ ) +:ref:`RID` **get_white_texture**\ (\ ) :ref:`🔗` Returns the ID of a 4×4 white texture (in :ref:`Image.FORMAT_RGB8` format). This texture will be created and returned on the first call to :ref:`get_white_texture`, then it will be cached for subsequent calls. See also :ref:`get_test_texture`. @@ -8078,7 +8086,7 @@ Example of getting the white texture and applying it to a :ref:`Sprite2D`\ ) +|void| **gi_set_use_half_resolution**\ (\ half_resolution\: :ref:`bool`\ ) :ref:`🔗` If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment.sdfgi_enabled`) buffers at halved resolution on each axis (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. :ref:`LightmapGI` rendering is not affected by this setting. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution`. @@ -8090,7 +8098,7 @@ If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SD .. rst-class:: classref-method -|void| **global_shader_parameter_add**\ (\ name\: :ref:`StringName`, type\: :ref:`GlobalShaderParameterType`, default_value\: :ref:`Variant`\ ) +|void| **global_shader_parameter_add**\ (\ name\: :ref:`StringName`, type\: :ref:`GlobalShaderParameterType`, default_value\: :ref:`Variant`\ ) :ref:`🔗` Creates a new global shader uniform. @@ -8104,7 +8112,7 @@ Creates a new global shader uniform. .. rst-class:: classref-method -:ref:`Variant` **global_shader_parameter_get**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **global_shader_parameter_get**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the value of the global shader uniform specified by ``name``. @@ -8118,7 +8126,7 @@ Returns the value of the global shader uniform specified by ``name``. .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **global_shader_parameter_get_list**\ (\ ) |const| +:ref:`Array`\[:ref:`StringName`\] **global_shader_parameter_get_list**\ (\ ) |const| :ref:`🔗` Returns the list of global shader uniform names. @@ -8132,7 +8140,7 @@ Returns the list of global shader uniform names. .. rst-class:: classref-method -:ref:`GlobalShaderParameterType` **global_shader_parameter_get_type**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`GlobalShaderParameterType` **global_shader_parameter_get_type**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the type associated to the global shader uniform specified by ``name``. @@ -8146,7 +8154,7 @@ Returns the type associated to the global shader uniform specified by ``name``. .. rst-class:: classref-method -|void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName`\ ) +|void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the global shader uniform specified by ``name``. @@ -8158,7 +8166,7 @@ Removes the global shader uniform specified by ``name``. .. rst-class:: classref-method -|void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the global shader uniform ``name`` to ``value``. @@ -8170,7 +8178,7 @@ Sets the global shader uniform ``name`` to ``value``. .. rst-class:: classref-method -|void| **global_shader_parameter_set_override**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **global_shader_parameter_set_override**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride` node. @@ -8182,7 +8190,7 @@ Overrides the global shader uniform ``name`` with ``value``. Equivalent to the : .. rst-class:: classref-method -:ref:`bool` **has_changed**\ (\ ) |const| +:ref:`bool` **has_changed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if changes have been made to the RenderingServer's data. :ref:`force_draw` is usually called if this happens. @@ -8194,7 +8202,7 @@ Returns ``true`` if changes have been made to the RenderingServer's data. :ref:` .. rst-class:: classref-method -:ref:`bool` **has_feature**\ (\ feature\: :ref:`Features`\ ) |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Features`\ ) |const| :ref:`🔗` **Deprecated:** This method has not been used since Godot 3.0. @@ -8208,7 +8216,7 @@ This method does nothing and always returns ``false``. .. rst-class:: classref-method -:ref:`bool` **has_os_feature**\ (\ feature\: :ref:`String`\ ) |const| +:ref:`bool` **has_os_feature**\ (\ feature\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``. @@ -8220,7 +8228,7 @@ Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s .. rst-class:: classref-method -|void| **instance_attach_object_instance_id**\ (\ instance\: :ref:`RID`, id\: :ref:`int`\ ) +|void| **instance_attach_object_instance_id**\ (\ instance\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with :ref:`instances_cull_aabb`, :ref:`instances_cull_convex`, and :ref:`instances_cull_ray`. @@ -8232,7 +8240,7 @@ Attaches a unique Object ID to instance. Object ID must be attached to instance .. rst-class:: classref-method -|void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID`, skeleton\: :ref:`RID`\ ) +|void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID`, skeleton\: :ref:`RID`\ ) :ref:`🔗` Attaches a skeleton to an instance. Removes the previous skeleton from the instance. @@ -8244,7 +8252,7 @@ Attaches a skeleton to an instance. Removes the previous skeleton from the insta .. rst-class:: classref-method -:ref:`RID` **instance_create**\ (\ ) +:ref:`RID` **instance_create**\ (\ ) :ref:`🔗` Creates a visual instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions. @@ -8262,7 +8270,7 @@ An instance is a way of placing a 3D object in the scenario. Objects like partic .. rst-class:: classref-method -:ref:`RID` **instance_create2**\ (\ base\: :ref:`RID`, scenario\: :ref:`RID`\ ) +:ref:`RID` **instance_create2**\ (\ base\: :ref:`RID`, scenario\: :ref:`RID`\ ) :ref:`🔗` Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions. @@ -8276,7 +8284,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Variant` **instance_geometry_get_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| +:ref:`Variant` **instance_geometry_get_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the value of the per-instance shader uniform from the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter`. @@ -8290,7 +8298,7 @@ Returns the value of the per-instance shader uniform from the specified 3D geome .. rst-class:: classref-method -:ref:`Variant` **instance_geometry_get_shader_parameter_default_value**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| +:ref:`Variant` **instance_geometry_get_shader_parameter_default_value**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the default value of the per-instance shader uniform from the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter`. @@ -8302,7 +8310,7 @@ Returns the default value of the per-instance shader uniform from the specified .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **instance_geometry_get_shader_parameter_list**\ (\ instance\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **instance_geometry_get_shader_parameter_list**\ (\ instance\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a dictionary of per-instance shader uniform names of the per-instance shader uniform from the specified 3D geometry instance. The returned dictionary is in PropertyInfo format, with the keys ``name``, ``class_name``, ``type``, ``hint``, ``hint_string`` and ``usage``. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter`. @@ -8314,7 +8322,7 @@ Returns a dictionary of per-instance shader uniform names of the per-instance sh .. rst-class:: classref-method -|void| **instance_geometry_set_cast_shadows_setting**\ (\ instance\: :ref:`RID`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) +|void| **instance_geometry_set_cast_shadows_setting**\ (\ instance\: :ref:`RID`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) :ref:`🔗` Sets the shadow casting setting to one of :ref:`ShadowCastingSetting`. Equivalent to :ref:`GeometryInstance3D.cast_shadow`. @@ -8326,7 +8334,7 @@ Sets the shadow casting setting to one of :ref:`ShadowCastingSetting`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) +|void| **instance_geometry_set_flag**\ (\ instance\: :ref:`RID`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets the flag for a given :ref:`InstanceFlags`. See :ref:`InstanceFlags` for more details. @@ -8338,7 +8346,7 @@ Sets the flag for a given :ref:`InstanceFlags`, lightmap\: :ref:`RID`, lightmap_uv_scale\: :ref:`Rect2`, lightmap_slice\: :ref:`int`\ ) +|void| **instance_geometry_set_lightmap**\ (\ instance\: :ref:`RID`, lightmap\: :ref:`RID`, lightmap_uv_scale\: :ref:`Rect2`, lightmap_slice\: :ref:`int`\ ) :ref:`🔗` Sets the lightmap GI instance to use for the specified 3D geometry instance. The lightmap UV scale for the specified instance (equivalent to :ref:`GeometryInstance3D.gi_lightmap_scale`) and lightmap atlas slice must also be specified. @@ -8350,7 +8358,7 @@ Sets the lightmap GI instance to use for the specified 3D geometry instance. The .. rst-class:: classref-method -|void| **instance_geometry_set_lod_bias**\ (\ instance\: :ref:`RID`, lod_bias\: :ref:`float`\ ) +|void| **instance_geometry_set_lod_bias**\ (\ instance\: :ref:`RID`, lod_bias\: :ref:`float`\ ) :ref:`🔗` Sets the level of detail bias to use when rendering the specified 3D geometry instance. Higher values result in higher detail from further away. Equivalent to :ref:`GeometryInstance3D.lod_bias`. @@ -8362,7 +8370,7 @@ Sets the level of detail bias to use when rendering the specified 3D geometry in .. rst-class:: classref-method -|void| **instance_geometry_set_material_overlay**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) +|void| **instance_geometry_set_material_overlay**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_overlay`. @@ -8374,7 +8382,7 @@ Sets a material that will be rendered for all surfaces on top of active material .. rst-class:: classref-method -|void| **instance_geometry_set_material_override**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) +|void| **instance_geometry_set_material_override**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_override`. @@ -8386,7 +8394,7 @@ Sets a material that will override the material for all surfaces on the mesh ass .. rst-class:: classref-method -|void| **instance_geometry_set_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **instance_geometry_set_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the per-instance shader uniform on the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.set_instance_shader_parameter`. @@ -8398,7 +8406,7 @@ Sets the per-instance shader uniform on the specified 3D geometry instance. Equi .. rst-class:: classref-method -|void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID`, transparency\: :ref:`float`\ ) +|void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID`, transparency\: :ref:`float`\ ) :ref:`🔗` Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency`. @@ -8416,7 +8424,7 @@ In spatial shaders, ``1.0 - transparency`` is set as the default value of the `` .. rst-class:: classref-method -|void| **instance_geometry_set_visibility_range**\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) +|void| **instance_geometry_set_visibility_range**\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) :ref:`🔗` Sets the visibility range values for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.visibility_range_begin` and related properties. @@ -8428,7 +8436,7 @@ Sets the visibility range values for the given geometry instance. Equivalent to .. rst-class:: classref-method -|void| **instance_set_base**\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) +|void| **instance_set_base**\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) :ref:`🔗` Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, particle system, reflection probe, decal, lightmap, voxel GI and visibility notifiers are all types that can be set as the base of an instance in order to be displayed in the scenario. @@ -8440,7 +8448,7 @@ Sets the base of the instance. A base can be any of the 3D objects that are crea .. rst-class:: classref-method -|void| **instance_set_blend_shape_weight**\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) +|void| **instance_set_blend_shape_weight**\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) :ref:`🔗` Sets the weight for a given blend shape associated with this instance. @@ -8452,7 +8460,7 @@ Sets the weight for a given blend shape associated with this instance. .. rst-class:: classref-method -|void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID`, aabb\: :ref:`AABB`\ ) +|void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` Sets a custom AABB to use when culling objects from the view frustum. Equivalent to setting :ref:`GeometryInstance3D.custom_aabb`. @@ -8464,7 +8472,7 @@ Sets a custom AABB to use when culling objects from the view frustum. Equivalent .. rst-class:: classref-method -|void| **instance_set_extra_visibility_margin**\ (\ instance\: :ref:`RID`, margin\: :ref:`float`\ ) +|void| **instance_set_extra_visibility_margin**\ (\ instance\: :ref:`RID`, margin\: :ref:`float`\ ) :ref:`🔗` Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to :ref:`GeometryInstance3D.extra_cull_margin`. @@ -8476,7 +8484,7 @@ Sets a margin to increase the size of the AABB when culling objects from the vie .. rst-class:: classref-method -|void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, ignores both frustum and occlusion culling on the specified 3D geometry instance. This is not the same as :ref:`GeometryInstance3D.ignore_occlusion_culling`, which only ignores occlusion culling and leaves frustum culling intact. @@ -8488,7 +8496,7 @@ If ``true``, ignores both frustum and occlusion culling on the specified 3D geom .. rst-class:: classref-method -|void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers`. @@ -8500,7 +8508,7 @@ Sets the render layers that this instance will be drawn to. Equivalent to :ref:` .. rst-class:: classref-method -|void| **instance_set_pivot_data**\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) +|void| **instance_set_pivot_data**\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) :ref:`🔗` Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting. @@ -8512,7 +8520,7 @@ Sets the sorting offset and switches between using the bounding box or instance .. rst-class:: classref-method -|void| **instance_set_scenario**\ (\ instance\: :ref:`RID`, scenario\: :ref:`RID`\ ) +|void| **instance_set_scenario**\ (\ instance\: :ref:`RID`, scenario\: :ref:`RID`\ ) :ref:`🔗` Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in. @@ -8524,7 +8532,7 @@ Sets the scenario that the instance is in. The scenario is the 3D world that the .. rst-class:: classref-method -|void| **instance_set_surface_override_material**\ (\ instance\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) +|void| **instance_set_surface_override_material**\ (\ instance\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) :ref:`🔗` Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material`. @@ -8536,7 +8544,7 @@ Sets the override material of a specific surface. Equivalent to :ref:`MeshInstan .. rst-class:: classref-method -|void| **instance_set_transform**\ (\ instance\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) +|void| **instance_set_transform**\ (\ instance\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the world space transform of the instance. Equivalent to :ref:`Node3D.global_transform`. @@ -8548,7 +8556,7 @@ Sets the world space transform of the instance. Equivalent to :ref:`Node3D.globa .. rst-class:: classref-method -|void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID`, parent\: :ref:`RID`\ ) +|void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID`, parent\: :ref:`RID`\ ) :ref:`🔗` Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent`. @@ -8560,7 +8568,7 @@ Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.vi .. rst-class:: classref-method -|void| **instance_set_visible**\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) +|void| **instance_set_visible**\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) :ref:`🔗` Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible`. @@ -8572,7 +8580,7 @@ Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible` **instances_cull_aabb**\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| +:ref:`PackedInt64Array` **instances_cull_aabb**\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| :ref:`🔗` Returns an array of object IDs intersecting with the provided AABB. Only 3D nodes that inherit from :ref:`VisualInstance3D` are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -8586,7 +8594,7 @@ Returns an array of object IDs intersecting with the provided AABB. Only 3D node .. rst-class:: classref-method -:ref:`PackedInt64Array` **instances_cull_convex**\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| +:ref:`PackedInt64Array` **instances_cull_convex**\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| :ref:`🔗` Returns an array of object IDs intersecting with the provided convex shape. Only 3D nodes that inherit from :ref:`VisualInstance3D` are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -8600,7 +8608,7 @@ Returns an array of object IDs intersecting with the provided convex shape. Only .. rst-class:: classref-method -:ref:`PackedInt64Array` **instances_cull_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| +:ref:`PackedInt64Array` **instances_cull_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| :ref:`🔗` Returns an array of object IDs intersecting with the provided 3D ray. Only 3D nodes that inherit from :ref:`VisualInstance3D` are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -8614,7 +8622,7 @@ Returns an array of object IDs intersecting with the provided 3D ray. Only 3D no .. rst-class:: classref-method -:ref:`bool` **is_on_render_thread**\ (\ ) +:ref:`bool` **is_on_render_thread**\ (\ ) :ref:`🔗` Returns ``true`` if our code is currently executing on the rendering thread. @@ -8626,7 +8634,7 @@ Returns ``true`` if our code is currently executing on the rendering thread. .. rst-class:: classref-method -|void| **light_directional_set_blend_splits**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **light_directional_set_blend_splits**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to :ref:`DirectionalLight3D.directional_shadow_blend_splits`. @@ -8638,7 +8646,7 @@ If ``true``, this directional light will blend between shadow map splits resulti .. rst-class:: classref-method -|void| **light_directional_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) +|void| **light_directional_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) :ref:`🔗` Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode`. See :ref:`LightDirectionalShadowMode` for options. @@ -8650,7 +8658,7 @@ Sets the shadow mode for this directional light. Equivalent to :ref:`Directional .. rst-class:: classref-method -|void| **light_directional_set_sky_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalSkyMode`\ ) +|void| **light_directional_set_sky_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalSkyMode`\ ) :ref:`🔗` If ``true``, this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon. @@ -8662,7 +8670,7 @@ If ``true``, this light will not be used for anything except sky shaders. Use th .. rst-class:: classref-method -|void| **light_omni_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightOmniShadowMode`\ ) +|void| **light_omni_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightOmniShadowMode`\ ) :ref:`🔗` Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to :ref:`OmniLight3D.omni_shadow_mode`. @@ -8674,7 +8682,7 @@ Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual para .. rst-class:: classref-method -|void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter`\ ) +|void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter`\ ) :ref:`🔗` Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis. @@ -8686,7 +8694,7 @@ Sets the texture filter mode to use when rendering light projectors. This parame .. rst-class:: classref-method -|void| **light_set_bake_mode**\ (\ light\: :ref:`RID`, bake_mode\: :ref:`LightBakeMode`\ ) +|void| **light_set_bake_mode**\ (\ light\: :ref:`RID`, bake_mode\: :ref:`LightBakeMode`\ ) :ref:`🔗` Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode`. @@ -8698,7 +8706,7 @@ Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3 .. rst-class:: classref-method -|void| **light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color of the light. Equivalent to :ref:`Light3D.light_color`. @@ -8710,7 +8718,7 @@ Sets the color of the light. Equivalent to :ref:`Light3D.light_color`, mask\: :ref:`int`\ ) +|void| **light_set_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the cull mask for this 3D light. Lights only affect objects in the selected layers. Equivalent to :ref:`Light3D.light_cull_mask`. @@ -8722,7 +8730,7 @@ Sets the cull mask for this 3D light. Lights only affect objects in the selected .. rst-class:: classref-method -|void| **light_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, shadow\: :ref:`float`, length\: :ref:`float`\ ) +|void| **light_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, shadow\: :ref:`float`, length\: :ref:`float`\ ) :ref:`🔗` Sets the distance fade for this 3D light. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to :ref:`Light3D.distance_fade_enabled`, :ref:`Light3D.distance_fade_begin`, :ref:`Light3D.distance_fade_shadow`, and :ref:`Light3D.distance_fade_length`. @@ -8734,7 +8742,7 @@ Sets the distance fade for this 3D light. This acts as a form of level of detail .. rst-class:: classref-method -|void| **light_set_max_sdfgi_cascade**\ (\ light\: :ref:`RID`, cascade\: :ref:`int`\ ) +|void| **light_set_max_sdfgi_cascade**\ (\ light\: :ref:`RID`, cascade\: :ref:`int`\ ) :ref:`🔗` Sets the maximum SDFGI cascade in which the 3D light's indirect lighting is rendered. Higher values allow the light to be rendered in SDFGI further away from the camera. @@ -8746,7 +8754,7 @@ Sets the maximum SDFGI cascade in which the 3D light's indirect lighting is rend .. rst-class:: classref-method -|void| **light_set_negative**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **light_set_negative**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative`. @@ -8758,7 +8766,7 @@ If ``true``, the 3D light will subtract light instead of adding light. Equivalen .. rst-class:: classref-method -|void| **light_set_param**\ (\ light\: :ref:`RID`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) +|void| **light_set_param**\ (\ light\: :ref:`RID`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) :ref:`🔗` Sets the specified 3D light parameter. See :ref:`LightParam` for options. Equivalent to :ref:`Light3D.set_param`. @@ -8770,7 +8778,7 @@ Sets the specified 3D light parameter. See :ref:`LightParam`, texture\: :ref:`RID`\ ) +|void| **light_set_projector**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector`. @@ -8782,7 +8790,7 @@ Sets the projector texture to use for the specified 3D light. Equivalent to :ref .. rst-class:: classref-method -|void| **light_set_reverse_cull_face_mode**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **light_set_reverse_cull_face_mode**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with :ref:`instance_geometry_set_cast_shadows_setting`. Equivalent to :ref:`Light3D.shadow_reverse_cull_face`. @@ -8794,7 +8802,7 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when .. rst-class:: classref-method -|void| **light_set_shadow**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **light_set_shadow**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled`. @@ -8806,7 +8814,7 @@ If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled .. rst-class:: classref-method -:ref:`RID` **lightmap_create**\ (\ ) +:ref:`RID` **lightmap_create**\ (\ ) :ref:`🔗` Creates a new lightmap global illumination instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``lightmap_*`` RenderingServer functions. @@ -8822,7 +8830,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree**\ (\ lightmap\: :ref:`RID`\ ) |const| +:ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -8836,7 +8844,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedVector3Array` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID`\ ) |const| +:ref:`PackedVector3Array` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -8850,7 +8858,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedColorArray` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID`\ ) |const| +:ref:`PackedColorArray` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -8864,7 +8872,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID`\ ) |const| +:ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -8878,7 +8886,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **lightmap_set_baked_exposure_normalization**\ (\ lightmap\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) +|void| **lightmap_set_baked_exposure_normalization**\ (\ lightmap\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) :ref:`🔗` Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. @@ -8890,7 +8898,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -|void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID`, bounds\: :ref:`AABB`\ ) +|void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID`, bounds\: :ref:`AABB`\ ) :ref:`🔗` .. container:: contribute @@ -8904,7 +8912,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -|void| **lightmap_set_probe_capture_data**\ (\ lightmap\: :ref:`RID`, points\: :ref:`PackedVector3Array`, point_sh\: :ref:`PackedColorArray`, tetrahedra\: :ref:`PackedInt32Array`, bsp_tree\: :ref:`PackedInt32Array`\ ) +|void| **lightmap_set_probe_capture_data**\ (\ lightmap\: :ref:`RID`, points\: :ref:`PackedVector3Array`, point_sh\: :ref:`PackedColorArray`, tetrahedra\: :ref:`PackedInt32Array`, bsp_tree\: :ref:`PackedInt32Array`\ ) :ref:`🔗` .. container:: contribute @@ -8918,7 +8926,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -|void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float`\ ) +|void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -8932,7 +8940,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -|void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID`, interior\: :ref:`bool`\ ) +|void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID`, interior\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -8946,7 +8954,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -|void| **lightmap_set_textures**\ (\ lightmap\: :ref:`RID`, light\: :ref:`RID`, uses_sh\: :ref:`bool`\ ) +|void| **lightmap_set_textures**\ (\ lightmap\: :ref:`RID`, light\: :ref:`RID`, uses_sh\: :ref:`bool`\ ) :ref:`🔗` Set the textures on the given ``lightmap`` GI instance to the texture array pointed to by the ``light`` RID. If the lightmap texture was baked with :ref:`LightmapGI.directional` set to ``true``, then ``uses_sh`` must also be ``true``. @@ -8958,7 +8966,7 @@ Set the textures on the given ``lightmap`` GI instance to the texture array poin .. rst-class:: classref-method -:ref:`RID` **make_sphere_mesh**\ (\ latitudes\: :ref:`int`, longitudes\: :ref:`int`, radius\: :ref:`float`\ ) +:ref:`RID` **make_sphere_mesh**\ (\ latitudes\: :ref:`int`, longitudes\: :ref:`int`, radius\: :ref:`float`\ ) :ref:`🔗` Returns a mesh of a sphere with the given number of horizontal subdivisions, vertical subdivisions and radius. See also :ref:`get_test_cube`. @@ -8970,7 +8978,7 @@ Returns a mesh of a sphere with the given number of horizontal subdivisions, ver .. rst-class:: classref-method -:ref:`RID` **material_create**\ (\ ) +:ref:`RID` **material_create**\ (\ ) :ref:`🔗` Creates an empty material and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``material_*`` RenderingServer functions. @@ -8986,7 +8994,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Variant` **material_get_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| +:ref:`Variant` **material_get_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the value of a certain material's parameter. @@ -8998,7 +9006,7 @@ Returns the value of a certain material's parameter. .. rst-class:: classref-method -|void| **material_set_next_pass**\ (\ material\: :ref:`RID`, next_material\: :ref:`RID`\ ) +|void| **material_set_next_pass**\ (\ material\: :ref:`RID`, next_material\: :ref:`RID`\ ) :ref:`🔗` Sets an object's next material. @@ -9010,7 +9018,7 @@ Sets an object's next material. .. rst-class:: classref-method -|void| **material_set_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **material_set_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets a material's parameter. @@ -9022,7 +9030,7 @@ Sets a material's parameter. .. rst-class:: classref-method -|void| **material_set_render_priority**\ (\ material\: :ref:`RID`, priority\: :ref:`int`\ ) +|void| **material_set_render_priority**\ (\ material\: :ref:`RID`, priority\: :ref:`int`\ ) :ref:`🔗` Sets a material's render priority. @@ -9034,7 +9042,7 @@ Sets a material's render priority. .. rst-class:: classref-method -|void| **material_set_shader**\ (\ shader_material\: :ref:`RID`, shader\: :ref:`RID`\ ) +|void| **material_set_shader**\ (\ shader_material\: :ref:`RID`, shader\: :ref:`RID`\ ) :ref:`🔗` Sets a shader material's shader. @@ -9046,7 +9054,7 @@ Sets a shader material's shader. .. rst-class:: classref-method -|void| **mesh_add_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`Dictionary`\ ) +|void| **mesh_add_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`Dictionary`\ ) :ref:`🔗` .. container:: contribute @@ -9060,7 +9068,7 @@ Sets a shader material's shader. .. rst-class:: classref-method -|void| **mesh_add_surface_from_arrays**\ (\ mesh\: :ref:`RID`, primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array` = [], lods\: :ref:`Dictionary` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) +|void| **mesh_add_surface_from_arrays**\ (\ mesh\: :ref:`RID`, primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array` = [], lods\: :ref:`Dictionary` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) :ref:`🔗` .. container:: contribute @@ -9074,7 +9082,7 @@ Sets a shader material's shader. .. rst-class:: classref-method -|void| **mesh_clear**\ (\ mesh\: :ref:`RID`\ ) +|void| **mesh_clear**\ (\ mesh\: :ref:`RID`\ ) :ref:`🔗` Removes all surfaces from a mesh. @@ -9086,7 +9094,7 @@ Removes all surfaces from a mesh. .. rst-class:: classref-method -:ref:`RID` **mesh_create**\ (\ ) +:ref:`RID` **mesh_create**\ (\ ) :ref:`🔗` Creates a new mesh and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``mesh_*`` RenderingServer functions. @@ -9104,7 +9112,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -:ref:`RID` **mesh_create_from_surfaces**\ (\ surfaces\: :ref:`Array`\[:ref:`Dictionary`\], blend_shape_count\: :ref:`int` = 0\ ) +:ref:`RID` **mesh_create_from_surfaces**\ (\ surfaces\: :ref:`Array`\[:ref:`Dictionary`\], blend_shape_count\: :ref:`int` = 0\ ) :ref:`🔗` .. container:: contribute @@ -9118,7 +9126,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -:ref:`int` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID`\ ) |const| +:ref:`int` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a mesh's blend shape count. @@ -9130,7 +9138,7 @@ Returns a mesh's blend shape count. .. rst-class:: classref-method -:ref:`BlendShapeMode` **mesh_get_blend_shape_mode**\ (\ mesh\: :ref:`RID`\ ) |const| +:ref:`BlendShapeMode` **mesh_get_blend_shape_mode**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a mesh's blend shape mode. @@ -9142,7 +9150,7 @@ Returns a mesh's blend shape mode. .. rst-class:: classref-method -:ref:`AABB` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID`\ ) |const| +:ref:`AABB` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a mesh's custom aabb. @@ -9154,7 +9162,7 @@ Returns a mesh's custom aabb. .. rst-class:: classref-method -:ref:`Dictionary` **mesh_get_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) +:ref:`Dictionary` **mesh_get_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute @@ -9168,7 +9176,7 @@ Returns a mesh's custom aabb. .. rst-class:: classref-method -:ref:`int` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID`\ ) |const| +:ref:`int` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a mesh's number of surfaces. @@ -9180,7 +9188,7 @@ Returns a mesh's number of surfaces. .. rst-class:: classref-method -|void| **mesh_set_blend_shape_mode**\ (\ mesh\: :ref:`RID`, mode\: :ref:`BlendShapeMode`\ ) +|void| **mesh_set_blend_shape_mode**\ (\ mesh\: :ref:`RID`, mode\: :ref:`BlendShapeMode`\ ) :ref:`🔗` Sets a mesh's blend shape mode. @@ -9192,7 +9200,7 @@ Sets a mesh's blend shape mode. .. rst-class:: classref-method -|void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) +|void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` Sets a mesh's custom aabb. @@ -9204,7 +9212,7 @@ Sets a mesh's custom aabb. .. rst-class:: classref-method -|void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID`, shadow_mesh\: :ref:`RID`\ ) +|void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID`, shadow_mesh\: :ref:`RID`\ ) :ref:`🔗` .. container:: contribute @@ -9218,7 +9226,7 @@ Sets a mesh's custom aabb. .. rst-class:: classref-method -:ref:`Array` **mesh_surface_get_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| +:ref:`Array` **mesh_surface_get_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns a mesh's surface's buffer arrays. @@ -9230,7 +9238,7 @@ Returns a mesh's surface's buffer arrays. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Array`\] **mesh_surface_get_blend_shape_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Array`\] **mesh_surface_get_blend_shape_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns a mesh's surface's arrays for blend shapes. @@ -9242,7 +9250,7 @@ Returns a mesh's surface's arrays for blend shapes. .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_attribute_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| +:ref:`int` **mesh_surface_get_format_attribute_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` Returns the stride of the attribute buffer for a mesh with given ``format``. @@ -9254,7 +9262,7 @@ Returns the stride of the attribute buffer for a mesh with given ``format``. .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_normal_tangent_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| +:ref:`int` **mesh_surface_get_format_normal_tangent_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` Returns the stride of the combined normals and tangents for a mesh with given ``format``. Note importantly that, while normals and tangents are in the vertex buffer with vertices, they are only interleaved with each other and so have a different stride than vertex positions. @@ -9266,7 +9274,7 @@ Returns the stride of the combined normals and tangents for a mesh with given `` .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_offset**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| +:ref:`int` **mesh_surface_get_format_offset**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the offset of a given attribute by ``array_index`` in the start of its respective buffer. @@ -9278,7 +9286,7 @@ Returns the offset of a given attribute by ``array_index`` in the start of its r .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_skin_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| +:ref:`int` **mesh_surface_get_format_skin_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` Returns the stride of the skin buffer for a mesh with given ``format``. @@ -9290,7 +9298,7 @@ Returns the stride of the skin buffer for a mesh with given ``format``. .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_vertex_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| +:ref:`int` **mesh_surface_get_format_vertex_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` Returns the stride of the vertex positions for a mesh with given ``format``. Note importantly that vertex positions are stored consecutively and are not interleaved with the other attributes in the vertex buffer (normals and tangents). @@ -9302,7 +9310,7 @@ Returns the stride of the vertex positions for a mesh with given ``format``. Not .. rst-class:: classref-method -:ref:`RID` **mesh_surface_get_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| +:ref:`RID` **mesh_surface_get_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns a mesh's surface's material. @@ -9314,7 +9322,7 @@ Returns a mesh's surface's material. .. rst-class:: classref-method -|void| **mesh_surface_set_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) +|void| **mesh_surface_set_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) :ref:`🔗` Sets a mesh's surface's material. @@ -9326,7 +9334,7 @@ Sets a mesh's surface's material. .. rst-class:: classref-method -|void| **mesh_surface_update_attribute_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +|void| **mesh_surface_update_attribute_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute @@ -9340,7 +9348,7 @@ Sets a mesh's surface's material. .. rst-class:: classref-method -|void| **mesh_surface_update_skin_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +|void| **mesh_surface_update_skin_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute @@ -9354,7 +9362,7 @@ Sets a mesh's surface's material. .. rst-class:: classref-method -|void| **mesh_surface_update_vertex_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +|void| **mesh_surface_update_vertex_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute @@ -9368,7 +9376,7 @@ Sets a mesh's surface's material. .. rst-class:: classref-method -|void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID`, instances\: :ref:`int`, transform_format\: :ref:`MultimeshTransformFormat`, color_format\: :ref:`bool` = false, custom_data_format\: :ref:`bool` = false\ ) +|void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID`, instances\: :ref:`int`, transform_format\: :ref:`MultimeshTransformFormat`, color_format\: :ref:`bool` = false, custom_data_format\: :ref:`bool` = false\ ) :ref:`🔗` .. container:: contribute @@ -9382,7 +9390,7 @@ Sets a mesh's surface's material. .. rst-class:: classref-method -:ref:`RID` **multimesh_create**\ (\ ) +:ref:`RID` **multimesh_create**\ (\ ) :ref:`🔗` Creates a new multimesh on the RenderingServer and returns an :ref:`RID` handle. This RID will be used in all ``multimesh_*`` RenderingServer functions. @@ -9400,7 +9408,7 @@ To place in a scene, attach this multimesh to an instance using :ref:`instance_s .. rst-class:: classref-method -:ref:`AABB` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| +:ref:`AABB` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. @@ -9412,7 +9420,7 @@ Calculates and returns the axis-aligned bounding box that encloses all instances .. rst-class:: classref-method -:ref:`PackedFloat32Array` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID`\ ) |const| +:ref:`PackedFloat32Array` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the MultiMesh data (such as instance transforms, colors, etc.). See :ref:`multimesh_set_buffer` for details on the returned data. @@ -9426,7 +9434,7 @@ Returns the MultiMesh data (such as instance transforms, colors, etc.). See :ref .. rst-class:: classref-method -:ref:`AABB` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| +:ref:`AABB` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the custom AABB defined for this MultiMesh resource. @@ -9438,7 +9446,7 @@ Returns the custom AABB defined for this MultiMesh resource. .. rst-class:: classref-method -:ref:`int` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID`\ ) |const| +:ref:`int` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of instances allocated for this multimesh. @@ -9450,7 +9458,7 @@ Returns the number of instances allocated for this multimesh. .. rst-class:: classref-method -:ref:`RID` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID`\ ) |const| +:ref:`RID` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the RID of the mesh that will be used in drawing this multimesh. @@ -9462,7 +9470,7 @@ Returns the RID of the mesh that will be used in drawing this multimesh. .. rst-class:: classref-method -:ref:`int` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID`\ ) |const| +:ref:`int` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of visible instances for this multimesh. @@ -9474,7 +9482,7 @@ Returns the number of visible instances for this multimesh. .. rst-class:: classref-method -:ref:`Color` **multimesh_instance_get_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| +:ref:`Color` **multimesh_instance_get_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the color by which the specified instance will be modulated. @@ -9486,7 +9494,7 @@ Returns the color by which the specified instance will be modulated. .. rst-class:: classref-method -:ref:`Color` **multimesh_instance_get_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| +:ref:`Color` **multimesh_instance_get_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom data associated with the specified instance. @@ -9498,7 +9506,7 @@ Returns the custom data associated with the specified instance. .. rst-class:: classref-method -:ref:`Transform3D` **multimesh_instance_get_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| +:ref:`Transform3D` **multimesh_instance_get_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Transform3D` of the specified instance. @@ -9510,7 +9518,7 @@ Returns the :ref:`Transform3D` of the specified instance. .. rst-class:: classref-method -:ref:`Transform2D` **multimesh_instance_get_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| +:ref:`Transform2D` **multimesh_instance_get_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Transform2D` of the specified instance. For use when the multimesh is set to use 2D transforms. @@ -9522,7 +9530,7 @@ Returns the :ref:`Transform2D` of the specified instance. For .. rst-class:: classref-method -|void| **multimesh_instance_set_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **multimesh_instance_set_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color`. @@ -9534,7 +9542,7 @@ Sets the color by which this instance will be modulated. Equivalent to :ref:`Mul .. rst-class:: classref-method -|void| **multimesh_instance_set_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, custom_data\: :ref:`Color`\ ) +|void| **multimesh_instance_set_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, custom_data\: :ref:`Color`\ ) :ref:`🔗` Sets the custom data for this instance. Custom data is passed as a :ref:`Color`, but is interpreted as a ``vec4`` in the shader. Equivalent to :ref:`MultiMesh.set_instance_custom_data`. @@ -9546,7 +9554,7 @@ Sets the custom data for this instance. Custom data is passed as a :ref:`Color`, index\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **multimesh_instance_set_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the :ref:`Transform3D` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform`. @@ -9558,7 +9566,7 @@ Sets the :ref:`Transform3D` for this instance. Equivalent to .. rst-class:: classref-method -|void| **multimesh_instance_set_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **multimesh_instance_set_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the :ref:`Transform2D` for this instance. For use when multimesh is used in 2D. Equivalent to :ref:`MultiMesh.set_instance_transform_2d`. @@ -9570,7 +9578,7 @@ Sets the :ref:`Transform2D` for this instance. For use when m .. rst-class:: classref-method -|void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`\ ) +|void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Set the entire data to use for drawing the ``multimesh`` at once to ``buffer`` (such as instance transforms and colors). ``buffer``'s size must match the number of instances multiplied by the per-instance data size (which depends on the enabled MultiMesh fields). Otherwise, an error message is printed and nothing is rendered. See also :ref:`multimesh_get_buffer`. @@ -9597,7 +9605,7 @@ The per-instance data size and expected data order is: .. rst-class:: classref-method -|void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) +|void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` Sets the custom AABB for this MultiMesh resource. @@ -9609,7 +9617,7 @@ Sets the custom AABB for this MultiMesh resource. .. rst-class:: classref-method -|void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID`, mesh\: :ref:`RID`\ ) +|void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID`, mesh\: :ref:`RID`\ ) :ref:`🔗` Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh`. @@ -9621,7 +9629,7 @@ Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh`, visible\: :ref:`int`\ ) +|void| **multimesh_set_visible_instances**\ (\ multimesh\: :ref:`RID`, visible\: :ref:`int`\ ) :ref:`🔗` Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to :ref:`MultiMesh.visible_instance_count`. @@ -9633,7 +9641,7 @@ Sets the number of instances visible at a given time. If -1, all instances that .. rst-class:: classref-method -:ref:`RID` **occluder_create**\ (\ ) +:ref:`RID` **occluder_create**\ (\ ) :ref:`🔗` Creates an occluder instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``occluder_*`` RenderingServer functions. @@ -9649,7 +9657,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **occluder_set_mesh**\ (\ occluder\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) +|void| **occluder_set_mesh**\ (\ occluder\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed. @@ -9661,7 +9669,7 @@ Sets the mesh data for the given occluder RID, which controls the shape of the o .. rst-class:: classref-method -:ref:`RID` **omni_light_create**\ (\ ) +:ref:`RID` **omni_light_create**\ (\ ) :ref:`🔗` Creates a new omni light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions. @@ -9679,7 +9687,7 @@ To place in a scene, attach this omni light to an instance using :ref:`instance_ .. rst-class:: classref-method -:ref:`RID` **particles_collision_create**\ (\ ) +:ref:`RID` **particles_collision_create**\ (\ ) :ref:`🔗` Creates a new 3D GPU particle collision or attractor and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``particles_collision_*`` RenderingServer functions. @@ -9693,7 +9701,7 @@ Creates a new 3D GPU particle collision or attractor and adds it to the Renderin .. rst-class:: classref-method -|void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID`\ ) +|void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID`\ ) :ref:`🔗` Requests an update for the 3D GPU particle collision heightfield. This may be automatically called by the 3D GPU particle collision heightfield depending on its :ref:`GPUParticlesCollisionHeightField3D.update_mode`. @@ -9705,7 +9713,7 @@ Requests an update for the 3D GPU particle collision heightfield. This may be au .. rst-class:: classref-method -|void| **particles_collision_set_attractor_attenuation**\ (\ particles_collision\: :ref:`RID`, curve\: :ref:`float`\ ) +|void| **particles_collision_set_attractor_attenuation**\ (\ particles_collision\: :ref:`RID`, curve\: :ref:`float`\ ) :ref:`🔗` Sets the attenuation ``curve`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.attenuation`. @@ -9717,7 +9725,7 @@ Sets the attenuation ``curve`` for the 3D GPU particles attractor specified by t .. rst-class:: classref-method -|void| **particles_collision_set_attractor_directionality**\ (\ particles_collision\: :ref:`RID`, amount\: :ref:`float`\ ) +|void| **particles_collision_set_attractor_directionality**\ (\ particles_collision\: :ref:`RID`, amount\: :ref:`float`\ ) :ref:`🔗` Sets the directionality ``amount`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.directionality`. @@ -9729,7 +9737,7 @@ Sets the directionality ``amount`` for the 3D GPU particles attractor specified .. rst-class:: classref-method -|void| **particles_collision_set_attractor_strength**\ (\ particles_collision\: :ref:`RID`, strength\: :ref:`float`\ ) +|void| **particles_collision_set_attractor_strength**\ (\ particles_collision\: :ref:`RID`, strength\: :ref:`float`\ ) :ref:`🔗` Sets the ``strength`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.strength`. @@ -9741,7 +9749,7 @@ Sets the ``strength`` for the 3D GPU particles attractor specified by the ``part .. rst-class:: classref-method -|void| **particles_collision_set_box_extents**\ (\ particles_collision\: :ref:`RID`, extents\: :ref:`Vector3`\ ) +|void| **particles_collision_set_box_extents**\ (\ particles_collision\: :ref:`RID`, extents\: :ref:`Vector3`\ ) :ref:`🔗` Sets the ``extents`` for the 3D GPU particles collision by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionBox3D.size`, :ref:`GPUParticlesCollisionSDF3D.size`, :ref:`GPUParticlesCollisionHeightField3D.size`, :ref:`GPUParticlesAttractorBox3D.size` or :ref:`GPUParticlesAttractorVectorField3D.size` depending on the ``particles_collision`` type. @@ -9753,7 +9761,7 @@ Sets the ``extents`` for the 3D GPU particles collision by the ``particles_colli .. rst-class:: classref-method -|void| **particles_collision_set_collision_type**\ (\ particles_collision\: :ref:`RID`, type\: :ref:`ParticlesCollisionType`\ ) +|void| **particles_collision_set_collision_type**\ (\ particles_collision\: :ref:`RID`, type\: :ref:`ParticlesCollisionType`\ ) :ref:`🔗` Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID. @@ -9765,7 +9773,7 @@ Sets the collision or attractor shape ``type`` for the 3D GPU particles collisio .. rst-class:: classref-method -|void| **particles_collision_set_cull_mask**\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) +|void| **particles_collision_set_cull_mask**\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the cull ``mask`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollision3D.cull_mask` or :ref:`GPUParticlesAttractor3D.cull_mask` depending on the ``particles_collision`` type. @@ -9777,7 +9785,7 @@ Sets the cull ``mask`` for the 3D GPU particles collision or attractor specified .. rst-class:: classref-method -|void| **particles_collision_set_field_texture**\ (\ particles_collision\: :ref:`RID`, texture\: :ref:`RID`\ ) +|void| **particles_collision_set_field_texture**\ (\ particles_collision\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` Sets the signed distance field ``texture`` for the 3D GPU particles collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionSDF3D.texture` or :ref:`GPUParticlesAttractorVectorField3D.texture` depending on the ``particles_collision`` type. @@ -9789,7 +9797,7 @@ Sets the signed distance field ``texture`` for the 3D GPU particles collision sp .. rst-class:: classref-method -|void| **particles_collision_set_height_field_resolution**\ (\ particles_collision\: :ref:`RID`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution`\ ) +|void| **particles_collision_set_height_field_resolution**\ (\ particles_collision\: :ref:`RID`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution`\ ) :ref:`🔗` Sets the heightmap ``resolution`` for the 3D GPU particles heightfield collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionHeightField3D.resolution`. @@ -9801,7 +9809,7 @@ Sets the heightmap ``resolution`` for the 3D GPU particles heightfield collision .. rst-class:: classref-method -|void| **particles_collision_set_sphere_radius**\ (\ particles_collision\: :ref:`RID`, radius\: :ref:`float`\ ) +|void| **particles_collision_set_sphere_radius**\ (\ particles_collision\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` Sets the ``radius`` for the 3D GPU particles sphere collision or attractor specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionSphere3D.radius` or :ref:`GPUParticlesAttractorSphere3D.radius` depending on the ``particles_collision`` type. @@ -9813,7 +9821,7 @@ Sets the ``radius`` for the 3D GPU particles sphere collision or attractor speci .. rst-class:: classref-method -:ref:`RID` **particles_create**\ (\ ) +:ref:`RID` **particles_create**\ (\ ) :ref:`🔗` Creates a GPU-based particle system and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``particles_*`` RenderingServer functions. @@ -9833,7 +9841,7 @@ To place in a scene, attach these particles to an instance using :ref:`instance_ .. rst-class:: classref-method -|void| **particles_emit**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, emit_flags\: :ref:`int`\ ) +|void| **particles_emit**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, emit_flags\: :ref:`int`\ ) :ref:`🔗` Manually emits particles from the ``particles`` instance. @@ -9845,7 +9853,7 @@ Manually emits particles from the ``particles`` instance. .. rst-class:: classref-method -:ref:`AABB` **particles_get_current_aabb**\ (\ particles\: :ref:`RID`\ ) +:ref:`AABB` **particles_get_current_aabb**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb`. @@ -9857,7 +9865,7 @@ Calculates and returns the axis-aligned bounding box that contains all the parti .. rst-class:: classref-method -:ref:`bool` **particles_get_emitting**\ (\ particles\: :ref:`RID`\ ) +:ref:`bool` **particles_get_emitting**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if particles are currently set to emitting. @@ -9869,7 +9877,7 @@ Returns ``true`` if particles are currently set to emitting. .. rst-class:: classref-method -:ref:`bool` **particles_is_inactive**\ (\ particles\: :ref:`RID`\ ) +:ref:`bool` **particles_is_inactive**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if particles are not emitting and particles are set to inactive. @@ -9881,7 +9889,7 @@ Returns ``true`` if particles are not emitting and particles are set to inactive .. rst-class:: classref-method -|void| **particles_request_process**\ (\ particles\: :ref:`RID`\ ) +|void| **particles_request_process**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to :ref:`instances_cull_aabb`, :ref:`instances_cull_convex`, or :ref:`instances_cull_ray`. @@ -9893,7 +9901,7 @@ Add particle system to list of particle systems that need to be updated. Update .. rst-class:: classref-method -|void| **particles_restart**\ (\ particles\: :ref:`RID`\ ) +|void| **particles_restart**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart`. @@ -9905,7 +9913,7 @@ Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.resta .. rst-class:: classref-method -|void| **particles_set_amount**\ (\ particles\: :ref:`RID`, amount\: :ref:`int`\ ) +|void| **particles_set_amount**\ (\ particles\: :ref:`RID`, amount\: :ref:`int`\ ) :ref:`🔗` Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount`. @@ -9917,7 +9925,7 @@ Sets the number of particles to be drawn and allocates the memory for them. Equi .. rst-class:: classref-method -|void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) +|void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) :ref:`🔗` Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio`. @@ -9929,7 +9937,7 @@ Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUPartic .. rst-class:: classref-method -|void| **particles_set_collision_base_size**\ (\ particles\: :ref:`RID`, size\: :ref:`float`\ ) +|void| **particles_set_collision_base_size**\ (\ particles\: :ref:`RID`, size\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute @@ -9943,7 +9951,7 @@ Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUPartic .. rst-class:: classref-method -|void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID`, aabb\: :ref:`AABB`\ ) +|void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb`. @@ -9955,7 +9963,7 @@ Sets a custom axis-aligned bounding box for the particle system. Equivalent to : .. rst-class:: classref-method -|void| **particles_set_draw_order**\ (\ particles\: :ref:`RID`, order\: :ref:`ParticlesDrawOrder`\ ) +|void| **particles_set_draw_order**\ (\ particles\: :ref:`RID`, order\: :ref:`ParticlesDrawOrder`\ ) :ref:`🔗` Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder`. See :ref:`ParticlesDrawOrder` for options. Equivalent to :ref:`GPUParticles3D.draw_order`. @@ -9967,7 +9975,7 @@ Sets the draw order of the particles to one of the named enums from :ref:`Partic .. rst-class:: classref-method -|void| **particles_set_draw_pass_mesh**\ (\ particles\: :ref:`RID`, pass\: :ref:`int`, mesh\: :ref:`RID`\ ) +|void| **particles_set_draw_pass_mesh**\ (\ particles\: :ref:`RID`, pass\: :ref:`int`, mesh\: :ref:`RID`\ ) :ref:`🔗` Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUParticles3D.draw_pass_1`, :ref:`GPUParticles3D.draw_pass_2`, :ref:`GPUParticles3D.draw_pass_3`, and :ref:`GPUParticles3D.draw_pass_4`. @@ -9979,7 +9987,7 @@ Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUPar .. rst-class:: classref-method -|void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID`, count\: :ref:`int`\ ) +|void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes`. @@ -9991,7 +9999,7 @@ Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_p .. rst-class:: classref-method -|void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) +|void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the :ref:`Transform3D` that will be used by the particles when they first emit. @@ -10003,7 +10011,7 @@ Sets the :ref:`Transform3D` that will be used by the particle .. rst-class:: classref-method -|void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) +|void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio`. @@ -10015,7 +10023,7 @@ Sets the velocity of a particle node, that will be used by :ref:`ParticleProcess .. rst-class:: classref-method -|void| **particles_set_emitting**\ (\ particles\: :ref:`RID`, emitting\: :ref:`bool`\ ) +|void| **particles_set_emitting**\ (\ particles\: :ref:`RID`, emitting\: :ref:`bool`\ ) :ref:`🔗` If ``true``, particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to :ref:`GPUParticles3D.emitting`. @@ -10027,7 +10035,7 @@ If ``true``, particles will emit over time. Setting to false does not reset the .. rst-class:: classref-method -|void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) +|void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) :ref:`🔗` Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness`. @@ -10039,7 +10047,7 @@ Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness`, fps\: :ref:`int`\ ) +|void| **particles_set_fixed_fps**\ (\ particles\: :ref:`RID`, fps\: :ref:`int`\ ) :ref:`🔗` Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps`. @@ -10051,7 +10059,7 @@ Sets the frame rate that the particle system rendering will be fixed to. Equival .. rst-class:: classref-method -|void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta`. @@ -10063,7 +10071,7 @@ If ``true``, uses fractional delta which smooths the movement of the particles. .. rst-class:: classref-method -|void| **particles_set_interp_to_end**\ (\ particles\: :ref:`RID`, factor\: :ref:`float`\ ) +|void| **particles_set_interp_to_end**\ (\ particles\: :ref:`RID`, factor\: :ref:`float`\ ) :ref:`🔗` Sets the value that informs a :ref:`ParticleProcessMaterial` to rush all particles towards the end of their lifetime. @@ -10075,7 +10083,7 @@ Sets the value that informs a :ref:`ParticleProcessMaterial`, enable\: :ref:`bool`\ ) +|void| **particles_set_interpolate**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -10089,7 +10097,7 @@ Sets the value that informs a :ref:`ParticleProcessMaterial`, lifetime\: :ref:`float`\ ) +|void| **particles_set_lifetime**\ (\ particles\: :ref:`RID`, lifetime\: :ref:`float`\ ) :ref:`🔗` Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime`. @@ -10101,7 +10109,7 @@ Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticl .. rst-class:: classref-method -|void| **particles_set_mode**\ (\ particles\: :ref:`RID`, mode\: :ref:`ParticlesMode`\ ) +|void| **particles_set_mode**\ (\ particles\: :ref:`RID`, mode\: :ref:`ParticlesMode`\ ) :ref:`🔗` Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``. @@ -10113,7 +10121,7 @@ Sets whether the GPU particles specified by the ``particles`` RID should be rend .. rst-class:: classref-method -|void| **particles_set_one_shot**\ (\ particles\: :ref:`RID`, one_shot\: :ref:`bool`\ ) +|void| **particles_set_one_shot**\ (\ particles\: :ref:`RID`, one_shot\: :ref:`bool`\ ) :ref:`🔗` If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot`. @@ -10125,7 +10133,7 @@ If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUPart .. rst-class:: classref-method -|void| **particles_set_pre_process_time**\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) +|void| **particles_set_pre_process_time**\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) :ref:`🔗` Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to :ref:`GPUParticles3D.preprocess`. @@ -10137,7 +10145,7 @@ Sets the preprocess time for the particles' animation. This lets you delay start .. rst-class:: classref-method -|void| **particles_set_process_material**\ (\ particles\: :ref:`RID`, material\: :ref:`RID`\ ) +|void| **particles_set_process_material**\ (\ particles\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` Sets the material for processing the particles. @@ -10151,7 +10159,7 @@ Sets the material for processing the particles. .. rst-class:: classref-method -|void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) +|void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) :ref:`🔗` Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness`. @@ -10163,7 +10171,7 @@ Sets the emission randomness ratio. This randomizes the emission of particles wi .. rst-class:: classref-method -|void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID`, scale\: :ref:`float`\ ) +|void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale`. @@ -10175,7 +10183,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. rst-class:: classref-method -|void| **particles_set_subemitter**\ (\ particles\: :ref:`RID`, subemitter_particles\: :ref:`RID`\ ) +|void| **particles_set_subemitter**\ (\ particles\: :ref:`RID`, subemitter_particles\: :ref:`RID`\ ) :ref:`🔗` .. container:: contribute @@ -10189,7 +10197,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. rst-class:: classref-method -|void| **particles_set_trail_bind_poses**\ (\ particles\: :ref:`RID`, bind_poses\: :ref:`Array`\[:ref:`Transform3D`\]\ ) +|void| **particles_set_trail_bind_poses**\ (\ particles\: :ref:`RID`, bind_poses\: :ref:`Array`\[:ref:`Transform3D`\]\ ) :ref:`🔗` .. container:: contribute @@ -10203,7 +10211,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. rst-class:: classref-method -|void| **particles_set_trails**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`, length_sec\: :ref:`float`\ ) +|void| **particles_set_trails**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`, length_sec\: :ref:`float`\ ) :ref:`🔗` If ``enable`` is ``true``, enables trails for the ``particles`` with the specified ``length_sec`` in seconds. Equivalent to :ref:`GPUParticles3D.trail_enabled` and :ref:`GPUParticles3D.trail_lifetime`. @@ -10215,7 +10223,7 @@ If ``enable`` is ``true``, enables trails for the ``particles`` with the specifi .. rst-class:: classref-method -|void| **particles_set_transform_align**\ (\ particles\: :ref:`RID`, align\: :ref:`ParticlesTransformAlign`\ ) +|void| **particles_set_transform_align**\ (\ particles\: :ref:`RID`, align\: :ref:`ParticlesTransformAlign`\ ) :ref:`🔗` .. container:: contribute @@ -10229,7 +10237,7 @@ If ``enable`` is ``true``, enables trails for the ``particles`` with the specifi .. rst-class:: classref-method -|void| **particles_set_use_local_coordinates**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **particles_set_use_local_coordinates**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords`. @@ -10241,7 +10249,7 @@ If ``true``, particles use local coordinates. If ``false`` they use global coord .. rst-class:: classref-method -|void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) +|void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) :ref:`🔗` Sets the filter quality for omni and spot light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality`. This parameter is global and cannot be set on a per-viewport basis. @@ -10253,7 +10261,7 @@ Sets the filter quality for omni and spot light shadows in 3D. See also :ref:`Pr .. rst-class:: classref-method -:ref:`RID` **reflection_probe_create**\ (\ ) +:ref:`RID` **reflection_probe_create**\ (\ ) :ref:`🔗` Creates a reflection probe and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``reflection_probe_*`` RenderingServer functions. @@ -10271,7 +10279,7 @@ To place in a scene, attach this reflection probe to an instance using :ref:`ins .. rst-class:: classref-method -|void| **reflection_probe_set_ambient_color**\ (\ probe\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **reflection_probe_set_ambient_color**\ (\ probe\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color`. @@ -10283,7 +10291,7 @@ Sets the reflection probe's custom ambient light color. Equivalent to :ref:`Refl .. rst-class:: classref-method -|void| **reflection_probe_set_ambient_energy**\ (\ probe\: :ref:`RID`, energy\: :ref:`float`\ ) +|void| **reflection_probe_set_ambient_energy**\ (\ probe\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy`. @@ -10295,7 +10303,7 @@ Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`Ref .. rst-class:: classref-method -|void| **reflection_probe_set_ambient_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeAmbientMode`\ ) +|void| **reflection_probe_set_ambient_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeAmbientMode`\ ) :ref:`🔗` Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode`. @@ -10307,7 +10315,7 @@ Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionPr .. rst-class:: classref-method -|void| **reflection_probe_set_as_interior**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **reflection_probe_set_as_interior**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior`. @@ -10319,7 +10327,7 @@ If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`Refle .. rst-class:: classref-method -|void| **reflection_probe_set_cull_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **reflection_probe_set_cull_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Sets the render cull mask for this reflection probe. Only instances with a matching layer will be reflected by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask`. @@ -10331,7 +10339,7 @@ Sets the render cull mask for this reflection probe. Only instances with a match .. rst-class:: classref-method -|void| **reflection_probe_set_enable_box_projection**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **reflection_probe_set_enable_box_projection**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, uses box projection. This can make reflections look more correct in certain situations. Equivalent to :ref:`ReflectionProbe.box_projection`. @@ -10343,7 +10351,7 @@ If ``true``, uses box projection. This can make reflections look more correct in .. rst-class:: classref-method -|void| **reflection_probe_set_enable_shadows**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **reflection_probe_set_enable_shadows**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to :ref:`ReflectionProbe.enable_shadows`. @@ -10355,7 +10363,7 @@ If ``true``, computes shadows in the reflection probe. This makes the reflection .. rst-class:: classref-method -|void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID`, intensity\: :ref:`float`\ ) +|void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID`, intensity\: :ref:`float`\ ) :ref:`🔗` Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity`. @@ -10367,7 +10375,7 @@ Sets the intensity of the reflection probe. Intensity modulates the strength of .. rst-class:: classref-method -|void| **reflection_probe_set_max_distance**\ (\ probe\: :ref:`RID`, distance\: :ref:`float`\ ) +|void| **reflection_probe_set_max_distance**\ (\ probe\: :ref:`RID`, distance\: :ref:`float`\ ) :ref:`🔗` Sets the max distance away from the probe an object can be before it is culled. Equivalent to :ref:`ReflectionProbe.max_distance`. @@ -10379,7 +10387,7 @@ Sets the max distance away from the probe an object can be before it is culled. .. rst-class:: classref-method -|void| **reflection_probe_set_mesh_lod_threshold**\ (\ probe\: :ref:`RID`, pixels\: :ref:`float`\ ) +|void| **reflection_probe_set_mesh_lod_threshold**\ (\ probe\: :ref:`RID`, pixels\: :ref:`float`\ ) :ref:`🔗` Sets the mesh level of detail to use in the reflection probe rendering. Higher values will use less detailed versions of meshes that have LOD variations generated, which can improve performance. Equivalent to :ref:`ReflectionProbe.mesh_lod_threshold`. @@ -10391,7 +10399,7 @@ Sets the mesh level of detail to use in the reflection probe rendering. Higher v .. rst-class:: classref-method -|void| **reflection_probe_set_origin_offset**\ (\ probe\: :ref:`RID`, offset\: :ref:`Vector3`\ ) +|void| **reflection_probe_set_origin_offset**\ (\ probe\: :ref:`RID`, offset\: :ref:`Vector3`\ ) :ref:`🔗` Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to :ref:`ReflectionProbe.origin_offset`. @@ -10403,7 +10411,7 @@ Sets the origin offset to be used when this reflection probe is in box project m .. rst-class:: classref-method -|void| **reflection_probe_set_reflection_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) +|void| **reflection_probe_set_reflection_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` Sets the render reflection mask for this reflection probe. Only instances with a matching layer will have reflections applied from this probe. Equivalent to :ref:`ReflectionProbe.reflection_mask`. @@ -10415,7 +10423,7 @@ Sets the render reflection mask for this reflection probe. Only instances with a .. rst-class:: classref-method -|void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID`, resolution\: :ref:`int`\ ) +|void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID`, resolution\: :ref:`int`\ ) :ref:`🔗` Sets the resolution to use when rendering the specified reflection probe. The ``resolution`` is specified for each cubemap face: for instance, specifying ``512`` will allocate 6 faces of 512×512 each (plus mipmaps for roughness levels). @@ -10427,7 +10435,7 @@ Sets the resolution to use when rendering the specified reflection probe. The `` .. rst-class:: classref-method -|void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID`, size\: :ref:`Vector3`\ ) +|void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID`, size\: :ref:`Vector3`\ ) :ref:`🔗` Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size`. @@ -10439,7 +10447,7 @@ Sets the size of the area that the reflection probe will capture. Equivalent to .. rst-class:: classref-method -|void| **reflection_probe_set_update_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) +|void| **reflection_probe_set_update_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) :ref:`🔗` Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode` for options. @@ -10451,7 +10459,7 @@ Sets how often the reflection probe updates. Can either be once or every frame. .. rst-class:: classref-method -|void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable`\ ) +|void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Schedules a callback to the given callable after a frame has been drawn. @@ -10463,7 +10471,7 @@ Schedules a callback to the given callable after a frame has been drawn. .. rst-class:: classref-method -:ref:`RID` **scenario_create**\ (\ ) +:ref:`RID` **scenario_create**\ (\ ) :ref:`🔗` Creates a scenario and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``scenario_*`` RenderingServer functions. @@ -10479,7 +10487,7 @@ The scenario is the 3D world that all the visual instances exist in. .. rst-class:: classref-method -|void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID`, effects\: :ref:`RID`\ ) +|void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID`, effects\: :ref:`RID`\ ) :ref:`🔗` Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes`. @@ -10491,7 +10499,7 @@ Sets the camera attributes (``effects``) that will be used with this scenario. S .. rst-class:: classref-method -|void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID`, compositor\: :ref:`RID`\ ) +|void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID`, compositor\: :ref:`RID`\ ) :ref:`🔗` Sets the compositor (``compositor``) that will be used with this scenario. See also :ref:`Compositor`. @@ -10503,7 +10511,7 @@ Sets the compositor (``compositor``) that will be used with this scenario. See a .. rst-class:: classref-method -|void| **scenario_set_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) +|void| **scenario_set_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) :ref:`🔗` Sets the environment that will be used with this scenario. See also :ref:`Environment`. @@ -10515,7 +10523,7 @@ Sets the environment that will be used with this scenario. See also :ref:`Enviro .. rst-class:: classref-method -|void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) +|void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) :ref:`🔗` Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment. @@ -10527,7 +10535,7 @@ Sets the fallback environment to be used by this scenario. The fallback environm .. rst-class:: classref-method -|void| **screen_space_roughness_limiter_set_active**\ (\ enable\: :ref:`bool`, amount\: :ref:`float`, limit\: :ref:`float`\ ) +|void| **screen_space_roughness_limiter_set_active**\ (\ enable\: :ref:`bool`, amount\: :ref:`float`, limit\: :ref:`float`\ ) :ref:`🔗` Sets the screen-space roughness limiter parameters, such as whether it should be enabled and its thresholds. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/enabled`, :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/amount` and :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/limit`. @@ -10539,7 +10547,7 @@ Sets the screen-space roughness limiter parameters, such as whether it should be .. rst-class:: classref-method -|void| **set_boot_image**\ (\ image\: :ref:`Image`, color\: :ref:`Color`, scale\: :ref:`bool`, use_filter\: :ref:`bool` = true\ ) +|void| **set_boot_image**\ (\ image\: :ref:`Image`, color\: :ref:`Color`, scale\: :ref:`bool`, use_filter\: :ref:`bool` = true\ ) :ref:`🔗` Sets a boot image. The color defines the background color. If ``scale`` is ``true``, the image will be scaled to fit the screen size. If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation. @@ -10551,7 +10559,7 @@ Sets a boot image. The color defines the background color. If ``scale`` is ``tru .. rst-class:: classref-method -|void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool`\ ) +|void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool`\ ) :ref:`🔗` This method is currently unimplemented and does nothing if called with ``generate`` set to ``true``. @@ -10563,7 +10571,7 @@ This method is currently unimplemented and does nothing if called with ``generat .. rst-class:: classref-method -|void| **set_default_clear_color**\ (\ color\: :ref:`Color`\ ) +|void| **set_default_clear_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Sets the default clear color which is used when a specific clear color has not been selected. See also :ref:`get_default_clear_color`. @@ -10575,7 +10583,7 @@ Sets the default clear color which is used when a specific clear color has not b .. rst-class:: classref-method -:ref:`RID` **shader_create**\ (\ ) +:ref:`RID` **shader_create**\ (\ ) :ref:`🔗` Creates an empty shader and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``shader_*`` RenderingServer functions. @@ -10591,7 +10599,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`String` **shader_get_code**\ (\ shader\: :ref:`RID`\ ) |const| +:ref:`String` **shader_get_code**\ (\ shader\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a shader's source code as a string. @@ -10603,7 +10611,7 @@ Returns a shader's source code as a string. .. rst-class:: classref-method -:ref:`RID` **shader_get_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| +:ref:`RID` **shader_get_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns a default texture from a shader searched by name. @@ -10617,7 +10625,7 @@ Returns a default texture from a shader searched by name. .. rst-class:: classref-method -:ref:`Variant` **shader_get_parameter_default**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **shader_get_parameter_default**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the default value for the specified shader uniform. This is usually the value written in the shader source code. @@ -10629,7 +10637,7 @@ Returns the default value for the specified shader uniform. This is usually the .. rst-class:: classref-method -|void| **shader_set_code**\ (\ shader\: :ref:`RID`, code\: :ref:`String`\ ) +|void| **shader_set_code**\ (\ shader\: :ref:`RID`, code\: :ref:`String`\ ) :ref:`🔗` Sets the shader's source code (which triggers recompilation after being changed). @@ -10641,7 +10649,7 @@ Sets the shader's source code (which triggers recompilation after being changed) .. rst-class:: classref-method -|void| **shader_set_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, texture\: :ref:`RID`, index\: :ref:`int` = 0\ ) +|void| **shader_set_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, texture\: :ref:`RID`, index\: :ref:`int` = 0\ ) :ref:`🔗` Sets a shader's default texture. Overwrites the texture given by name. @@ -10655,7 +10663,7 @@ Sets a shader's default texture. Overwrites the texture given by name. .. rst-class:: classref-method -|void| **shader_set_path_hint**\ (\ shader\: :ref:`RID`, path\: :ref:`String`\ ) +|void| **shader_set_path_hint**\ (\ shader\: :ref:`RID`, path\: :ref:`String`\ ) :ref:`🔗` Sets the path hint for the specified shader. This should generally match the :ref:`Shader` resource's :ref:`Resource.resource_path`. @@ -10667,7 +10675,7 @@ Sets the path hint for the specified shader. This should generally match the :re .. rst-class:: classref-method -|void| **skeleton_allocate_data**\ (\ skeleton\: :ref:`RID`, bones\: :ref:`int`, is_2d_skeleton\: :ref:`bool` = false\ ) +|void| **skeleton_allocate_data**\ (\ skeleton\: :ref:`RID`, bones\: :ref:`int`, is_2d_skeleton\: :ref:`bool` = false\ ) :ref:`🔗` .. container:: contribute @@ -10681,7 +10689,7 @@ Sets the path hint for the specified shader. This should generally match the :re .. rst-class:: classref-method -:ref:`Transform3D` **skeleton_bone_get_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| +:ref:`Transform3D` **skeleton_bone_get_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Transform3D` set for a specific bone of this skeleton. @@ -10693,7 +10701,7 @@ Returns the :ref:`Transform3D` set for a specific bone of thi .. rst-class:: classref-method -:ref:`Transform2D` **skeleton_bone_get_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| +:ref:`Transform2D` **skeleton_bone_get_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Transform2D` set for a specific bone of this skeleton. @@ -10705,7 +10713,7 @@ Returns the :ref:`Transform2D` set for a specific bone of thi .. rst-class:: classref-method -|void| **skeleton_bone_set_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **skeleton_bone_set_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the :ref:`Transform3D` for a specific bone of this skeleton. @@ -10717,7 +10725,7 @@ Sets the :ref:`Transform3D` for a specific bone of this skele .. rst-class:: classref-method -|void| **skeleton_bone_set_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform2D`\ ) +|void| **skeleton_bone_set_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the :ref:`Transform2D` for a specific bone of this skeleton. @@ -10729,7 +10737,7 @@ Sets the :ref:`Transform2D` for a specific bone of this skele .. rst-class:: classref-method -:ref:`RID` **skeleton_create**\ (\ ) +:ref:`RID` **skeleton_create**\ (\ ) :ref:`🔗` Creates a skeleton and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``skeleton_*`` RenderingServer functions. @@ -10743,7 +10751,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`int` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID`\ ) |const| +:ref:`int` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of bones allocated for this skeleton. @@ -10755,7 +10763,7 @@ Returns the number of bones allocated for this skeleton. .. rst-class:: classref-method -|void| **skeleton_set_base_transform_2d**\ (\ skeleton\: :ref:`RID`, base_transform\: :ref:`Transform2D`\ ) +|void| **skeleton_set_base_transform_2d**\ (\ skeleton\: :ref:`RID`, base_transform\: :ref:`Transform2D`\ ) :ref:`🔗` .. container:: contribute @@ -10769,7 +10777,7 @@ Returns the number of bones allocated for this skeleton. .. rst-class:: classref-method -:ref:`Image` **sky_bake_panorama**\ (\ sky\: :ref:`RID`, energy\: :ref:`float`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) +:ref:`Image` **sky_bake_panorama**\ (\ sky\: :ref:`RID`, energy\: :ref:`float`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Generates and returns an :ref:`Image` containing the radiance map for the specified ``sky`` RID. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`environment_bake_panorama`. @@ -10785,7 +10793,7 @@ Generates and returns an :ref:`Image` containing the radiance map f .. rst-class:: classref-method -:ref:`RID` **sky_create**\ (\ ) +:ref:`RID` **sky_create**\ (\ ) :ref:`🔗` Creates an empty sky and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``sky_*`` RenderingServer functions. @@ -10799,7 +10807,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **sky_set_material**\ (\ sky\: :ref:`RID`, material\: :ref:`RID`\ ) +|void| **sky_set_material**\ (\ sky\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` Sets the material that the sky uses to render the background, ambient and reflection maps. @@ -10811,7 +10819,7 @@ Sets the material that the sky uses to render the background, ambient and reflec .. rst-class:: classref-method -|void| **sky_set_mode**\ (\ sky\: :ref:`RID`, mode\: :ref:`SkyMode`\ ) +|void| **sky_set_mode**\ (\ sky\: :ref:`RID`, mode\: :ref:`SkyMode`\ ) :ref:`🔗` Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode`. @@ -10823,7 +10831,7 @@ Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to .. rst-class:: classref-method -|void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID`, radiance_size\: :ref:`int`\ ) +|void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID`, radiance_size\: :ref:`int`\ ) :ref:`🔗` Sets the ``radiance_size`` of the sky specified by the ``sky`` RID (in pixels). Equivalent to :ref:`Sky.radiance_size`. @@ -10835,7 +10843,7 @@ Sets the ``radiance_size`` of the sky specified by the ``sky`` RID (in pixels). .. rst-class:: classref-method -:ref:`RID` **spot_light_create**\ (\ ) +:ref:`RID` **spot_light_create**\ (\ ) :ref:`🔗` Creates a spot light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions. @@ -10851,7 +10859,7 @@ To place in a scene, attach this spot light to an instance using :ref:`instance_ .. rst-class:: classref-method -|void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality`\ ) +|void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality`\ ) :ref:`🔗` Sets :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality` to use when rendering materials that have subsurface scattering enabled. @@ -10863,7 +10871,7 @@ Sets :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurfac .. rst-class:: classref-method -|void| **sub_surface_scattering_set_scale**\ (\ scale\: :ref:`float`, depth_scale\: :ref:`float`\ ) +|void| **sub_surface_scattering_set_scale**\ (\ scale\: :ref:`float`, depth_scale\: :ref:`float`\ ) :ref:`🔗` Sets the :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale` and :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale` to use when rendering materials that have subsurface scattering enabled. @@ -10875,7 +10883,7 @@ Sets the :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsu .. rst-class:: classref-method -:ref:`RID` **texture_2d_create**\ (\ image\: :ref:`Image`\ ) +:ref:`RID` **texture_2d_create**\ (\ image\: :ref:`Image`\ ) :ref:`🔗` Creates a 2-dimensional texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_*`` RenderingServer functions. @@ -10893,7 +10901,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Image` **texture_2d_get**\ (\ texture\: :ref:`RID`\ ) |const| +:ref:`Image` **texture_2d_get**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` Returns an :ref:`Image` instance from the given ``texture`` :ref:`RID`. @@ -10913,7 +10921,7 @@ Example of getting the test texture from :ref:`get_test_texture` **texture_2d_layer_get**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) |const| +:ref:`Image` **texture_2d_layer_get**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns an :ref:`Image` instance from the given ``texture`` :ref:`RID` and ``layer``. @@ -10925,7 +10933,7 @@ Returns an :ref:`Image` instance from the given ``texture`` :ref:`R .. rst-class:: classref-method -:ref:`RID` **texture_2d_layered_create**\ (\ layers\: :ref:`Array`\[:ref:`Image`\], layered_type\: :ref:`TextureLayeredType`\ ) +:ref:`RID` **texture_2d_layered_create**\ (\ layers\: :ref:`Array`\[:ref:`Image`\], layered_type\: :ref:`TextureLayeredType`\ ) :ref:`🔗` Creates a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions. @@ -10941,7 +10949,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`RID` **texture_2d_layered_placeholder_create**\ (\ layered_type\: :ref:`TextureLayeredType`\ ) +:ref:`RID` **texture_2d_layered_placeholder_create**\ (\ layered_type\: :ref:`TextureLayeredType`\ ) :ref:`🔗` Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions, although it does nothing when used. See also :ref:`texture_2d_placeholder_create`. @@ -10955,7 +10963,7 @@ Creates a placeholder for a 2-dimensional layered texture and adds it to the Ren .. rst-class:: classref-method -:ref:`RID` **texture_2d_placeholder_create**\ (\ ) +:ref:`RID` **texture_2d_placeholder_create**\ (\ ) :ref:`🔗` Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions, although it does nothing when used. See also :ref:`texture_2d_layered_placeholder_create`\ @@ -10971,7 +10979,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **texture_2d_update**\ (\ texture\: :ref:`RID`, image\: :ref:`Image`, layer\: :ref:`int`\ ) +|void| **texture_2d_update**\ (\ texture\: :ref:`RID`, image\: :ref:`Image`, layer\: :ref:`int`\ ) :ref:`🔗` Updates the texture specified by the ``texture`` :ref:`RID` with the data in ``image``. A ``layer`` must also be specified, which should be ``0`` when updating a single-layer texture (:ref:`Texture2D`). @@ -10985,7 +10993,7 @@ Updates the texture specified by the ``texture`` :ref:`RID` with the .. rst-class:: classref-method -:ref:`RID` **texture_3d_create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) +:ref:`RID` **texture_3d_create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` **Note:** The equivalent resource is :ref:`Texture3D`. @@ -10997,7 +11005,7 @@ Updates the texture specified by the ``texture`` :ref:`RID` with the .. rst-class:: classref-method -:ref:`Array`\[:ref:`Image`\] **texture_3d_get**\ (\ texture\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`Image`\] **texture_3d_get**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` Returns 3D texture data as an array of :ref:`Image`\ s for the specified texture :ref:`RID`. @@ -11009,7 +11017,7 @@ Returns 3D texture data as an array of :ref:`Image`\ s for the spec .. rst-class:: classref-method -:ref:`RID` **texture_3d_placeholder_create**\ (\ ) +:ref:`RID` **texture_3d_placeholder_create**\ (\ ) :ref:`🔗` Creates a placeholder for a 3-dimensional texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_3d_*`` RenderingServer functions, although it does nothing when used. @@ -11025,7 +11033,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **texture_3d_update**\ (\ texture\: :ref:`RID`, data\: :ref:`Array`\[:ref:`Image`\]\ ) +|void| **texture_3d_update**\ (\ texture\: :ref:`RID`, data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` Updates the texture specified by the ``texture`` :ref:`RID`'s data with the data in ``data``. All the texture's layers must be replaced at once. @@ -11039,7 +11047,7 @@ Updates the texture specified by the ``texture`` :ref:`RID`'s data wi .. rst-class:: classref-method -:ref:`Format` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) |const| +:ref:`Format` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the format for the texture. @@ -11051,7 +11059,7 @@ Returns the format for the texture. .. rst-class:: classref-method -:ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| +:ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension. @@ -11065,7 +11073,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. rst-class:: classref-method -:ref:`String` **texture_get_path**\ (\ texture\: :ref:`RID`\ ) |const| +:ref:`String` **texture_get_path**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -11079,7 +11087,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. rst-class:: classref-method -:ref:`RID` **texture_get_rd_texture**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| +:ref:`RID` **texture_get_rd_texture**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a texture :ref:`RID` that can be used with :ref:`RenderingDevice`. @@ -11091,7 +11099,7 @@ Returns a texture :ref:`RID` that can be used with :ref:`RenderingDev .. rst-class:: classref-method -:ref:`RID` **texture_proxy_create**\ (\ base\: :ref:`RID`\ ) +:ref:`RID` **texture_proxy_create**\ (\ base\: :ref:`RID`\ ) :ref:`🔗` **Deprecated:** ProxyTexture was removed in Godot 4. @@ -11105,7 +11113,7 @@ This method does nothing and always returns an invalid :ref:`RID`. .. rst-class:: classref-method -|void| **texture_proxy_update**\ (\ texture\: :ref:`RID`, proxy_to\: :ref:`RID`\ ) +|void| **texture_proxy_update**\ (\ texture\: :ref:`RID`, proxy_to\: :ref:`RID`\ ) :ref:`🔗` **Deprecated:** ProxyTexture was removed in Godot 4. @@ -11119,7 +11127,7 @@ This method does nothing. .. rst-class:: classref-method -:ref:`RID` **texture_rd_create**\ (\ rd_texture\: :ref:`RID`, layer_type\: :ref:`TextureLayeredType` = 0\ ) +:ref:`RID` **texture_rd_create**\ (\ rd_texture\: :ref:`RID`, layer_type\: :ref:`TextureLayeredType` = 0\ ) :ref:`🔗` Creates a new texture object based on a texture created directly on the :ref:`RenderingDevice`. If the texture contains layers, ``layer_type`` is used to define the layer type. @@ -11131,7 +11139,7 @@ Creates a new texture object based on a texture created directly on the :ref:`Re .. rst-class:: classref-method -|void| **texture_replace**\ (\ texture\: :ref:`RID`, by_texture\: :ref:`RID`\ ) +|void| **texture_replace**\ (\ texture\: :ref:`RID`, by_texture\: :ref:`RID`\ ) :ref:`🔗` Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID. @@ -11143,7 +11151,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. rst-class:: classref-method -|void| **texture_set_force_redraw_if_visible**\ (\ texture\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **texture_set_force_redraw_if_visible**\ (\ texture\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute @@ -11157,7 +11165,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. rst-class:: classref-method -|void| **texture_set_path**\ (\ texture\: :ref:`RID`, path\: :ref:`String`\ ) +|void| **texture_set_path**\ (\ texture\: :ref:`RID`, path\: :ref:`String`\ ) :ref:`🔗` .. container:: contribute @@ -11171,7 +11179,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. rst-class:: classref-method -|void| **texture_set_size_override**\ (\ texture\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) +|void| **texture_set_size_override**\ (\ texture\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute @@ -11185,7 +11193,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. rst-class:: classref-method -|void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID`, camera\: :ref:`RID`\ ) +|void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID`, camera\: :ref:`RID`\ ) :ref:`🔗` Sets a viewport's camera. @@ -11197,7 +11205,7 @@ Sets a viewport's camera. .. rst-class:: classref-method -|void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) +|void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` Sets a viewport's canvas. @@ -11209,7 +11217,7 @@ Sets a viewport's canvas. .. rst-class:: classref-method -|void| **viewport_attach_to_screen**\ (\ viewport\: :ref:`RID`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0), screen\: :ref:`int` = 0\ ) +|void| **viewport_attach_to_screen**\ (\ viewport\: :ref:`RID`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0), screen\: :ref:`int` = 0\ ) :ref:`🔗` Copies the viewport to a region of the screen specified by ``rect``. If :ref:`viewport_set_render_direct_to_screen` is ``true``, then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. @@ -11238,7 +11246,7 @@ Using this can result in significant optimization, especially on lower-end devic .. rst-class:: classref-method -:ref:`RID` **viewport_create**\ (\ ) +:ref:`RID` **viewport_create**\ (\ ) :ref:`🔗` Creates an empty viewport and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``viewport_*`` RenderingServer functions. @@ -11254,7 +11262,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`float` **viewport_get_measured_render_time_cpu**\ (\ viewport\: :ref:`RID`\ ) |const| +:ref:`float` **viewport_get_measured_render_time_cpu**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the CPU time taken to render the last frame in milliseconds. This *only* includes time spent in rendering-related operations; scripts' ``_process`` functions and other engine subsystems are not included in this readout. To get a complete readout of CPU time spent to render the scene, sum the render times of all viewports that are drawn every frame plus :ref:`get_frame_setup_time_cpu`. Unlike :ref:`Engine.get_frames_per_second`, this method will accurately reflect CPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps`. See also :ref:`viewport_get_measured_render_time_gpu`. @@ -11268,7 +11276,7 @@ Returns the CPU time taken to render the last frame in milliseconds. This *only* .. rst-class:: classref-method -:ref:`float` **viewport_get_measured_render_time_gpu**\ (\ viewport\: :ref:`RID`\ ) |const| +:ref:`float` **viewport_get_measured_render_time_gpu**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike :ref:`Engine.get_frames_per_second`, this method accurately reflects GPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps`. See also :ref:`viewport_get_measured_render_time_gpu`. @@ -11284,7 +11292,7 @@ Returns the GPU time taken to render the last frame in milliseconds. To get a co .. rst-class:: classref-method -:ref:`int` **viewport_get_render_info**\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) +:ref:`int` **viewport_get_render_info**\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) :ref:`🔗` Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass ``type``\ s, each of them having the same ``info``\ s you can query (different passes will return different values). See :ref:`ViewportRenderInfoType` for a list of render pass types and :ref:`ViewportRenderInfo` for a list of information that can be queried. @@ -11312,7 +11320,7 @@ See also :ref:`get_rendering_info` **viewport_get_render_target**\ (\ viewport\: :ref:`RID`\ ) |const| +:ref:`RID` **viewport_get_render_target**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the render target for the viewport. @@ -11324,7 +11332,7 @@ Returns the render target for the viewport. .. rst-class:: classref-method -:ref:`RID` **viewport_get_texture**\ (\ viewport\: :ref:`RID`\ ) |const| +:ref:`RID` **viewport_get_texture**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the viewport's last rendered frame. @@ -11336,7 +11344,7 @@ Returns the viewport's last rendered frame. .. rst-class:: classref-method -:ref:`ViewportUpdateMode` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID`\ ) |const| +:ref:`ViewportUpdateMode` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the viewport's update mode. See :ref:`ViewportUpdateMode` constants for options. @@ -11350,7 +11358,7 @@ Returns the viewport's update mode. See :ref:`ViewportUpdateMode`, canvas\: :ref:`RID`\ ) +|void| **viewport_remove_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` Detaches a viewport from a canvas. @@ -11362,7 +11370,7 @@ Detaches a viewport from a canvas. .. rst-class:: classref-method -|void| **viewport_set_active**\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) +|void| **viewport_set_active**\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) :ref:`🔗` If ``true``, sets the viewport active, else sets it inactive. @@ -11374,7 +11382,7 @@ If ``true``, sets the viewport active, else sets it inactive. .. rst-class:: classref-method -|void| **viewport_set_canvas_cull_mask**\ (\ viewport\: :ref:`RID`, canvas_cull_mask\: :ref:`int`\ ) +|void| **viewport_set_canvas_cull_mask**\ (\ viewport\: :ref:`RID`, canvas_cull_mask\: :ref:`int`\ ) :ref:`🔗` Sets the rendering mask associated with this :ref:`Viewport`. Only :ref:`CanvasItem` nodes with a matching rendering visibility layer will be rendered by this :ref:`Viewport`. @@ -11386,7 +11394,7 @@ Sets the rendering mask associated with this :ref:`Viewport`. On .. rst-class:: classref-method -|void| **viewport_set_canvas_stacking**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, layer\: :ref:`int`, sublayer\: :ref:`int`\ ) +|void| **viewport_set_canvas_stacking**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, layer\: :ref:`int`, sublayer\: :ref:`int`\ ) :ref:`🔗` Sets the stacking order for a viewport's canvas. @@ -11400,7 +11408,7 @@ Sets the stacking order for a viewport's canvas. .. rst-class:: classref-method -|void| **viewport_set_canvas_transform**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, offset\: :ref:`Transform2D`\ ) +|void| **viewport_set_canvas_transform**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, offset\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the transformation of a viewport's canvas. @@ -11412,7 +11420,7 @@ Sets the transformation of a viewport's canvas. .. rst-class:: classref-method -|void| **viewport_set_clear_mode**\ (\ viewport\: :ref:`RID`, clear_mode\: :ref:`ViewportClearMode`\ ) +|void| **viewport_set_clear_mode**\ (\ viewport\: :ref:`RID`, clear_mode\: :ref:`ViewportClearMode`\ ) :ref:`🔗` Sets the clear mode of a viewport. See :ref:`ViewportClearMode` for options. @@ -11424,7 +11432,7 @@ Sets the clear mode of a viewport. See :ref:`ViewportClearMode`, draw\: :ref:`ViewportDebugDraw`\ ) +|void| **viewport_set_debug_draw**\ (\ viewport\: :ref:`RID`, draw\: :ref:`ViewportDebugDraw`\ ) :ref:`🔗` Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` for options. @@ -11436,7 +11444,7 @@ Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw`, filter\: :ref:`CanvasItemTextureFilter`\ ) +|void| **viewport_set_default_canvas_item_texture_filter**\ (\ viewport\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter` for options. @@ -11448,7 +11456,7 @@ Sets the default texture filtering mode for the specified ``viewport`` RID. See .. rst-class:: classref-method -|void| **viewport_set_default_canvas_item_texture_repeat**\ (\ viewport\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) +|void| **viewport_set_default_canvas_item_texture_repeat**\ (\ viewport\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat` for options. @@ -11460,7 +11468,7 @@ Sets the default texture repeat mode for the specified ``viewport`` RID. See :re .. rst-class:: classref-method -|void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) +|void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered. @@ -11472,7 +11480,7 @@ If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered. .. rst-class:: classref-method -|void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) +|void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the viewport's 3D elements are not rendered. @@ -11484,7 +11492,7 @@ If ``true``, the viewport's 3D elements are not rendered. .. rst-class:: classref-method -|void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportEnvironmentMode`\ ) +|void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportEnvironmentMode`\ ) :ref:`🔗` Sets the viewport's environment mode which allows enabling or disabling rendering of 3D environment over 2D canvas. When disabled, 2D will not be affected by the environment. When enabled, 2D will be affected by the environment if the environment background mode is :ref:`ENV_BG_CANVAS`. The default behavior is to inherit the setting from the viewport's parent. If the topmost parent is also set to :ref:`VIEWPORT_ENVIRONMENT_INHERIT`, then the behavior will be the same as if it was set to :ref:`VIEWPORT_ENVIRONMENT_ENABLED`. @@ -11496,7 +11504,7 @@ Sets the viewport's environment mode which allows enabling or disabling renderin .. rst-class:: classref-method -|void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID`, sharpness\: :ref:`float`\ ) +|void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID`, sharpness\: :ref:`float`\ ) :ref:`🔗` Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. @@ -11508,7 +11516,7 @@ Determines how sharp the upscaled image will be when using the FSR upscaling mod .. rst-class:: classref-method -|void| **viewport_set_global_canvas_transform**\ (\ viewport\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **viewport_set_global_canvas_transform**\ (\ viewport\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets the viewport's global transformation matrix. @@ -11520,7 +11528,7 @@ Sets the viewport's global transformation matrix. .. rst-class:: classref-method -|void| **viewport_set_measure_render_time**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **viewport_set_measure_render_time**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets the measurement for the given ``viewport`` RID (obtained using :ref:`Viewport.get_viewport_rid`). Once enabled, :ref:`viewport_get_measured_render_time_cpu` and :ref:`viewport_get_measured_render_time_gpu` will return values greater than ``0.0`` when queried with the given ``viewport``. @@ -11532,7 +11540,7 @@ Sets the measurement for the given ``viewport`` RID (obtained using :ref:`Viewpo .. rst-class:: classref-method -|void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) +|void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) :ref:`🔗` Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA` for options. @@ -11544,7 +11552,7 @@ Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewpor .. rst-class:: classref-method -|void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) +|void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) :ref:`🔗` Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA` for options. @@ -11556,7 +11564,7 @@ Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID .. rst-class:: classref-method -|void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality`\ ) +|void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality`\ ) :ref:`🔗` Sets the :ref:`ProjectSettings.rendering/occlusion_culling/bvh_build_quality` to use for occlusion culling. This parameter is global and cannot be set on a per-viewport basis. @@ -11568,7 +11576,7 @@ Sets the :ref:`ProjectSettings.rendering/occlusion_culling/bvh_build_quality`\ ) +|void| **viewport_set_occlusion_rays_per_thread**\ (\ rays_per_thread\: :ref:`int`\ ) :ref:`🔗` Sets the :ref:`ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_thread` to use for occlusion culling. This parameter is global and cannot be set on a per-viewport basis. @@ -11580,7 +11588,7 @@ Sets the :ref:`ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_th .. rst-class:: classref-method -|void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID`, parent_viewport\: :ref:`RID`\ ) +|void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID`, parent_viewport\: :ref:`RID`\ ) :ref:`🔗` Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID. @@ -11592,7 +11600,7 @@ Sets the viewport's parent to the viewport specified by the ``parent_viewport`` .. rst-class:: classref-method -|void| **viewport_set_positional_shadow_atlas_quadrant_subdivision**\ (\ viewport\: :ref:`RID`, quadrant\: :ref:`int`, subdivision\: :ref:`int`\ ) +|void| **viewport_set_positional_shadow_atlas_quadrant_subdivision**\ (\ viewport\: :ref:`RID`, quadrant\: :ref:`int`, subdivision\: :ref:`int`\ ) :ref:`🔗` Sets the number of subdivisions to use in the specified shadow atlas ``quadrant`` for omni and spot shadows. See also :ref:`Viewport.set_positional_shadow_atlas_quadrant_subdiv`. @@ -11604,7 +11612,7 @@ Sets the number of subdivisions to use in the specified shadow atlas ``quadrant` .. rst-class:: classref-method -|void| **viewport_set_positional_shadow_atlas_size**\ (\ viewport\: :ref:`RID`, size\: :ref:`int`, use_16_bits\: :ref:`bool` = false\ ) +|void| **viewport_set_positional_shadow_atlas_size**\ (\ viewport\: :ref:`RID`, size\: :ref:`int`, use_16_bits\: :ref:`bool` = false\ ) :ref:`🔗` Sets the ``size`` of the shadow atlas's images (used for omni and spot lights) on the viewport specified by the ``viewport`` RID. The value is rounded up to the nearest power of 2. If ``use_16_bits`` is ``true``, use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. @@ -11618,7 +11626,7 @@ Sets the ``size`` of the shadow atlas's images (used for omni and spot lights) o .. rst-class:: classref-method -|void| **viewport_set_render_direct_to_screen**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **viewport_set_render_direct_to_screen**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the screen_texture. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. @@ -11630,7 +11638,7 @@ If ``true``, render the contents of the viewport directly to screen. This allows .. rst-class:: classref-method -|void| **viewport_set_scaling_3d_mode**\ (\ viewport\: :ref:`RID`, scaling_3d_mode\: :ref:`ViewportScaling3DMode`\ ) +|void| **viewport_set_scaling_3d_mode**\ (\ viewport\: :ref:`RID`, scaling_3d_mode\: :ref:`ViewportScaling3DMode`\ ) :ref:`🔗` Sets the 3D resolution scaling mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. @@ -11642,7 +11650,7 @@ Sets the 3D resolution scaling mode. Bilinear scaling renders at different resol .. rst-class:: classref-method -|void| **viewport_set_scaling_3d_scale**\ (\ viewport\: :ref:`RID`, scale\: :ref:`float`\ ) +|void| **viewport_set_scaling_3d_scale**\ (\ viewport\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`ViewportScaling3DMode` to scale the output image to the full viewport size. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`ViewportMSAA` for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. @@ -11656,7 +11664,7 @@ When using FSR upscaling, AMD recommends exposing the following values as preset .. rst-class:: classref-method -|void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID`, scenario\: :ref:`RID`\ ) +|void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID`, scenario\: :ref:`RID`\ ) :ref:`🔗` Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc. @@ -11668,7 +11676,7 @@ Sets a viewport's scenario. The scenario contains information about environment .. rst-class:: classref-method -|void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportScreenSpaceAA`\ ) +|void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportScreenSpaceAA`\ ) :ref:`🔗` Sets the viewport's screen-space antialiasing mode. @@ -11680,7 +11688,7 @@ Sets the viewport's screen-space antialiasing mode. .. rst-class:: classref-method -|void| **viewport_set_sdf_oversize_and_scale**\ (\ viewport\: :ref:`RID`, oversize\: :ref:`ViewportSDFOversize`, scale\: :ref:`ViewportSDFScale`\ ) +|void| **viewport_set_sdf_oversize_and_scale**\ (\ viewport\: :ref:`RID`, oversize\: :ref:`ViewportSDFOversize`, scale\: :ref:`ViewportSDFScale`\ ) :ref:`🔗` Sets the viewport's 2D signed distance field :ref:`ProjectSettings.rendering/2d/sdf/oversize` and :ref:`ProjectSettings.rendering/2d/sdf/scale`. This is used when sampling the signed distance field in :ref:`CanvasItem` shaders as well as :ref:`GPUParticles2D` collision. This is *not* used by SDFGI in 3D rendering. @@ -11692,7 +11700,7 @@ Sets the viewport's 2D signed distance field :ref:`ProjectSettings.rendering/2d/ .. rst-class:: classref-method -|void| **viewport_set_size**\ (\ viewport\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) +|void| **viewport_set_size**\ (\ viewport\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) :ref:`🔗` Sets the viewport's width and height in pixels. @@ -11704,7 +11712,7 @@ Sets the viewport's width and height in pixels. .. rst-class:: classref-method -|void| **viewport_set_snap_2d_transforms_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **viewport_set_snap_2d_transforms_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, canvas item transforms (i.e. origin position) are snapped to the nearest pixel when rendering. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. Equivalent to :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel`. @@ -11716,7 +11724,7 @@ If ``true``, canvas item transforms (i.e. origin position) are snapped to the ne .. rst-class:: classref-method -|void| **viewport_set_snap_2d_vertices_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **viewport_set_snap_2d_vertices_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, canvas item vertices (i.e. polygon points) are snapped to the nearest pixel when rendering. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. Equivalent to :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel`. @@ -11728,7 +11736,7 @@ If ``true``, canvas item vertices (i.e. polygon points) are snapped to the neare .. rst-class:: classref-method -|void| **viewport_set_texture_mipmap_bias**\ (\ viewport\: :ref:`RID`, mipmap_bias\: :ref:`float`\ ) +|void| **viewport_set_texture_mipmap_bias**\ (\ viewport\: :ref:`RID`, mipmap_bias\: :ref:`float`\ ) :ref:`🔗` Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between ``-0.75`` and ``0.0``. Enabling temporal antialiasing (:ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa`) can help reduce the graininess visible when using negative mipmap bias. @@ -11742,7 +11750,7 @@ Affects the final texture sharpness by reading from a lower or higher mipmap (al .. rst-class:: classref-method -|void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the viewport renders its background as transparent. @@ -11754,7 +11762,7 @@ If ``true``, the viewport renders its background as transparent. .. rst-class:: classref-method -|void| **viewport_set_update_mode**\ (\ viewport\: :ref:`RID`, update_mode\: :ref:`ViewportUpdateMode`\ ) +|void| **viewport_set_update_mode**\ (\ viewport\: :ref:`RID`, update_mode\: :ref:`ViewportUpdateMode`\ ) :ref:`🔗` Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. @@ -11766,7 +11774,7 @@ Sets when the viewport should be updated. See :ref:`ViewportUpdateMode`, enable\: :ref:`bool`\ ) +|void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding`. @@ -11778,7 +11786,7 @@ If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`Pr .. rst-class:: classref-method -|void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. @@ -11792,7 +11800,7 @@ If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer .. rst-class:: classref-method -|void| **viewport_set_use_occlusion_culling**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **viewport_set_use_occlusion_culling**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables occlusion culling on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling`. @@ -11804,7 +11812,7 @@ If ``true``, enables occlusion culling on the specified viewport. Equivalent to .. rst-class:: classref-method -|void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa`. @@ -11816,7 +11824,7 @@ If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.ren .. rst-class:: classref-method -|void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID`, use_xr\: :ref:`bool`\ ) +|void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID`, use_xr\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface`. @@ -11828,7 +11836,7 @@ If ``true``, the viewport uses augmented or virtual reality technologies. See :r .. rst-class:: classref-method -|void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSMode`\ ) +|void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSMode`\ ) :ref:`🔗` Sets the Variable Rate Shading (VRS) mode for the viewport. If the GPU does not support VRS, this property is ignored. Equivalent to :ref:`ProjectSettings.rendering/vrs/mode`. @@ -11840,7 +11848,7 @@ Sets the Variable Rate Shading (VRS) mode for the viewport. If the GPU does not .. rst-class:: classref-method -|void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID`, texture\: :ref:`RID`\ ) +|void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` The texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE`. Equivalent to :ref:`ProjectSettings.rendering/vrs/texture`. @@ -11852,7 +11860,7 @@ The texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE`, mode\: :ref:`ViewportVRSUpdateMode`\ ) +|void| **viewport_set_vrs_update_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSUpdateMode`\ ) :ref:`🔗` Sets the update mode for Variable Rate Shading (VRS) for the viewport. VRS requires the input texture to be converted to the format usable by the VRS method supported by the hardware. The update mode defines how often this happens. If the GPU does not support VRS, or VRS is not enabled, this property is ignored. @@ -11866,7 +11874,7 @@ If set to :ref:`VIEWPORT_VRS_UPDATE_ONCE` **visibility_notifier_create**\ (\ ) +:ref:`RID` **visibility_notifier_create**\ (\ ) :ref:`🔗` Creates a new 3D visibility notifier object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``visibility_notifier_*`` RenderingServer functions. @@ -11884,7 +11892,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -|void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID`, aabb\: :ref:`AABB`\ ) +|void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` .. container:: contribute @@ -11898,7 +11906,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -|void| **visibility_notifier_set_callbacks**\ (\ notifier\: :ref:`RID`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) +|void| **visibility_notifier_set_callbacks**\ (\ notifier\: :ref:`RID`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute @@ -11912,7 +11920,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -|void| **voxel_gi_allocate_data**\ (\ voxel_gi\: :ref:`RID`, to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3i`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) +|void| **voxel_gi_allocate_data**\ (\ voxel_gi\: :ref:`RID`, to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3i`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) :ref:`🔗` .. container:: contribute @@ -11926,7 +11934,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -:ref:`RID` **voxel_gi_create**\ (\ ) +:ref:`RID` **voxel_gi_create**\ (\ ) :ref:`🔗` Creates a new voxel-based global illumination object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``voxel_gi_*`` RenderingServer functions. @@ -11942,7 +11950,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedByteArray` **voxel_gi_get_data_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| +:ref:`PackedByteArray` **voxel_gi_get_data_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -11956,7 +11964,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedByteArray` **voxel_gi_get_distance_field**\ (\ voxel_gi\: :ref:`RID`\ ) |const| +:ref:`PackedByteArray` **voxel_gi_get_distance_field**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -11970,7 +11978,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedInt32Array` **voxel_gi_get_level_counts**\ (\ voxel_gi\: :ref:`RID`\ ) |const| +:ref:`PackedInt32Array` **voxel_gi_get_level_counts**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -11984,7 +11992,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedByteArray` **voxel_gi_get_octree_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| +:ref:`PackedByteArray` **voxel_gi_get_octree_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -11998,7 +12006,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Vector3i` **voxel_gi_get_octree_size**\ (\ voxel_gi\: :ref:`RID`\ ) |const| +:ref:`Vector3i` **voxel_gi_get_octree_size**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -12012,7 +12020,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Transform3D` **voxel_gi_get_to_cell_xform**\ (\ voxel_gi\: :ref:`RID`\ ) |const| +:ref:`Transform3D` **voxel_gi_get_to_cell_xform**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute @@ -12026,7 +12034,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -|void| **voxel_gi_set_baked_exposure_normalization**\ (\ voxel_gi\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) +|void| **voxel_gi_set_baked_exposure_normalization**\ (\ voxel_gi\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) :ref:`🔗` Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. @@ -12038,7 +12046,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -|void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) +|void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.bias` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -12050,7 +12058,7 @@ Sets the :ref:`VoxelGIData.bias` value to use o .. rst-class:: classref-method -|void| **voxel_gi_set_dynamic_range**\ (\ voxel_gi\: :ref:`RID`, range\: :ref:`float`\ ) +|void| **voxel_gi_set_dynamic_range**\ (\ voxel_gi\: :ref:`RID`, range\: :ref:`float`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.dynamic_range` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -12062,7 +12070,7 @@ Sets the :ref:`VoxelGIData.dynamic_range`, energy\: :ref:`float`\ ) +|void| **voxel_gi_set_energy**\ (\ voxel_gi\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.energy` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -12074,7 +12082,7 @@ Sets the :ref:`VoxelGIData.energy` value to u .. rst-class:: classref-method -|void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) +|void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.interior` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -12086,7 +12094,7 @@ Sets the :ref:`VoxelGIData.interior` value .. rst-class:: classref-method -|void| **voxel_gi_set_normal_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) +|void| **voxel_gi_set_normal_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.normal_bias` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -12098,7 +12106,7 @@ Sets the :ref:`VoxelGIData.normal_bias` .. rst-class:: classref-method -|void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID`, amount\: :ref:`float`\ ) +|void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID`, amount\: :ref:`float`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.propagation` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -12110,7 +12118,7 @@ Sets the :ref:`VoxelGIData.propagation` .. rst-class:: classref-method -|void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality`\ ) +|void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality`\ ) :ref:`🔗` Sets the :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality` value to use when rendering. This parameter is global and cannot be set on a per-VoxelGI basis. @@ -12122,7 +12130,7 @@ Sets the :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality`, enable\: :ref:`bool`\ ) +|void| **voxel_gi_set_use_two_bounces**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` Sets the :ref:`VoxelGIData.use_two_bounces` value to use on the specified ``voxel_gi``'s :ref:`RID`. diff --git a/classes/class_renderscenebuffers.rst b/classes/class_renderscenebuffers.rst index 52fe3f1ef0d..f6a5b3ef58b 100644 --- a/classes/class_renderscenebuffers.rst +++ b/classes/class_renderscenebuffers.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **configure**\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) +|void| **configure**\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) :ref:`🔗` This method is called by the rendering server when the associated viewports configuration is changed. It will discard the old buffers and recreate the internal buffers used. diff --git a/classes/class_renderscenebuffersconfiguration.rst b/classes/class_renderscenebuffersconfiguration.rst index 7d6c636f663..848f7adaf2d 100644 --- a/classes/class_renderscenebuffersconfiguration.rst +++ b/classes/class_renderscenebuffersconfiguration.rst @@ -62,7 +62,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **fsr_sharpness** = ``0.0`` +:ref:`float` **fsr_sharpness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -79,7 +79,7 @@ FSR Sharpness applicable if FSR upscaling is used. .. rst-class:: classref-property -:ref:`Vector2i` **internal_size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **internal_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ The size of the 3D render buffer used for rendering. .. rst-class:: classref-property -:ref:`ViewportMSAA` **msaa_3d** = ``0`` +:ref:`ViewportMSAA` **msaa_3d** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The MSAA mode we're using for 3D rendering. .. rst-class:: classref-property -:ref:`RID` **render_target** = ``RID()`` +:ref:`RID` **render_target** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ The render target associated with these buffer. .. rst-class:: classref-property -:ref:`ViewportScaling3DMode` **scaling_3d_mode** = ``255`` +:ref:`ViewportScaling3DMode` **scaling_3d_mode** = ``255`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -147,7 +147,7 @@ The requested scaling mode with which we upscale/downscale if :ref:`internal_siz .. rst-class:: classref-property -:ref:`ViewportScreenSpaceAA` **screen_space_aa** = ``0`` +:ref:`ViewportScreenSpaceAA` **screen_space_aa** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The requested screen space AA applied in post processing. .. rst-class:: classref-property -:ref:`Vector2i` **target_size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **target_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -181,7 +181,7 @@ The target (upscale) size if scaling is used. .. rst-class:: classref-property -:ref:`float` **texture_mipmap_bias** = ``0.0`` +:ref:`float` **texture_mipmap_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ Bias applied to mipmaps. .. rst-class:: classref-property -:ref:`int` **view_count** = ``1`` +:ref:`int` **view_count** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_renderscenebuffersextension.rst b/classes/class_renderscenebuffersextension.rst index 2c92ebe6deb..0fe292eb0bc 100644 --- a/classes/class_renderscenebuffersextension.rst +++ b/classes/class_renderscenebuffersextension.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_configure**\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) |virtual| +|void| **_configure**\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) |virtual| :ref:`🔗` Implement this in GDExtension to handle the (re)sizing of a viewport. @@ -64,7 +64,7 @@ Implement this in GDExtension to handle the (re)sizing of a viewport. .. rst-class:: classref-method -|void| **_set_fsr_sharpness**\ (\ fsr_sharpness\: :ref:`float`\ ) |virtual| +|void| **_set_fsr_sharpness**\ (\ fsr_sharpness\: :ref:`float`\ ) |virtual| :ref:`🔗` Implement this in GDExtension to record a new FSR sharpness value. @@ -76,7 +76,7 @@ Implement this in GDExtension to record a new FSR sharpness value. .. rst-class:: classref-method -|void| **_set_texture_mipmap_bias**\ (\ texture_mipmap_bias\: :ref:`float`\ ) |virtual| +|void| **_set_texture_mipmap_bias**\ (\ texture_mipmap_bias\: :ref:`float`\ ) |virtual| :ref:`🔗` Implement this in GDExtension to change the texture mipmap bias. @@ -88,7 +88,7 @@ Implement this in GDExtension to change the texture mipmap bias. .. rst-class:: classref-method -|void| **_set_use_debanding**\ (\ use_debanding\: :ref:`bool`\ ) |virtual| +|void| **_set_use_debanding**\ (\ use_debanding\: :ref:`bool`\ ) |virtual| :ref:`🔗` Implement this in GDExtension to react to the debanding flag changing. diff --git a/classes/class_renderscenebuffersrd.rst b/classes/class_renderscenebuffersrd.rst index 368324f4285..44cf432275c 100644 --- a/classes/class_renderscenebuffersrd.rst +++ b/classes/class_renderscenebuffersrd.rst @@ -92,7 +92,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_context**\ (\ context\: :ref:`StringName`\ ) +|void| **clear_context**\ (\ context\: :ref:`StringName`\ ) :ref:`🔗` Frees all buffers related to this context. @@ -104,7 +104,7 @@ Frees all buffers related to this context. .. rst-class:: classref-method -:ref:`RID` **create_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, data_format\: :ref:`DataFormat`, usage_bits\: :ref:`int`, texture_samples\: :ref:`TextureSamples`, size\: :ref:`Vector2i`, layers\: :ref:`int`, mipmaps\: :ref:`int`, unique\: :ref:`bool`\ ) +:ref:`RID` **create_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, data_format\: :ref:`DataFormat`, usage_bits\: :ref:`int`, texture_samples\: :ref:`TextureSamples`, size\: :ref:`Vector2i`, layers\: :ref:`int`, mipmaps\: :ref:`int`, unique\: :ref:`bool`\ ) :ref:`🔗` Create a new texture with the given definition and cache this under the given name. Will return the existing texture if it already exists. @@ -116,7 +116,7 @@ Create a new texture with the given definition and cache this under the given na .. rst-class:: classref-method -:ref:`RID` **create_texture_from_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, unique\: :ref:`bool`\ ) +:ref:`RID` **create_texture_from_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, unique\: :ref:`bool`\ ) :ref:`🔗` Create a new texture using the given format and view and cache this under the given name. Will return the existing texture if it already exists. @@ -128,7 +128,7 @@ Create a new texture using the given format and view and cache this under the gi .. rst-class:: classref-method -:ref:`RID` **create_texture_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, view_name\: :ref:`StringName`, view\: :ref:`RDTextureView`\ ) +:ref:`RID` **create_texture_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, view_name\: :ref:`StringName`, view\: :ref:`RDTextureView`\ ) :ref:`🔗` Create a new texture view for an existing texture and cache this under the given view_name. Will return the existing teture view if it already exists. Will error if the source texture doesn't exist. @@ -140,7 +140,7 @@ Create a new texture view for an existing texture and cache this under the given .. rst-class:: classref-method -:ref:`RID` **get_color_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) +:ref:`RID` **get_color_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the specified layer from the color texture we are rendering 3D content to. @@ -154,7 +154,7 @@ If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of th .. rst-class:: classref-method -:ref:`RID` **get_color_texture**\ (\ msaa\: :ref:`bool` = false\ ) +:ref:`RID` **get_color_texture**\ (\ msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the color texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. @@ -168,7 +168,7 @@ If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of th .. rst-class:: classref-method -:ref:`RID` **get_depth_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) +:ref:`RID` **get_depth_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the specified layer from the depth texture we are rendering 3D content to. @@ -182,7 +182,7 @@ If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of th .. rst-class:: classref-method -:ref:`RID` **get_depth_texture**\ (\ msaa\: :ref:`bool` = false\ ) +:ref:`RID` **get_depth_texture**\ (\ msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the depth texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. @@ -196,7 +196,7 @@ If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of th .. rst-class:: classref-method -:ref:`Vector2i` **get_internal_size**\ (\ ) |const| +:ref:`Vector2i` **get_internal_size**\ (\ ) |const| :ref:`🔗` Returns the internal size of the render buffer (size before upscaling) with which textures are created by default. @@ -208,7 +208,7 @@ Returns the internal size of the render buffer (size before upscaling) with whic .. rst-class:: classref-method -:ref:`ViewportMSAA` **get_msaa_3d**\ (\ ) |const| +:ref:`ViewportMSAA` **get_msaa_3d**\ (\ ) |const| :ref:`🔗` Returns the applied 3D MSAA mode for this viewport. @@ -220,7 +220,7 @@ Returns the applied 3D MSAA mode for this viewport. .. rst-class:: classref-method -:ref:`RID` **get_render_target**\ (\ ) |const| +:ref:`RID` **get_render_target**\ (\ ) |const| :ref:`🔗` Returns the render target associated with this buffers object. @@ -232,7 +232,7 @@ Returns the render target associated with this buffers object. .. rst-class:: classref-method -:ref:`RID` **get_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| +:ref:`RID` **get_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a cached texture with this name. @@ -244,7 +244,7 @@ Returns a cached texture with this name. .. rst-class:: classref-method -:ref:`RDTextureFormat` **get_texture_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| +:ref:`RDTextureFormat` **get_texture_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the texture format information with which a cached texture was created. @@ -256,7 +256,7 @@ Returns the texture format information with which a cached texture was created. .. rst-class:: classref-method -:ref:`RID` **get_texture_slice**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`\ ) +:ref:`RID` **get_texture_slice**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`\ ) :ref:`🔗` Returns a specific slice (layer or mipmap) for a cached texture. @@ -268,7 +268,7 @@ Returns a specific slice (layer or mipmap) for a cached texture. .. rst-class:: classref-method -:ref:`Vector2i` **get_texture_slice_size**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, mipmap\: :ref:`int`\ ) +:ref:`Vector2i` **get_texture_slice_size**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, mipmap\: :ref:`int`\ ) :ref:`🔗` Returns the texture size of a given slice of a cached texture. @@ -280,7 +280,7 @@ Returns the texture size of a given slice of a cached texture. .. rst-class:: classref-method -:ref:`RID` **get_texture_slice_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`, view\: :ref:`RDTextureView`\ ) +:ref:`RID` **get_texture_slice_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`, view\: :ref:`RDTextureView`\ ) :ref:`🔗` Returns a specific view of a slice (layer or mipmap) for a cached texture. @@ -292,7 +292,7 @@ Returns a specific view of a slice (layer or mipmap) for a cached texture. .. rst-class:: classref-method -:ref:`bool` **get_use_taa**\ (\ ) |const| +:ref:`bool` **get_use_taa**\ (\ ) |const| :ref:`🔗` Returns ``true`` if TAA is enabled. @@ -304,7 +304,7 @@ Returns ``true`` if TAA is enabled. .. rst-class:: classref-method -:ref:`RID` **get_velocity_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) +:ref:`RID` **get_velocity_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the specified layer from the velocity texture we are rendering 3D content to. @@ -316,7 +316,7 @@ Returns the specified layer from the velocity texture we are rendering 3D conten .. rst-class:: classref-method -:ref:`RID` **get_velocity_texture**\ (\ msaa\: :ref:`bool` = false\ ) +:ref:`RID` **get_velocity_texture**\ (\ msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the velocity texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. @@ -330,7 +330,7 @@ If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of th .. rst-class:: classref-method -:ref:`int` **get_view_count**\ (\ ) |const| +:ref:`int` **get_view_count**\ (\ ) |const| :ref:`🔗` Returns the view count for the associated viewport. @@ -342,7 +342,7 @@ Returns the view count for the associated viewport. .. rst-class:: classref-method -:ref:`bool` **has_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a cached texture exists for this name. diff --git a/classes/class_renderscenedata.rst b/classes/class_renderscenedata.rst index 9116952c1a6..3391d9f10ed 100644 --- a/classes/class_renderscenedata.rst +++ b/classes/class_renderscenedata.rst @@ -60,7 +60,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Projection` **get_cam_projection**\ (\ ) |const| +:ref:`Projection` **get_cam_projection**\ (\ ) |const| :ref:`🔗` Returns the camera projection used to render this frame. @@ -74,7 +74,7 @@ Returns the camera projection used to render this frame. .. rst-class:: classref-method -:ref:`Transform3D` **get_cam_transform**\ (\ ) |const| +:ref:`Transform3D` **get_cam_transform**\ (\ ) |const| :ref:`🔗` Returns the camera transform used to render this frame. @@ -88,7 +88,7 @@ Returns the camera transform used to render this frame. .. rst-class:: classref-method -:ref:`RID` **get_uniform_buffer**\ (\ ) |const| +:ref:`RID` **get_uniform_buffer**\ (\ ) |const| :ref:`🔗` Return the :ref:`RID` of the uniform buffer containing the scene data as a UBO. @@ -100,7 +100,7 @@ Return the :ref:`RID` of the uniform buffer containing the scene data .. rst-class:: classref-method -:ref:`int` **get_view_count**\ (\ ) |const| +:ref:`int` **get_view_count**\ (\ ) |const| :ref:`🔗` Returns the number of views being rendered. @@ -112,7 +112,7 @@ Returns the number of views being rendered. .. rst-class:: classref-method -:ref:`Vector3` **get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |const| :ref:`🔗` Returns the eye offset per view used to render this frame. This is the offset between our camera transform and the eye transform. @@ -124,7 +124,7 @@ Returns the eye offset per view used to render this frame. This is the offset be .. rst-class:: classref-method -:ref:`Projection` **get_view_projection**\ (\ view\: :ref:`int`\ ) |const| +:ref:`Projection` **get_view_projection**\ (\ view\: :ref:`int`\ ) |const| :ref:`🔗` Returns the view projection per view used to render this frame. diff --git a/classes/class_renderscenedataextension.rst b/classes/class_renderscenedataextension.rst index 81c75f175ac..9054b1cdb9e 100644 --- a/classes/class_renderscenedataextension.rst +++ b/classes/class_renderscenedataextension.rst @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Projection` **_get_cam_projection**\ (\ ) |virtual| |const| +:ref:`Projection` **_get_cam_projection**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the camera :ref:`Projection`. @@ -68,7 +68,7 @@ Implement this in GDExtension to return the camera :ref:`Projection` **_get_cam_transform**\ (\ ) |virtual| |const| +:ref:`Transform3D` **_get_cam_transform**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the camera :ref:`Transform3D`. @@ -80,7 +80,7 @@ Implement this in GDExtension to return the camera :ref:`Transform3D` **_get_uniform_buffer**\ (\ ) |virtual| |const| +:ref:`RID` **_get_uniform_buffer**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the :ref:`RID` of the uniform buffer containing the scene data as a UBO. @@ -92,7 +92,7 @@ Implement this in GDExtension to return the :ref:`RID` of the uniform .. rst-class:: classref-method -:ref:`int` **_get_view_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_view_count**\ (\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the view count. @@ -104,7 +104,7 @@ Implement this in GDExtension to return the view count. .. rst-class:: classref-method -:ref:`Vector3` **_get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector3` **_get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the eye offset for the given ``view``. @@ -116,7 +116,7 @@ Implement this in GDExtension to return the eye offset for the given ``view``. .. rst-class:: classref-method -:ref:`Projection` **_get_view_projection**\ (\ view\: :ref:`int`\ ) |virtual| |const| +:ref:`Projection` **_get_view_projection**\ (\ view\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Implement this in GDExtension to return the view :ref:`Projection` for the given ``view``. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 6bb0c15b896..14f3dd0285e 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -97,7 +97,7 @@ Signals .. rst-class:: classref-signal -**changed**\ (\ ) +**changed**\ (\ ) :ref:`🔗` Emitted when the resource changes, usually when one of its properties is modified. See also :ref:`emit_changed`. @@ -111,7 +111,7 @@ Emitted when the resource changes, usually when one of its properties is modifie .. rst-class:: classref-signal -**setup_local_to_scene_requested**\ (\ ) +**setup_local_to_scene_requested**\ (\ ) :ref:`🔗` **Deprecated:** This signal is only emitted when the resource is created. Override :ref:`_setup_local_to_scene` instead. @@ -130,7 +130,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **resource_local_to_scene** = ``false`` +:ref:`bool` **resource_local_to_scene** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ If ``true``, the resource is duplicated for each instance of all scenes using it .. rst-class:: classref-property -:ref:`String` **resource_name** = ``""`` +:ref:`String` **resource_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ An optional name for this resource. When defined, its value is displayed to repr .. rst-class:: classref-property -:ref:`String` **resource_path** = ``""`` +:ref:`String` **resource_path** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -187,7 +187,7 @@ The unique path to this resource. If it has been saved to disk, the value will b .. rst-class:: classref-property -:ref:`String` **resource_scene_unique_id** +:ref:`String` **resource_scene_unique_id** :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_get_rid**\ (\ ) |virtual| +:ref:`RID` **_get_rid**\ (\ ) |virtual| :ref:`🔗` Override this method to return a custom :ref:`RID` when :ref:`get_rid` is called. @@ -227,7 +227,7 @@ Override this method to return a custom :ref:`RID` when :ref:`get_rid .. rst-class:: classref-method -|void| **_setup_local_to_scene**\ (\ ) |virtual| +|void| **_setup_local_to_scene**\ (\ ) |virtual| :ref:`🔗` Override this method to customize the newly duplicated resource created from :ref:`PackedScene.instantiate`, if the original's :ref:`resource_local_to_scene` is set to ``true``. @@ -250,7 +250,7 @@ Override this method to customize the newly duplicated resource created from :re .. rst-class:: classref-method -:ref:`Resource` **duplicate**\ (\ subresources\: :ref:`bool` = false\ ) |const| +:ref:`Resource` **duplicate**\ (\ subresources\: :ref:`bool` = false\ ) |const| :ref:`🔗` Duplicates this resource, returning a new resource with its ``export``\ ed or :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` properties copied from the original. @@ -268,7 +268,7 @@ Subresource properties with the :ref:`@GlobalScope.PROPERTY_USAGE_ALWAYS_DUPLICA .. rst-class:: classref-method -|void| **emit_changed**\ (\ ) +|void| **emit_changed**\ (\ ) :ref:`🔗` Emits the :ref:`changed` signal. This method is called automatically for some built-in resources. @@ -290,7 +290,7 @@ Emits the :ref:`changed` signal. This method is c .. rst-class:: classref-method -:ref:`String` **generate_scene_unique_id**\ (\ ) |static| +:ref:`String` **generate_scene_unique_id**\ (\ ) |static| :ref:`🔗` Generates a unique identifier for a resource to be contained inside a :ref:`PackedScene`, based on the current date, time, and a random value. The returned string is only composed of letters (``a`` to ``y``) and numbers (``0`` to ``8``). See also :ref:`resource_scene_unique_id`. @@ -302,7 +302,7 @@ Generates a unique identifier for a resource to be contained inside a :ref:`Pack .. rst-class:: classref-method -:ref:`Node` **get_local_scene**\ (\ ) |const| +:ref:`Node` **get_local_scene**\ (\ ) |const| :ref:`🔗` If :ref:`resource_local_to_scene` is set to ``true`` and the resource has been loaded from a :ref:`PackedScene` instantiation, returns the root :ref:`Node` of the scene where this resource is used. Otherwise, returns ``null``. @@ -314,7 +314,7 @@ If :ref:`resource_local_to_scene` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of this resource (or an empty RID). Many resources (such as :ref:`Texture2D`, :ref:`Mesh`, and so on) are high-level abstractions of resources stored in a specialized server (:ref:`DisplayServer`, :ref:`RenderingServer`, etc.), so this function will return the original :ref:`RID`. @@ -326,7 +326,7 @@ Returns the :ref:`RID` of this resource (or an empty RID). Many resou .. rst-class:: classref-method -|void| **setup_local_to_scene**\ (\ ) +|void| **setup_local_to_scene**\ (\ ) :ref:`🔗` **Deprecated:** This method should only be called internally. @@ -340,7 +340,7 @@ Calls :ref:`_setup_local_to_scene`\ ) +|void| **take_over_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Sets the :ref:`resource_path` to ``path``, potentially overriding an existing cache entry for this path. Further attempts to load an overridden resource by path will instead return this resource. diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 79d2858395d..669503db9be 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -70,7 +70,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CacheMode**: +enum **CacheMode**: :ref:`🔗` .. _class_ResourceFormatLoader_constant_CACHE_MODE_IGNORE: @@ -125,7 +125,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_exists**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_exists**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -139,7 +139,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_classes_used**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_classes_used**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -153,7 +153,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_dependencies**\ (\ path\: :ref:`String`, add_types\: :ref:`bool`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_dependencies**\ (\ path\: :ref:`String`, add_types\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. @@ -167,7 +167,7 @@ If implemented, gets the dependencies of a given resource. If ``add_types`` is ` .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| :ref:`🔗` Gets the list of extensions for files this loader is able to read. @@ -179,7 +179,7 @@ Gets the list of extensions for files this loader is able to read. .. rst-class:: classref-method -:ref:`String` **_get_resource_script_class**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_get_resource_script_class**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Returns the script class name associated with the :ref:`Resource` under the given ``path``. If the resource has no script or the script isn't a named class, it should return ``""``. @@ -191,7 +191,7 @@ Returns the script class name associated with the :ref:`Resource .. rst-class:: classref-method -:ref:`String` **_get_resource_type**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_get_resource_type**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return ``""``. @@ -205,7 +205,7 @@ Gets the class name of the resource associated with the given path. If the loade .. rst-class:: classref-method -:ref:`int` **_get_resource_uid**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`int` **_get_resource_uid**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -219,7 +219,7 @@ Gets the class name of the resource associated with the given path. If the loade .. rst-class:: classref-method -:ref:`bool` **_handles_type**\ (\ type\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_handles_type**\ (\ type\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Tells which resource class this loader can load. @@ -233,7 +233,7 @@ Tells which resource class this loader can load. .. rst-class:: classref-method -:ref:`Variant` **_load**\ (\ path\: :ref:`String`, original_path\: :ref:`String`, use_sub_threads\: :ref:`bool`, cache_mode\: :ref:`int`\ ) |virtual| |const| +:ref:`Variant` **_load**\ (\ path\: :ref:`String`, original_path\: :ref:`String`, use_sub_threads\: :ref:`bool`, cache_mode\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a :ref:`Resource` object on success, or an :ref:`Error` constant in case of failure. @@ -247,7 +247,7 @@ The ``cache_mode`` property defines whether and how the cache should be used or .. rst-class:: classref-method -:ref:`bool` **_recognize_path**\ (\ path\: :ref:`String`, type\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_recognize_path**\ (\ path\: :ref:`String`, type\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Tells whether or not this loader should load a resource from its resource path for a given type. @@ -261,7 +261,7 @@ If it is not implemented, the default behavior returns whether the path's extens .. rst-class:: classref-method -:ref:`Error` **_rename_dependencies**\ (\ path\: :ref:`String`, renames\: :ref:`Dictionary`\ ) |virtual| |const| +:ref:`Error` **_rename_dependencies**\ (\ path\: :ref:`String`, renames\: :ref:`Dictionary`\ ) |virtual| |const| :ref:`🔗` If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths. diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index e326ee4c501..c78825a92db 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| :ref:`🔗` Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`_recognize`). @@ -68,7 +68,7 @@ Returns the list of extensions available for saving the resource object, provide .. rst-class:: classref-method -:ref:`bool` **_recognize**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| +:ref:`bool` **_recognize**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| :ref:`🔗` Returns whether the given resource object can be saved by this saver. @@ -80,7 +80,7 @@ Returns whether the given resource object can be saved by this saver. .. rst-class:: classref-method -:ref:`bool` **_recognize_path**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_recognize_path**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if this saver handles a given save path and ``false`` otherwise. @@ -94,7 +94,7 @@ If this method is not implemented, the default behavior returns whether the path .. rst-class:: classref-method -:ref:`Error` **_save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| +:ref:`Error` **_save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| :ref:`🔗` Saves the given resource object to a file at the target ``path``. ``flags`` is a bitmask composed with :ref:`SaverFlags` constants. @@ -108,7 +108,7 @@ Returns :ref:`@GlobalScope.OK` on success, or an .. rst-class:: classref-method -:ref:`Error` **_set_uid**\ (\ path\: :ref:`String`, uid\: :ref:`int`\ ) |virtual| +:ref:`Error` **_set_uid**\ (\ path\: :ref:`String`, uid\: :ref:`int`\ ) |virtual| :ref:`🔗` Sets a new UID for the resource at the given ``path``. Returns :ref:`@GlobalScope.OK` on success, or an :ref:`Error` constant in case of failure. diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 0e615272466..0e46655f0b9 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -43,7 +43,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ImportOrder**: +enum **ImportOrder**: :ref:`🔗` .. _class_ResourceImporter_constant_IMPORT_ORDER_DEFAULT: diff --git a/classes/class_resourceimporterbitmap.rst b/classes/class_resourceimporterbitmap.rst index e4be9d6a882..1afbe2f852e 100644 --- a/classes/class_resourceimporterbitmap.rst +++ b/classes/class_resourceimporterbitmap.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **create_from** = ``0`` +:ref:`int` **create_from** = ``0`` :ref:`🔗` The data source to use for generating the bitmap. @@ -71,7 +71,7 @@ The data source to use for generating the bitmap. .. rst-class:: classref-property -:ref:`float` **threshold** = ``0.5`` +:ref:`float` **threshold** = ``0.5`` :ref:`🔗` The threshold to use to determine which bits should be considered enabled or disabled. See also :ref:`create_from`. diff --git a/classes/class_resourceimporterbmfont.rst b/classes/class_resourceimporterbmfont.rst index 1f54f413e48..1a7f55c59f1 100644 --- a/classes/class_resourceimporterbmfont.rst +++ b/classes/class_resourceimporterbmfont.rst @@ -61,7 +61,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **compress** = ``true`` +:ref:`bool` **compress** = ``true`` :ref:`🔗` If ``true``, uses lossless compression for the resulting font. @@ -73,7 +73,7 @@ If ``true``, uses lossless compression for the resulting font. .. rst-class:: classref-property -:ref:`Array` **fallbacks** = ``[]`` +:ref:`Array` **fallbacks** = ``[]`` :ref:`🔗` List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts at the beginning of the array are attempted first. @@ -85,7 +85,7 @@ List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts .. rst-class:: classref-property -:ref:`int` **scaling_mode** = ``2`` +:ref:`int` **scaling_mode** = ``2`` :ref:`🔗` Font scaling mode. diff --git a/classes/class_resourceimportercsvtranslation.rst b/classes/class_resourceimportercsvtranslation.rst index b03df9e1b03..0a2b76a6a91 100644 --- a/classes/class_resourceimportercsvtranslation.rst +++ b/classes/class_resourceimportercsvtranslation.rst @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **compress** = ``true`` +:ref:`bool` **compress** = ``true`` :ref:`🔗` If ``true``, creates an :ref:`OptimizedTranslation` instead of a :ref:`Translation`. This makes the resulting file smaller at the cost of a small CPU overhead. @@ -77,7 +77,7 @@ If ``true``, creates an :ref:`OptimizedTranslation` .. rst-class:: classref-property -:ref:`int` **delimiter** = ``0`` +:ref:`int` **delimiter** = ``0`` :ref:`🔗` The delimiter to use in the CSV file. The default value matches the common CSV convention. Tab-separated values are sometimes called TSV files. diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index 8b4103bfc8d..c0388887f2e 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -89,7 +89,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_system_fallback** = ``true`` +:ref:`bool` **allow_system_fallback** = ``true`` :ref:`🔗` If ``true``, automatically use system fonts as a fallback if a glyph isn't found in this dynamic font. This makes supporting CJK characters or emoji more straightforward, as you don't need to include a CJK/emoji font in your project. See also :ref:`fallbacks`. @@ -103,7 +103,7 @@ If ``true``, automatically use system fonts as a fallback if a glyph isn't found .. rst-class:: classref-property -:ref:`int` **antialiasing** = ``1`` +:ref:`int` **antialiasing** = ``1`` :ref:`🔗` The font antialiasing method to use. @@ -121,7 +121,7 @@ The font antialiasing method to use. .. rst-class:: classref-property -:ref:`bool` **compress** = ``true`` +:ref:`bool` **compress** = ``true`` :ref:`🔗` If ``true``, uses lossless compression for the resulting font. @@ -133,7 +133,7 @@ If ``true``, uses lossless compression for the resulting font. .. rst-class:: classref-property -:ref:`bool` **disable_embedded_bitmaps** = ``true`` +:ref:`bool` **disable_embedded_bitmaps** = ``true`` :ref:`🔗` If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). @@ -145,7 +145,7 @@ If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and co .. rst-class:: classref-property -:ref:`Array` **fallbacks** = ``[]`` +:ref:`Array` **fallbacks** = ``[]`` :ref:`🔗` List of font fallbacks to use if a glyph isn't found in this dynamic font. Fonts at the beginning of the array are attempted first, but fallback fonts that don't support the glyph's language and script are attempted last (see :ref:`language_support` and :ref:`script_support`). See also :ref:`allow_system_fallback`. @@ -157,7 +157,7 @@ List of font fallbacks to use if a glyph isn't found in this dynamic font. Fonts .. rst-class:: classref-property -:ref:`bool` **force_autohinter** = ``false`` +:ref:`bool` **force_autohinter** = ``false`` :ref:`🔗` If ``true``, forces generation of hinting data for the font using `FreeType `__'s autohinter. This will make :ref:`hinting` effective with fonts that don't include hinting data. @@ -169,7 +169,7 @@ If ``true``, forces generation of hinting data for the font using `FreeType ` **generate_mipmaps** = ``false`` +:ref:`bool` **generate_mipmaps** = ``false`` :ref:`🔗` If ``true``, this font will have mipmaps generated. This prevents text from looking grainy when a :ref:`Control` is scaled down, or when a :ref:`Label3D` is viewed from a long distance (if :ref:`Label3D.texture_filter` is set to a mode that displays mipmaps). @@ -183,7 +183,7 @@ Enabling :ref:`generate_mipmaps` **hinting** = ``1`` +:ref:`int` **hinting** = ``1`` :ref:`🔗` The hinting mode to use. This controls how aggressively glyph edges should be snapped to pixels when rasterizing the font. Depending on personal preference, you may prefer using one hinting mode over the other. Hinting modes other than **None** are only effective if the font contains hinting data (see :ref:`force_autohinter`). @@ -201,7 +201,7 @@ The hinting mode to use. This controls how aggressively glyph edges should be sn .. rst-class:: classref-property -:ref:`Dictionary` **language_support** = ``{}`` +:ref:`Dictionary` **language_support** = ``{}`` :ref:`🔗` Override the list of languages supported by this font. If left empty, this is supplied by the font metadata. There is usually no need to change this. See also :ref:`script_support`. @@ -213,7 +213,7 @@ Override the list of languages supported by this font. If left empty, this is su .. rst-class:: classref-property -:ref:`int` **msdf_pixel_range** = ``8`` +:ref:`int` **msdf_pixel_range** = ``8`` :ref:`🔗` The width of the range around the shape between the minimum and maximum representable signed distance. If using font outlines, :ref:`msdf_pixel_range` must be set to at least *twice* the size of the largest font outline. The default :ref:`msdf_pixel_range` value of ``8`` allows outline sizes up to ``4`` to look correct. @@ -225,7 +225,7 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property -:ref:`int` **msdf_size** = ``48`` +:ref:`int` **msdf_size** = ``48`` :ref:`🔗` Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. Only effective if :ref:`multichannel_signed_distance_field` is ``true``. @@ -237,7 +237,7 @@ Source font size used to generate MSDF textures. Higher values allow for more pr .. rst-class:: classref-property -:ref:`bool` **multichannel_signed_distance_field** = ``false`` +:ref:`bool` **multichannel_signed_distance_field** = ``false`` :ref:`🔗` If set to ``true``, the default font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for :ref:`Control`\ s that are scaled down (or for :ref:`Label3D`\ s viewed from a long distance). @@ -251,7 +251,7 @@ MSDF font rendering can be combined with :ref:`generate_mipmaps` **opentype_features** = ``{}`` +:ref:`Dictionary` **opentype_features** = ``{}`` :ref:`🔗` The OpenType features to enable, disable or set a value for this font. This can be used to enable optional features provided by the font, such as ligatures or alternative glyphs. The list of supported OpenType features varies on a per-font basis. @@ -263,7 +263,7 @@ The OpenType features to enable, disable or set a value for this font. This can .. rst-class:: classref-property -:ref:`float` **oversampling** = ``0.0`` +:ref:`float` **oversampling** = ``0.0`` :ref:`🔗` If set to a value greater than ``0.0``, overrides the oversampling factor for the font. This can be used to render the font at a higher or lower resolution than intended without affecting its physical size. In most cases, this should be left at ``0.0``. @@ -275,7 +275,7 @@ If set to a value greater than ``0.0``, overrides the oversampling factor for th .. rst-class:: classref-property -:ref:`Array` **preload** = ``[]`` +:ref:`Array` **preload** = ``[]`` :ref:`🔗` The glyph ranges to prerender. This can avoid stuttering during gameplay when new characters need to be rendered, especially if :ref:`subpixel_positioning` is enabled. The downside of using preloading is that initial project load times will increase, as well as memory usage. @@ -287,7 +287,7 @@ The glyph ranges to prerender. This can avoid stuttering during gameplay when ne .. rst-class:: classref-property -:ref:`Dictionary` **script_support** = ``{}`` +:ref:`Dictionary` **script_support** = ``{}`` :ref:`🔗` Override the list of language scripts supported by this font. If left empty, this is supplied by the font metadata. There is usually no need to change this. See also :ref:`language_support`. @@ -299,7 +299,7 @@ Override the list of language scripts supported by this font. If left empty, thi .. rst-class:: classref-property -:ref:`int` **subpixel_positioning** = ``1`` +:ref:`int` **subpixel_positioning** = ``1`` :ref:`🔗` Subpixel positioning improves font rendering appearance, especially at smaller font sizes. The downside is that it takes more time to initially render the font, which can cause stuttering during gameplay, especially if used with large font sizes. This should be set to **Disabled** for fonts with a pixel art appearance. diff --git a/classes/class_resourceimporterimagefont.rst b/classes/class_resourceimporterimagefont.rst index 8615a9fe008..4cf144ee34f 100644 --- a/classes/class_resourceimporterimagefont.rst +++ b/classes/class_resourceimporterimagefont.rst @@ -75,7 +75,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **ascent** = ``0`` +:ref:`int` **ascent** = ``0`` :ref:`🔗` Font ascent (number of pixels above the baseline). If set to ``0``, half of the character height is used. @@ -87,7 +87,7 @@ Font ascent (number of pixels above the baseline). If set to ``0``, half of the .. rst-class:: classref-property -:ref:`Rect2i` **character_margin** = ``Rect2i(0, 0, 0, 0)`` +:ref:`Rect2i` **character_margin** = ``Rect2i(0, 0, 0, 0)`` :ref:`🔗` Margin applied around every imported glyph. If your font image contains guides (in the form of lines between glyphs) or if spacing between characters appears incorrect, try adjusting :ref:`character_margin`. @@ -99,7 +99,7 @@ Margin applied around every imported glyph. If your font image contains guides ( .. rst-class:: classref-property -:ref:`PackedStringArray` **character_ranges** = ``PackedStringArray()`` +:ref:`PackedStringArray` **character_ranges** = ``PackedStringArray()`` :ref:`🔗` The character ranges to import from the font image. This is an array that maps each position on the image (in tile coordinates, not pixels). The font atlas is traversed from left to right and top to bottom. Characters can be specified with decimal numbers (127), hexadecimal numbers (``0x007f``, or ``U+007f``) or between single quotes (``'~'``). Ranges can be specified with a hyphen between characters. @@ -119,7 +119,7 @@ Make sure :ref:`character_ranges` **columns** = ``1`` +:ref:`int` **columns** = ``1`` :ref:`🔗` Number of columns in the font image. See also :ref:`rows`. @@ -131,7 +131,7 @@ Number of columns in the font image. See also :ref:`rows` **compress** = ``true`` +:ref:`bool` **compress** = ``true`` :ref:`🔗` If ``true``, uses lossless compression for the resulting font. @@ -143,7 +143,7 @@ If ``true``, uses lossless compression for the resulting font. .. rst-class:: classref-property -:ref:`int` **descent** = ``0`` +:ref:`int` **descent** = ``0`` :ref:`🔗` Font descent (number of pixels below the baseline). If set to ``0``, half of the character height is used. @@ -155,7 +155,7 @@ Font descent (number of pixels below the baseline). If set to ``0``, half of the .. rst-class:: classref-property -:ref:`Array` **fallbacks** = ``[]`` +:ref:`Array` **fallbacks** = ``[]`` :ref:`🔗` List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts at the beginning of the array are attempted first. @@ -167,7 +167,7 @@ List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts .. rst-class:: classref-property -:ref:`Rect2i` **image_margin** = ``Rect2i(0, 0, 0, 0)`` +:ref:`Rect2i` **image_margin** = ``Rect2i(0, 0, 0, 0)`` :ref:`🔗` Margin to cut on the sides of the entire image. This can be used to cut parts of the image that contain attribution information or similar. @@ -179,7 +179,7 @@ Margin to cut on the sides of the entire image. This can be used to cut parts of .. rst-class:: classref-property -:ref:`PackedStringArray` **kerning_pairs** = ``PackedStringArray()`` +:ref:`PackedStringArray` **kerning_pairs** = ``PackedStringArray()`` :ref:`🔗` Kerning pairs for the font. Kerning pair adjust the spacing between two characters. @@ -195,7 +195,7 @@ Each string consist of three space separated values: "from" string, "to" string .. rst-class:: classref-property -:ref:`int` **rows** = ``1`` +:ref:`int` **rows** = ``1`` :ref:`🔗` Number of rows in the font image. See also :ref:`columns`. @@ -207,7 +207,7 @@ Number of rows in the font image. See also :ref:`columns` **scaling_mode** = ``2`` +:ref:`int` **scaling_mode** = ``2`` :ref:`🔗` Font scaling mode. diff --git a/classes/class_resourceimporterlayeredtexture.rst b/classes/class_resourceimporterlayeredtexture.rst index 6f4812e5868..dca1439ec64 100644 --- a/classes/class_resourceimporterlayeredtexture.rst +++ b/classes/class_resourceimporterlayeredtexture.rst @@ -67,7 +67,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **compress/channel_pack** = ``0`` +:ref:`int` **compress/channel_pack** = ``0`` :ref:`🔗` Controls how color channels should be used in the imported texture. @@ -85,7 +85,7 @@ Controls how color channels should be used in the imported texture. .. rst-class:: classref-property -:ref:`int` **compress/hdr_compression** = ``1`` +:ref:`int` **compress/hdr_compression** = ``1`` :ref:`🔗` Controls how VRAM compression should be performed for HDR images. @@ -105,7 +105,7 @@ Controls how VRAM compression should be performed for HDR images. .. rst-class:: classref-property -:ref:`bool` **compress/high_quality** = ``false`` +:ref:`bool` **compress/high_quality** = ``false`` :ref:`🔗` If ``true``, uses BPTC compression on desktop platforms and ASTC compression on mobile platforms. When using BPTC, BC7 is used for SDR textures and BC6H is used for HDR textures. @@ -121,7 +121,7 @@ BPTC and ASTC support VRAM compression for HDR textures, but S3TC and ETC2 do no .. rst-class:: classref-property -:ref:`float` **compress/lossy_quality** = ``0.7`` +:ref:`float` **compress/lossy_quality** = ``0.7`` :ref:`🔗` The quality to use when using the **Lossy** compression mode. Higher values result in better quality, at the cost of larger file sizes. Lossy quality does not affect memory usage of the imported texture, only its file size on disk. @@ -133,7 +133,7 @@ The quality to use when using the **Lossy** compression mode. Higher values resu .. rst-class:: classref-property -:ref:`int` **compress/mode** = ``1`` +:ref:`int` **compress/mode** = ``1`` :ref:`🔗` The compression mode to use. Each compression mode provides a different tradeoff: @@ -157,7 +157,7 @@ See `Compress mode <../tutorials/assets_pipeline/importing_images.html#compress- .. rst-class:: classref-property -:ref:`bool` **mipmaps/generate** = ``true`` +:ref:`bool` **mipmaps/generate** = ``true`` :ref:`🔗` If ``true``, smaller versions of the texture are generated on import. For example, a 64×64 texture will generate 6 mipmaps (32×32, 16×16, 8×8, 4×4, 2×2, 1×1). This has several benefits: @@ -177,7 +177,7 @@ It's recommended to enable mipmaps in 3D. However, in 2D, this should only be en .. rst-class:: classref-property -:ref:`int` **mipmaps/limit** = ``-1`` +:ref:`int` **mipmaps/limit** = ``-1`` :ref:`🔗` Unimplemented. This currently has no effect when changed. @@ -189,7 +189,7 @@ Unimplemented. This currently has no effect when changed. .. rst-class:: classref-property -:ref:`int` **slices/arrangement** = ``1`` +:ref:`int` **slices/arrangement** = ``1`` :ref:`🔗` Controls how the cubemap's texture is internally laid out. When using high-resolution cubemaps, **2×3** and **3×2** are less prone to exceeding hardware texture size limits compared to **1×6** and **6×1**. diff --git a/classes/class_resourceimportermp3.rst b/classes/class_resourceimportermp3.rst index 919b2f8dd91..981ba3b2dac 100644 --- a/classes/class_resourceimportermp3.rst +++ b/classes/class_resourceimportermp3.rst @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bar_beats** = ``4`` +:ref:`int` **bar_beats** = ``4`` :ref:`🔗` The number of bars within a single beat in the audio track. This is only relevant for music that wishes to make use of interactive music functionality (not implemented yet), not sound effects. @@ -79,7 +79,7 @@ A more convenient editor for :ref:`bar_beats` **beat_count** = ``0`` +:ref:`int` **beat_count** = ``0`` :ref:`🔗` The beat count of the audio track. This is only relevant for music that wishes to make use of interactive music functionality (not implemented yet), not sound effects. @@ -93,7 +93,7 @@ A more convenient editor for :ref:`beat_count` **bpm** = ``0`` +:ref:`float` **bpm** = ``0`` :ref:`🔗` The Beats Per Minute of the audio track. This should match the BPM measure that was used to compose the track. This is only relevant for music that wishes to make use of interactive music functionality (not implemented yet), not sound effects. @@ -107,7 +107,7 @@ A more convenient editor for :ref:`bpm` .. rst-class:: classref-property -:ref:`bool` **loop** = ``false`` +:ref:`bool` **loop** = ``false`` :ref:`🔗` If enabled, the audio will begin playing at the beginning after playback ends by reaching the end of the audio. @@ -121,7 +121,7 @@ If enabled, the audio will begin playing at the beginning after playback ends by .. rst-class:: classref-property -:ref:`float` **loop_offset** = ``0`` +:ref:`float` **loop_offset** = ``0`` :ref:`🔗` Determines where audio will start to loop after playback reaches the end of the audio. This can be used to only loop a part of the audio file, which is useful for some ambient sounds or music. The value is determined in seconds relative to the beginning of the audio. A value of ``0.0`` will loop the entire audio file. diff --git a/classes/class_resourceimporterobj.rst b/classes/class_resourceimporterobj.rst index 09f0e8ff10c..db0de9ba1fd 100644 --- a/classes/class_resourceimporterobj.rst +++ b/classes/class_resourceimporterobj.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **force_disable_mesh_compression** = ``false`` +:ref:`bool` **force_disable_mesh_compression** = ``false`` :ref:`🔗` If ``true``, mesh compression will not be used. Consider enabling if you notice blocky artifacts in your mesh normals or UVs, or if you have meshes that are larger than a few thousand meters in each direction. @@ -75,7 +75,7 @@ If ``true``, mesh compression will not be used. Consider enabling if you notice .. rst-class:: classref-property -:ref:`bool` **generate_tangents** = ``true`` +:ref:`bool` **generate_tangents** = ``true`` :ref:`🔗` If ``true``, generate vertex tangents using `Mikktspace `__ if the source mesh doesn't have tangent data. When possible, it's recommended to let the 3D modeling software generate tangents on export instead on relying on this option. Tangents are required for correct display of normal and height maps, along with any material/shader features that require tangents. @@ -89,7 +89,7 @@ If you don't need material features that require tangents, disabling this can re .. rst-class:: classref-property -:ref:`Vector3` **offset_mesh** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **offset_mesh** = ``Vector3(0, 0, 0)`` :ref:`🔗` Offsets the mesh's data by the specified value. This can be used to work around misaligned meshes without having to modify the source file. @@ -101,7 +101,7 @@ Offsets the mesh's data by the specified value. This can be used to work around .. rst-class:: classref-property -:ref:`bool` **optimize_mesh** = ``true`` +:ref:`bool` **optimize_mesh** = ``true`` :ref:`🔗` Unused parameter. This currently has no effect. @@ -113,7 +113,7 @@ Unused parameter. This currently has no effect. .. rst-class:: classref-property -:ref:`Vector3` **scale_mesh** = ``Vector3(1, 1, 1)`` +:ref:`Vector3` **scale_mesh** = ``Vector3(1, 1, 1)`` :ref:`🔗` Scales the mesh's data by the specified value. This can be used to work around misscaled meshes without having to modify the source file. diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index db1720f0a79..4ee02791d74 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bar_beats** = ``4`` +:ref:`int` **bar_beats** = ``4`` :ref:`🔗` The number of bars within a single beat in the audio track. This is only relevant for music that wishes to make use of interactive music functionality (not implemented yet), not sound effects. @@ -93,7 +93,7 @@ A more convenient editor for :ref:`bar_beats` **beat_count** = ``0`` +:ref:`int` **beat_count** = ``0`` :ref:`🔗` The beat count of the audio track. This is only relevant for music that wishes to make use of interactive music functionality (not implemented yet), not sound effects. @@ -107,7 +107,7 @@ A more convenient editor for :ref:`beat_count` **bpm** = ``0`` +:ref:`float` **bpm** = ``0`` :ref:`🔗` The Beats Per Minute of the audio track. This should match the BPM measure that was used to compose the track. This is only relevant for music that wishes to make use of interactive music functionality (not implemented yet), not sound effects. @@ -121,7 +121,7 @@ A more convenient editor for :ref:`bpm` **loop** = ``false`` +:ref:`bool` **loop** = ``false`` :ref:`🔗` If enabled, the audio will begin playing at the beginning after playback ends by reaching the end of the audio. @@ -135,7 +135,7 @@ If enabled, the audio will begin playing at the beginning after playback ends by .. rst-class:: classref-property -:ref:`float` **loop_offset** = ``0`` +:ref:`float` **loop_offset** = ``0`` :ref:`🔗` Determines where audio will start to loop after playback reaches the end of the audio. This can be used to only loop a part of the audio file, which is useful for some ambient sounds or music. The value is determined in seconds relative to the beginning of the audio. A value of ``0.0`` will loop the entire audio file. @@ -156,7 +156,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| +:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` This method loads audio data from a PackedByteArray buffer into an AudioStreamOggVorbis object. @@ -168,7 +168,7 @@ This method loads audio data from a PackedByteArray buffer into an AudioStreamOg .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| +:ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` This method loads audio data from a file into an AudioStreamOggVorbis object. The file path is provided as a string. diff --git a/classes/class_resourceimporterscene.rst b/classes/class_resourceimporterscene.rst index 41c171295eb..f7414151688 100644 --- a/classes/class_resourceimporterscene.rst +++ b/classes/class_resourceimporterscene.rst @@ -93,7 +93,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Dictionary` **_subresources** = ``{}`` +:ref:`Dictionary` **_subresources** = ``{}`` :ref:`🔗` Contains properties for the scene's subresources. This is an internal option which is not visible in the Import dock. @@ -105,7 +105,7 @@ Contains properties for the scene's subresources. This is an internal option whi .. rst-class:: classref-property -:ref:`float` **animation/fps** = ``30`` +:ref:`float` **animation/fps** = ``30`` :ref:`🔗` The number of frames per second to use for baking animation curves to a series of points with linear interpolation. It's recommended to configure this value to match the value you're using as a baseline in your 3D modeling software. Higher values result in more precise animation with fast movement changes, at the cost of higher file sizes and memory usage. Thanks to interpolation, there is usually not much benefit in going above 30 FPS (as the animation will still appear smooth at higher rendering framerates). @@ -117,7 +117,7 @@ The number of frames per second to use for baking animation curves to a series o .. rst-class:: classref-property -:ref:`bool` **animation/import** = ``true`` +:ref:`bool` **animation/import** = ``true`` :ref:`🔗` If ``true``, import animations from the 3D scene. @@ -129,7 +129,7 @@ If ``true``, import animations from the 3D scene. .. rst-class:: classref-property -:ref:`bool` **animation/import_rest_as_RESET** = ``false`` +:ref:`bool` **animation/import_rest_as_RESET** = ``false`` :ref:`🔗` If ``true``, adds an :ref:`Animation` named ``RESET``, containing the :ref:`Skeleton3D.get_bone_rest` from :ref:`Skeleton3D` nodes. This can be useful to extract an animation in the reference pose. @@ -141,7 +141,7 @@ If ``true``, adds an :ref:`Animation` named ``RESET``, containi .. rst-class:: classref-property -:ref:`bool` **animation/remove_immutable_tracks** = ``true`` +:ref:`bool` **animation/remove_immutable_tracks** = ``true`` :ref:`🔗` If ``true``, remove animation tracks that only contain default values. This can reduce output file size and memory usage with certain 3D scenes, depending on the contents of their animation tracks. @@ -153,7 +153,7 @@ If ``true``, remove animation tracks that only contain default values. This can .. rst-class:: classref-property -:ref:`bool` **animation/trimming** = ``false`` +:ref:`bool` **animation/trimming** = ``false`` :ref:`🔗` If ``true``, trim the beginning and end of animations if there are no keyframe changes. This can reduce output file size and memory usage with certain 3D scenes, depending on the contents of their animation tracks. @@ -165,7 +165,7 @@ If ``true``, trim the beginning and end of animations if there are no keyframe c .. rst-class:: classref-property -:ref:`String` **import_script/path** = ``""`` +:ref:`String` **import_script/path** = ``""`` :ref:`🔗` Path to an import script, which can run code after the import process has completed for custom processing. See `Using import scripts for automation <../tutorials/assets_pipeline/importing_3d_scenes/import_configuration.html#using-import-scripts-for-automation>`__ for more information. @@ -177,7 +177,7 @@ Path to an import script, which can run code after the import process has comple .. rst-class:: classref-property -:ref:`bool` **meshes/create_shadow_meshes** = ``true`` +:ref:`bool` **meshes/create_shadow_meshes** = ``true`` :ref:`🔗` If ``true``, enables the generation of shadow meshes on import. This optimizes shadow rendering without reducing quality by welding vertices together when possible. This in turn reduces the memory bandwidth required to render shadows. Shadow mesh generation currently doesn't support using a lower detail level than the source mesh (but shadow rendering will make use of LODs when relevant). @@ -189,7 +189,7 @@ If ``true``, enables the generation of shadow meshes on import. This optimizes s .. rst-class:: classref-property -:ref:`bool` **meshes/ensure_tangents** = ``true`` +:ref:`bool` **meshes/ensure_tangents** = ``true`` :ref:`🔗` If ``true``, generate vertex tangents using `Mikktspace `__ if the input meshes don't have tangent data. When possible, it's recommended to let the 3D modeling software generate tangents on export instead on relying on this option. Tangents are required for correct display of normal and height maps, along with any material/shader features that require tangents. @@ -203,7 +203,7 @@ If you don't need material features that require tangents, disabling this can re .. rst-class:: classref-property -:ref:`bool` **meshes/force_disable_compression** = ``false`` +:ref:`bool` **meshes/force_disable_compression** = ``false`` :ref:`🔗` If ``true``, mesh compression will not be used. Consider enabling if you notice blocky artifacts in your mesh normals or UVs, or if you have meshes that are larger than a few thousand meters in each direction. @@ -215,7 +215,7 @@ If ``true``, mesh compression will not be used. Consider enabling if you notice .. rst-class:: classref-property -:ref:`bool` **meshes/generate_lods** = ``true`` +:ref:`bool` **meshes/generate_lods** = ``true`` :ref:`🔗` If ``true``, generates lower detail variants of the mesh which will be displayed in the distance to improve rendering performance. Not all meshes benefit from LOD, especially if they are never rendered from far away. Disabling this can reduce output file size and speed up importing. See `Mesh level of detail (LOD) <../tutorials/3d/mesh_lod.html#doc-mesh-lod>`__ for more information. @@ -227,7 +227,7 @@ If ``true``, generates lower detail variants of the mesh which will be displayed .. rst-class:: classref-property -:ref:`int` **meshes/light_baking** = ``1`` +:ref:`int` **meshes/light_baking** = ``1`` :ref:`🔗` Configures the meshes' :ref:`GeometryInstance3D.gi_mode` in the 3D scene. If set to **Static Lightmaps**, sets the meshes' GI mode to Static and generates UV2 on import for :ref:`LightmapGI` baking. @@ -239,7 +239,7 @@ Configures the meshes' :ref:`GeometryInstance3D.gi_mode` **meshes/lightmap_texel_size** = ``0.2`` +:ref:`float` **meshes/lightmap_texel_size** = ``0.2`` :ref:`🔗` Controls the size of each texel on the baked lightmap. A smaller value results in more precise lightmaps, at the cost of larger lightmap sizes and longer bake times. @@ -253,7 +253,7 @@ Controls the size of each texel on the baked lightmap. A smaller value results i .. rst-class:: classref-property -:ref:`bool` **nodes/apply_root_scale** = ``true`` +:ref:`bool` **nodes/apply_root_scale** = ``true`` :ref:`🔗` If ``true``, :ref:`nodes/root_scale` will be applied to the descendant nodes, meshes, animations, bones, etc. This means that if you add a child node later on within the imported scene, it won't be scaled. If ``false``, :ref:`nodes/root_scale` will multiply the scale of the root node instead. @@ -265,7 +265,7 @@ If ``true``, :ref:`nodes/root_scale` **nodes/import_as_skeleton_bones** = ``false`` +:ref:`bool` **nodes/import_as_skeleton_bones** = ``false`` :ref:`🔗` Treat all nodes in the imported scene as if they are bones within a single :ref:`Skeleton3D`. Can be used to guarantee that imported animations target skeleton bones rather than nodes. May also be used to assign the ``"Root"`` bone in a :ref:`BoneMap`. See :doc:`Retargeting 3D Skeletons <../tutorials/assets_pipeline/retargeting_3d_skeletons>` for more information. @@ -277,7 +277,7 @@ Treat all nodes in the imported scene as if they are bones within a single :ref: .. rst-class:: classref-property -:ref:`String` **nodes/root_name** = ``""`` +:ref:`String` **nodes/root_name** = ``""`` :ref:`🔗` Override for the root node name. If empty, the root node will use what the scene specifies, or the file name if the scene does not specify a root name. @@ -289,7 +289,7 @@ Override for the root node name. If empty, the root node will use what the scene .. rst-class:: classref-property -:ref:`float` **nodes/root_scale** = ``1.0`` +:ref:`float` **nodes/root_scale** = ``1.0`` :ref:`🔗` The uniform scale to use for the scene root. The default value of ``1.0`` will not perform any rescaling. See :ref:`nodes/apply_root_scale` for details of how this scale is applied. @@ -301,7 +301,7 @@ The uniform scale to use for the scene root. The default value of ``1.0`` will n .. rst-class:: classref-property -:ref:`String` **nodes/root_type** = ``""`` +:ref:`String` **nodes/root_type** = ``""`` :ref:`🔗` Override for the root node type. If empty, the root node will use what the scene specifies, or :ref:`Node3D` if the scene does not specify a root type. Using a node type that inherits from :ref:`Node3D` is recommended. Otherwise, you'll lose the ability to position the node directly in the 3D editor. @@ -313,7 +313,7 @@ Override for the root node type. If empty, the root node will use what the scene .. rst-class:: classref-property -:ref:`bool` **skins/use_named_skins** = ``true`` +:ref:`bool` **skins/use_named_skins** = ``true`` :ref:`🔗` If checked, use named :ref:`Skin`\ s for animation. The :ref:`MeshInstance3D` node contains 3 properties of relevance here: a skeleton :ref:`NodePath` pointing to the :ref:`Skeleton3D` node (usually ``..``), a mesh, and a skin: diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst index 9fb331f3e6b..5be053430fd 100644 --- a/classes/class_resourceimportertexture.rst +++ b/classes/class_resourceimportertexture.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **compress/channel_pack** = ``0`` +:ref:`int` **compress/channel_pack** = ``0`` :ref:`🔗` Controls how color channels should be used in the imported texture. @@ -107,7 +107,7 @@ Controls how color channels should be used in the imported texture. .. rst-class:: classref-property -:ref:`int` **compress/hdr_compression** = ``1`` +:ref:`int` **compress/hdr_compression** = ``1`` :ref:`🔗` Controls how VRAM compression should be performed for HDR images. @@ -127,7 +127,7 @@ Controls how VRAM compression should be performed for HDR images. .. rst-class:: classref-property -:ref:`bool` **compress/high_quality** = ``false`` +:ref:`bool` **compress/high_quality** = ``false`` :ref:`🔗` If ``true``, uses BPTC compression on desktop platforms and ASTC compression on mobile platforms. When using BPTC, BC7 is used for SDR textures and BC6H is used for HDR textures. @@ -143,7 +143,7 @@ BPTC and ASTC support VRAM compression for HDR textures, but S3TC and ETC2 do no .. rst-class:: classref-property -:ref:`float` **compress/lossy_quality** = ``0.7`` +:ref:`float` **compress/lossy_quality** = ``0.7`` :ref:`🔗` The quality to use when using the **Lossy** compression mode. Higher values result in better quality, at the cost of larger file sizes. Lossy quality does not affect memory usage of the imported texture, only its file size on disk. @@ -155,7 +155,7 @@ The quality to use when using the **Lossy** compression mode. Higher values resu .. rst-class:: classref-property -:ref:`int` **compress/mode** = ``0`` +:ref:`int` **compress/mode** = ``0`` :ref:`🔗` The compression mode to use. Each compression mode provides a different tradeoff: @@ -179,7 +179,7 @@ See `Compress mode <../tutorials/assets_pipeline/importing_images.html#compress- .. rst-class:: classref-property -:ref:`int` **compress/normal_map** = ``0`` +:ref:`int` **compress/normal_map** = ``0`` :ref:`🔗` When using a texture as normal map, only the red and green channels are required. Given regular texture compression algorithms produce artifacts that don't look that nice in normal maps, the RGTC compression format is the best fit for this data. Forcing this option to Enable will make Godot import the image as RGTC compressed. By default, it's set to Detect. This means that if the texture is ever detected to be used as a normal map, it will be changed to Enable and reimported automatically. @@ -193,7 +193,7 @@ Note that RGTC compression affects the resulting normal map image. You will have .. rst-class:: classref-property -:ref:`int` **detect_3d/compress_to** = ``1`` +:ref:`int` **detect_3d/compress_to** = ``1`` :ref:`🔗` This changes the :ref:`compress/mode` option that is used when a texture is detected as being used in 3D. @@ -207,7 +207,7 @@ Changing this import option only has an effect if a texture is detected as being .. rst-class:: classref-property -:ref:`bool` **editor/convert_colors_with_editor_theme** = ``false`` +:ref:`bool` **editor/convert_colors_with_editor_theme** = ``false`` :ref:`🔗` If ``true``, converts the imported image's colors to match :ref:`EditorSettings.interface/theme/icon_and_font_color`. This assumes the image uses the exact same colors as :doc:`Godot's own color palette for editor icons <../contributing/development/editor/creating_icons>`, with the source file designed for a dark editor theme. This should be enabled for editor plugin icons and custom class icons, but should be left disabled otherwise. @@ -221,7 +221,7 @@ If ``true``, converts the imported image's colors to match :ref:`EditorSettings. .. rst-class:: classref-property -:ref:`bool` **editor/scale_with_editor_scale** = ``false`` +:ref:`bool` **editor/scale_with_editor_scale** = ``false`` :ref:`🔗` If ``true``, scales the imported image to match :ref:`EditorSettings.interface/editor/custom_display_scale`. This should be enabled for editor plugin icons and custom class icons, but should be left disabled otherwise. @@ -235,7 +235,7 @@ If ``true``, scales the imported image to match :ref:`EditorSettings.interface/e .. rst-class:: classref-property -:ref:`bool` **mipmaps/generate** = ``false`` +:ref:`bool` **mipmaps/generate** = ``false`` :ref:`🔗` If ``true``, smaller versions of the texture are generated on import. For example, a 64×64 texture will generate 6 mipmaps (32×32, 16×16, 8×8, 4×4, 2×2, 1×1). This has several benefits: @@ -255,7 +255,7 @@ It's recommended to enable mipmaps in 3D. However, in 2D, this should only be en .. rst-class:: classref-property -:ref:`int` **mipmaps/limit** = ``-1`` +:ref:`int` **mipmaps/limit** = ``-1`` :ref:`🔗` Unimplemented. This currently has no effect when changed. @@ -267,7 +267,7 @@ Unimplemented. This currently has no effect when changed. .. rst-class:: classref-property -:ref:`bool` **process/fix_alpha_border** = ``true`` +:ref:`bool` **process/fix_alpha_border** = ``true`` :ref:`🔗` If ``true``, puts pixels of the same surrounding color in transition from transparent to opaque areas. For textures displayed with bilinear filtering, this helps to reduce the outline effect when exporting images from an image editor. @@ -281,7 +281,7 @@ It's recommended to leave this enabled (as it is by default), unless this causes .. rst-class:: classref-property -:ref:`bool` **process/hdr_as_srgb** = ``false`` +:ref:`bool` **process/hdr_as_srgb** = ``false`` :ref:`🔗` Some HDR images you can find online may be broken and contain sRGB color data (instead of linear color data). It is advised not to use those files. If you absolutely have to, enabling :ref:`process/hdr_as_srgb` will make them look correct. @@ -295,7 +295,7 @@ Some HDR images you can find online may be broken and contain sRGB color data (i .. rst-class:: classref-property -:ref:`bool` **process/hdr_clamp_exposure** = ``false`` +:ref:`bool` **process/hdr_clamp_exposure** = ``false`` :ref:`🔗` If ``true``, clamps exposure in the imported high dynamic range images using a smart clamping formula (without introducing *visible* clipping). @@ -311,7 +311,7 @@ While these HDR panorama images are accurate to real life, this can cause the ra .. rst-class:: classref-property -:ref:`bool` **process/normal_map_invert_y** = ``false`` +:ref:`bool` **process/normal_map_invert_y** = ``false`` :ref:`🔗` If ``true``, convert the normal map from Y- (DirectX-style) to Y+ (OpenGL-style) by inverting its green color channel. This is the normal map convention expected by Godot. @@ -325,7 +325,7 @@ More information about normal maps (including a coordinate order table for popul .. rst-class:: classref-property -:ref:`bool` **process/premult_alpha** = ``false`` +:ref:`bool` **process/premult_alpha** = ``false`` :ref:`🔗` An alternative to fixing darkened borders with :ref:`process/fix_alpha_border` is to use premultiplied alpha. By enabling this option, the texture will be converted to this format. A premultiplied alpha texture requires specific materials to be displayed correctly: @@ -341,7 +341,7 @@ An alternative to fixing darkened borders with :ref:`process/fix_alpha_border` **process/size_limit** = ``0`` +:ref:`int` **process/size_limit** = ``0`` :ref:`🔗` If set to a value greater than ``0``, the size of the texture is limited on import to a value smaller than or equal to the value specified here. For non-square textures, the size limit affects the longer dimension, with the shorter dimension scaled to preserve aspect ratio. Resizing is performed using cubic interpolation. @@ -355,7 +355,7 @@ This can be used to reduce memory usage without affecting the source images, or .. rst-class:: classref-property -:ref:`int` **roughness/mode** = ``0`` +:ref:`int` **roughness/mode** = ``0`` :ref:`🔗` The color channel to consider as a roughness map in this texture. Only effective if Roughness > Src Normal is not empty. @@ -367,7 +367,7 @@ The color channel to consider as a roughness map in this texture. Only effective .. rst-class:: classref-property -:ref:`String` **roughness/src_normal** = ``""`` +:ref:`String` **roughness/src_normal** = ``""`` :ref:`🔗` The path to the texture to consider as a normal map for roughness filtering on import. Specifying this can help decrease specular aliasing slightly in 3D. @@ -381,7 +381,7 @@ Roughness filtering on import is only used in 3D rendering, not 2D. .. rst-class:: classref-property -:ref:`float` **svg/scale** = ``1.0`` +:ref:`float` **svg/scale** = ``1.0`` :ref:`🔗` The scale the SVG should be rendered at, with ``1.0`` being the original design size. Higher values result in a larger image. Note that unlike font oversampling, this affects the size the SVG is rendered at in 2D. See also :ref:`editor/scale_with_editor_scale`. diff --git a/classes/class_resourceimportertextureatlas.rst b/classes/class_resourceimportertextureatlas.rst index 70e7be440fd..4be1188b380 100644 --- a/classes/class_resourceimportertextureatlas.rst +++ b/classes/class_resourceimportertextureatlas.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **atlas_file** = ``""`` +:ref:`String` **atlas_file** = ``""`` :ref:`🔗` Path to the atlas spritesheet. This *must* be set to valid path to a PNG image. Otherwise, the atlas will fail to import. @@ -66,7 +66,7 @@ Path to the atlas spritesheet. This *must* be set to valid path to a PNG image. .. rst-class:: classref-property -:ref:`bool` **crop_to_region** = ``false`` +:ref:`bool` **crop_to_region** = ``false`` :ref:`🔗` If ``true``, discards empty areas from the atlas. This only affects final sprite positioning, not storage. See also :ref:`trim_alpha_border_from_region`. @@ -80,7 +80,7 @@ If ``true``, discards empty areas from the atlas. This only affects final sprite .. rst-class:: classref-property -:ref:`int` **import_mode** = ``0`` +:ref:`int` **import_mode** = ``0`` :ref:`🔗` **Region:** Imports the atlas in an :ref:`AtlasTexture` resource, which is rendered as a rectangle. This is fast to render, but transparent areas still have to be rendered if they can't be trimmed effectively by :ref:`trim_alpha_border_from_region`. This can reduce performance when rendering large sprites on screen. @@ -94,7 +94,7 @@ If ``true``, discards empty areas from the atlas. This only affects final sprite .. rst-class:: classref-property -:ref:`bool` **trim_alpha_border_from_region** = ``true`` +:ref:`bool` **trim_alpha_border_from_region** = ``true`` :ref:`🔗` If ``true``, trims the region to exclude fully transparent pixels using a clipping rectangle (which is never rotated). This can be used to save memory. See also :ref:`crop_to_region`. diff --git a/classes/class_resourceimporterwav.rst b/classes/class_resourceimporterwav.rst index 096a261c101..1c71c45d83d 100644 --- a/classes/class_resourceimporterwav.rst +++ b/classes/class_resourceimporterwav.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **compress/mode** = ``0`` +:ref:`int` **compress/mode** = ``0`` :ref:`🔗` The compression mode to use on import. @@ -89,7 +89,7 @@ The compression mode to use on import. .. rst-class:: classref-property -:ref:`int` **edit/loop_begin** = ``0`` +:ref:`int` **edit/loop_begin** = ``0`` :ref:`🔗` The begin loop point to use when :ref:`edit/loop_mode` is **Forward**, **Ping-Pong** or **Backward**. This is set in seconds after the beginning of the audio file. @@ -101,7 +101,7 @@ The begin loop point to use when :ref:`edit/loop_mode` **edit/loop_end** = ``-1`` +:ref:`int` **edit/loop_end** = ``-1`` :ref:`🔗` The end loop point to use when :ref:`edit/loop_mode` is **Forward**, **Ping-Pong** or **Backward**. This is set in seconds after the beginning of the audio file. A value of ``-1`` uses the end of the audio file as the end loop point. @@ -113,7 +113,7 @@ The end loop point to use when :ref:`edit/loop_mode` **edit/loop_mode** = ``0`` +:ref:`int` **edit/loop_mode** = ``0`` :ref:`🔗` Controls how audio should loop. This is automatically read from the WAV metadata on import. @@ -135,7 +135,7 @@ Controls how audio should loop. This is automatically read from the WAV metadata .. rst-class:: classref-property -:ref:`bool` **edit/normalize** = ``false`` +:ref:`bool` **edit/normalize** = ``false`` :ref:`🔗` If ``true``, normalize the audio volume so that its peak volume is equal to 0 dB. When enabled, normalization will make audio sound louder depending on its original peak volume. @@ -147,7 +147,7 @@ If ``true``, normalize the audio volume so that its peak volume is equal to 0 dB .. rst-class:: classref-property -:ref:`bool` **edit/trim** = ``false`` +:ref:`bool` **edit/trim** = ``false`` :ref:`🔗` If ``true``, automatically trim the beginning and end of the audio if it's lower than -50 dB after normalization (see :ref:`edit/normalize`). This prevents having files with silence at the beginning or end, which increases their size unnecessarily and adds latency to the moment they are played back. A fade-in/fade-out period of 500 samples is also used during trimming to avoid audible pops. @@ -159,7 +159,7 @@ If ``true``, automatically trim the beginning and end of the audio if it's lower .. rst-class:: classref-property -:ref:`bool` **force/8_bit** = ``false`` +:ref:`bool` **force/8_bit** = ``false`` :ref:`🔗` If ``true``, forces the imported audio to use 8-bit quantization if the source file is 16-bit or higher. @@ -173,7 +173,7 @@ Enabling this is generally not recommended, as 8-bit quantization decreases audi .. rst-class:: classref-property -:ref:`bool` **force/max_rate** = ``false`` +:ref:`bool` **force/max_rate** = ``false`` :ref:`🔗` If set to a value greater than ``0``, forces the audio's sample rate to be reduced to a value lower than or equal to the value specified in :ref:`force/max_rate_hz`. @@ -187,7 +187,7 @@ This can decrease file size noticeably on certain sounds, without impacting qual .. rst-class:: classref-property -:ref:`float` **force/max_rate_hz** = ``44100`` +:ref:`float` **force/max_rate_hz** = ``44100`` :ref:`🔗` The frequency to limit the imported audio sample to (in Hz). Only effective if :ref:`force/max_rate` is ``true``. @@ -199,7 +199,7 @@ The frequency to limit the imported audio sample to (in Hz). Only effective if : .. rst-class:: classref-property -:ref:`bool` **force/mono** = ``false`` +:ref:`bool` **force/mono** = ``false`` :ref:`🔗` If ``true``, forces the imported audio to be mono if the source file is stereo. This decreases the file size by 50% by merging the two channels into one. diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 5af630f413e..46543e6f4ca 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -79,7 +79,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ThreadLoadStatus**: +enum **ThreadLoadStatus**: :ref:`🔗` .. _class_ResourceLoader_constant_THREAD_LOAD_INVALID_RESOURCE: @@ -121,7 +121,7 @@ The resource was loaded successfully and can be accessed via :ref:`load_threaded .. rst-class:: classref-enumeration -enum **CacheMode**: +enum **CacheMode**: :ref:`🔗` .. _class_ResourceLoader_constant_CACHE_MODE_IGNORE: @@ -176,7 +176,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_resource_format_loader**\ (\ format_loader\: :ref:`ResourceFormatLoader`, at_front\: :ref:`bool` = false\ ) +|void| **add_resource_format_loader**\ (\ format_loader\: :ref:`ResourceFormatLoader`, at_front\: :ref:`bool` = false\ ) :ref:`🔗` Registers a new :ref:`ResourceFormatLoader`. The ResourceLoader will use the ResourceFormatLoader as described in :ref:`load`. @@ -190,7 +190,7 @@ This method is performed implicitly for ResourceFormatLoaders written in GDScrip .. rst-class:: classref-method -:ref:`bool` **exists**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = ""\ ) +:ref:`bool` **exists**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = ""\ ) :ref:`🔗` Returns whether a recognized resource exists for the given ``path``. @@ -206,7 +206,7 @@ An optional ``type_hint`` can be used to further specify the :ref:`Resource` **get_dependencies**\ (\ path\: :ref:`String`\ ) +:ref:`PackedStringArray` **get_dependencies**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns the dependencies for the resource at the given ``path``. @@ -226,7 +226,7 @@ Returns the dependencies for the resource at the given ``path``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_recognized_extensions_for_type**\ (\ type\: :ref:`String`\ ) +:ref:`PackedStringArray` **get_recognized_extensions_for_type**\ (\ type\: :ref:`String`\ ) :ref:`🔗` Returns the list of recognized extensions for a resource type. @@ -238,7 +238,7 @@ Returns the list of recognized extensions for a resource type. .. rst-class:: classref-method -:ref:`int` **get_resource_uid**\ (\ path\: :ref:`String`\ ) +:ref:`int` **get_resource_uid**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns the ID associated with a given resource path, or ``-1`` when no such ID exists. @@ -250,7 +250,7 @@ Returns the ID associated with a given resource path, or ``-1`` when no such ID .. rst-class:: classref-method -:ref:`bool` **has_cached**\ (\ path\: :ref:`String`\ ) +:ref:`bool` **has_cached**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns whether a cached resource is available for the given ``path``. @@ -264,7 +264,7 @@ Once a resource has been loaded by the engine, it is cached in memory for faster .. rst-class:: classref-method -:ref:`Resource` **load**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", cache_mode\: :ref:`CacheMode` = 1\ ) +:ref:`Resource` **load**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", cache_mode\: :ref:`CacheMode` = 1\ ) :ref:`🔗` Loads a resource at the given ``path``, caching the result for further access. @@ -290,7 +290,7 @@ GDScript has a simplified :ref:`@GDScript.load` bui .. rst-class:: classref-method -:ref:`Resource` **load_threaded_get**\ (\ path\: :ref:`String`\ ) +:ref:`Resource` **load_threaded_get**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns the resource loaded by :ref:`load_threaded_request`. @@ -304,7 +304,7 @@ If this is called before the loading thread is done (i.e. :ref:`load_threaded_ge .. rst-class:: classref-method -:ref:`ThreadLoadStatus` **load_threaded_get_status**\ (\ path\: :ref:`String`, progress\: :ref:`Array` = []\ ) +:ref:`ThreadLoadStatus` **load_threaded_get_status**\ (\ path\: :ref:`String`, progress\: :ref:`Array` = []\ ) :ref:`🔗` Returns the status of a threaded loading operation started with :ref:`load_threaded_request` for the resource at ``path``. See :ref:`ThreadLoadStatus` for possible return values. @@ -318,7 +318,7 @@ An array variable can optionally be passed via ``progress``, and will return a o .. rst-class:: classref-method -:ref:`Error` **load_threaded_request**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", use_sub_threads\: :ref:`bool` = false, cache_mode\: :ref:`CacheMode` = 1\ ) +:ref:`Error` **load_threaded_request**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", use_sub_threads\: :ref:`bool` = false, cache_mode\: :ref:`CacheMode` = 1\ ) :ref:`🔗` Loads the resource using threads. If ``use_sub_threads`` is ``true``, multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns). @@ -332,7 +332,7 @@ The ``cache_mode`` property defines whether and how the cache should be used or .. rst-class:: classref-method -|void| **remove_resource_format_loader**\ (\ format_loader\: :ref:`ResourceFormatLoader`\ ) +|void| **remove_resource_format_loader**\ (\ format_loader\: :ref:`ResourceFormatLoader`\ ) :ref:`🔗` Unregisters the given :ref:`ResourceFormatLoader`. @@ -344,7 +344,7 @@ Unregisters the given :ref:`ResourceFormatLoader`. .. rst-class:: classref-method -|void| **set_abort_on_missing_resources**\ (\ abort\: :ref:`bool`\ ) +|void| **set_abort_on_missing_resources**\ (\ abort\: :ref:`bool`\ ) :ref:`🔗` Changes the behavior on missing sub-resources. The default behavior is to abort loading. diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 63b64ff769e..ea1aad522c4 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -58,7 +58,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_resource**\ (\ name\: :ref:`StringName`, resource\: :ref:`Resource`\ ) +|void| **add_resource**\ (\ name\: :ref:`StringName`, resource\: :ref:`Resource`\ ) :ref:`🔗` Adds a resource to the preloader with the given ``name``. If a resource with the given ``name`` already exists, the new resource will be renamed to "``name`` N" where N is an incrementing number starting from 2. @@ -70,7 +70,7 @@ Adds a resource to the preloader with the given ``name``. If a resource with the .. rst-class:: classref-method -:ref:`Resource` **get_resource**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Resource` **get_resource**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the resource associated to ``name``. @@ -82,7 +82,7 @@ Returns the resource associated to ``name``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_resource_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_resource_list**\ (\ ) |const| :ref:`🔗` Returns the list of resources inside the preloader. @@ -94,7 +94,7 @@ Returns the list of resources inside the preloader. .. rst-class:: classref-method -:ref:`bool` **has_resource**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_resource**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the preloader contains a resource associated to ``name``. @@ -106,7 +106,7 @@ Returns ``true`` if the preloader contains a resource associated to ``name``. .. rst-class:: classref-method -|void| **remove_resource**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_resource**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the resource associated to ``name`` from the preloader. @@ -118,7 +118,7 @@ Removes the resource associated to ``name`` from the preloader. .. rst-class:: classref-method -|void| **rename_resource**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) +|void| **rename_resource**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) :ref:`🔗` Renames a resource inside the preloader from ``name`` to ``newname``. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 1edce50b7df..9a132f8b9c2 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -54,7 +54,7 @@ Enumerations .. rst-class:: classref-enumeration -flags **SaverFlags**: +flags **SaverFlags**: :ref:`🔗` .. _class_ResourceSaver_constant_FLAG_NONE: @@ -133,7 +133,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`, at_front\: :ref:`bool` = false\ ) +|void| **add_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`, at_front\: :ref:`bool` = false\ ) :ref:`🔗` Registers a new :ref:`ResourceFormatSaver`. The ResourceSaver will use the ResourceFormatSaver as described in :ref:`save`. @@ -147,7 +147,7 @@ This method is performed implicitly for ResourceFormatSavers written in GDScript .. rst-class:: classref-method -:ref:`PackedStringArray` **get_recognized_extensions**\ (\ type\: :ref:`Resource`\ ) +:ref:`PackedStringArray` **get_recognized_extensions**\ (\ type\: :ref:`Resource`\ ) :ref:`🔗` Returns the list of extensions available for saving a resource of a given type. @@ -159,7 +159,7 @@ Returns the list of extensions available for saving a resource of a given type. .. rst-class:: classref-method -|void| **remove_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`\ ) +|void| **remove_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`\ ) :ref:`🔗` Unregisters the given :ref:`ResourceFormatSaver`. @@ -171,7 +171,7 @@ Unregisters the given :ref:`ResourceFormatSaver`. .. rst-class:: classref-method -:ref:`Error` **save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) +:ref:`Error` **save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) :ref:`🔗` Saves a resource to disk to the given path, using a :ref:`ResourceFormatSaver` that recognizes the resource object. If ``path`` is empty, **ResourceSaver** will try to use :ref:`Resource.resource_path`. diff --git a/classes/class_resourceuid.rst b/classes/class_resourceuid.rst index d913ebbe06e..cc39a4191b4 100644 --- a/classes/class_resourceuid.rst +++ b/classes/class_resourceuid.rst @@ -62,7 +62,7 @@ Constants .. rst-class:: classref-constant -**INVALID_ID** = ``-1`` +**INVALID_ID** = ``-1`` :ref:`🔗` The value to use for an invalid UID, for example if the resource could not be loaded. @@ -81,7 +81,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) +|void| **add_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) :ref:`🔗` Adds a new UID value which is mapped to the given resource path. @@ -95,7 +95,7 @@ Fails with an error if the UID already exists, so be sure to check :ref:`has_id< .. rst-class:: classref-method -:ref:`int` **create_id**\ (\ ) +:ref:`int` **create_id**\ (\ ) :ref:`🔗` Generates a random resource UID which is guaranteed to be unique within the list of currently loaded UIDs. @@ -109,7 +109,7 @@ In order for this UID to be registered, you must call :ref:`add_id` **get_id_path**\ (\ id\: :ref:`int`\ ) |const| +:ref:`String` **get_id_path**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path that the given UID value refers to. @@ -123,7 +123,7 @@ Fails with an error if the UID does not exist, so be sure to check :ref:`has_id< .. rst-class:: classref-method -:ref:`bool` **has_id**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **has_id**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the given UID value is known to the cache. @@ -135,7 +135,7 @@ Returns whether the given UID value is known to the cache. .. rst-class:: classref-method -:ref:`String` **id_to_text**\ (\ id\: :ref:`int`\ ) |const| +:ref:`String` **id_to_text**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given UID to a ``uid://`` string value. @@ -147,7 +147,7 @@ Converts the given UID to a ``uid://`` string value. .. rst-class:: classref-method -|void| **remove_id**\ (\ id\: :ref:`int`\ ) +|void| **remove_id**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes a loaded UID value from the cache. @@ -161,7 +161,7 @@ Fails with an error if the UID does not exist, so be sure to check :ref:`has_id< .. rst-class:: classref-method -|void| **set_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) +|void| **set_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) :ref:`🔗` Updates the resource path of an existing UID. @@ -175,7 +175,7 @@ Fails with an error if the UID does not exist, so be sure to check :ref:`has_id< .. rst-class:: classref-method -:ref:`int` **text_to_id**\ (\ text_id\: :ref:`String`\ ) |const| +:ref:`int` **text_to_id**\ (\ text_id\: :ref:`String`\ ) |const| :ref:`🔗` Extracts the UID value from the given ``uid://`` string. diff --git a/classes/class_ribbontrailmesh.rst b/classes/class_ribbontrailmesh.rst index cf4163bcce1..69b779435fb 100644 --- a/classes/class_ribbontrailmesh.rst +++ b/classes/class_ribbontrailmesh.rst @@ -67,7 +67,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Shape**: +enum **Shape**: :ref:`🔗` .. _class_RibbonTrailMesh_constant_SHAPE_FLAT: @@ -98,7 +98,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Curve` **curve** +:ref:`Curve` **curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ Determines the size of the ribbon along its length. The size of a particular sec .. rst-class:: classref-property -:ref:`float` **section_length** = ``0.2`` +:ref:`float` **section_length** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ The length of a section of the ribbon. .. rst-class:: classref-property -:ref:`int` **section_segments** = ``3`` +:ref:`int` **section_segments** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ The number of segments in a section. The :ref:`curve` **sections** = ``5`` +:ref:`int` **sections** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ The total number of sections on the ribbon. .. rst-class:: classref-property -:ref:`Shape` **shape** = ``1`` +:ref:`Shape` **shape** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ Determines the shape of the ribbon. .. rst-class:: classref-property -:ref:`float` **size** = ``1.0`` +:ref:`float` **size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index 2ade015afcb..10be3363c3e 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_process_custom_fx**\ (\ char_fx\: :ref:`CharFXTransform`\ ) |virtual| |const| +:ref:`bool` **_process_custom_fx**\ (\ char_fx\: :ref:`CharFXTransform`\ ) |virtual| |const| :ref:`🔗` Override this method to modify properties in ``char_fx``. The method must return ``true`` if the character could be transformed successfully. If the method returns ``false``, it will skip transformation to avoid displaying broken text. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 551ef6d87cd..f1a0d6a2b4e 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -329,7 +329,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Triggered when the document is fully loaded. @@ -341,7 +341,7 @@ Triggered when the document is fully loaded. .. rst-class:: classref-signal -**meta_clicked**\ (\ meta\: :ref:`Variant`\ ) +**meta_clicked**\ (\ meta\: :ref:`Variant`\ ) :ref:`🔗` Triggered when the user clicks on content between meta (URL) tags. If the meta is defined in BBCode, e.g. ``[url={"key": "value"}]Text[/url]``, then the parameter for this signal will always be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. Alternatively, you can convert the :ref:`String` input to the desired type based on its contents (such as calling :ref:`JSON.parse` on it). @@ -368,7 +368,7 @@ For example, the following method can be connected to :ref:`meta_clicked`\ ) +**meta_hover_ended**\ (\ meta\: :ref:`Variant`\ ) :ref:`🔗` Triggers when the mouse exits a meta tag. @@ -380,7 +380,7 @@ Triggers when the mouse exits a meta tag. .. rst-class:: classref-signal -**meta_hover_started**\ (\ meta\: :ref:`Variant`\ ) +**meta_hover_started**\ (\ meta\: :ref:`Variant`\ ) :ref:`🔗` Triggers when the mouse enters a meta tag. @@ -397,7 +397,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ListType**: +enum **ListType**: :ref:`🔗` .. _class_RichTextLabel_constant_LIST_NUMBERS: @@ -439,7 +439,7 @@ Each list item has a filled circle marker. .. rst-class:: classref-enumeration -enum **MenuItems**: +enum **MenuItems**: :ref:`🔗` .. _class_RichTextLabel_constant_MENU_COPY: @@ -473,7 +473,7 @@ Represents the size of the :ref:`MenuItems` enum. .. rst-class:: classref-enumeration -enum **MetaUnderline**: +enum **MetaUnderline**: :ref:`🔗` .. _class_RichTextLabel_constant_META_UNDERLINE_NEVER: @@ -507,7 +507,7 @@ If :ref:`meta_underlined` is ``tru .. rst-class:: classref-enumeration -flags **ImageUpdateMask**: +flags **ImageUpdateMask**: :ref:`🔗` .. _class_RichTextLabel_constant_UPDATE_TEXTURE: @@ -586,7 +586,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AutowrapMode` **autowrap_mode** = ``3`` +:ref:`AutowrapMode` **autowrap_mode** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -603,7 +603,7 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` **bbcode_enabled** = ``false`` +:ref:`bool` **bbcode_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -622,7 +622,7 @@ If ``true``, the label uses BBCode formatting. .. rst-class:: classref-property -:ref:`bool` **context_menu_enabled** = ``false`` +:ref:`bool` **context_menu_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -639,7 +639,7 @@ If ``true``, a right-click displays the context menu. .. rst-class:: classref-property -:ref:`Array` **custom_effects** = ``[]`` +:ref:`Array` **custom_effects** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -658,7 +658,7 @@ To add a custom effect, it's more convenient to use :ref:`install_effect` **deselect_on_focus_loss_enabled** = ``true`` +:ref:`bool` **deselect_on_focus_loss_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -675,7 +675,7 @@ If ``true``, the selected text will be deselected when focus is lost. .. rst-class:: classref-property -:ref:`bool` **drag_and_drop_selection_enabled** = ``true`` +:ref:`bool` **drag_and_drop_selection_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -692,7 +692,7 @@ If ``true``, allow drag and drop of selected text. .. rst-class:: classref-property -:ref:`bool` **fit_content** = ``false`` +:ref:`bool` **fit_content** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -709,7 +709,7 @@ If ``true``, the label's minimum size will be automatically updated to fit its c .. rst-class:: classref-property -:ref:`bool` **hint_underlined** = ``true`` +:ref:`bool` **hint_underlined** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -726,7 +726,7 @@ If ``true``, the label underlines hint tags such as ``[hint=description]{text}[/ .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -743,7 +743,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`bool` **meta_underlined** = ``true`` +:ref:`bool` **meta_underlined** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -760,7 +760,7 @@ If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. These .. rst-class:: classref-property -:ref:`int` **progress_bar_delay** = ``1000`` +:ref:`int` **progress_bar_delay** = ``1000`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -779,7 +779,7 @@ The delay after which the loading progress bar is displayed, in milliseconds. Se .. rst-class:: classref-property -:ref:`bool` **scroll_active** = ``true`` +:ref:`bool` **scroll_active** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -796,7 +796,7 @@ If ``true``, the scrollbar is visible. Setting this to ``false`` does not block .. rst-class:: classref-property -:ref:`bool` **scroll_following** = ``false`` +:ref:`bool` **scroll_following** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -813,7 +813,7 @@ If ``true``, the window scrolls down to display new content automatically. .. rst-class:: classref-property -:ref:`bool` **selection_enabled** = ``false`` +:ref:`bool` **selection_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -830,7 +830,7 @@ If ``true``, the label allows text selection. .. rst-class:: classref-property -:ref:`bool` **shortcut_keys_enabled** = ``true`` +:ref:`bool` **shortcut_keys_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -847,7 +847,7 @@ If ``true``, shortcut keys for context menu items are enabled, even if the conte .. rst-class:: classref-property -:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -864,7 +864,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -881,7 +881,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`int` **tab_size** = ``4`` +:ref:`int` **tab_size** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -898,7 +898,7 @@ The number of spaces associated with a single tab length. Does not affect ``\t`` .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -917,7 +917,7 @@ The label's text in BBCode format. Is not representative of manual modifications .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -934,7 +934,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`bool` **threaded** = ``false`` +:ref:`bool` **threaded** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -951,7 +951,7 @@ If ``true``, text processing is done in a background thread. .. rst-class:: classref-property -:ref:`int` **visible_characters** = ``-1`` +:ref:`int` **visible_characters** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -970,7 +970,7 @@ The number of characters to display. If set to ``-1``, all characters are displa .. rst-class:: classref-property -:ref:`VisibleCharactersBehavior` **visible_characters_behavior** = ``0`` +:ref:`VisibleCharactersBehavior` **visible_characters_behavior** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -987,7 +987,7 @@ Sets the clipping behavior when :ref:`visible_characters` **visible_ratio** = ``1.0`` +:ref:`float` **visible_ratio** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1011,7 +1011,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) +|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image, a ``color`` to tint the image and a ``region`` to only use parts of the image. @@ -1033,7 +1033,7 @@ If ``size_in_percent`` is set, ``width`` and ``height`` values are percentages o .. rst-class:: classref-method -|void| **add_text**\ (\ text\: :ref:`String`\ ) +|void| **add_text**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Adds raw non-BBCode-parsed text to the tag stack. @@ -1045,7 +1045,7 @@ Adds raw non-BBCode-parsed text to the tag stack. .. rst-class:: classref-method -|void| **append_text**\ (\ bbcode\: :ref:`String`\ ) +|void| **append_text**\ (\ bbcode\: :ref:`String`\ ) :ref:`🔗` Parses ``bbcode`` and adds tags to the tag stack as needed. @@ -1059,7 +1059,7 @@ Parses ``bbcode`` and adds tags to the tag stack as needed. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the tag stack, causing the label to display nothing. @@ -1073,7 +1073,7 @@ Clears the tag stack, causing the label to display nothing. .. rst-class:: classref-method -|void| **deselect**\ (\ ) +|void| **deselect**\ (\ ) :ref:`🔗` Clears the current selection. @@ -1085,7 +1085,7 @@ Clears the current selection. .. rst-class:: classref-method -:ref:`int` **get_character_line**\ (\ character\: :ref:`int`\ ) +:ref:`int` **get_character_line**\ (\ character\: :ref:`int`\ ) :ref:`🔗` Returns the line number of the character position provided. Line and character numbers are both zero-indexed. @@ -1099,7 +1099,7 @@ Returns the line number of the character position provided. Line and character n .. rst-class:: classref-method -:ref:`int` **get_character_paragraph**\ (\ character\: :ref:`int`\ ) +:ref:`int` **get_character_paragraph**\ (\ character\: :ref:`int`\ ) :ref:`🔗` Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed. @@ -1113,7 +1113,7 @@ Returns the paragraph number of the character position provided. Paragraph and c .. rst-class:: classref-method -:ref:`int` **get_content_height**\ (\ ) |const| +:ref:`int` **get_content_height**\ (\ ) |const| :ref:`🔗` Returns the height of the content. @@ -1127,7 +1127,7 @@ Returns the height of the content. .. rst-class:: classref-method -:ref:`int` **get_content_width**\ (\ ) |const| +:ref:`int` **get_content_width**\ (\ ) |const| :ref:`🔗` Returns the width of the content. @@ -1141,7 +1141,7 @@ Returns the width of the content. .. rst-class:: classref-method -:ref:`int` **get_line_count**\ (\ ) |const| +:ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` Returns the total number of lines in the text. Wrapped text is counted as multiple lines. @@ -1155,7 +1155,7 @@ Returns the total number of lines in the text. Wrapped text is counted as multip .. rst-class:: classref-method -:ref:`float` **get_line_offset**\ (\ line\: :ref:`int`\ ) +:ref:`float` **get_line_offset**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Returns the vertical offset of the line found at the provided index. @@ -1169,7 +1169,7 @@ Returns the vertical offset of the line found at the provided index. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu**\ (\ ) |const| +:ref:`PopupMenu` **get_menu**\ (\ ) |const| :ref:`🔗` Returns the :ref:`PopupMenu` of this **RichTextLabel**. By default, this menu is displayed when right-clicking on the **RichTextLabel**. @@ -1228,7 +1228,7 @@ You can add custom menu items or remove standard ones. Make sure your IDs don't .. rst-class:: classref-method -:ref:`int` **get_paragraph_count**\ (\ ) |const| +:ref:`int` **get_paragraph_count**\ (\ ) |const| :ref:`🔗` Returns the total number of paragraphs (newlines or ``p`` tags in the tag stack's text tags). Considers wrapped text as one paragraph. @@ -1240,7 +1240,7 @@ Returns the total number of paragraphs (newlines or ``p`` tags in the tag stack' .. rst-class:: classref-method -:ref:`float` **get_paragraph_offset**\ (\ paragraph\: :ref:`int`\ ) +:ref:`float` **get_paragraph_offset**\ (\ paragraph\: :ref:`int`\ ) :ref:`🔗` Returns the vertical offset of the paragraph found at the provided index. @@ -1254,7 +1254,7 @@ Returns the vertical offset of the paragraph found at the provided index. .. rst-class:: classref-method -:ref:`String` **get_parsed_text**\ (\ ) |const| +:ref:`String` **get_parsed_text**\ (\ ) |const| :ref:`🔗` Returns the text without BBCode mark-up. @@ -1266,7 +1266,7 @@ Returns the text without BBCode mark-up. .. rst-class:: classref-method -:ref:`String` **get_selected_text**\ (\ ) |const| +:ref:`String` **get_selected_text**\ (\ ) |const| :ref:`🔗` Returns the current selection text. Does not include BBCodes. @@ -1278,7 +1278,7 @@ Returns the current selection text. Does not include BBCodes. .. rst-class:: classref-method -:ref:`int` **get_selection_from**\ (\ ) |const| +:ref:`int` **get_selection_from**\ (\ ) |const| :ref:`🔗` Returns the current selection first character index if a selection is active, ``-1`` otherwise. Does not include BBCodes. @@ -1290,7 +1290,7 @@ Returns the current selection first character index if a selection is active, `` .. rst-class:: classref-method -:ref:`int` **get_selection_to**\ (\ ) |const| +:ref:`int` **get_selection_to**\ (\ ) |const| :ref:`🔗` Returns the current selection last character index if a selection is active, ``-1`` otherwise. Does not include BBCodes. @@ -1302,7 +1302,7 @@ Returns the current selection last character index if a selection is active, ``- .. rst-class:: classref-method -:ref:`int` **get_total_character_count**\ (\ ) |const| +:ref:`int` **get_total_character_count**\ (\ ) |const| :ref:`🔗` Returns the total number of characters from text tags. Does not include BBCodes. @@ -1314,7 +1314,7 @@ Returns the total number of characters from text tags. Does not include BBCodes. .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) :ref:`🔗` Returns the vertical scrollbar. @@ -1328,7 +1328,7 @@ Returns the vertical scrollbar. .. rst-class:: classref-method -:ref:`int` **get_visible_line_count**\ (\ ) |const| +:ref:`int` **get_visible_line_count**\ (\ ) |const| :ref:`🔗` Returns the number of visible lines. @@ -1342,7 +1342,7 @@ Returns the number of visible lines. .. rst-class:: classref-method -:ref:`int` **get_visible_paragraph_count**\ (\ ) |const| +:ref:`int` **get_visible_paragraph_count**\ (\ ) |const| :ref:`🔗` Returns the number of visible paragraphs. A paragraph is considered visible if at least one of its lines is visible. @@ -1356,7 +1356,7 @@ Returns the number of visible paragraphs. A paragraph is considered visible if a .. rst-class:: classref-method -|void| **install_effect**\ (\ effect\: :ref:`Variant`\ ) +|void| **install_effect**\ (\ effect\: :ref:`Variant`\ ) :ref:`🔗` Installs a custom effect. This can also be done in the RichTextLabel inspector using the :ref:`custom_effects` property. ``effect`` should be a valid :ref:`RichTextEffect`. @@ -1393,7 +1393,7 @@ Registering the above effect in RichTextLabel from script: .. rst-class:: classref-method -:ref:`bool` **invalidate_paragraph**\ (\ paragraph\: :ref:`int`\ ) +:ref:`bool` **invalidate_paragraph**\ (\ paragraph\: :ref:`int`\ ) :ref:`🔗` Invalidates ``paragraph`` and all subsequent paragraphs cache. @@ -1405,7 +1405,7 @@ Invalidates ``paragraph`` and all subsequent paragraphs cache. .. rst-class:: classref-method -:ref:`bool` **is_menu_visible**\ (\ ) |const| +:ref:`bool` **is_menu_visible**\ (\ ) |const| :ref:`🔗` Returns whether the menu is visible. Use this instead of ``get_menu().visible`` to improve performance (so the creation of the menu is avoided). @@ -1417,7 +1417,7 @@ Returns whether the menu is visible. Use this instead of ``get_menu().visible`` .. rst-class:: classref-method -:ref:`bool` **is_ready**\ (\ ) |const| +:ref:`bool` **is_ready**\ (\ ) |const| :ref:`🔗` If :ref:`threaded` is enabled, returns ``true`` if the background thread has finished text processing, otherwise always return ``true``. @@ -1429,7 +1429,7 @@ If :ref:`threaded` is enabled, returns `` .. rst-class:: classref-method -|void| **menu_option**\ (\ option\: :ref:`int`\ ) +|void| **menu_option**\ (\ option\: :ref:`int`\ ) :ref:`🔗` Executes a given action as defined in the :ref:`MenuItems` enum. @@ -1441,7 +1441,7 @@ Executes a given action as defined in the :ref:`MenuItems` Adds a newline tag to the tag stack. @@ -1453,7 +1453,7 @@ Adds a newline tag to the tag stack. .. rst-class:: classref-method -|void| **parse_bbcode**\ (\ bbcode\: :ref:`String`\ ) +|void| **parse_bbcode**\ (\ bbcode\: :ref:`String`\ ) :ref:`🔗` The assignment version of :ref:`append_text`. Clears the tag stack and inserts the new content. @@ -1465,7 +1465,7 @@ The assignment version of :ref:`append_text` **parse_expressions_for_values**\ (\ expressions\: :ref:`PackedStringArray`\ ) +:ref:`Dictionary` **parse_expressions_for_values**\ (\ expressions\: :ref:`PackedStringArray`\ ) :ref:`🔗` Parses BBCode parameter ``expressions`` into a dictionary. @@ -1477,7 +1477,7 @@ Parses BBCode parameter ``expressions`` into a dictionary. .. rst-class:: classref-method -|void| **pop**\ (\ ) +|void| **pop**\ (\ ) :ref:`🔗` Terminates the current tag. Use after ``push_*`` methods to close BBCodes manually. Does not need to follow ``add_*`` methods. @@ -1489,7 +1489,7 @@ Terminates the current tag. Use after ``push_*`` methods to close BBCodes manual .. rst-class:: classref-method -|void| **pop_all**\ (\ ) +|void| **pop_all**\ (\ ) :ref:`🔗` Terminates all tags opened by ``push_*`` methods. @@ -1501,7 +1501,7 @@ Terminates all tags opened by ``push_*`` methods. .. rst-class:: classref-method -|void| **pop_context**\ (\ ) +|void| **pop_context**\ (\ ) :ref:`🔗` Terminates tags opened after the last :ref:`push_context` call (including context marker), or all tags if there's no context marker on the stack. @@ -1513,7 +1513,7 @@ Terminates tags opened after the last :ref:`push_context`\ ) +|void| **push_bgcolor**\ (\ bgcolor\: :ref:`Color`\ ) :ref:`🔗` Adds a ``[bgcolor]`` tag to the tag stack. @@ -1525,7 +1525,7 @@ Adds a ``[bgcolor]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_bold**\ (\ ) +|void| **push_bold**\ (\ ) :ref:`🔗` Adds a ``[font]`` tag with a bold font to the tag stack. This is the same as adding a ``[b]`` tag if not currently in a ``[i]`` tag. @@ -1537,7 +1537,7 @@ Adds a ``[font]`` tag with a bold font to the tag stack. This is the same as add .. rst-class:: classref-method -|void| **push_bold_italics**\ (\ ) +|void| **push_bold_italics**\ (\ ) :ref:`🔗` Adds a ``[font]`` tag with a bold italics font to the tag stack. @@ -1549,9 +1549,9 @@ Adds a ``[font]`` tag with a bold italics font to the tag stack. .. rst-class:: classref-method -|void| **push_cell**\ (\ ) +|void| **push_cell**\ (\ ) :ref:`🔗` -Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table` for details. +Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table` for details. Use :ref:`set_table_column_expand` to set column expansion ratio, :ref:`set_cell_border_color` to set cell border, :ref:`set_cell_row_background_color` to set cell background, :ref:`set_cell_size_override` to override cell size, and :ref:`set_cell_padding` to set padding. .. rst-class:: classref-item-separator @@ -1561,7 +1561,7 @@ Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :r .. rst-class:: classref-method -|void| **push_color**\ (\ color\: :ref:`Color`\ ) +|void| **push_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Adds a ``[color]`` tag to the tag stack. @@ -1573,7 +1573,7 @@ Adds a ``[color]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_context**\ (\ ) +|void| **push_context**\ (\ ) :ref:`🔗` Adds a context marker to the tag stack. See :ref:`pop_context`. @@ -1585,7 +1585,7 @@ Adds a context marker to the tag stack. See :ref:`pop_context`, env\: :ref:`Dictionary`\ ) +|void| **push_customfx**\ (\ effect\: :ref:`RichTextEffect`, env\: :ref:`Dictionary`\ ) :ref:`🔗` Adds a custom effect tag to the tag stack. The effect does not need to be in :ref:`custom_effects`. The environment is directly passed to the effect. @@ -1597,7 +1597,7 @@ Adds a custom effect tag to the tag stack. The effect does not need to be in :re .. rst-class:: classref-method -|void| **push_dropcap**\ (\ string\: :ref:`String`, font\: :ref:`Font`, size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), color\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, outline_color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) +|void| **push_dropcap**\ (\ string\: :ref:`String`, font\: :ref:`Font`, size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), color\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, outline_color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) :ref:`🔗` Adds a ``[dropcap]`` tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. @@ -1609,7 +1609,7 @@ Adds a ``[dropcap]`` tag to the tag stack. Drop cap (dropped capital) is a decor .. rst-class:: classref-method -|void| **push_fgcolor**\ (\ fgcolor\: :ref:`Color`\ ) +|void| **push_fgcolor**\ (\ fgcolor\: :ref:`Color`\ ) :ref:`🔗` Adds a ``[fgcolor]`` tag to the tag stack. @@ -1621,7 +1621,7 @@ Adds a ``[fgcolor]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_font**\ (\ font\: :ref:`Font`, font_size\: :ref:`int` = 0\ ) +|void| **push_font**\ (\ font\: :ref:`Font`, font_size\: :ref:`int` = 0\ ) :ref:`🔗` Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. @@ -1635,7 +1635,7 @@ Passing ``0`` to ``font_size`` will use the existing default font size. .. rst-class:: classref-method -|void| **push_font_size**\ (\ font_size\: :ref:`int`\ ) +|void| **push_font_size**\ (\ font_size\: :ref:`int`\ ) :ref:`🔗` Adds a ``[font_size]`` tag to the tag stack. Overrides default font size for its duration. @@ -1647,7 +1647,7 @@ Adds a ``[font_size]`` tag to the tag stack. Overrides default font size for its .. rst-class:: classref-method -|void| **push_hint**\ (\ description\: :ref:`String`\ ) +|void| **push_hint**\ (\ description\: :ref:`String`\ ) :ref:`🔗` Adds a ``[hint]`` tag to the tag stack. Same as BBCode ``[hint=something]{text}[/hint]``. @@ -1659,7 +1659,7 @@ Adds a ``[hint]`` tag to the tag stack. Same as BBCode ``[hint=something]{text}[ .. rst-class:: classref-method -|void| **push_indent**\ (\ level\: :ref:`int`\ ) +|void| **push_indent**\ (\ level\: :ref:`int`\ ) :ref:`🔗` Adds an ``[indent]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size` to determine new margin length. @@ -1671,7 +1671,7 @@ Adds an ``[indent]`` tag to the tag stack. Multiplies ``level`` by current :ref: .. rst-class:: classref-method -|void| **push_italics**\ (\ ) +|void| **push_italics**\ (\ ) :ref:`🔗` Adds a ``[font]`` tag with an italics font to the tag stack. This is the same as adding an ``[i]`` tag if not currently in a ``[b]`` tag. @@ -1683,7 +1683,7 @@ Adds a ``[font]`` tag with an italics font to the tag stack. This is the same as .. rst-class:: classref-method -|void| **push_language**\ (\ language\: :ref:`String`\ ) +|void| **push_language**\ (\ language\: :ref:`String`\ ) :ref:`🔗` Adds language code used for text shaping algorithm and Open-Type font features. @@ -1695,7 +1695,7 @@ Adds language code used for text shaping algorithm and Open-Type font features. .. rst-class:: classref-method -|void| **push_list**\ (\ level\: :ref:`int`, type\: :ref:`ListType`, capitalize\: :ref:`bool`, bullet\: :ref:`String` = "•"\ ) +|void| **push_list**\ (\ level\: :ref:`int`, type\: :ref:`ListType`, capitalize\: :ref:`bool`, bullet\: :ref:`String` = "•"\ ) :ref:`🔗` Adds ``[ol]`` or ``[ul]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size` to determine new margin length. @@ -1707,7 +1707,7 @@ Adds ``[ol]`` or ``[ul]`` tag to the tag stack. Multiplies ``level`` by current .. rst-class:: classref-method -|void| **push_meta**\ (\ data\: :ref:`Variant`, underline_mode\: :ref:`MetaUnderline` = 1\ ) +|void| **push_meta**\ (\ data\: :ref:`Variant`, underline_mode\: :ref:`MetaUnderline` = 1\ ) :ref:`🔗` Adds a meta tag to the tag stack. Similar to the BBCode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. @@ -1723,7 +1723,7 @@ If :ref:`meta_underlined` is ``tru .. rst-class:: classref-method -|void| **push_mono**\ (\ ) +|void| **push_mono**\ (\ ) :ref:`🔗` Adds a ``[font]`` tag with a monospace font to the tag stack. @@ -1735,7 +1735,7 @@ Adds a ``[font]`` tag with a monospace font to the tag stack. .. rst-class:: classref-method -|void| **push_normal**\ (\ ) +|void| **push_normal**\ (\ ) :ref:`🔗` Adds a ``[font]`` tag with a normal font to the tag stack. @@ -1747,7 +1747,7 @@ Adds a ``[font]`` tag with a normal font to the tag stack. .. rst-class:: classref-method -|void| **push_outline_color**\ (\ color\: :ref:`Color`\ ) +|void| **push_outline_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Adds a ``[outline_color]`` tag to the tag stack. Adds text outline for its duration. @@ -1759,7 +1759,7 @@ Adds a ``[outline_color]`` tag to the tag stack. Adds text outline for its durat .. rst-class:: classref-method -|void| **push_outline_size**\ (\ outline_size\: :ref:`int`\ ) +|void| **push_outline_size**\ (\ outline_size\: :ref:`int`\ ) :ref:`🔗` Adds a ``[outline_size]`` tag to the tag stack. Overrides default text outline size for its duration. @@ -1771,7 +1771,7 @@ Adds a ``[outline_size]`` tag to the tag stack. Overrides default text outline s .. rst-class:: classref-method -|void| **push_paragraph**\ (\ alignment\: :ref:`HorizontalAlignment`, base_direction\: :ref:`TextDirection` = 0, language\: :ref:`String` = "", st_parser\: :ref:`StructuredTextParser` = 0, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 163, tab_stops\: :ref:`PackedFloat32Array` = PackedFloat32Array()\ ) +|void| **push_paragraph**\ (\ alignment\: :ref:`HorizontalAlignment`, base_direction\: :ref:`TextDirection` = 0, language\: :ref:`String` = "", st_parser\: :ref:`StructuredTextParser` = 0, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 163, tab_stops\: :ref:`PackedFloat32Array` = PackedFloat32Array()\ ) :ref:`🔗` Adds a ``[p]`` tag to the tag stack. @@ -1783,7 +1783,7 @@ Adds a ``[p]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_strikethrough**\ (\ ) +|void| **push_strikethrough**\ (\ ) :ref:`🔗` Adds a ``[s]`` tag to the tag stack. @@ -1795,9 +1795,9 @@ Adds a ``[s]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) +|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) :ref:`🔗` -Adds a ``[table=columns,inline_align]`` tag to the tag stack. +Adds a ``[table=columns,inline_align]`` tag to the tag stack. Use :ref:`set_table_column_expand` to set column expansion ratio. Use :ref:`push_cell` to add cells. .. rst-class:: classref-item-separator @@ -1807,7 +1807,7 @@ Adds a ``[table=columns,inline_align]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_underline**\ (\ ) +|void| **push_underline**\ (\ ) :ref:`🔗` Adds a ``[u]`` tag to the tag stack. @@ -1819,7 +1819,7 @@ Adds a ``[u]`` tag to the tag stack. .. rst-class:: classref-method -:ref:`bool` **remove_paragraph**\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) +:ref:`bool` **remove_paragraph**\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) :ref:`🔗` Removes a paragraph of content from the label. Returns ``true`` if the paragraph exists. @@ -1835,7 +1835,7 @@ If ``no_invalidate`` is set to ``true``, cache for the subsequent paragraphs is .. rst-class:: classref-method -|void| **scroll_to_line**\ (\ line\: :ref:`int`\ ) +|void| **scroll_to_line**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Scrolls the window's top line to match ``line``. @@ -1847,7 +1847,7 @@ Scrolls the window's top line to match ``line``. .. rst-class:: classref-method -|void| **scroll_to_paragraph**\ (\ paragraph\: :ref:`int`\ ) +|void| **scroll_to_paragraph**\ (\ paragraph\: :ref:`int`\ ) :ref:`🔗` Scrolls the window's top line to match first line of the ``paragraph``. @@ -1859,7 +1859,7 @@ Scrolls the window's top line to match first line of the ``paragraph``. .. rst-class:: classref-method -|void| **scroll_to_selection**\ (\ ) +|void| **scroll_to_selection**\ (\ ) :ref:`🔗` Scrolls to the beginning of the current selection. @@ -1871,7 +1871,7 @@ Scrolls to the beginning of the current selection. .. rst-class:: classref-method -|void| **select_all**\ (\ ) +|void| **select_all**\ (\ ) :ref:`🔗` Select all the text. @@ -1885,7 +1885,7 @@ If :ref:`selection_enabled` is ` .. rst-class:: classref-method -|void| **set_cell_border_color**\ (\ color\: :ref:`Color`\ ) +|void| **set_cell_border_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Sets color of a table cell border. @@ -1897,7 +1897,7 @@ Sets color of a table cell border. .. rst-class:: classref-method -|void| **set_cell_padding**\ (\ padding\: :ref:`Rect2`\ ) +|void| **set_cell_padding**\ (\ padding\: :ref:`Rect2`\ ) :ref:`🔗` Sets inner padding of a table cell. @@ -1909,7 +1909,7 @@ Sets inner padding of a table cell. .. rst-class:: classref-method -|void| **set_cell_row_background_color**\ (\ odd_row_bg\: :ref:`Color`, even_row_bg\: :ref:`Color`\ ) +|void| **set_cell_row_background_color**\ (\ odd_row_bg\: :ref:`Color`, even_row_bg\: :ref:`Color`\ ) :ref:`🔗` Sets color of a table cell. Separate colors for alternating rows can be specified. @@ -1921,7 +1921,7 @@ Sets color of a table cell. Separate colors for alternating rows can be specifie .. rst-class:: classref-method -|void| **set_cell_size_override**\ (\ min_size\: :ref:`Vector2`, max_size\: :ref:`Vector2`\ ) +|void| **set_cell_size_override**\ (\ min_size\: :ref:`Vector2`, max_size\: :ref:`Vector2`\ ) :ref:`🔗` Sets minimum and maximum size overrides for a table cell. @@ -1933,7 +1933,7 @@ Sets minimum and maximum size overrides for a table cell. .. rst-class:: classref-method -|void| **set_table_column_expand**\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1\ ) +|void| **set_table_column_expand**\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1\ ) :ref:`🔗` Edits the selected column's expansion options. If ``expand`` is ``true``, the column expands in proportion to its expansion ratio versus the other columns' ratios. @@ -1949,7 +1949,7 @@ If ``expand`` is ``false``, the column will not contribute to the total ratio. .. rst-class:: classref-method -|void| **update_image**\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) +|void| **update_image**\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` Updates the existing images with the key ``key``. Only properties specified by ``mask`` bits are updated. See :ref:`add_image`. @@ -1966,7 +1966,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **default_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **default_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` The default text color. @@ -1978,7 +1978,7 @@ The default text color. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The default tint of text outline. @@ -1990,7 +1990,7 @@ The default tint of text outline. .. rst-class:: classref-themeproperty -:ref:`Color` **font_selected_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **font_selected_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` The color of selected text, used when :ref:`selection_enabled` is ``true``. If equal to ``Color(0, 0, 0, 0)``, it will be ignored. @@ -2002,7 +2002,7 @@ The color of selected text, used when :ref:`selection_enabled` **font_shadow_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **font_shadow_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` The color of the font's shadow. @@ -2014,7 +2014,7 @@ The color of the font's shadow. .. rst-class:: classref-themeproperty -:ref:`Color` **selection_color** = ``Color(0.1, 0.1, 1, 0.8)`` +:ref:`Color` **selection_color** = ``Color(0.1, 0.1, 1, 0.8)`` :ref:`🔗` The color of the selection box. @@ -2026,7 +2026,7 @@ The color of the selection box. .. rst-class:: classref-themeproperty -:ref:`Color` **table_border** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **table_border** = ``Color(0, 0, 0, 0)`` :ref:`🔗` The default cell border color. @@ -2038,7 +2038,7 @@ The default cell border color. .. rst-class:: classref-themeproperty -:ref:`Color` **table_even_row_bg** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **table_even_row_bg** = ``Color(0, 0, 0, 0)`` :ref:`🔗` The default background color for even rows. @@ -2050,7 +2050,7 @@ The default background color for even rows. .. rst-class:: classref-themeproperty -:ref:`Color` **table_odd_row_bg** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **table_odd_row_bg** = ``Color(0, 0, 0, 0)`` :ref:`🔗` The default background color for odd rows. @@ -2062,7 +2062,7 @@ The default background color for odd rows. .. rst-class:: classref-themeproperty -:ref:`int` **line_separation** = ``0`` +:ref:`int` **line_separation** = ``0`` :ref:`🔗` The vertical space between lines. @@ -2074,7 +2074,7 @@ The vertical space between lines. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -2088,7 +2088,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`int` **shadow_offset_x** = ``1`` +:ref:`int` **shadow_offset_x** = ``1`` :ref:`🔗` The horizontal offset of the font's shadow. @@ -2100,7 +2100,7 @@ The horizontal offset of the font's shadow. .. rst-class:: classref-themeproperty -:ref:`int` **shadow_offset_y** = ``1`` +:ref:`int` **shadow_offset_y** = ``1`` :ref:`🔗` The vertical offset of the font's shadow. @@ -2112,7 +2112,7 @@ The vertical offset of the font's shadow. .. rst-class:: classref-themeproperty -:ref:`int` **shadow_outline_size** = ``1`` +:ref:`int` **shadow_outline_size** = ``1`` :ref:`🔗` The size of the shadow outline. @@ -2124,7 +2124,7 @@ The size of the shadow outline. .. rst-class:: classref-themeproperty -:ref:`int` **table_h_separation** = ``3`` +:ref:`int` **table_h_separation** = ``3`` :ref:`🔗` The horizontal separation of elements in a table. @@ -2136,7 +2136,7 @@ The horizontal separation of elements in a table. .. rst-class:: classref-themeproperty -:ref:`int` **table_v_separation** = ``3`` +:ref:`int` **table_v_separation** = ``3`` :ref:`🔗` The vertical separation of elements in a table. @@ -2148,7 +2148,7 @@ The vertical separation of elements in a table. .. rst-class:: classref-themeproperty -:ref:`int` **text_highlight_h_padding** = ``3`` +:ref:`int` **text_highlight_h_padding** = ``3`` :ref:`🔗` The horizontal padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. @@ -2160,7 +2160,7 @@ The horizontal padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` .. rst-class:: classref-themeproperty -:ref:`int` **text_highlight_v_padding** = ``3`` +:ref:`int` **text_highlight_v_padding** = ``3`` :ref:`🔗` The vertical padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. @@ -2172,7 +2172,7 @@ The vertical padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` t .. rst-class:: classref-themeproperty -:ref:`Font` **bold_font** +:ref:`Font` **bold_font** :ref:`🔗` The font used for bold text. @@ -2184,7 +2184,7 @@ The font used for bold text. .. rst-class:: classref-themeproperty -:ref:`Font` **bold_italics_font** +:ref:`Font` **bold_italics_font** :ref:`🔗` The font used for bold italics text. @@ -2196,7 +2196,7 @@ The font used for bold italics text. .. rst-class:: classref-themeproperty -:ref:`Font` **italics_font** +:ref:`Font` **italics_font** :ref:`🔗` The font used for italics text. @@ -2208,7 +2208,7 @@ The font used for italics text. .. rst-class:: classref-themeproperty -:ref:`Font` **mono_font** +:ref:`Font` **mono_font** :ref:`🔗` The font used for monospace text. @@ -2220,7 +2220,7 @@ The font used for monospace text. .. rst-class:: classref-themeproperty -:ref:`Font` **normal_font** +:ref:`Font` **normal_font** :ref:`🔗` The default text font. @@ -2232,7 +2232,7 @@ The default text font. .. rst-class:: classref-themeproperty -:ref:`int` **bold_font_size** +:ref:`int` **bold_font_size** :ref:`🔗` The font size used for bold text. @@ -2244,7 +2244,7 @@ The font size used for bold text. .. rst-class:: classref-themeproperty -:ref:`int` **bold_italics_font_size** +:ref:`int` **bold_italics_font_size** :ref:`🔗` The font size used for bold italics text. @@ -2256,7 +2256,7 @@ The font size used for bold italics text. .. rst-class:: classref-themeproperty -:ref:`int` **italics_font_size** +:ref:`int` **italics_font_size** :ref:`🔗` The font size used for italics text. @@ -2268,7 +2268,7 @@ The font size used for italics text. .. rst-class:: classref-themeproperty -:ref:`int` **mono_font_size** +:ref:`int` **mono_font_size** :ref:`🔗` The font size used for monospace text. @@ -2280,7 +2280,7 @@ The font size used for monospace text. .. rst-class:: classref-themeproperty -:ref:`int` **normal_font_size** +:ref:`int` **normal_font_size** :ref:`🔗` The default text font size. @@ -2292,7 +2292,7 @@ The default text font size. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` The background used when the **RichTextLabel** is focused. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -2304,7 +2304,7 @@ The background used when the **RichTextLabel** is focused. The :ref:`focus` **normal** +:ref:`StyleBox` **normal** :ref:`🔗` The normal background for the **RichTextLabel**. diff --git a/classes/class_rid.rst b/classes/class_rid.rst index dd8faf39c2a..fa93b9bde11 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -88,7 +88,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`RID` **RID**\ (\ ) +:ref:`RID` **RID**\ (\ ) :ref:`🔗` Constructs an empty **RID** with the invalid ID ``0``. @@ -115,7 +115,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_id**\ (\ ) |const| +:ref:`int` **get_id**\ (\ ) |const| :ref:`🔗` Returns the ID of the referenced low-level resource. @@ -127,7 +127,7 @@ Returns the ID of the referenced low-level resource. .. rst-class:: classref-method -:ref:`bool` **is_valid**\ (\ ) |const| +:ref:`bool` **is_valid**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the **RID** is not ``0``. @@ -144,7 +144,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`RID`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the **RID**\ s are not equal. @@ -156,7 +156,7 @@ Returns ``true`` if the **RID**\ s are not equal. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`RID`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the **RID**'s ID is less than ``right``'s ID. @@ -168,7 +168,7 @@ Returns ``true`` if the **RID**'s ID is less than ``right``'s ID. .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`RID`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the **RID**'s ID is less than or equal to ``right``'s ID. @@ -180,7 +180,7 @@ Returns ``true`` if the **RID**'s ID is less than or equal to ``right``'s ID. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`RID`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if both **RID**\ s are equal, which means they both refer to the same low-level resource. @@ -192,7 +192,7 @@ Returns ``true`` if both **RID**\ s are equal, which means they both refer to th .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`RID`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the **RID**'s ID is greater than ``right``'s ID. @@ -204,7 +204,7 @@ Returns ``true`` if the **RID**'s ID is greater than ``right``'s ID. .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`RID`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if the **RID**'s ID is greater than or equal to ``right``'s ID. diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 39c48fbd291..a91d5910b12 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -145,7 +145,7 @@ Signals .. rst-class:: classref-signal -**body_entered**\ (\ body\: :ref:`Node`\ ) +**body_entered**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Emitted when a collision with another :ref:`PhysicsBody2D` or :ref:`TileMap` occurs. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -159,7 +159,7 @@ Emitted when a collision with another :ref:`PhysicsBody2D` .. rst-class:: classref-signal -**body_exited**\ (\ body\: :ref:`Node`\ ) +**body_exited**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Emitted when the collision with another :ref:`PhysicsBody2D` or :ref:`TileMap` ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -173,7 +173,7 @@ Emitted when the collision with another :ref:`PhysicsBody2D .. rst-class:: classref-signal -**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when one of this RigidBody2D's :ref:`Shape2D`\ s collides with another :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -193,7 +193,7 @@ Emitted when one of this RigidBody2D's :ref:`Shape2D`\ s collides .. rst-class:: classref-signal -**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when the collision between one of this RigidBody2D's :ref:`Shape2D`\ s and another :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -213,7 +213,7 @@ Emitted when the collision between one of this RigidBody2D's :ref:`Shape2D` Emitted when the physics engine changes the body's sleeping state. @@ -232,7 +232,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FreezeMode**: +enum **FreezeMode**: :ref:`🔗` .. _class_RigidBody2D_constant_FREEZE_MODE_STATIC: @@ -258,7 +258,7 @@ Kinematic body freeze mode. Similar to :ref:`FREEZE_MODE_STATIC` .. _class_RigidBody2D_constant_CENTER_OF_MASS_MODE_AUTO: @@ -284,7 +284,7 @@ In this mode, the body's center of mass is set through :ref:`center_of_mass` .. _class_RigidBody2D_constant_DAMP_MODE_COMBINE: @@ -310,7 +310,7 @@ In this mode, the body's damping value replaces any value set in areas or the de .. rst-class:: classref-enumeration -enum **CCDMode**: +enum **CCDMode**: :ref:`🔗` .. _class_RigidBody2D_constant_CCD_MODE_DISABLED: @@ -349,7 +349,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_damp** = ``0.0`` +:ref:`float` **angular_damp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -368,7 +368,7 @@ See :ref:`ProjectSettings.physics/2d/default_angular_damp` **angular_damp_mode** = ``0`` +:ref:`DampMode` **angular_damp_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -385,7 +385,7 @@ Defines how :ref:`angular_damp` is appl .. rst-class:: classref-property -:ref:`float` **angular_velocity** = ``0.0`` +:ref:`float` **angular_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -402,7 +402,7 @@ The body's rotational velocity in *radians* per second. .. rst-class:: classref-property -:ref:`bool` **can_sleep** = ``true`` +:ref:`bool` **can_sleep** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -419,7 +419,7 @@ If ``true``, the body can enter sleep mode when there is no movement. See :ref:` .. rst-class:: classref-property -:ref:`Vector2` **center_of_mass** = ``Vector2(0, 0)`` +:ref:`Vector2` **center_of_mass** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -438,7 +438,7 @@ When :ref:`center_of_mass_mode` .. rst-class:: classref-property -:ref:`CenterOfMassMode` **center_of_mass_mode** = ``0`` +:ref:`CenterOfMassMode` **center_of_mass_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -455,7 +455,7 @@ Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode` **constant_force** = ``Vector2(0, 0)`` +:ref:`Vector2` **constant_force** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -474,7 +474,7 @@ See :ref:`add_constant_force` and : .. rst-class:: classref-property -:ref:`float` **constant_torque** = ``0.0`` +:ref:`float` **constant_torque** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -493,7 +493,7 @@ See :ref:`add_constant_torque`. .. rst-class:: classref-property -:ref:`bool` **contact_monitor** = ``false`` +:ref:`bool` **contact_monitor** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -512,7 +512,7 @@ If ``true``, the RigidBody2D will emit signals when it collides with another bod .. rst-class:: classref-property -:ref:`CCDMode` **continuous_cd** = ``0`` +:ref:`CCDMode` **continuous_cd** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -531,7 +531,7 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-property -:ref:`bool` **custom_integrator** = ``false`` +:ref:`bool` **custom_integrator** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -550,7 +550,7 @@ Setting this property will call the method :ref:`PhysicsServer2D.body_set_omit_f .. rst-class:: classref-property -:ref:`bool` **freeze** = ``false`` +:ref:`bool` **freeze** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -571,7 +571,7 @@ For a body that is always frozen, use :ref:`StaticBody2D` or .. rst-class:: classref-property -:ref:`FreezeMode` **freeze_mode** = ``0`` +:ref:`FreezeMode` **freeze_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -590,7 +590,7 @@ For a body that is always frozen, use :ref:`StaticBody2D` or .. rst-class:: classref-property -:ref:`float` **gravity_scale** = ``1.0`` +:ref:`float` **gravity_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -607,7 +607,7 @@ Multiplies the gravity applied to the body. The body's gravity is calculated fro .. rst-class:: classref-property -:ref:`float` **inertia** = ``0.0`` +:ref:`float` **inertia** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -654,7 +654,7 @@ If set to ``0``, inertia is automatically computed (default value). .. rst-class:: classref-property -:ref:`float` **linear_damp** = ``0.0`` +:ref:`float` **linear_damp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -673,7 +673,7 @@ See :ref:`ProjectSettings.physics/2d/default_linear_damp` **linear_damp_mode** = ``0`` +:ref:`DampMode` **linear_damp_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -690,7 +690,7 @@ Defines how :ref:`linear_damp` is applie .. rst-class:: classref-property -:ref:`Vector2` **linear_velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **linear_velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -707,7 +707,7 @@ The body's linear velocity in pixels per second. Can be used sporadically, but * .. rst-class:: classref-property -:ref:`bool` **lock_rotation** = ``false`` +:ref:`bool` **lock_rotation** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -724,7 +724,7 @@ If ``true``, the body cannot rotate. Gravity and forces only apply linear moveme .. rst-class:: classref-property -:ref:`float` **mass** = ``1.0`` +:ref:`float` **mass** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -741,7 +741,7 @@ The body's mass. .. rst-class:: classref-property -:ref:`int` **max_contacts_reported** = ``0`` +:ref:`int` **max_contacts_reported** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -760,7 +760,7 @@ The maximum number of contacts that will be recorded. Requires a value greater t .. rst-class:: classref-property -:ref:`PhysicsMaterial` **physics_material_override** +:ref:`PhysicsMaterial` **physics_material_override** :ref:`🔗` .. rst-class:: classref-property-setget @@ -779,7 +779,7 @@ If a material is assigned to this property, it will be used instead of any other .. rst-class:: classref-property -:ref:`bool` **sleeping** = ``false`` +:ref:`bool` **sleeping** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -801,7 +801,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState2D`\ ) |virtual| +|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState2D`\ ) |virtual| :ref:`🔗` Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it is called before the standard force integration, but the :ref:`custom_integrator` property allows you to disable the standard force integration and do fully custom force integration for a body. @@ -813,7 +813,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -|void| **add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) :ref:`🔗` Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -827,7 +827,7 @@ This is equivalent to using :ref:`add_constant_force`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -841,7 +841,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -|void| **add_constant_torque**\ (\ torque\: :ref:`float`\ ) +|void| **add_constant_torque**\ (\ torque\: :ref:`float`\ ) :ref:`🔗` Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = 0``. @@ -853,7 +853,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -|void| **apply_central_force**\ (\ force\: :ref:`Vector2`\ ) +|void| **apply_central_force**\ (\ force\: :ref:`Vector2`\ ) :ref:`🔗` Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -867,7 +867,7 @@ This is equivalent to using :ref:`apply_force` = Vector2(0, 0)\ ) +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a directional impulse without affecting rotation. @@ -883,7 +883,7 @@ This is equivalent to using :ref:`apply_impulse`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -897,7 +897,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -|void| **apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Applies a positioned impulse to the body. @@ -913,7 +913,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **apply_torque**\ (\ torque\: :ref:`float`\ ) +|void| **apply_torque**\ (\ torque\: :ref:`float`\ ) :ref:`🔗` Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -927,7 +927,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -|void| **apply_torque_impulse**\ (\ torque\: :ref:`float`\ ) +|void| **apply_torque_impulse**\ (\ torque\: :ref:`float`\ ) :ref:`🔗` Applies a rotational impulse to the body without affecting the position. @@ -943,7 +943,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node2D`\] **get_colliding_bodies**\ (\ ) |const| +:ref:`Array`\[:ref:`Node2D`\] **get_colliding_bodies**\ (\ ) |const| :ref:`🔗` Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. @@ -957,7 +957,7 @@ Returns a list of the bodies colliding with this one. Requires :ref:`contact_mon .. rst-class:: classref-method -:ref:`int` **get_contact_count**\ (\ ) |const| +:ref:`int` **get_contact_count**\ (\ ) |const| :ref:`🔗` Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see :ref:`contact_monitor`). @@ -971,7 +971,7 @@ Returns the number of contacts this body has with other bodies. By default, this .. rst-class:: classref-method -|void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector2`\ ) +|void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector2`\ ) :ref:`🔗` Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index 44086f6b96b..0c03ed9ba42 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -149,7 +149,7 @@ Signals .. rst-class:: classref-signal -**body_entered**\ (\ body\: :ref:`Node`\ ) +**body_entered**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Emitted when a collision with another :ref:`PhysicsBody3D` or :ref:`GridMap` occurs. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -163,7 +163,7 @@ Emitted when a collision with another :ref:`PhysicsBody3D` .. rst-class:: classref-signal -**body_exited**\ (\ body\: :ref:`Node`\ ) +**body_exited**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Emitted when the collision with another :ref:`PhysicsBody3D` or :ref:`GridMap` ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -177,7 +177,7 @@ Emitted when the collision with another :ref:`PhysicsBody3D .. rst-class:: classref-signal -**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when one of this RigidBody3D's :ref:`Shape3D`\ s collides with another :ref:`PhysicsBody3D` or :ref:`GridMap`'s :ref:`Shape3D`\ s. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -197,7 +197,7 @@ Emitted when one of this RigidBody3D's :ref:`Shape3D`\ s collides .. rst-class:: classref-signal -**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) :ref:`🔗` Emitted when the collision between one of this RigidBody3D's :ref:`Shape3D`\ s and another :ref:`PhysicsBody3D` or :ref:`GridMap`'s :ref:`Shape3D`\ s ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -217,7 +217,7 @@ Emitted when the collision between one of this RigidBody3D's :ref:`Shape3D` Emitted when the physics engine changes the body's sleeping state. @@ -236,7 +236,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FreezeMode**: +enum **FreezeMode**: :ref:`🔗` .. _class_RigidBody3D_constant_FREEZE_MODE_STATIC: @@ -262,7 +262,7 @@ Kinematic body freeze mode. Similar to :ref:`FREEZE_MODE_STATIC` .. _class_RigidBody3D_constant_CENTER_OF_MASS_MODE_AUTO: @@ -288,7 +288,7 @@ In this mode, the body's center of mass is set through :ref:`center_of_mass` .. _class_RigidBody3D_constant_DAMP_MODE_COMBINE: @@ -319,7 +319,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_damp** = ``0.0`` +:ref:`float` **angular_damp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -338,7 +338,7 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` **angular_damp_mode** = ``0`` +:ref:`DampMode` **angular_damp_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -355,7 +355,7 @@ Defines how :ref:`angular_damp` is appl .. rst-class:: classref-property -:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -372,7 +372,7 @@ The RigidBody3D's rotational velocity in *radians* per second. .. rst-class:: classref-property -:ref:`bool` **can_sleep** = ``true`` +:ref:`bool` **can_sleep** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -389,7 +389,7 @@ If ``true``, the body can enter sleep mode when there is no movement. See :ref:` .. rst-class:: classref-property -:ref:`Vector3` **center_of_mass** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **center_of_mass** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -408,7 +408,7 @@ When :ref:`center_of_mass_mode` .. rst-class:: classref-property -:ref:`CenterOfMassMode` **center_of_mass_mode** = ``0`` +:ref:`CenterOfMassMode` **center_of_mass_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -425,7 +425,7 @@ Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode` **constant_force** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **constant_force** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -444,7 +444,7 @@ See :ref:`add_constant_force` and : .. rst-class:: classref-property -:ref:`Vector3` **constant_torque** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **constant_torque** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -463,7 +463,7 @@ See :ref:`add_constant_torque`. .. rst-class:: classref-property -:ref:`bool` **contact_monitor** = ``false`` +:ref:`bool` **contact_monitor** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -482,7 +482,7 @@ If ``true``, the RigidBody3D will emit signals when it collides with another bod .. rst-class:: classref-property -:ref:`bool` **continuous_cd** = ``false`` +:ref:`bool` **continuous_cd** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -501,7 +501,7 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-property -:ref:`bool` **custom_integrator** = ``false`` +:ref:`bool` **custom_integrator** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -520,7 +520,7 @@ Setting this property will call the method :ref:`PhysicsServer3D.body_set_omit_f .. rst-class:: classref-property -:ref:`bool` **freeze** = ``false`` +:ref:`bool` **freeze** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -541,7 +541,7 @@ For a body that is always frozen, use :ref:`StaticBody3D` or .. rst-class:: classref-property -:ref:`FreezeMode` **freeze_mode** = ``0`` +:ref:`FreezeMode` **freeze_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -560,7 +560,7 @@ For a body that is always frozen, use :ref:`StaticBody3D` or .. rst-class:: classref-property -:ref:`float` **gravity_scale** = ``1.0`` +:ref:`float` **gravity_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -577,7 +577,7 @@ This is multiplied by the global 3D gravity setting found in **Project > Project .. rst-class:: classref-property -:ref:`Vector3` **inertia** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **inertia** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -624,7 +624,7 @@ If set to :ref:`Vector3.ZERO`, inertia is automatic .. rst-class:: classref-property -:ref:`float` **linear_damp** = ``0.0`` +:ref:`float` **linear_damp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -643,7 +643,7 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` **linear_damp_mode** = ``0`` +:ref:`DampMode` **linear_damp_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -660,7 +660,7 @@ Defines how :ref:`linear_damp` is applie .. rst-class:: classref-property -:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -677,7 +677,7 @@ The body's linear velocity in units per second. Can be used sporadically, but ** .. rst-class:: classref-property -:ref:`bool` **lock_rotation** = ``false`` +:ref:`bool` **lock_rotation** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -694,7 +694,7 @@ If ``true``, the body cannot rotate. Gravity and forces only apply linear moveme .. rst-class:: classref-property -:ref:`float` **mass** = ``1.0`` +:ref:`float` **mass** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -711,7 +711,7 @@ The body's mass. .. rst-class:: classref-property -:ref:`int` **max_contacts_reported** = ``0`` +:ref:`int` **max_contacts_reported** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -730,7 +730,7 @@ The maximum number of contacts that will be recorded. Requires a value greater t .. rst-class:: classref-property -:ref:`PhysicsMaterial` **physics_material_override** +:ref:`PhysicsMaterial` **physics_material_override** :ref:`🔗` .. rst-class:: classref-property-setget @@ -749,7 +749,7 @@ If a material is assigned to this property, it will be used instead of any other .. rst-class:: classref-property -:ref:`bool` **sleeping** = ``false`` +:ref:`bool` **sleeping** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -771,7 +771,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| +|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| :ref:`🔗` Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it is called before the standard force integration, but the :ref:`custom_integrator` property allows you to disable the standard force integration and do fully custom force integration for a body. @@ -783,7 +783,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) :ref:`🔗` Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -797,7 +797,7 @@ This is equivalent to using :ref:`add_constant_force`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -811,7 +811,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) +|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) :ref:`🔗` Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``. @@ -823,7 +823,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -|void| **apply_central_force**\ (\ force\: :ref:`Vector3`\ ) +|void| **apply_central_force**\ (\ force\: :ref:`Vector3`\ ) :ref:`🔗` Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -837,7 +837,7 @@ This is equivalent to using :ref:`apply_force`\ ) +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) :ref:`🔗` Applies a directional impulse without affecting rotation. @@ -853,7 +853,7 @@ This is equivalent to using :ref:`apply_impulse`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -867,7 +867,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) :ref:`🔗` Applies a positioned impulse to the body. @@ -883,7 +883,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -|void| **apply_torque**\ (\ torque\: :ref:`Vector3`\ ) +|void| **apply_torque**\ (\ torque\: :ref:`Vector3`\ ) :ref:`🔗` Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -897,7 +897,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) +|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) :ref:`🔗` Applies a rotational impulse to the body without affecting the position. @@ -913,7 +913,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node3D`\] **get_colliding_bodies**\ (\ ) |const| +:ref:`Array`\[:ref:`Node3D`\] **get_colliding_bodies**\ (\ ) |const| :ref:`🔗` Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. @@ -927,7 +927,7 @@ Returns a list of the bodies colliding with this one. Requires :ref:`contact_mon .. rst-class:: classref-method -:ref:`int` **get_contact_count**\ (\ ) |const| +:ref:`int` **get_contact_count**\ (\ ) |const| :ref:`🔗` Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see :ref:`contact_monitor`). @@ -941,7 +941,7 @@ Returns the number of contacts this body has with other bodies. By default, this .. rst-class:: classref-method -:ref:`Basis` **get_inverse_inertia_tensor**\ (\ ) |const| +:ref:`Basis` **get_inverse_inertia_tensor**\ (\ ) |const| :ref:`🔗` Returns the inverse inertia tensor basis. This is used to calculate the angular acceleration resulting from a torque applied to the **RigidBody3D**. @@ -953,7 +953,7 @@ Returns the inverse inertia tensor basis. This is used to calculate the angular .. rst-class:: classref-method -|void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector3`\ ) +|void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index c7fd8514203..142f7643c55 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **animation_path** = ``NodePath("")`` +:ref:`NodePath` **animation_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ Path to an :ref:`AnimationMixer` node to use as a basis fo .. rst-class:: classref-property -:ref:`float` **cell_size** = ``1.0`` +:ref:`float` **cell_size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ The grid's cell size in 3D units. .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(0.5, 0.5, 1, 1)`` +:ref:`Color` **color** = ``Color(0.5, 0.5, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ The grid's color. .. rst-class:: classref-property -:ref:`float` **radius** = ``10.0`` +:ref:`float` **radius** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ The grid's radius in 3D units. The grid's opacity will fade gradually as the dis .. rst-class:: classref-property -:ref:`bool` **zero_y** = ``true`` +:ref:`bool` **zero_y** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_scenemultiplayer.rst b/classes/class_scenemultiplayer.rst index d4da6438304..385ea6b4d3f 100644 --- a/classes/class_scenemultiplayer.rst +++ b/classes/class_scenemultiplayer.rst @@ -90,7 +90,7 @@ Signals .. rst-class:: classref-signal -**peer_authenticating**\ (\ id\: :ref:`int`\ ) +**peer_authenticating**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` connects to a new peer and a valid :ref:`auth_callback` is set. In this case, the :ref:`MultiplayerAPI.peer_connected` will not be emitted until :ref:`complete_auth` is called with given peer ``id``. While in this state, the peer will not be included in the list returned by :ref:`MultiplayerAPI.get_peers` (but in the one returned by :ref:`get_authenticating_peers`), and only authentication data will be sent or received. See :ref:`send_auth` for sending authentication data. @@ -102,7 +102,7 @@ Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer`\ ) +**peer_authentication_failed**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` disconnects from a peer for which authentication had not yet completed. See :ref:`peer_authenticating`. @@ -114,7 +114,7 @@ Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer`, packet\: :ref:`PackedByteArray`\ ) +**peer_packet**\ (\ id\: :ref:`int`, packet\: :ref:`PackedByteArray`\ ) :ref:`🔗` Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` receives a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. @@ -131,7 +131,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_object_decoding** = ``false`` +:ref:`bool` **allow_object_decoding** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ If ``true``, the MultiplayerAPI will allow encoding and decoding of object durin .. rst-class:: classref-property -:ref:`Callable` **auth_callback** = ``Callable()`` +:ref:`Callable` **auth_callback** = ``Callable()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ The callback to execute when when receiving authentication data sent via :ref:`s .. rst-class:: classref-property -:ref:`float` **auth_timeout** = ``3.0`` +:ref:`float` **auth_timeout** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ If set to a value greater than ``0.0``, the maximum amount of time peers can sta .. rst-class:: classref-property -:ref:`int` **max_delta_packet_size** = ``65535`` +:ref:`int` **max_delta_packet_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ Maximum size of each delta packet. Higher values increase the chance of receivin .. rst-class:: classref-property -:ref:`int` **max_sync_packet_size** = ``1350`` +:ref:`int` **max_sync_packet_size** = ``1350`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Maximum size of each synchronization packet. Higher values increase the chance o .. rst-class:: classref-property -:ref:`bool` **refuse_new_connections** = ``false`` +:ref:`bool` **refuse_new_connections** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -235,7 +235,7 @@ If ``true``, the MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` **root_path** = ``NodePath("")`` +:ref:`NodePath` **root_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ This effectively allows to have different branches of the scene tree to be manag .. rst-class:: classref-property -:ref:`bool` **server_relay** = ``true`` +:ref:`bool` **server_relay** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -280,7 +280,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the current SceneMultiplayer network state (you shouldn't call this unless you know what you are doing). @@ -292,7 +292,7 @@ Clears the current SceneMultiplayer network state (you shouldn't call this unles .. rst-class:: classref-method -:ref:`Error` **complete_auth**\ (\ id\: :ref:`int`\ ) +:ref:`Error` **complete_auth**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Mark the authentication step as completed for the remote peer identified by ``id``. The :ref:`MultiplayerAPI.peer_connected` signal will be emitted for this peer once the remote side also completes the authentication. No further authentication messages are expected to be received from this peer. @@ -306,7 +306,7 @@ If a peer disconnects before completing authentication, either due to a network .. rst-class:: classref-method -|void| **disconnect_peer**\ (\ id\: :ref:`int`\ ) +|void| **disconnect_peer**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Disconnects the peer identified by ``id``, removing it from the list of connected peers, and closing the underlying connection with it. @@ -318,7 +318,7 @@ Disconnects the peer identified by ``id``, removing it from the list of connecte .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_authenticating_peers**\ (\ ) +:ref:`PackedInt32Array` **get_authenticating_peers**\ (\ ) :ref:`🔗` Returns the IDs of the peers currently trying to authenticate with this :ref:`MultiplayerAPI`. @@ -330,7 +330,7 @@ Returns the IDs of the peers currently trying to authenticate with this :ref:`Mu .. rst-class:: classref-method -:ref:`Error` **send_auth**\ (\ id\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) +:ref:`Error` **send_auth**\ (\ id\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sends the specified ``data`` to the remote peer identified by ``id`` as part of an authentication message. This can be used to authenticate peers, and control when :ref:`MultiplayerAPI.peer_connected` is emitted (and the remote peer accepted as one of the connected peers). @@ -342,7 +342,7 @@ Sends the specified ``data`` to the remote peer identified by ``id`` as part of .. rst-class:: classref-method -:ref:`Error` **send_bytes**\ (\ bytes\: :ref:`PackedByteArray`, id\: :ref:`int` = 0, mode\: :ref:`TransferMode` = 2, channel\: :ref:`int` = 0\ ) +:ref:`Error` **send_bytes**\ (\ bytes\: :ref:`PackedByteArray`, id\: :ref:`int` = 0, mode\: :ref:`TransferMode` = 2, channel\: :ref:`int` = 0\ ) :ref:`🔗` Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`MultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. diff --git a/classes/class_scenereplicationconfig.rst b/classes/class_scenereplicationconfig.rst index 5fdf6153696..d5ea1b029ad 100644 --- a/classes/class_scenereplicationconfig.rst +++ b/classes/class_scenereplicationconfig.rst @@ -63,7 +63,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ReplicationMode**: +enum **ReplicationMode**: :ref:`🔗` .. _class_SceneReplicationConfig_constant_REPLICATION_MODE_NEVER: @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_property**\ (\ path\: :ref:`NodePath`, index\: :ref:`int` = -1\ ) +|void| **add_property**\ (\ path\: :ref:`NodePath`, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds the property identified by the given ``path`` to the list of the properties being synchronized, optionally passing an ``index``. @@ -116,7 +116,7 @@ Adds the property identified by the given ``path`` to the list of the properties .. rst-class:: classref-method -:ref:`Array`\[:ref:`NodePath`\] **get_properties**\ (\ ) |const| +:ref:`Array`\[:ref:`NodePath`\] **get_properties**\ (\ ) |const| :ref:`🔗` Returns a list of synchronized property :ref:`NodePath`\ s. @@ -128,7 +128,7 @@ Returns a list of synchronized property :ref:`NodePath`\ s. .. rst-class:: classref-method -:ref:`bool` **has_property**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`bool` **has_property**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``path`` is configured for synchronization. @@ -140,7 +140,7 @@ Returns ``true`` if the given ``path`` is configured for synchronization. .. rst-class:: classref-method -:ref:`int` **property_get_index**\ (\ path\: :ref:`NodePath`\ ) |const| +:ref:`int` **property_get_index**\ (\ path\: :ref:`NodePath`\ ) |const| :ref:`🔗` Finds the index of the given ``path``. @@ -152,7 +152,7 @@ Finds the index of the given ``path``. .. rst-class:: classref-method -:ref:`ReplicationMode` **property_get_replication_mode**\ (\ path\: :ref:`NodePath`\ ) +:ref:`ReplicationMode` **property_get_replication_mode**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` Returns the replication mode for the property identified by the given ``path``. See :ref:`ReplicationMode`. @@ -164,7 +164,7 @@ Returns the replication mode for the property identified by the given ``path``. .. rst-class:: classref-method -:ref:`bool` **property_get_spawn**\ (\ path\: :ref:`NodePath`\ ) +:ref:`bool` **property_get_spawn**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` Returns ``true`` if the property identified by the given ``path`` is configured to be synchronized on spawn. @@ -176,7 +176,7 @@ Returns ``true`` if the property identified by the given ``path`` is configured .. rst-class:: classref-method -:ref:`bool` **property_get_sync**\ (\ path\: :ref:`NodePath`\ ) +:ref:`bool` **property_get_sync**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` **Deprecated:** Use :ref:`property_get_replication_mode` instead. @@ -190,7 +190,7 @@ Returns ``true`` if the property identified by the given ``path`` is configured .. rst-class:: classref-method -:ref:`bool` **property_get_watch**\ (\ path\: :ref:`NodePath`\ ) +:ref:`bool` **property_get_watch**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` **Deprecated:** Use :ref:`property_get_replication_mode` instead. @@ -204,7 +204,7 @@ Returns ``true`` if the property identified by the given ``path`` is configured .. rst-class:: classref-method -|void| **property_set_replication_mode**\ (\ path\: :ref:`NodePath`, mode\: :ref:`ReplicationMode`\ ) +|void| **property_set_replication_mode**\ (\ path\: :ref:`NodePath`, mode\: :ref:`ReplicationMode`\ ) :ref:`🔗` Sets the synchronization mode for the property identified by the given ``path``. See :ref:`ReplicationMode`. @@ -216,7 +216,7 @@ Sets the synchronization mode for the property identified by the given ``path``. .. rst-class:: classref-method -|void| **property_set_spawn**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) +|void| **property_set_spawn**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets whether the property identified by the given ``path`` is configured to be synchronized on spawn. @@ -228,7 +228,7 @@ Sets whether the property identified by the given ``path`` is configured to be s .. rst-class:: classref-method -|void| **property_set_sync**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) +|void| **property_set_sync**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`property_set_replication_mode` with :ref:`REPLICATION_MODE_ALWAYS` instead. @@ -242,7 +242,7 @@ Sets whether the property identified by the given ``path`` is configured to be s .. rst-class:: classref-method -|void| **property_set_watch**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) +|void| **property_set_watch**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** Use :ref:`property_set_replication_mode` with :ref:`REPLICATION_MODE_ON_CHANGE` instead. @@ -256,7 +256,7 @@ Sets whether the property identified by the given ``path`` is configured to be r .. rst-class:: classref-method -|void| **remove_property**\ (\ path\: :ref:`NodePath`\ ) +|void| **remove_property**\ (\ path\: :ref:`NodePath`\ ) :ref:`🔗` Removes the property identified by the given ``path`` from the configuration. diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 2129af69218..469bee388f1 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -88,7 +88,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **GenEditState**: +enum **GenEditState**: :ref:`🔗` .. _class_SceneState_constant_GEN_EDIT_STATE_DISABLED: @@ -141,7 +141,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **get_connection_binds**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`Array` **get_connection_binds**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the list of bound parameters for the signal at ``idx``. @@ -153,7 +153,7 @@ Returns the list of bound parameters for the signal at ``idx``. .. rst-class:: classref-method -:ref:`int` **get_connection_count**\ (\ ) |const| +:ref:`int` **get_connection_count**\ (\ ) |const| :ref:`🔗` Returns the number of signal connections in the scene. @@ -167,7 +167,7 @@ The ``idx`` argument used to query connection metadata in other ``get_connection .. rst-class:: classref-method -:ref:`int` **get_connection_flags**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`int` **get_connection_flags**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` constants. @@ -179,7 +179,7 @@ Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` **get_connection_method**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_connection_method**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the method connected to the signal at ``idx``. @@ -191,7 +191,7 @@ Returns the method connected to the signal at ``idx``. .. rst-class:: classref-method -:ref:`StringName` **get_connection_signal**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_connection_signal**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the signal at ``idx``. @@ -203,7 +203,7 @@ Returns the name of the signal at ``idx``. .. rst-class:: classref-method -:ref:`NodePath` **get_connection_source**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_connection_source**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path to the node that owns the signal at ``idx``, relative to the root node. @@ -215,7 +215,7 @@ Returns the path to the node that owns the signal at ``idx``, relative to the ro .. rst-class:: classref-method -:ref:`NodePath` **get_connection_target**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_connection_target**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node. @@ -227,7 +227,7 @@ Returns the path to the node that owns the method connected to the signal at ``i .. rst-class:: classref-method -:ref:`int` **get_connection_unbinds**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`int` **get_connection_unbinds**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of unbound parameters for the signal at ``idx``. @@ -239,7 +239,7 @@ Returns the number of unbound parameters for the signal at ``idx``. .. rst-class:: classref-method -:ref:`int` **get_node_count**\ (\ ) |const| +:ref:`int` **get_node_count**\ (\ ) |const| :ref:`🔗` Returns the number of nodes in the scene. @@ -253,7 +253,7 @@ The ``idx`` argument used to query node data in other ``get_node_*`` methods in .. rst-class:: classref-method -:ref:`PackedStringArray` **get_node_groups**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedStringArray` **get_node_groups**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the list of group names associated with the node at ``idx``. @@ -265,7 +265,7 @@ Returns the list of group names associated with the node at ``idx``. .. rst-class:: classref-method -:ref:`int` **get_node_index**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`int` **get_node_index**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instantiated or inherited scene among siblings from the base scene. Despite the name, this index is not related to the ``idx`` argument used here and in other methods. @@ -277,7 +277,7 @@ Returns the node's index, which is its position relative to its siblings. This i .. rst-class:: classref-method -:ref:`PackedScene` **get_node_instance**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`PackedScene` **get_node_instance**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. the whole branch starting at this node, with its child nodes and resources), or ``null`` if the node is not an instance. @@ -289,7 +289,7 @@ Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. th .. rst-class:: classref-method -:ref:`String` **get_node_instance_placeholder**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_node_instance_placeholder**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. @@ -301,7 +301,7 @@ Returns the path to the represented scene file if the node at ``idx`` is an :ref .. rst-class:: classref-method -:ref:`StringName` **get_node_name**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_node_name**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the node at ``idx``. @@ -313,7 +313,7 @@ Returns the name of the node at ``idx``. .. rst-class:: classref-method -:ref:`NodePath` **get_node_owner_path**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_node_owner_path**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path to the owner of the node at ``idx``, relative to the root node. @@ -325,7 +325,7 @@ Returns the path to the owner of the node at ``idx``, relative to the root node. .. rst-class:: classref-method -:ref:`NodePath` **get_node_path**\ (\ idx\: :ref:`int`, for_parent\: :ref:`bool` = false\ ) |const| +:ref:`NodePath` **get_node_path**\ (\ idx\: :ref:`int`, for_parent\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the path to the node at ``idx``. @@ -339,7 +339,7 @@ If ``for_parent`` is ``true``, returns the path of the ``idx`` node's parent ins .. rst-class:: classref-method -:ref:`int` **get_node_property_count**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`int` **get_node_property_count**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of exported or overridden properties for the node at ``idx``. @@ -353,7 +353,7 @@ The ``prop_idx`` argument used to query node property data in other ``get_node_p .. rst-class:: classref-method -:ref:`StringName` **get_node_property_name**\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_node_property_name**\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the property at ``prop_idx`` for the node at ``idx``. @@ -365,7 +365,7 @@ Returns the name of the property at ``prop_idx`` for the node at ``idx``. .. rst-class:: classref-method -:ref:`Variant` **get_node_property_value**\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_node_property_value**\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of the property at ``prop_idx`` for the node at ``idx``. @@ -377,7 +377,7 @@ Returns the value of the property at ``prop_idx`` for the node at ``idx``. .. rst-class:: classref-method -:ref:`StringName` **get_node_type**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_node_type**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the type of the node at ``idx``. @@ -389,7 +389,7 @@ Returns the type of the node at ``idx``. .. rst-class:: classref-method -:ref:`bool` **is_node_instance_placeholder**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_node_instance_placeholder**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 0d916e6b10f..82e2d63d69c 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -135,7 +135,7 @@ Signals .. rst-class:: classref-signal -**node_added**\ (\ node\: :ref:`Node`\ ) +**node_added**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the ``node`` enters this tree. @@ -147,7 +147,7 @@ Emitted when the ``node`` enters this tree. .. rst-class:: classref-signal -**node_configuration_warning_changed**\ (\ node\: :ref:`Node`\ ) +**node_configuration_warning_changed**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the ``node``'s :ref:`Node.update_configuration_warnings` is called. Only emitted in the editor. @@ -159,7 +159,7 @@ Emitted when the ``node``'s :ref:`Node.update_configuration_warnings`\ ) +**node_removed**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the ``node`` exits this tree. @@ -171,7 +171,7 @@ Emitted when the ``node`` exits this tree. .. rst-class:: classref-signal -**node_renamed**\ (\ node\: :ref:`Node`\ ) +**node_renamed**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Emitted when the ``node``'s :ref:`Node.name` is changed. @@ -183,7 +183,7 @@ Emitted when the ``node``'s :ref:`Node.name` is change .. rst-class:: classref-signal -**physics_frame**\ (\ ) +**physics_frame**\ (\ ) :ref:`🔗` Emitted immediately before :ref:`Node._physics_process` is called on every node in this tree. @@ -195,7 +195,7 @@ Emitted immediately before :ref:`Node._physics_process` Emitted immediately before :ref:`Node._process` is called on every node in this tree. @@ -207,7 +207,7 @@ Emitted immediately before :ref:`Node._process` Emitted any time the tree's hierarchy changes (nodes being moved, renamed, etc.). @@ -219,7 +219,7 @@ Emitted any time the tree's hierarchy changes (nodes being moved, renamed, etc.) .. rst-class:: classref-signal -**tree_process_mode_changed**\ (\ ) +**tree_process_mode_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`Node.process_mode` of any node inside the tree is changed. Only emitted in the editor, to update the visibility of disabled nodes. @@ -236,7 +236,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **GroupCallFlags**: +enum **GroupCallFlags**: :ref:`🔗` .. _class_SceneTree_constant_GROUP_CALL_DEFAULT: @@ -285,7 +285,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **auto_accept_quit** = ``true`` +:ref:`bool` **auto_accept_quit** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ For mobile platforms, see :ref:`quit_on_go_back` **current_scene** +:ref:`Node` **current_scene** :ref:`🔗` .. rst-class:: classref-property-setget @@ -323,7 +323,7 @@ The root node of the currently loaded main scene, usually as a direct child of : .. rst-class:: classref-property -:ref:`bool` **debug_collisions_hint** = ``false`` +:ref:`bool` **debug_collisions_hint** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -342,7 +342,7 @@ If ``true``, collision shapes will be visible when running the game from the edi .. rst-class:: classref-property -:ref:`bool` **debug_navigation_hint** = ``false`` +:ref:`bool` **debug_navigation_hint** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -361,7 +361,7 @@ If ``true``, navigation polygons will be visible when running the game from the .. rst-class:: classref-property -:ref:`bool` **debug_paths_hint** = ``false`` +:ref:`bool` **debug_paths_hint** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -380,7 +380,7 @@ If ``true``, curves from :ref:`Path2D` and :ref:`Path3D` **edited_scene_root** +:ref:`Node` **edited_scene_root** :ref:`🔗` .. rst-class:: classref-property-setget @@ -399,7 +399,7 @@ The root of the scene currently being edited in the editor. This is usually a di .. rst-class:: classref-property -:ref:`bool` **multiplayer_poll** = ``true`` +:ref:`bool` **multiplayer_poll** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -418,7 +418,7 @@ If ``false``, you need to manually call :ref:`MultiplayerAPI.poll` **paused** = ``false`` +:ref:`bool` **paused** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -439,7 +439,7 @@ If ``true``, the scene tree is considered paused. This causes the following beha .. rst-class:: classref-property -:ref:`bool` **physics_interpolation** = ``false`` +:ref:`bool` **physics_interpolation** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -458,7 +458,7 @@ The default value of this property is controlled by :ref:`ProjectSettings.physic .. rst-class:: classref-property -:ref:`bool` **quit_on_go_back** = ``true`` +:ref:`bool` **quit_on_go_back** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -477,7 +477,7 @@ To handle 'Go Back' button when this option is disabled, use :ref:`DisplayServer .. rst-class:: classref-property -:ref:`Window` **root** +:ref:`Window` **root** :ref:`🔗` .. rst-class:: classref-property-setget @@ -500,7 +500,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **call_group**\ (\ group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| +|void| **call_group**\ (\ group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Calls ``method`` on each node inside this tree added to the given ``group``. You can pass arguments to ``method`` by specifying them at the end of this method call. Nodes that cannot call ``method`` (either because the method doesn't exist or the arguments do not match) are ignored. See also :ref:`set_group` and :ref:`notify_group`. @@ -516,7 +516,7 @@ Calls ``method`` on each node inside this tree added to the given ``group``. You .. rst-class:: classref-method -|void| **call_group_flags**\ (\ flags\: :ref:`int`, group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| +|void| **call_group_flags**\ (\ flags\: :ref:`int`, group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Calls the given ``method`` on each node inside this tree added to the given ``group``. Use ``flags`` to customize this method's behavior (see :ref:`GroupCallFlags`). Additional arguments for ``method`` can be passed at the end of this method. Nodes that cannot call ``method`` (either because the method doesn't exist or the arguments do not match) are ignored. @@ -537,7 +537,7 @@ Calls the given ``method`` on each node inside this tree added to the given ``gr .. rst-class:: classref-method -:ref:`Error` **change_scene_to_file**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **change_scene_to_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Changes the running scene to the one at the given ``path``, after loading it into a :ref:`PackedScene` and creating a new instance. @@ -553,7 +553,7 @@ Returns :ref:`@GlobalScope.OK` on success, :ref: .. rst-class:: classref-method -:ref:`Error` **change_scene_to_packed**\ (\ packed_scene\: :ref:`PackedScene`\ ) +:ref:`Error` **change_scene_to_packed**\ (\ packed_scene\: :ref:`PackedScene`\ ) :ref:`🔗` Changes the running scene to a new instance of the given :ref:`PackedScene` (which must be valid). @@ -575,7 +575,7 @@ This ensures that both scenes aren't running at the same time, while still freei .. rst-class:: classref-method -:ref:`SceneTreeTimer` **create_timer**\ (\ time_sec\: :ref:`float`, process_always\: :ref:`bool` = true, process_in_physics\: :ref:`bool` = false, ignore_time_scale\: :ref:`bool` = false\ ) +:ref:`SceneTreeTimer` **create_timer**\ (\ time_sec\: :ref:`float`, process_always\: :ref:`bool` = true, process_in_physics\: :ref:`bool` = false, ignore_time_scale\: :ref:`bool` = false\ ) :ref:`🔗` Returns a new :ref:`SceneTreeTimer`. After ``time_sec`` in seconds have passed, the timer will emit :ref:`SceneTreeTimer.timeout` and will be automatically freed. @@ -618,7 +618,7 @@ This method is commonly used to create a one-shot delay timer, as in the followi .. rst-class:: classref-method -:ref:`Tween` **create_tween**\ (\ ) +:ref:`Tween` **create_tween**\ (\ ) :ref:`🔗` Creates and returns a new :ref:`Tween` processed in this tree. The Tween will start automatically on the next process frame or physics frame (depending on its :ref:`TweenProcessMode`). @@ -632,7 +632,7 @@ Creates and returns a new :ref:`Tween` processed in this tree. The .. rst-class:: classref-method -:ref:`Node` **get_first_node_in_group**\ (\ group\: :ref:`StringName`\ ) +:ref:`Node` **get_first_node_in_group**\ (\ group\: :ref:`StringName`\ ) :ref:`🔗` Returns the first :ref:`Node` found inside the tree, that has been added to the given ``group``, in scene hierarchy order. Returns ``null`` if no match is found. See also :ref:`get_nodes_in_group`. @@ -644,7 +644,7 @@ Returns the first :ref:`Node` found inside the tree, that has been a .. rst-class:: classref-method -:ref:`int` **get_frame**\ (\ ) |const| +:ref:`int` **get_frame**\ (\ ) |const| :ref:`🔗` Returns how many frames have been processed, since the application started. This is *not* a measurement of elapsed time. @@ -656,7 +656,7 @@ Returns how many frames have been processed, since the application started. This .. rst-class:: classref-method -:ref:`MultiplayerAPI` **get_multiplayer**\ (\ for_path\: :ref:`NodePath` = NodePath("")\ ) |const| +:ref:`MultiplayerAPI` **get_multiplayer**\ (\ for_path\: :ref:`NodePath` = NodePath("")\ ) |const| :ref:`🔗` Searches for the :ref:`MultiplayerAPI` configured for the given path, if one does not exist it searches the parent paths until one is found. If the path is empty, or none is found, the default one is returned. See :ref:`set_multiplayer`. @@ -668,7 +668,7 @@ Searches for the :ref:`MultiplayerAPI` configured for the .. rst-class:: classref-method -:ref:`int` **get_node_count**\ (\ ) |const| +:ref:`int` **get_node_count**\ (\ ) |const| :ref:`🔗` Returns the number of nodes inside this tree. @@ -680,7 +680,7 @@ Returns the number of nodes inside this tree. .. rst-class:: classref-method -:ref:`int` **get_node_count_in_group**\ (\ group\: :ref:`StringName`\ ) |const| +:ref:`int` **get_node_count_in_group**\ (\ group\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the number of nodes assigned to the given group. @@ -692,7 +692,7 @@ Returns the number of nodes assigned to the given group. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Node`\] **get_nodes_in_group**\ (\ group\: :ref:`StringName`\ ) +:ref:`Array`\[:ref:`Node`\] **get_nodes_in_group**\ (\ group\: :ref:`StringName`\ ) :ref:`🔗` Returns an :ref:`Array` containing all nodes inside this tree, that have been added to the given ``group``, in scene hierarchy order. @@ -704,7 +704,7 @@ Returns an :ref:`Array` containing all nodes inside this tree, that .. rst-class:: classref-method -:ref:`Array`\[:ref:`Tween`\] **get_processed_tweens**\ (\ ) +:ref:`Array`\[:ref:`Tween`\] **get_processed_tweens**\ (\ ) :ref:`🔗` Returns an :ref:`Array` of currently existing :ref:`Tween`\ s in the tree, including paused tweens. @@ -716,7 +716,7 @@ Returns an :ref:`Array` of currently existing :ref:`Tween` **has_group**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_group**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a node added to the given group ``name`` exists in the tree. @@ -728,7 +728,7 @@ Returns ``true`` if a node added to the given group ``name`` exists in the tree. .. rst-class:: classref-method -|void| **notify_group**\ (\ group\: :ref:`StringName`, notification\: :ref:`int`\ ) +|void| **notify_group**\ (\ group\: :ref:`StringName`, notification\: :ref:`int`\ ) :ref:`🔗` Calls :ref:`Object.notification` with the given ``notification`` to all nodes inside this tree added to the ``group``. See also :ref:`call_group` and :ref:`set_group`. @@ -742,7 +742,7 @@ Calls :ref:`Object.notification` with the give .. rst-class:: classref-method -|void| **notify_group_flags**\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, notification\: :ref:`int`\ ) +|void| **notify_group_flags**\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, notification\: :ref:`int`\ ) :ref:`🔗` Calls :ref:`Object.notification` with the given ``notification`` to all nodes inside this tree added to the ``group``. Use ``call_flags`` to customize this method's behavior (see :ref:`GroupCallFlags`). @@ -754,7 +754,7 @@ Calls :ref:`Object.notification` with the give .. rst-class:: classref-method -|void| **queue_delete**\ (\ obj\: :ref:`Object`\ ) +|void| **queue_delete**\ (\ obj\: :ref:`Object`\ ) :ref:`🔗` Queues the given ``obj`` to be deleted, calling its :ref:`Object.free` at the end of the current frame. This method is similar to :ref:`Node.queue_free`. @@ -766,7 +766,7 @@ Queues the given ``obj`` to be deleted, calling its :ref:`Object.free` = 0\ ) +|void| **quit**\ (\ exit_code\: :ref:`int` = 0\ ) :ref:`🔗` Quits the application at the end of the current iteration, with the given ``exit_code``. @@ -782,7 +782,7 @@ By convention, an exit code of ``0`` indicates success, whereas any other exit c .. rst-class:: classref-method -:ref:`Error` **reload_current_scene**\ (\ ) +:ref:`Error` **reload_current_scene**\ (\ ) :ref:`🔗` Reloads the currently active scene, replacing :ref:`current_scene` with a new instance of its original :ref:`PackedScene`. @@ -796,7 +796,7 @@ Returns :ref:`@GlobalScope.OK` on success, :ref: .. rst-class:: classref-method -|void| **set_group**\ (\ group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_group**\ (\ group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the given ``property`` to ``value`` on all nodes inside this tree added to the given ``group``. Nodes that do not have the ``property`` are ignored. See also :ref:`call_group` and :ref:`notify_group`. @@ -812,7 +812,7 @@ Sets the given ``property`` to ``value`` on all nodes inside this tree added to .. rst-class:: classref-method -|void| **set_group_flags**\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_group_flags**\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the given ``property`` to ``value`` on all nodes inside this tree added to the given ``group``. Nodes that do not have the ``property`` are ignored. Use ``call_flags`` to customize this method's behavior (see :ref:`GroupCallFlags`). @@ -826,7 +826,7 @@ Sets the given ``property`` to ``value`` on all nodes inside this tree added to .. rst-class:: classref-method -|void| **set_multiplayer**\ (\ multiplayer\: :ref:`MultiplayerAPI`, root_path\: :ref:`NodePath` = NodePath("")\ ) +|void| **set_multiplayer**\ (\ multiplayer\: :ref:`MultiplayerAPI`, root_path\: :ref:`NodePath` = NodePath("")\ ) :ref:`🔗` Sets a custom :ref:`MultiplayerAPI` with the given ``root_path`` (controlling also the relative subpaths), or override the default one if ``root_path`` is empty. @@ -840,7 +840,7 @@ Sets a custom :ref:`MultiplayerAPI` with the given ``root_ .. rst-class:: classref-method -|void| **unload_current_scene**\ (\ ) +|void| **unload_current_scene**\ (\ ) :ref:`🔗` If a current scene is loaded, calling this method will unload it. diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 66bb1366387..356e38dc75a 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -73,7 +73,7 @@ Signals .. rst-class:: classref-signal -**timeout**\ (\ ) +**timeout**\ (\ ) :ref:`🔗` Emitted when the timer reaches 0. @@ -90,7 +90,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **time_left** +:ref:`float` **time_left** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_script.rst b/classes/class_script.rst index e6ce12aa4ca..e65cc33bc26 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -99,7 +99,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **source_code** +:ref:`String` **source_code** :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_instantiate**\ (\ ) |const| +:ref:`bool` **can_instantiate**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script can be instantiated. @@ -133,7 +133,7 @@ Returns ``true`` if the script can be instantiated. .. rst-class:: classref-method -:ref:`Script` **get_base_script**\ (\ ) |const| +:ref:`Script` **get_base_script**\ (\ ) |const| :ref:`🔗` Returns the script directly inherited by this script. @@ -145,7 +145,7 @@ Returns the script directly inherited by this script. .. rst-class:: classref-method -:ref:`StringName` **get_global_name**\ (\ ) |const| +:ref:`StringName` **get_global_name**\ (\ ) |const| :ref:`🔗` Returns the class name associated with the script, if there is one. Returns an empty string otherwise. @@ -178,7 +178,7 @@ To give the script a global name, you can use the ``class_name`` keyword in GDSc .. rst-class:: classref-method -:ref:`StringName` **get_instance_base_type**\ (\ ) |const| +:ref:`StringName` **get_instance_base_type**\ (\ ) |const| :ref:`🔗` Returns the script's base type. @@ -190,7 +190,7 @@ Returns the script's base type. .. rst-class:: classref-method -:ref:`Variant` **get_property_default_value**\ (\ property\: :ref:`StringName`\ ) +:ref:`Variant` **get_property_default_value**\ (\ property\: :ref:`StringName`\ ) :ref:`🔗` Returns the default value of the specified property. @@ -202,7 +202,7 @@ Returns the default value of the specified property. .. rst-class:: classref-method -:ref:`Dictionary` **get_script_constant_map**\ (\ ) +:ref:`Dictionary` **get_script_constant_map**\ (\ ) :ref:`🔗` Returns a dictionary containing constant names and their values. @@ -214,7 +214,7 @@ Returns a dictionary containing constant names and their values. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_script_method_list**\ (\ ) +:ref:`Array`\[:ref:`Dictionary`\] **get_script_method_list**\ (\ ) :ref:`🔗` Returns the list of methods in this **Script**. @@ -226,7 +226,7 @@ Returns the list of methods in this **Script**. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_script_property_list**\ (\ ) +:ref:`Array`\[:ref:`Dictionary`\] **get_script_property_list**\ (\ ) :ref:`🔗` Returns the list of properties in this **Script**. @@ -238,7 +238,7 @@ Returns the list of properties in this **Script**. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_script_signal_list**\ (\ ) +:ref:`Array`\[:ref:`Dictionary`\] **get_script_signal_list**\ (\ ) :ref:`🔗` Returns the list of user signals defined in this **Script**. @@ -250,7 +250,7 @@ Returns the list of user signals defined in this **Script**. .. rst-class:: classref-method -:ref:`bool` **has_script_signal**\ (\ signal_name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_script_signal**\ (\ signal_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the script, or a base class, defines a signal with the given name. @@ -262,7 +262,7 @@ Returns ``true`` if the script, or a base class, defines a signal with the given .. rst-class:: classref-method -:ref:`bool` **has_source_code**\ (\ ) |const| +:ref:`bool` **has_source_code**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script contains non-empty source code. @@ -274,7 +274,7 @@ Returns ``true`` if the script contains non-empty source code. .. rst-class:: classref-method -:ref:`bool` **instance_has**\ (\ base_object\: :ref:`Object`\ ) |const| +:ref:`bool` **instance_has**\ (\ base_object\: :ref:`Object`\ ) |const| :ref:`🔗` Returns ``true`` if ``base_object`` is an instance of this script. @@ -286,7 +286,7 @@ Returns ``true`` if ``base_object`` is an instance of this script. .. rst-class:: classref-method -:ref:`bool` **is_abstract**\ (\ ) |const| +:ref:`bool` **is_abstract**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. @@ -298,7 +298,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **is_tool**\ (\ ) |const| +:ref:`bool` **is_tool**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script is a tool script. A tool script can run in the editor. @@ -310,7 +310,7 @@ Returns ``true`` if the script is a tool script. A tool script can run in the ed .. rst-class:: classref-method -:ref:`Error` **reload**\ (\ keep_state\: :ref:`bool` = false\ ) +:ref:`Error` **reload**\ (\ keep_state\: :ref:`bool` = false\ ) :ref:`🔗` Reloads the script's class implementation. Returns an error code. diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index 8fe7f9ae84a..fb1a0e45e84 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -85,7 +85,7 @@ Signals .. rst-class:: classref-signal -**script_created**\ (\ script\: :ref:`Script`\ ) +**script_created**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Emitted when the user clicks the OK button. @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **config**\ (\ inherits\: :ref:`String`, path\: :ref:`String`, built_in_enabled\: :ref:`bool` = true, load_enabled\: :ref:`bool` = true\ ) +|void| **config**\ (\ inherits\: :ref:`String`, path\: :ref:`String`, built_in_enabled\: :ref:`bool` = true, load_enabled\: :ref:`bool` = true\ ) :ref:`🔗` Prefills required fields to configure the ScriptCreateDialog for use. diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 87661bc35c3..f7963518b6d 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**editor_script_changed**\ (\ script\: :ref:`Script`\ ) +**editor_script_changed**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. @@ -76,7 +76,7 @@ Emitted when user changed active script. Argument is a freshly activated :ref:`S .. rst-class:: classref-signal -**script_close**\ (\ script\: :ref:`Script`\ ) +**script_close**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. @@ -93,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ScriptEditorBase` **get_current_editor**\ (\ ) |const| +:ref:`ScriptEditorBase` **get_current_editor**\ (\ ) |const| :ref:`🔗` Returns the :ref:`ScriptEditorBase` object that the user is currently editing. @@ -105,7 +105,7 @@ Returns the :ref:`ScriptEditorBase` object that the user .. rst-class:: classref-method -:ref:`Script` **get_current_script**\ (\ ) +:ref:`Script` **get_current_script**\ (\ ) :ref:`🔗` Returns a :ref:`Script` that is currently active in editor. @@ -117,7 +117,7 @@ Returns a :ref:`Script` that is currently active in editor. .. rst-class:: classref-method -:ref:`Array`\[:ref:`ScriptEditorBase`\] **get_open_script_editors**\ (\ ) |const| +:ref:`Array`\[:ref:`ScriptEditorBase`\] **get_open_script_editors**\ (\ ) |const| :ref:`🔗` Returns an array with all :ref:`ScriptEditorBase` objects which are currently open in editor. @@ -129,7 +129,7 @@ Returns an array with all :ref:`ScriptEditorBase` object .. rst-class:: classref-method -:ref:`Array`\[:ref:`Script`\] **get_open_scripts**\ (\ ) |const| +:ref:`Array`\[:ref:`Script`\] **get_open_scripts**\ (\ ) |const| :ref:`🔗` Returns an array with all :ref:`Script` objects which are currently open in editor. @@ -141,7 +141,7 @@ Returns an array with all :ref:`Script` objects which are currentl .. rst-class:: classref-method -|void| **goto_help**\ (\ topic\: :ref:`String`\ ) +|void| **goto_help**\ (\ topic\: :ref:`String`\ ) :ref:`🔗` Opens help for the given topic. The ``topic`` is an encoded string that controls which class, method, constant, signal, annotation, property, or theme item should be focused. @@ -178,7 +178,7 @@ The supported ``topic`` formats include ``class_name:class``, ``class_method:cla .. rst-class:: classref-method -|void| **goto_line**\ (\ line_number\: :ref:`int`\ ) +|void| **goto_line**\ (\ line_number\: :ref:`int`\ ) :ref:`🔗` Goes to the specified line in the current script. @@ -190,7 +190,7 @@ Goes to the specified line in the current script. .. rst-class:: classref-method -|void| **open_script_create_dialog**\ (\ base_name\: :ref:`String`, base_path\: :ref:`String`\ ) +|void| **open_script_create_dialog**\ (\ base_name\: :ref:`String`, base_path\: :ref:`String`\ ) :ref:`🔗` Opens the script create dialog. The script will extend ``base_name``. The file extension can be omitted from ``base_path``. It will be added based on the selected scripting language. @@ -202,7 +202,7 @@ Opens the script create dialog. The script will extend ``base_name``. The file e .. rst-class:: classref-method -|void| **register_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) +|void| **register_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` Registers the :ref:`EditorSyntaxHighlighter` to the editor, the :ref:`EditorSyntaxHighlighter` will be available on all open scripts. @@ -216,7 +216,7 @@ Registers the :ref:`EditorSyntaxHighlighter` to t .. rst-class:: classref-method -|void| **unregister_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) +|void| **unregister_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` Unregisters the :ref:`EditorSyntaxHighlighter` from the editor. diff --git a/classes/class_scripteditorbase.rst b/classes/class_scripteditorbase.rst index 02447ba822b..5dcd5fc9175 100644 --- a/classes/class_scripteditorbase.rst +++ b/classes/class_scripteditorbase.rst @@ -48,7 +48,7 @@ Signals .. rst-class:: classref-signal -**edited_script_changed**\ (\ ) +**edited_script_changed**\ (\ ) :ref:`🔗` Emitted after script validation. @@ -60,7 +60,7 @@ Emitted after script validation. .. rst-class:: classref-signal -**go_to_help**\ (\ what\: :ref:`String`\ ) +**go_to_help**\ (\ what\: :ref:`String`\ ) :ref:`🔗` Emitted when the user requests a specific documentation page. @@ -72,7 +72,7 @@ Emitted when the user requests a specific documentation page. .. rst-class:: classref-signal -**go_to_method**\ (\ script\: :ref:`Object`, method\: :ref:`String`\ ) +**go_to_method**\ (\ script\: :ref:`Object`, method\: :ref:`String`\ ) :ref:`🔗` Emitted when the user requests to view a specific method of a script, similar to :ref:`request_open_script_at_line`. @@ -84,7 +84,7 @@ Emitted when the user requests to view a specific method of a script, similar to .. rst-class:: classref-signal -**name_changed**\ (\ ) +**name_changed**\ (\ ) :ref:`🔗` Emitted after script validation or when the edited resource has changed. @@ -96,7 +96,7 @@ Emitted after script validation or when the edited resource has changed. .. rst-class:: classref-signal -**replace_in_files_requested**\ (\ text\: :ref:`String`\ ) +**replace_in_files_requested**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Emitted when the user request to find and replace text in the file system. @@ -108,7 +108,7 @@ Emitted when the user request to find and replace text in the file system. .. rst-class:: classref-signal -**request_help**\ (\ topic\: :ref:`String`\ ) +**request_help**\ (\ topic\: :ref:`String`\ ) :ref:`🔗` Emitted when the user requests contextual help. @@ -120,7 +120,7 @@ Emitted when the user requests contextual help. .. rst-class:: classref-signal -**request_open_script_at_line**\ (\ script\: :ref:`Object`, line\: :ref:`int`\ ) +**request_open_script_at_line**\ (\ script\: :ref:`Object`, line\: :ref:`int`\ ) :ref:`🔗` Emitted when the user requests to view a specific line of a script, similar to :ref:`go_to_method`. @@ -132,7 +132,7 @@ Emitted when the user requests to view a specific line of a script, similar to : .. rst-class:: classref-signal -**request_save_history**\ (\ ) +**request_save_history**\ (\ ) :ref:`🔗` Emitted when the user contextual goto and the item is in the same script. @@ -144,7 +144,7 @@ Emitted when the user contextual goto and the item is in the same script. .. rst-class:: classref-signal -**request_save_previous_state**\ (\ line\: :ref:`int`\ ) +**request_save_previous_state**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Emitted when the user changes current script or moves caret by 10 or more columns within the same script. @@ -156,7 +156,7 @@ Emitted when the user changes current script or moves caret by 10 or more column .. rst-class:: classref-signal -**search_in_files_requested**\ (\ text\: :ref:`String`\ ) +**search_in_files_requested**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Emitted when the user request to search text in the file system. @@ -173,7 +173,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_syntax_highlighter**\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) +|void| **add_syntax_highlighter**\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` Adds a :ref:`EditorSyntaxHighlighter` to the open script. @@ -185,7 +185,7 @@ Adds a :ref:`EditorSyntaxHighlighter` to the open .. rst-class:: classref-method -:ref:`Control` **get_base_editor**\ (\ ) |const| +:ref:`Control` **get_base_editor**\ (\ ) |const| :ref:`🔗` Returns the underlying :ref:`Control` used for editing scripts. For text scripts, this is a :ref:`CodeEdit`. diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index ceca4119e46..f7ca6e7797f 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_instantiate**\ (\ ) |virtual| |const| +:ref:`bool` **_can_instantiate**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -125,7 +125,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_editor_can_reload_from_file**\ (\ ) |virtual| +:ref:`bool` **_editor_can_reload_from_file**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -139,7 +139,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Script` **_get_base_script**\ (\ ) |virtual| |const| +:ref:`Script` **_get_base_script**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -153,7 +153,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_class_icon_path**\ (\ ) |virtual| |const| +:ref:`String` **_get_class_icon_path**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_get_constants**\ (\ ) |virtual| |const| +:ref:`Dictionary` **_get_constants**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -181,7 +181,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_documentation**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_documentation**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -195,7 +195,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **_get_global_name**\ (\ ) |virtual| |const| +:ref:`StringName` **_get_global_name**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -209,7 +209,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **_get_instance_base_type**\ (\ ) |virtual| |const| +:ref:`StringName` **_get_instance_base_type**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ScriptLanguage` **_get_language**\ (\ ) |virtual| |const| +:ref:`ScriptLanguage` **_get_language**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -237,7 +237,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_member_line**\ (\ member\: :ref:`StringName`\ ) |virtual| |const| +:ref:`int` **_get_member_line**\ (\ member\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -251,7 +251,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`StringName`\] **_get_members**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`StringName`\] **_get_members**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -265,7 +265,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_get_method_info**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| +:ref:`Dictionary` **_get_method_info**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -279,7 +279,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| +:ref:`Variant` **_get_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -293,7 +293,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get_rpc_config**\ (\ ) |virtual| |const| +:ref:`Variant` **_get_rpc_config**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -307,7 +307,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get_script_method_argument_count**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| +:ref:`Variant` **_get_script_method_argument_count**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Return the expected argument count for the given ``method``, or ``null`` if it can't be determined (which will then fall back to the default behavior). @@ -319,7 +319,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_script_method_list**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_method_list**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -333,7 +333,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_script_property_list**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_property_list**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -347,7 +347,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_script_signal_list**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_signal_list**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -361,7 +361,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`String` **_get_source_code**\ (\ ) |virtual| |const| +:ref:`String` **_get_source_code**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -375,7 +375,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_has_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_has_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -389,7 +389,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_has_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_has_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -403,7 +403,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_has_script_signal**\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_has_script_signal**\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -417,7 +417,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_has_source_code**\ (\ ) |virtual| |const| +:ref:`bool` **_has_source_code**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -431,7 +431,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_has_static_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| +:ref:`bool` **_has_static_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -445,7 +445,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_inherits_script**\ (\ script\: :ref:`Script`\ ) |virtual| |const| +:ref:`bool` **_inherits_script**\ (\ script\: :ref:`Script`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -459,7 +459,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -``void*`` **_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| +``void*`` **_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -473,7 +473,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_instance_has**\ (\ object\: :ref:`Object`\ ) |virtual| |const| +:ref:`bool` **_instance_has**\ (\ object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -487,7 +487,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. rst-class:: classref-method -:ref:`bool` **_is_abstract**\ (\ ) |virtual| |const| +:ref:`bool` **_is_abstract**\ (\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. @@ -499,7 +499,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **_is_placeholder_fallback_enabled**\ (\ ) |virtual| |const| +:ref:`bool` **_is_placeholder_fallback_enabled**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -513,7 +513,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **_is_tool**\ (\ ) |virtual| |const| +:ref:`bool` **_is_tool**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -527,7 +527,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **_is_valid**\ (\ ) |virtual| |const| +:ref:`bool` **_is_valid**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -541,7 +541,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -|void| **_placeholder_erased**\ (\ placeholder\: ``void*``\ ) |virtual| +|void| **_placeholder_erased**\ (\ placeholder\: ``void*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -555,7 +555,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -``void*`` **_placeholder_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| +``void*`` **_placeholder_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -569,7 +569,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`Error` **_reload**\ (\ keep_state\: :ref:`bool`\ ) |virtual| +:ref:`Error` **_reload**\ (\ keep_state\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -583,7 +583,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -|void| **_set_source_code**\ (\ code\: :ref:`String`\ ) |virtual| +|void| **_set_source_code**\ (\ code\: :ref:`String`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -597,7 +597,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -|void| **_update_exports**\ (\ ) |virtual| +|void| **_update_exports**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index 765ca694615..89e83de30bd 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -31,7 +31,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ScriptNameCasing**: +enum **ScriptNameCasing**: :ref:`🔗` .. _class_ScriptLanguage_constant_SCRIPT_NAME_CASING_AUTO: diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 5b02d51bae6..a64cbf219ef 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -155,7 +155,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **LookupResultType**: +enum **LookupResultType**: :ref:`🔗` .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_SCRIPT_LOCATION: @@ -285,7 +285,7 @@ enum **LookupResultType**: .. rst-class:: classref-enumeration -enum **CodeCompletionLocation**: +enum **CodeCompletionLocation**: :ref:`🔗` .. _class_ScriptLanguageExtension_constant_LOCATION_LOCAL: @@ -327,7 +327,7 @@ The option is from other engine code, not covered by the other enum constants - .. rst-class:: classref-enumeration -enum **CodeCompletionKind**: +enum **CodeCompletionKind**: :ref:`🔗` .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_CLASS: @@ -474,7 +474,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| +|void| **_add_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -488,7 +488,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_add_named_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| +|void| **_add_named_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -502,7 +502,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_auto_indent_code**\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_auto_indent_code**\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -516,7 +516,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_inherit_from_file**\ (\ ) |virtual| |const| +:ref:`bool` **_can_inherit_from_file**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -530,7 +530,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_make_function**\ (\ ) |virtual| |const| +:ref:`bool` **_can_make_function**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -544,7 +544,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_complete_code**\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| +:ref:`Dictionary` **_complete_code**\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -558,7 +558,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **_create_script**\ (\ ) |virtual| |const| +:ref:`Object` **_create_script**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -572,7 +572,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_debug_get_current_stack_info**\ (\ ) |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_debug_get_current_stack_info**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -586,7 +586,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_debug_get_error**\ (\ ) |virtual| |const| +:ref:`String` **_debug_get_error**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -600,7 +600,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_debug_get_globals**\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| +:ref:`Dictionary` **_debug_get_globals**\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -614,7 +614,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_debug_get_stack_level_count**\ (\ ) |virtual| |const| +:ref:`int` **_debug_get_stack_level_count**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -628,7 +628,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_debug_get_stack_level_function**\ (\ level\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_debug_get_stack_level_function**\ (\ level\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -642,7 +642,7 @@ Method Descriptions .. rst-class:: classref-method -``void*`` **_debug_get_stack_level_instance**\ (\ level\: :ref:`int`\ ) |virtual| +``void*`` **_debug_get_stack_level_instance**\ (\ level\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -656,7 +656,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_debug_get_stack_level_line**\ (\ level\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_debug_get_stack_level_line**\ (\ level\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -670,7 +670,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_debug_get_stack_level_locals**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| +:ref:`Dictionary` **_debug_get_stack_level_locals**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -684,7 +684,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_debug_get_stack_level_members**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| +:ref:`Dictionary` **_debug_get_stack_level_members**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -698,7 +698,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_debug_parse_stack_level_expression**\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| +:ref:`String` **_debug_parse_stack_level_expression**\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -712,7 +712,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_find_function**\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| +:ref:`int` **_find_function**\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Returns the line where the function is defined in the code, or ``-1`` if the function is not present. @@ -724,7 +724,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_finish**\ (\ ) |virtual| +|void| **_finish**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -738,7 +738,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_frame**\ (\ ) |virtual| +|void| **_frame**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -752,7 +752,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_built_in_templates**\ (\ object\: :ref:`StringName`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_built_in_templates**\ (\ object\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -766,7 +766,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_comment_delimiters**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_comment_delimiters**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -780,7 +780,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_doc_comment_delimiters**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_doc_comment_delimiters**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -794,7 +794,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`String` **_get_extension**\ (\ ) |virtual| |const| +:ref:`String` **_get_extension**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -808,7 +808,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Dictionary` **_get_global_class_name**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`Dictionary` **_get_global_class_name**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -822,7 +822,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -836,7 +836,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_public_annotations**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_public_annotations**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -850,7 +850,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Dictionary` **_get_public_constants**\ (\ ) |virtual| |const| +:ref:`Dictionary` **_get_public_constants**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -864,7 +864,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **_get_public_functions**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_public_functions**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -878,7 +878,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -892,7 +892,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_reserved_words**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_reserved_words**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -906,7 +906,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_string_delimiters**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_string_delimiters**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -920,7 +920,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`String` **_get_type**\ (\ ) |virtual| |const| +:ref:`String` **_get_type**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -934,7 +934,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_handles_global_class_type**\ (\ type\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_handles_global_class_type**\ (\ type\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -948,7 +948,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_has_named_classes**\ (\ ) |virtual| |const| +:ref:`bool` **_has_named_classes**\ (\ ) |virtual| |const| :ref:`🔗` **Deprecated:** This method is not called by the engine. @@ -960,7 +960,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_init**\ (\ ) |virtual| +|void| **_init**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -974,7 +974,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_is_control_flow_keyword**\ (\ keyword\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_is_control_flow_keyword**\ (\ keyword\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -988,7 +988,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_is_using_templates**\ (\ ) |virtual| +:ref:`bool` **_is_using_templates**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1002,7 +1002,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Dictionary` **_lookup_code**\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| +:ref:`Dictionary` **_lookup_code**\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1016,7 +1016,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`String` **_make_function**\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |const| +:ref:`String` **_make_function**\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1030,7 +1030,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Script` **_make_template**\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |const| +:ref:`Script` **_make_template**\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1044,7 +1044,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Error` **_open_in_external_editor**\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| +:ref:`Error` **_open_in_external_editor**\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1058,7 +1058,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_overrides_external_editor**\ (\ ) |virtual| +:ref:`bool` **_overrides_external_editor**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1072,7 +1072,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`ScriptNameCasing` **_preferred_file_name_casing**\ (\ ) |virtual| |const| +:ref:`ScriptNameCasing` **_preferred_file_name_casing**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1086,7 +1086,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`int` **_profiling_get_accumulated_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| +:ref:`int` **_profiling_get_accumulated_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1100,7 +1100,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`int` **_profiling_get_frame_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| +:ref:`int` **_profiling_get_frame_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1114,7 +1114,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_profiling_set_save_native_calls**\ (\ enable\: :ref:`bool`\ ) |virtual| +|void| **_profiling_set_save_native_calls**\ (\ enable\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1128,7 +1128,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_profiling_start**\ (\ ) |virtual| +|void| **_profiling_start**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1142,7 +1142,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_profiling_stop**\ (\ ) |virtual| +|void| **_profiling_stop**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1156,7 +1156,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_reload_all_scripts**\ (\ ) |virtual| +|void| **_reload_all_scripts**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1170,7 +1170,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_reload_tool_script**\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| +|void| **_reload_tool_script**\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1184,7 +1184,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_remove_named_global_constant**\ (\ name\: :ref:`StringName`\ ) |virtual| +|void| **_remove_named_global_constant**\ (\ name\: :ref:`StringName`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1198,7 +1198,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_supports_builtin_mode**\ (\ ) |virtual| |const| +:ref:`bool` **_supports_builtin_mode**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1212,7 +1212,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`bool` **_supports_documentation**\ (\ ) |virtual| |const| +:ref:`bool` **_supports_documentation**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1226,7 +1226,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_thread_enter**\ (\ ) |virtual| +|void| **_thread_enter**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1240,7 +1240,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -|void| **_thread_exit**\ (\ ) |virtual| +|void| **_thread_exit**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -1254,7 +1254,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`Dictionary` **_validate**\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |const| +:ref:`Dictionary` **_validate**\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -1268,7 +1268,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -:ref:`String` **_validate_path**\ (\ path\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_validate_path**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index fabf3760582..5de397d0be2 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -82,7 +82,7 @@ Signals .. rst-class:: classref-signal -**scrolling**\ (\ ) +**scrolling**\ (\ ) :ref:`🔗` Emitted when the scrollbar is being scrolled. @@ -99,7 +99,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **custom_step** = ``-1.0`` +:ref:`float` **custom_step** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Texture2D` **decrement** +:ref:`Texture2D` **decrement** :ref:`🔗` Icon used as a button to scroll the **ScrollBar** left/up. Supports custom step using the :ref:`custom_step` property. @@ -133,7 +133,7 @@ Icon used as a button to scroll the **ScrollBar** left/up. Supports custom step .. rst-class:: classref-themeproperty -:ref:`Texture2D` **decrement_highlight** +:ref:`Texture2D` **decrement_highlight** :ref:`🔗` Displayed when the mouse cursor hovers over the decrement button. @@ -145,7 +145,7 @@ Displayed when the mouse cursor hovers over the decrement button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **decrement_pressed** +:ref:`Texture2D` **decrement_pressed** :ref:`🔗` Displayed when the decrement button is being pressed. @@ -157,7 +157,7 @@ Displayed when the decrement button is being pressed. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment** +:ref:`Texture2D` **increment** :ref:`🔗` Icon used as a button to scroll the **ScrollBar** right/down. Supports custom step using the :ref:`custom_step` property. @@ -169,7 +169,7 @@ Icon used as a button to scroll the **ScrollBar** right/down. Supports custom st .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment_highlight** +:ref:`Texture2D` **increment_highlight** :ref:`🔗` Displayed when the mouse cursor hovers over the increment button. @@ -181,7 +181,7 @@ Displayed when the mouse cursor hovers over the increment button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment_pressed** +:ref:`Texture2D` **increment_pressed** :ref:`🔗` Displayed when the increment button is being pressed. @@ -193,7 +193,7 @@ Displayed when the increment button is being pressed. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **grabber** +:ref:`StyleBox` **grabber** :ref:`🔗` Used as texture for the grabber, the draggable element representing current scroll. @@ -205,7 +205,7 @@ Used as texture for the grabber, the draggable element representing current scro .. rst-class:: classref-themeproperty -:ref:`StyleBox` **grabber_highlight** +:ref:`StyleBox` **grabber_highlight** :ref:`🔗` Used when the mouse hovers over the grabber. @@ -217,7 +217,7 @@ Used when the mouse hovers over the grabber. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **grabber_pressed** +:ref:`StyleBox` **grabber_pressed** :ref:`🔗` Used when the grabber is being dragged. @@ -229,7 +229,7 @@ Used when the grabber is being dragged. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **scroll** +:ref:`StyleBox` **scroll** :ref:`🔗` Used as background of this **ScrollBar**. @@ -241,7 +241,7 @@ Used as background of this **ScrollBar**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **scroll_focus** +:ref:`StyleBox` **scroll_focus** :ref:`🔗` Used as background when the **ScrollBar** has the GUI focus. diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index ae8b3f62051..d5b548c9050 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -99,7 +99,7 @@ Signals .. rst-class:: classref-signal -**scroll_ended**\ (\ ) +**scroll_ended**\ (\ ) :ref:`🔗` Emitted when scrolling stops when dragging the scrollable area *with a touch event*. This signal is *not* emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events. @@ -113,7 +113,7 @@ Emitted when scrolling stops when dragging the scrollable area *with a touch eve .. rst-class:: classref-signal -**scroll_started**\ (\ ) +**scroll_started**\ (\ ) :ref:`🔗` Emitted when scrolling starts when dragging the scrollable area w\ *ith a touch event*. This signal is *not* emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events. @@ -132,7 +132,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ScrollMode**: +enum **ScrollMode**: :ref:`🔗` .. _class_ScrollContainer_constant_SCROLL_MODE_DISABLED: @@ -179,7 +179,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **follow_focus** = ``false`` +:ref:`bool` **follow_focus** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ If ``true``, the ScrollContainer will automatically scroll to focused children ( .. rst-class:: classref-property -:ref:`ScrollMode` **horizontal_scroll_mode** = ``1`` +:ref:`ScrollMode` **horizontal_scroll_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ Controls whether horizontal scrollbar can be used and when it should be visible. .. rst-class:: classref-property -:ref:`int` **scroll_deadzone** = ``0`` +:ref:`int` **scroll_deadzone** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -230,7 +230,7 @@ Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive. .. rst-class:: classref-property -:ref:`int` **scroll_horizontal** = ``0`` +:ref:`int` **scroll_horizontal** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ The current horizontal scroll value. .. rst-class:: classref-property -:ref:`float` **scroll_horizontal_custom_step** = ``-1.0`` +:ref:`float` **scroll_horizontal_custom_step** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ Overrides the :ref:`ScrollBar.custom_step` .. rst-class:: classref-property -:ref:`int` **scroll_vertical** = ``0`` +:ref:`int` **scroll_vertical** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -295,7 +295,7 @@ The current vertical scroll value. .. rst-class:: classref-property -:ref:`float` **scroll_vertical_custom_step** = ``-1.0`` +:ref:`float` **scroll_vertical_custom_step** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -312,7 +312,7 @@ Overrides the :ref:`ScrollBar.custom_step` .. rst-class:: classref-property -:ref:`ScrollMode` **vertical_scroll_mode** = ``1`` +:ref:`ScrollMode` **vertical_scroll_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -334,7 +334,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **ensure_control_visible**\ (\ control\: :ref:`Control`\ ) +|void| **ensure_control_visible**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Ensures the given ``control`` is visible (must be a direct or indirect child of the ScrollContainer). Used by :ref:`follow_focus`. @@ -354,7 +354,7 @@ Ensures the given ``control`` is visible (must be a direct or indirect child of .. rst-class:: classref-method -:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) +:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) :ref:`🔗` Returns the horizontal scrollbar :ref:`HScrollBar` of this **ScrollContainer**. @@ -368,7 +368,7 @@ Returns the horizontal scrollbar :ref:`HScrollBar` of this **S .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) :ref:`🔗` Returns the vertical scrollbar :ref:`VScrollBar` of this **ScrollContainer**. @@ -387,7 +387,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The background :ref:`StyleBox` of the **ScrollContainer**. diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index e2af7dd66a9..3fb405b5a02 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **a** = ``Vector2(0, 0)`` +:ref:`Vector2` **a** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ The segment's first point position. .. rst-class:: classref-property -:ref:`Vector2` **b** = ``Vector2(0, 10)`` +:ref:`Vector2` **b** = ``Vector2(0, 10)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index baf9ef65423..dba9b2dc128 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **post**\ (\ ) +|void| **post**\ (\ ) :ref:`🔗` Lowers the **Semaphore**, allowing one more thread in. @@ -79,7 +79,7 @@ Lowers the **Semaphore**, allowing one more thread in. .. rst-class:: classref-method -:ref:`bool` **try_wait**\ (\ ) +:ref:`bool` **try_wait**\ (\ ) :ref:`🔗` Like :ref:`wait`, but won't block, so if the value is zero, fails immediately and returns ``false``. If non-zero, it returns ``true`` to report success. @@ -91,7 +91,7 @@ Like :ref:`wait`, but won't block, so if the value .. rst-class:: classref-method -|void| **wait**\ (\ ) +|void| **wait**\ (\ ) :ref:`🔗` Waits for the **Semaphore**, if its value is zero, blocks until non-zero. diff --git a/classes/class_separationrayshape2d.rst b/classes/class_separationrayshape2d.rst index c198df3b6ee..3c2d581ad31 100644 --- a/classes/class_separationrayshape2d.rst +++ b/classes/class_separationrayshape2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **length** = ``20.0`` +:ref:`float` **length** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ The ray's length. .. rst-class:: classref-property -:ref:`bool` **slide_on_slope** = ``false`` +:ref:`bool` **slide_on_slope** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_separationrayshape3d.rst b/classes/class_separationrayshape3d.rst index 3090cd92669..a32a4be7086 100644 --- a/classes/class_separationrayshape3d.rst +++ b/classes/class_separationrayshape3d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **length** = ``1.0`` +:ref:`float` **length** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ The ray's length. .. rst-class:: classref-property -:ref:`bool` **slide_on_slope** = ``false`` +:ref:`bool` **slide_on_slope** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_separator.rst b/classes/class_separator.rst index 52775b8852d..149e0a4e3aa 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -50,7 +50,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **separation** = ``0`` +:ref:`int` **separation** = ``0`` :ref:`🔗` The size of the area covered by the separator. Effectively works like a minimum width/height. @@ -62,7 +62,7 @@ The size of the area covered by the separator. Effectively works like a minimum .. rst-class:: classref-themeproperty -:ref:`StyleBox` **separator** +:ref:`StyleBox` **separator** :ref:`🔗` The style for the separator line. Works best with :ref:`StyleBoxLine` (remember to enable :ref:`StyleBoxLine.vertical` for :ref:`VSeparator`). diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 1abcd3baaee..00d4576142b 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -75,7 +75,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_Shader_constant_MODE_SPATIAL: @@ -130,7 +130,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **code** = ``""`` +:ref:`String` **code** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Texture2D` **get_default_texture_parameter**\ (\ name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| +:ref:`Texture2D` **get_default_texture_parameter**\ (\ name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the texture that is set as default for the specified parameter. @@ -168,7 +168,7 @@ Returns the texture that is set as default for the specified parameter. .. rst-class:: classref-method -:ref:`Mode` **get_mode**\ (\ ) |const| +:ref:`Mode` **get_mode**\ (\ ) |const| :ref:`🔗` Returns the shader mode for the shader. @@ -180,7 +180,7 @@ Returns the shader mode for the shader. .. rst-class:: classref-method -:ref:`Array` **get_shader_uniform_list**\ (\ get_groups\: :ref:`bool` = false\ ) +:ref:`Array` **get_shader_uniform_list**\ (\ get_groups\: :ref:`bool` = false\ ) :ref:`🔗` Get the list of shader uniforms that can be assigned to a :ref:`ShaderMaterial`, for use with :ref:`ShaderMaterial.set_shader_parameter` and :ref:`ShaderMaterial.get_shader_parameter`. The parameters returned are contained in dictionaries in a similar format to the ones returned by :ref:`Object.get_property_list`. @@ -194,7 +194,7 @@ If argument ``get_groups`` is true, parameter grouping hints will be provided. .. rst-class:: classref-method -|void| **set_default_texture_parameter**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`, index\: :ref:`int` = 0\ ) +|void| **set_default_texture_parameter**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`, index\: :ref:`int` = 0\ ) :ref:`🔗` 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`. diff --git a/classes/class_shaderinclude.rst b/classes/class_shaderinclude.rst index 00828fda3d5..e9b74ac9aea 100644 --- a/classes/class_shaderinclude.rst +++ b/classes/class_shaderinclude.rst @@ -53,7 +53,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **code** = ``""`` +:ref:`String` **code** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 5bb12d5d721..7f8ad034ffb 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Shader` **shader** +:ref:`Shader` **shader** :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_shader_parameter**\ (\ param\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_shader_parameter**\ (\ param\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the current value set for this material of a uniform in the shader. @@ -105,7 +105,7 @@ Returns the current value set for this material of a uniform in the shader. .. rst-class:: classref-method -|void| **set_shader_parameter**\ (\ param\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_shader_parameter**\ (\ param\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Changes the value set for this material of a uniform in the shader. diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index bbfbd3527d9..2828c55fc0d 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **custom_solver_bias** = ``0.0`` +:ref:`float` **custom_solver_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **collide**\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) +:ref:`bool` **collide**\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) :ref:`🔗` Returns ``true`` if this shape is colliding with another. @@ -117,7 +117,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -:ref:`PackedVector2Array` **collide_and_get_contacts**\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) +:ref:`PackedVector2Array` **collide_and_get_contacts**\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) :ref:`🔗` Returns a list of contact point pairs where this shape touches another. @@ -135,7 +135,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -:ref:`bool` **collide_with_motion**\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) +:ref:`bool` **collide_with_motion**\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) :ref:`🔗` Returns whether this shape would collide with another, if a given movement was applied. @@ -149,7 +149,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -:ref:`PackedVector2Array` **collide_with_motion_and_get_contacts**\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) +:ref:`PackedVector2Array` **collide_with_motion_and_get_contacts**\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) :ref:`🔗` Returns a list of contact point pairs where this shape would touch another, if a given movement was applied. @@ -167,7 +167,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -|void| **draw**\ (\ canvas_item\: :ref:`RID`, color\: :ref:`Color`\ ) +|void| **draw**\ (\ canvas_item\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Draws a solid shape onto a :ref:`CanvasItem` with the :ref:`RenderingServer` API filled with the specified ``color``. The exact drawing method is specific for each shape and cannot be configured. @@ -179,7 +179,7 @@ Draws a solid shape onto a :ref:`CanvasItem` with the :ref:`Re .. rst-class:: classref-method -:ref:`Rect2` **get_rect**\ (\ ) |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Rect2` representing the shapes boundary. diff --git a/classes/class_shape3d.rst b/classes/class_shape3d.rst index f1df6c19616..66d7ea74d5d 100644 --- a/classes/class_shape3d.rst +++ b/classes/class_shape3d.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **custom_solver_bias** = ``0.0`` +:ref:`float` **custom_solver_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ When set to ``0``, the default value from :ref:`ProjectSettings.physics/3d/solve .. rst-class:: classref-property -:ref:`float` **margin** = ``0.04`` +:ref:`float` **margin** = ``0.04`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ArrayMesh` **get_debug_mesh**\ (\ ) +:ref:`ArrayMesh` **get_debug_mesh**\ (\ ) :ref:`🔗` Returns the :ref:`ArrayMesh` used to draw the debug collision for this **Shape3D**. diff --git a/classes/class_shapecast2d.rst b/classes/class_shapecast2d.rst index b6e233e860b..fefcbd4e2df 100644 --- a/classes/class_shapecast2d.rst +++ b/classes/class_shapecast2d.rst @@ -112,7 +112,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -129,7 +129,7 @@ If ``true``, collisions with :ref:`Area2D`\ s will be reported. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -146,7 +146,7 @@ If ``true``, collisions with :ref:`PhysicsBody2D`\ s will b .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -163,7 +163,7 @@ The shape's collision mask. Only objects in at least one collision layer enabled .. rst-class:: classref-property -:ref:`Array` **collision_result** = ``[]`` +:ref:`Array` **collision_result** = ``[]`` :ref:`🔗` Returns the complete collision information from the collision sweep. The data returned is the same as in the :ref:`PhysicsDirectSpaceState2D.get_rest_info` method. @@ -175,7 +175,7 @@ Returns the complete collision information from the collision sweep. The data re .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property -:ref:`bool` **exclude_parent** = ``true`` +:ref:`bool` **exclude_parent** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -209,7 +209,7 @@ If ``true``, the parent node will be excluded from collision detection. .. rst-class:: classref-property -:ref:`float` **margin** = ``0.0`` +:ref:`float` **margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ The collision margin for the shape. A larger margin helps detecting collisions m .. rst-class:: classref-property -:ref:`int` **max_results** = ``32`` +:ref:`int` **max_results** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -243,7 +243,7 @@ The number of intersections can be limited with this parameter, to reduce the pr .. rst-class:: classref-property -:ref:`Shape2D` **shape** +:ref:`Shape2D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ The :ref:`Shape2D`-derived shape to be used for collision queries .. rst-class:: classref-property -:ref:`Vector2` **target_position** = ``Vector2(0, 50)`` +:ref:`Vector2` **target_position** = ``Vector2(0, 50)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -282,7 +282,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) +|void| **add_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) :ref:`🔗` Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject2D` node. @@ -294,7 +294,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Adds a collision exception so the shape does not report collisions with the specified :ref:`RID`. @@ -306,7 +306,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -|void| **clear_exceptions**\ (\ ) +|void| **clear_exceptions**\ (\ ) :ref:`🔗` Removes all collision exceptions for this shape. @@ -318,7 +318,7 @@ Removes all collision exceptions for this shape. .. rst-class:: classref-method -|void| **force_shapecast_update**\ (\ ) +|void| **force_shapecast_update**\ (\ ) :ref:`🔗` Updates the collision information for the shape immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the shape or its parent has changed state. @@ -332,7 +332,7 @@ Updates the collision information for the shape immediately, without waiting for .. rst-class:: classref-method -:ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| +:ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| :ref:`🔗` The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape can move without triggering a collision. @@ -344,7 +344,7 @@ The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` **get_closest_collision_unsafe_fraction**\ (\ ) |const| +:ref:`float` **get_closest_collision_unsafe_fraction**\ (\ ) |const| :ref:`🔗` The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape must move to trigger a collision. @@ -358,7 +358,7 @@ In ideal conditions this would be the same as :ref:`get_closest_collision_safe_f .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collided :ref:`Object` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -370,7 +370,7 @@ Returns the collided :ref:`Object` of one of the multiple collisio .. rst-class:: classref-method -:ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the collided object of one of the multiple collisions at ``index``. @@ -382,7 +382,7 @@ Returns the :ref:`RID` of the collided object of one of the multiple .. rst-class:: classref-method -:ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the shape ID of the colliding shape of one of the multiple collisions at ``index``, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -394,7 +394,7 @@ Returns the shape ID of the colliding shape of one of the multiple collisions at .. rst-class:: classref-method -:ref:`int` **get_collision_count**\ (\ ) |const| +:ref:`int` **get_collision_count**\ (\ ) |const| :ref:`🔗` 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. @@ -406,7 +406,7 @@ The number of collisions detected at the point of impact. Use this to iterate ov .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -418,7 +418,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the normal of one of the multiple collisions at ``index`` of the intersecting object. @@ -430,7 +430,7 @@ Returns the normal of one of the multiple collisions at ``index`` of the interse .. rst-class:: classref-method -:ref:`Vector2` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collision point of one of the multiple collisions at ``index`` where the shape intersects the colliding object. @@ -444,7 +444,7 @@ Returns the collision point of one of the multiple collisions at ``index`` where .. rst-class:: classref-method -:ref:`bool` **is_colliding**\ (\ ) |const| +:ref:`bool` **is_colliding**\ (\ ) |const| :ref:`🔗` Returns whether any object is intersecting with the shape's vector (considering the vector length). @@ -456,7 +456,7 @@ Returns whether any object is intersecting with the shape's vector (considering .. rst-class:: classref-method -|void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) :ref:`🔗` Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject2D` node. @@ -468,7 +468,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Removes a collision exception so the shape does report collisions with the specified :ref:`RID`. @@ -480,7 +480,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_shapecast3d.rst b/classes/class_shapecast3d.rst index 02f1eb48d72..09a71f904f8 100644 --- a/classes/class_shapecast3d.rst +++ b/classes/class_shapecast3d.rst @@ -116,7 +116,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collide_with_areas** = ``false`` +:ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ If ``true``, collisions with :ref:`Area3D`\ s will be reported. .. rst-class:: classref-property -:ref:`bool` **collide_with_bodies** = ``true`` +:ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ If ``true``, collisions with :ref:`PhysicsBody3D`\ s will b .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ The shape's collision mask. Only objects in at least one collision layer enabled .. rst-class:: classref-property -:ref:`Array` **collision_result** = ``[]`` +:ref:`Array` **collision_result** = ``[]`` :ref:`🔗` Returns the complete collision information from the collision sweep. The data returned is the same as in the :ref:`PhysicsDirectSpaceState3D.get_rest_info` method. @@ -179,7 +179,7 @@ Returns the complete collision information from the collision sweep. The data re .. rst-class:: classref-property -:ref:`Color` **debug_shape_custom_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **debug_shape_custom_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -198,7 +198,7 @@ If set to ``Color(0.0, 0.0, 0.0)`` (by default), the color set in :ref:`ProjectS .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property -:ref:`bool` **exclude_parent** = ``true`` +:ref:`bool` **exclude_parent** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -232,7 +232,7 @@ If ``true``, the parent node will be excluded from collision detection. .. rst-class:: classref-property -:ref:`float` **margin** = ``0.0`` +:ref:`float` **margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -249,7 +249,7 @@ The collision margin for the shape. A larger margin helps detecting collisions m .. rst-class:: classref-property -:ref:`int` **max_results** = ``32`` +:ref:`int` **max_results** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -266,7 +266,7 @@ The number of intersections can be limited with this parameter, to reduce the pr .. rst-class:: classref-property -:ref:`Shape3D` **shape** +:ref:`Shape3D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -283,7 +283,7 @@ The :ref:`Shape3D`-derived shape to be used for collision queries .. rst-class:: classref-property -:ref:`Vector3` **target_position** = ``Vector3(0, -1, 0)`` +:ref:`Vector3` **target_position** = ``Vector3(0, -1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -305,7 +305,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) +|void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) :ref:`🔗` Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject3D` node. @@ -317,7 +317,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Adds a collision exception so the shape does not report collisions with the specified :ref:`RID`. @@ -329,7 +329,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -|void| **clear_exceptions**\ (\ ) +|void| **clear_exceptions**\ (\ ) :ref:`🔗` Removes all collision exceptions for this **ShapeCast3D**. @@ -341,7 +341,7 @@ Removes all collision exceptions for this **ShapeCast3D**. .. rst-class:: classref-method -|void| **force_shapecast_update**\ (\ ) +|void| **force_shapecast_update**\ (\ ) :ref:`🔗` Updates the collision information for the shape immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the shape or its parent has changed state. @@ -355,7 +355,7 @@ Updates the collision information for the shape immediately, without waiting for .. rst-class:: classref-method -:ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| +:ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| :ref:`🔗` The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape can move without triggering a collision. @@ -367,7 +367,7 @@ The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` **get_closest_collision_unsafe_fraction**\ (\ ) |const| +:ref:`float` **get_closest_collision_unsafe_fraction**\ (\ ) |const| :ref:`🔗` The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape must move to trigger a collision. @@ -381,7 +381,7 @@ In ideal conditions this would be the same as :ref:`get_closest_collision_safe_f .. rst-class:: classref-method -:ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collided :ref:`Object` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -393,7 +393,7 @@ Returns the collided :ref:`Object` of one of the multiple collisio .. rst-class:: classref-method -:ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| +:ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the collided object of one of the multiple collisions at ``index``. @@ -405,7 +405,7 @@ Returns the :ref:`RID` of the collided object of one of the multiple .. rst-class:: classref-method -:ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the shape ID of the colliding shape of one of the multiple collisions at ``index``, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -417,7 +417,7 @@ Returns the shape ID of the colliding shape of one of the multiple collisions at .. rst-class:: classref-method -:ref:`int` **get_collision_count**\ (\ ) |const| +:ref:`int` **get_collision_count**\ (\ ) |const| :ref:`🔗` 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. @@ -429,7 +429,7 @@ The number of collisions detected at the point of impact. Use this to iterate ov .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -441,7 +441,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the normal of one of the multiple collisions at ``index`` of the intersecting object. @@ -453,7 +453,7 @@ Returns the normal of one of the multiple collisions at ``index`` of the interse .. rst-class:: classref-method -:ref:`Vector3` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collision point of one of the multiple collisions at ``index`` where the shape intersects the colliding object. @@ -467,7 +467,7 @@ Returns the collision point of one of the multiple collisions at ``index`` where .. rst-class:: classref-method -:ref:`bool` **is_colliding**\ (\ ) |const| +:ref:`bool` **is_colliding**\ (\ ) |const| :ref:`🔗` Returns whether any object is intersecting with the shape's vector (considering the vector length). @@ -479,7 +479,7 @@ Returns whether any object is intersecting with the shape's vector (considering .. rst-class:: classref-method -|void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) :ref:`🔗` Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject3D` node. @@ -491,7 +491,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Removes a collision exception so the shape does report collisions with the specified :ref:`RID`. @@ -503,7 +503,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) +|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` **Deprecated:** Use :ref:`Resource.changed` instead. @@ -517,7 +517,7 @@ This method does nothing. .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index ab9e8e7f945..d8fdc0723cf 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -64,7 +64,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Array` **events** = ``[]`` +:ref:`Array` **events** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_as_text**\ (\ ) |const| +:ref:`String` **get_as_text**\ (\ ) |const| :ref:`🔗` Returns the shortcut's first valid :ref:`InputEvent` as a :ref:`String`. @@ -100,7 +100,7 @@ Returns the shortcut's first valid :ref:`InputEvent` as a :ref .. rst-class:: classref-method -:ref:`bool` **has_valid_event**\ (\ ) |const| +:ref:`bool` **has_valid_event**\ (\ ) |const| :ref:`🔗` Returns whether :ref:`events` contains an :ref:`InputEvent` which is valid. @@ -112,7 +112,7 @@ Returns whether :ref:`events` contains an :ref:` .. rst-class:: classref-method -:ref:`bool` **matches_event**\ (\ event\: :ref:`InputEvent`\ ) |const| +:ref:`bool` **matches_event**\ (\ event\: :ref:`InputEvent`\ ) |const| :ref:`🔗` Returns whether any :ref:`InputEvent` in :ref:`events` equals ``event``. diff --git a/classes/class_signal.rst b/classes/class_signal.rst index 87b037f2705..de512669939 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -128,7 +128,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Signal` **Signal**\ (\ ) +:ref:`Signal` **Signal**\ (\ ) :ref:`🔗` Constructs an empty **Signal** with no object nor signal name bound. @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **connect**\ (\ callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) +:ref:`int` **connect**\ (\ callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) :ref:`🔗` Connects this signal to the specified ``callable``. Optional ``flags`` can be also added to configure the connection's behavior (see :ref:`ConnectFlags` constants). You can provide additional arguments to the connected ``callable`` by using :ref:`Callable.bind`. @@ -187,7 +187,7 @@ A signal can only be connected once to the same :ref:`Callable`. .. rst-class:: classref-method -|void| **disconnect**\ (\ callable\: :ref:`Callable`\ ) +|void| **disconnect**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Disconnects this signal from the specified :ref:`Callable`. If the connection does not exist, generates an error. Use :ref:`is_connected` to make sure that the connection exists. @@ -199,7 +199,7 @@ Disconnects this signal from the specified :ref:`Callable`. If t .. rst-class:: classref-method -|void| **emit**\ (\ ...\ ) |vararg| |const| +|void| **emit**\ (\ ...\ ) |vararg| |const| :ref:`🔗` Emits this signal. All :ref:`Callable`\ s connected to this signal will be triggered. This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -211,7 +211,7 @@ Emits this signal. All :ref:`Callable`\ s connected to this sign .. rst-class:: classref-method -:ref:`Array` **get_connections**\ (\ ) |const| +:ref:`Array` **get_connections**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` of connections for this signal. Each connection is represented as a :ref:`Dictionary` that contains three entries: @@ -229,7 +229,7 @@ Returns an :ref:`Array` of connections for this signal. Each connec .. rst-class:: classref-method -:ref:`StringName` **get_name**\ (\ ) |const| +:ref:`StringName` **get_name**\ (\ ) |const| :ref:`🔗` Returns the name of this signal. @@ -241,7 +241,7 @@ Returns the name of this signal. .. rst-class:: classref-method -:ref:`Object` **get_object**\ (\ ) |const| +:ref:`Object` **get_object**\ (\ ) |const| :ref:`🔗` Returns the object emitting this signal. @@ -253,7 +253,7 @@ Returns the object emitting this signal. .. rst-class:: classref-method -:ref:`int` **get_object_id**\ (\ ) |const| +:ref:`int` **get_object_id**\ (\ ) |const| :ref:`🔗` Returns the ID of the object emitting this signal (see :ref:`Object.get_instance_id`). @@ -265,7 +265,7 @@ Returns the ID of the object emitting this signal (see :ref:`Object.get_instance .. rst-class:: classref-method -:ref:`bool` **is_connected**\ (\ callable\: :ref:`Callable`\ ) |const| +:ref:`bool` **is_connected**\ (\ callable\: :ref:`Callable`\ ) |const| :ref:`🔗` Returns ``true`` if the specified :ref:`Callable` is connected to this signal. @@ -277,7 +277,7 @@ Returns ``true`` if the specified :ref:`Callable` is connected t .. rst-class:: classref-method -:ref:`bool` **is_null**\ (\ ) |const| +:ref:`bool` **is_null**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the signal's name does not exist in its object, or the object is not valid. @@ -294,7 +294,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Signal`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Signal`\ ) :ref:`🔗` Returns ``true`` if the signals do not share the same object and name. @@ -306,7 +306,7 @@ Returns ``true`` if the signals do not share the same object and name. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Signal`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Signal`\ ) :ref:`🔗` Returns ``true`` if both signals share the same object and name. diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 334dc2ad873..72017ee1c55 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -69,7 +69,7 @@ Signals .. rst-class:: classref-signal -**bone_setup_changed**\ (\ ) +**bone_setup_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`Bone2D` setup attached to this skeletons changes. This is primarily used internally within the skeleton. @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **execute_modifications**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) +|void| **execute_modifications**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) :ref:`🔗` Executes all the modifications on the :ref:`SkeletonModificationStack2D`, if the Skeleton2D has one assigned. @@ -98,7 +98,7 @@ Executes all the modifications on the :ref:`SkeletonModificationStack2D` **get_bone**\ (\ idx\: :ref:`int`\ ) +:ref:`Bone2D` **get_bone**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Returns a :ref:`Bone2D` from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter ``idx``. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. @@ -110,7 +110,7 @@ Returns a :ref:`Bone2D` from the node hierarchy parented by Skelet .. rst-class:: classref-method -:ref:`int` **get_bone_count**\ (\ ) |const| +:ref:`int` **get_bone_count**\ (\ ) |const| :ref:`🔗` Returns the number of :ref:`Bone2D` nodes in the node hierarchy parented by Skeleton2D. @@ -122,7 +122,7 @@ Returns the number of :ref:`Bone2D` nodes in the node hierarchy pa .. rst-class:: classref-method -:ref:`Transform2D` **get_bone_local_pose_override**\ (\ bone_idx\: :ref:`int`\ ) +:ref:`Transform2D` **get_bone_local_pose_override**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Returns the local pose override transform for ``bone_idx``. @@ -134,7 +134,7 @@ Returns the local pose override transform for ``bone_idx``. .. rst-class:: classref-method -:ref:`SkeletonModificationStack2D` **get_modification_stack**\ (\ ) |const| +:ref:`SkeletonModificationStack2D` **get_modification_stack**\ (\ ) |const| :ref:`🔗` Returns the :ref:`SkeletonModificationStack2D` attached to this skeleton, if one exists. @@ -146,7 +146,7 @@ Returns the :ref:`SkeletonModificationStack2D .. rst-class:: classref-method -:ref:`RID` **get_skeleton**\ (\ ) |const| +:ref:`RID` **get_skeleton**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of a Skeleton2D instance. @@ -158,7 +158,7 @@ Returns the :ref:`RID` of a Skeleton2D instance. .. rst-class:: classref-method -|void| **set_bone_local_pose_override**\ (\ bone_idx\: :ref:`int`, override_pose\: :ref:`Transform2D`, strength\: :ref:`float`, persistent\: :ref:`bool`\ ) +|void| **set_bone_local_pose_override**\ (\ bone_idx\: :ref:`int`, override_pose\: :ref:`Transform2D`, strength\: :ref:`float`, persistent\: :ref:`bool`\ ) :ref:`🔗` Sets the local pose transform, ``override_pose``, for the bone at ``bone_idx``. @@ -174,7 +174,7 @@ Sets the local pose transform, ``override_pose``, for the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_modification_stack**\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) +|void| **set_modification_stack**\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) :ref:`🔗` Sets the :ref:`SkeletonModificationStack2D` attached to this skeleton. diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index fe644ac7304..7ecafa644b2 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -159,7 +159,7 @@ Signals .. rst-class:: classref-signal -**bone_enabled_changed**\ (\ bone_idx\: :ref:`int`\ ) +**bone_enabled_changed**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled`. Use :ref:`is_bone_enabled` to check the new value. @@ -171,7 +171,7 @@ Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled` .. container:: contribute @@ -185,7 +185,7 @@ Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled` Emitted when the pose is updated. @@ -199,7 +199,7 @@ Emitted when the pose is updated. .. rst-class:: classref-signal -**show_rest_only_changed**\ (\ ) +**show_rest_only_changed**\ (\ ) :ref:`🔗` Emitted when the value of :ref:`show_rest_only` changes. @@ -211,7 +211,7 @@ Emitted when the value of :ref:`show_rest_only` Emitted when the final pose has been calculated will be applied to the skin in the update process. @@ -230,7 +230,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ModifierCallbackModeProcess**: +enum **ModifierCallbackModeProcess**: :ref:`🔗` .. _class_Skeleton3D_constant_MODIFIER_CALLBACK_MODE_PROCESS_PHYSICS: @@ -261,7 +261,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_UPDATE_SKELETON** = ``50`` +**NOTIFICATION_UPDATE_SKELETON** = ``50`` :ref:`🔗` Notification received when this skeleton's pose needs to be updated. In that case, this is called only once per frame in a deferred process. @@ -278,7 +278,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ModifierCallbackModeProcess` **modifier_callback_mode_process** = ``1`` +:ref:`ModifierCallbackModeProcess` **modifier_callback_mode_process** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -295,7 +295,7 @@ Sets the processing timing for the Modifier. .. rst-class:: classref-property -:ref:`float` **motion_scale** = ``1.0`` +:ref:`float` **motion_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -314,7 +314,7 @@ Multiplies the 3D position track animation. .. rst-class:: classref-property -:ref:`bool` **show_rest_only** = ``false`` +:ref:`bool` **show_rest_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -336,7 +336,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_bone**\ (\ name\: :ref:`String`\ ) +:ref:`int` **add_bone**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Adds a new bone with the given name. Returns the new bone's index, or ``-1`` if this method fails. @@ -350,7 +350,7 @@ Adds a new bone with the given name. Returns the new bone's index, or ``-1`` if .. rst-class:: classref-method -|void| **clear_bones**\ (\ ) +|void| **clear_bones**\ (\ ) :ref:`🔗` Clear all the bones in this skeleton. @@ -362,7 +362,7 @@ Clear all the bones in this skeleton. .. rst-class:: classref-method -|void| **clear_bones_global_pose_override**\ (\ ) +|void| **clear_bones_global_pose_override**\ (\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -376,7 +376,7 @@ Removes the global pose override on all bones in the skeleton. .. rst-class:: classref-method -:ref:`Skin` **create_skin_from_rest_transforms**\ (\ ) +:ref:`Skin` **create_skin_from_rest_transforms**\ (\ ) :ref:`🔗` .. container:: contribute @@ -390,7 +390,7 @@ Removes the global pose override on all bones in the skeleton. .. rst-class:: classref-method -:ref:`int` **find_bone**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **find_bone**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the bone index that matches ``name`` as its name. Returns ``-1`` if no bone with this name exists. @@ -402,7 +402,7 @@ Returns the bone index that matches ``name`` as its name. Returns ``-1`` if no b .. rst-class:: classref-method -|void| **force_update_all_bone_transforms**\ (\ ) +|void| **force_update_all_bone_transforms**\ (\ ) :ref:`🔗` **Deprecated:** This method should only be called internally. @@ -416,7 +416,7 @@ Force updates the bone transforms/poses for all bones in the skeleton. .. rst-class:: classref-method -|void| **force_update_bone_child_transform**\ (\ bone_idx\: :ref:`int`\ ) +|void| **force_update_bone_child_transform**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Force updates the bone transform for the bone at ``bone_idx`` and all of its children. @@ -428,7 +428,7 @@ Force updates the bone transform for the bone at ``bone_idx`` and all of its chi .. rst-class:: classref-method -:ref:`bool` **get_animate_physical_bones**\ (\ ) |const| +:ref:`bool` **get_animate_physical_bones**\ (\ ) |const| :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -440,7 +440,7 @@ Force updates the bone transform for the bone at ``bone_idx`` and all of its chi .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_bone_children**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **get_bone_children**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array containing the bone indexes of all the child node of the passed in bone, ``bone_idx``. @@ -452,7 +452,7 @@ Returns an array containing the bone indexes of all the child node of the passed .. rst-class:: classref-method -:ref:`int` **get_bone_count**\ (\ ) |const| +:ref:`int` **get_bone_count**\ (\ ) |const| :ref:`🔗` Returns the number of bones in the skeleton. @@ -464,7 +464,7 @@ Returns the number of bones in the skeleton. .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bone_global_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. @@ -478,7 +478,7 @@ Returns the overall transform of the specified bone, with respect to the skeleto .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_pose_no_override**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bone_global_pose_no_override**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -492,7 +492,7 @@ Returns the overall transform of the specified bone, with respect to the skeleto .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -506,7 +506,7 @@ Returns the global pose override transform for ``bone_idx``. .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_rest**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bone_global_rest**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the global rest transform for ``bone_idx``. @@ -518,7 +518,7 @@ Returns the global rest transform for ``bone_idx``. .. rst-class:: classref-method -:ref:`String` **get_bone_name**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_bone_name**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the bone at index ``bone_idx``. @@ -530,7 +530,7 @@ Returns the name of the bone at index ``bone_idx``. .. rst-class:: classref-method -:ref:`int` **get_bone_parent**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_bone_parent**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, then bone has no parent. @@ -544,7 +544,7 @@ Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, t .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bone_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the pose transform of the specified bone. @@ -558,7 +558,7 @@ Returns the pose transform of the specified bone. .. rst-class:: classref-method -:ref:`Vector3` **get_bone_pose_position**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_bone_pose_position**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the pose position of the bone at ``bone_idx``. The returned :ref:`Vector3` is in the local coordinate space of the **Skeleton3D** node. @@ -570,7 +570,7 @@ Returns the pose position of the bone at ``bone_idx``. The returned :ref:`Vector .. rst-class:: classref-method -:ref:`Quaternion` **get_bone_pose_rotation**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Quaternion` **get_bone_pose_rotation**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the pose rotation of the bone at ``bone_idx``. The returned :ref:`Quaternion` is local to the bone with respect to the rotation of any parent bones. @@ -582,7 +582,7 @@ Returns the pose rotation of the bone at ``bone_idx``. The returned :ref:`Quater .. rst-class:: classref-method -:ref:`Vector3` **get_bone_pose_scale**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Vector3` **get_bone_pose_scale**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the pose scale of the bone at ``bone_idx``. @@ -594,7 +594,7 @@ Returns the pose scale of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_rest**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bone_rest**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the rest transform for a bone ``bone_idx``. @@ -606,7 +606,7 @@ Returns the rest transform for a bone ``bone_idx``. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_parentless_bones**\ (\ ) |const| +:ref:`PackedInt32Array` **get_parentless_bones**\ (\ ) |const| :ref:`🔗` Returns an array with all of the bones that are parentless. Another way to look at this is that it returns the indexes of all the bones that are not dependent or modified by other bones in the Skeleton. @@ -618,7 +618,7 @@ Returns an array with all of the bones that are parentless. Another way to look .. rst-class:: classref-method -:ref:`int` **get_version**\ (\ ) |const| +:ref:`int` **get_version**\ (\ ) |const| :ref:`🔗` Returns the number of times the bone hierarchy has changed within this skeleton, including renames. @@ -634,7 +634,7 @@ Use for invalidating caches in IK solvers and other nodes which process bones. .. rst-class:: classref-method -:ref:`bool` **is_bone_enabled**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_bone_enabled**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the bone pose for the bone at ``bone_idx`` is enabled. @@ -646,7 +646,7 @@ Returns whether the bone pose for the bone at ``bone_idx`` is enabled. .. rst-class:: classref-method -|void| **localize_rests**\ (\ ) +|void| **localize_rests**\ (\ ) :ref:`🔗` Returns all bones in the skeleton to their rest poses. @@ -658,7 +658,7 @@ Returns all bones in the skeleton to their rest poses. .. rst-class:: classref-method -|void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) +|void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -674,7 +674,7 @@ Works just like the :ref:`RigidBody3D` node. .. rst-class:: classref-method -|void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) +|void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -690,7 +690,7 @@ Works just like the :ref:`RigidBody3D` node. .. rst-class:: classref-method -|void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) +|void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -706,7 +706,7 @@ Optionally, a list of bone names can be passed-in, allowing only the passed-in b .. rst-class:: classref-method -|void| **physical_bones_stop_simulation**\ (\ ) +|void| **physical_bones_stop_simulation**\ (\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -720,7 +720,7 @@ Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to s .. rst-class:: classref-method -:ref:`SkinReference` **register_skin**\ (\ skin\: :ref:`Skin`\ ) +:ref:`SkinReference` **register_skin**\ (\ skin\: :ref:`Skin`\ ) :ref:`🔗` Binds the given Skin to the Skeleton. @@ -732,7 +732,7 @@ Binds the given Skin to the Skeleton. .. rst-class:: classref-method -|void| **reset_bone_pose**\ (\ bone_idx\: :ref:`int`\ ) +|void| **reset_bone_pose**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Sets the bone pose to rest for ``bone_idx``. @@ -744,7 +744,7 @@ Sets the bone pose to rest for ``bone_idx``. .. rst-class:: classref-method -|void| **reset_bone_poses**\ (\ ) +|void| **reset_bone_poses**\ (\ ) :ref:`🔗` Sets all bone poses to rests. @@ -756,7 +756,7 @@ Sets all bone poses to rests. .. rst-class:: classref-method -|void| **set_animate_physical_bones**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_animate_physical_bones**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -768,7 +768,7 @@ Sets all bone poses to rests. .. rst-class:: classref-method -|void| **set_bone_enabled**\ (\ bone_idx\: :ref:`int`, enabled\: :ref:`bool` = true\ ) +|void| **set_bone_enabled**\ (\ bone_idx\: :ref:`int`, enabled\: :ref:`bool` = true\ ) :ref:`🔗` Disables the pose for the bone at ``bone_idx`` if ``false``, enables the bone pose if ``true``. @@ -780,7 +780,7 @@ Disables the pose for the bone at ``bone_idx`` if ``false``, enables the bone po .. rst-class:: classref-method -|void| **set_bone_global_pose**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) +|void| **set_bone_global_pose**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. @@ -794,7 +794,7 @@ Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`, amount\: :ref:`float`, persistent\: :ref:`bool` = false\ ) +|void| **set_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`, amount\: :ref:`float`, persistent\: :ref:`bool` = false\ ) :ref:`🔗` **Deprecated:** This method may be changed or removed in future versions. @@ -812,7 +812,7 @@ Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the bone name, ``name``, for the bone at ``bone_idx``. @@ -824,7 +824,7 @@ Sets the bone name, ``name``, for the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_bone_parent**\ (\ bone_idx\: :ref:`int`, parent_idx\: :ref:`int`\ ) +|void| **set_bone_parent**\ (\ bone_idx\: :ref:`int`, parent_idx\: :ref:`int`\ ) :ref:`🔗` Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If -1, then bone has no parent. @@ -838,7 +838,7 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If .. rst-class:: classref-method -|void| **set_bone_pose**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) +|void| **set_bone_pose**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the pose transform, ``pose``, for the bone at ``bone_idx``. @@ -850,7 +850,7 @@ Sets the pose transform, ``pose``, for the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_bone_pose_position**\ (\ bone_idx\: :ref:`int`, position\: :ref:`Vector3`\ ) +|void| **set_bone_pose_position**\ (\ bone_idx\: :ref:`int`, position\: :ref:`Vector3`\ ) :ref:`🔗` Sets the pose position of the bone at ``bone_idx`` to ``position``. ``position`` is a :ref:`Vector3` describing a position local to the **Skeleton3D** node. @@ -862,7 +862,7 @@ Sets the pose position of the bone at ``bone_idx`` to ``position``. ``position`` .. rst-class:: classref-method -|void| **set_bone_pose_rotation**\ (\ bone_idx\: :ref:`int`, rotation\: :ref:`Quaternion`\ ) +|void| **set_bone_pose_rotation**\ (\ bone_idx\: :ref:`int`, rotation\: :ref:`Quaternion`\ ) :ref:`🔗` Sets the pose rotation of the bone at ``bone_idx`` to ``rotation``. ``rotation`` is a :ref:`Quaternion` describing a rotation in the bone's local coordinate space with respect to the rotation of any parent bones. @@ -874,7 +874,7 @@ Sets the pose rotation of the bone at ``bone_idx`` to ``rotation``. ``rotation`` .. rst-class:: classref-method -|void| **set_bone_pose_scale**\ (\ bone_idx\: :ref:`int`, scale\: :ref:`Vector3`\ ) +|void| **set_bone_pose_scale**\ (\ bone_idx\: :ref:`int`, scale\: :ref:`Vector3`\ ) :ref:`🔗` Sets the pose scale of the bone at ``bone_idx`` to ``scale``. @@ -886,7 +886,7 @@ Sets the pose scale of the bone at ``bone_idx`` to ``scale``. .. rst-class:: classref-method -|void| **set_bone_rest**\ (\ bone_idx\: :ref:`int`, rest\: :ref:`Transform3D`\ ) +|void| **set_bone_rest**\ (\ bone_idx\: :ref:`int`, rest\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the rest transform for bone ``bone_idx``. @@ -898,7 +898,7 @@ Sets the rest transform for bone ``bone_idx``. .. rst-class:: classref-method -|void| **unparent_bone_and_rest**\ (\ bone_idx\: :ref:`int`\ ) +|void| **unparent_bone_and_rest**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Unparents the bone at ``bone_idx`` and sets its rest position to that of its parent prior to being reset. diff --git a/classes/class_skeletonik3d.rst b/classes/class_skeletonik3d.rst index 26e23a31671..0d219b7a9fc 100644 --- a/classes/class_skeletonik3d.rst +++ b/classes/class_skeletonik3d.rst @@ -104,7 +104,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **interpolation** +:ref:`float` **interpolation** :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Interpolation value for how much the IK results are applied to the current skele .. rst-class:: classref-property -:ref:`Vector3` **magnet** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **magnet** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ Secondary target position (first is :ref:`target` **max_iterations** = ``10`` +:ref:`int` **max_iterations** = ``10`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -157,7 +157,7 @@ Number of iteration loops used by the IK solver to produce more accurate (and el .. rst-class:: classref-property -:ref:`float` **min_distance** = ``0.01`` +:ref:`float` **min_distance** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -174,7 +174,7 @@ The minimum distance between bone and goal target. If the distance is below this .. rst-class:: classref-property -:ref:`bool` **override_tip_basis** = ``true`` +:ref:`bool` **override_tip_basis** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ If ``true`` overwrites the rotation of the tip bone with the rotation of the :re .. rst-class:: classref-property -:ref:`StringName` **root_bone** = ``&""`` +:ref:`StringName` **root_bone** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -208,7 +208,7 @@ The name of the current root bone, the first bone in the IK chain. .. rst-class:: classref-property -:ref:`Transform3D` **target** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **target** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ First target of the IK chain where the tip bone is placed and, if :ref:`override .. rst-class:: classref-property -:ref:`NodePath` **target_node** = ``NodePath("")`` +:ref:`NodePath` **target_node** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ Target node :ref:`NodePath` for the IK chain. If available, the .. rst-class:: classref-property -:ref:`StringName` **tip_bone** = ``&""`` +:ref:`StringName` **tip_bone** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -259,7 +259,7 @@ The name of the current tip bone, the last bone in the IK chain placed at the :r .. rst-class:: classref-property -:ref:`bool` **use_magnet** = ``false`` +:ref:`bool` **use_magnet** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -281,7 +281,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Skeleton3D` **get_parent_skeleton**\ (\ ) |const| +:ref:`Skeleton3D` **get_parent_skeleton**\ (\ ) |const| :ref:`🔗` Returns the parent :ref:`Skeleton3D` Node that was present when SkeletonIK entered the :ref:`SceneTree`. Returns null if the parent node was not a :ref:`Skeleton3D` Node when SkeletonIK3D entered the :ref:`SceneTree`. @@ -293,7 +293,7 @@ Returns the parent :ref:`Skeleton3D` Node that was present whe .. rst-class:: classref-method -:ref:`bool` **is_running**\ (\ ) +:ref:`bool` **is_running**\ (\ ) :ref:`🔗` Returns ``true`` if SkeletonIK is applying IK effects on continues frames to the :ref:`Skeleton3D` bones. Returns ``false`` if SkeletonIK is stopped or :ref:`start` was used with the ``one_time`` parameter set to ``true``. @@ -305,7 +305,7 @@ Returns ``true`` if SkeletonIK is applying IK effects on continues frames to the .. rst-class:: classref-method -|void| **start**\ (\ one_time\: :ref:`bool` = false\ ) +|void| **start**\ (\ one_time\: :ref:`bool` = false\ ) :ref:`🔗` Starts applying IK effects on each frame to the :ref:`Skeleton3D` bones but will only take effect starting on the next frame. If ``one_time`` is ``true``, this will take effect immediately but also reset on the next frame. @@ -317,7 +317,7 @@ Starts applying IK effects on each frame to the :ref:`Skeleton3D` Stops applying IK effects on each frame to the :ref:`Skeleton3D` bones and also calls :ref:`Skeleton3D.clear_bones_global_pose_override` to remove existing overrides on all bones. diff --git a/classes/class_skeletonmodification2d.rst b/classes/class_skeletonmodification2d.rst index f4b4460e97d..7475c8735e4 100644 --- a/classes/class_skeletonmodification2d.rst +++ b/classes/class_skeletonmodification2d.rst @@ -82,7 +82,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ If ``true``, the modification's :ref:`_execute` **execution_mode** = ``0`` +:ref:`int` **execution_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_draw_editor_gizmo**\ (\ ) |virtual| +|void| **_draw_editor_gizmo**\ (\ ) |virtual| :ref:`🔗` Used for drawing **editor-only** modification gizmos. This function will only be called in the Godot editor and can be overridden to draw custom gizmos. @@ -135,7 +135,7 @@ Used for drawing **editor-only** modification gizmos. This function will only be .. rst-class:: classref-method -|void| **_execute**\ (\ delta\: :ref:`float`\ ) |virtual| +|void| **_execute**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` Executes the given modification. This is where the modification performs whatever function it is designed to do. @@ -147,7 +147,7 @@ Executes the given modification. This is where the modification performs whateve .. rst-class:: classref-method -|void| **_setup_modification**\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) |virtual| +|void| **_setup_modification**\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) |virtual| :ref:`🔗` Called when the modification is setup. This is where the modification performs initialization. @@ -159,7 +159,7 @@ Called when the modification is setup. This is where the modification performs i .. rst-class:: classref-method -:ref:`float` **clamp_angle**\ (\ angle\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`, invert\: :ref:`bool`\ ) +:ref:`float` **clamp_angle**\ (\ angle\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`, invert\: :ref:`bool`\ ) :ref:`🔗` Takes an angle and clamps it so it is within the passed-in ``min`` and ``max`` range. ``invert`` will inversely clamp the angle, clamping it to the range outside of the given bounds. @@ -171,7 +171,7 @@ Takes an angle and clamps it so it is within the passed-in ``min`` and ``max`` r .. rst-class:: classref-method -:ref:`bool` **get_editor_draw_gizmo**\ (\ ) |const| +:ref:`bool` **get_editor_draw_gizmo**\ (\ ) |const| :ref:`🔗` Returns whether this modification will call :ref:`_draw_editor_gizmo` in the Godot editor to draw modification-specific gizmos. @@ -183,7 +183,7 @@ Returns whether this modification will call :ref:`_draw_editor_gizmo` **get_is_setup**\ (\ ) |const| +:ref:`bool` **get_is_setup**\ (\ ) |const| :ref:`🔗` Returns whether this modification has been successfully setup or not. @@ -195,7 +195,7 @@ Returns whether this modification has been successfully setup or not. .. rst-class:: classref-method -:ref:`SkeletonModificationStack2D` **get_modification_stack**\ (\ ) +:ref:`SkeletonModificationStack2D` **get_modification_stack**\ (\ ) :ref:`🔗` Returns the :ref:`SkeletonModificationStack2D` that this modification is bound to. Through the modification stack, you can access the Skeleton2D the modification is operating on. @@ -207,7 +207,7 @@ Returns the :ref:`SkeletonModificationStack2D .. rst-class:: classref-method -|void| **set_editor_draw_gizmo**\ (\ draw_gizmo\: :ref:`bool`\ ) +|void| **set_editor_draw_gizmo**\ (\ draw_gizmo\: :ref:`bool`\ ) :ref:`🔗` Sets whether this modification will call :ref:`_draw_editor_gizmo` in the Godot editor to draw modification-specific gizmos. @@ -219,7 +219,7 @@ Sets whether this modification will call :ref:`_draw_editor_gizmo`\ ) +|void| **set_is_setup**\ (\ is_setup\: :ref:`bool`\ ) :ref:`🔗` Manually allows you to set the setup state of the modification. This function should only rarely be used, as the :ref:`SkeletonModificationStack2D` the modification is bound to should handle setting the modification up. diff --git a/classes/class_skeletonmodification2dccdik.rst b/classes/class_skeletonmodification2dccdik.rst index 9c060fd0e04..dce4267f46b 100644 --- a/classes/class_skeletonmodification2dccdik.rst +++ b/classes/class_skeletonmodification2dccdik.rst @@ -96,7 +96,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **ccdik_data_chain_length** = ``0`` +:ref:`int` **ccdik_data_chain_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ The number of CCDIK joints in the CCDIK modification. .. rst-class:: classref-property -:ref:`NodePath` **target_nodepath** = ``NodePath("")`` +:ref:`NodePath` **target_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ The NodePath to the node that is the target for the CCDIK modification. This nod .. rst-class:: classref-property -:ref:`NodePath` **tip_nodepath** = ``NodePath("")`` +:ref:`NodePath` **tip_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -152,7 +152,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_ccdik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_ccdik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint_idx``. @@ -164,7 +164,7 @@ Returns the :ref:`Bone2D` node assigned to the CCDIK joint at ``jo .. rst-class:: classref-method -:ref:`int` **get_ccdik_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_ccdik_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the index of the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint_idx``. @@ -176,7 +176,7 @@ Returns the index of the :ref:`Bone2D` node assigned to the CCDIK .. rst-class:: classref-method -:ref:`bool` **get_ccdik_joint_constraint_angle_invert**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_ccdik_joint_constraint_angle_invert**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the CCDIK joint at ``joint_idx`` uses an inverted joint constraint. See :ref:`set_ccdik_joint_constraint_angle_invert` for details. @@ -188,7 +188,7 @@ Returns whether the CCDIK joint at ``joint_idx`` uses an inverted joint constrai .. rst-class:: classref-method -:ref:`float` **get_ccdik_joint_constraint_angle_max**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_ccdik_joint_constraint_angle_max**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum angle constraint for the joint at ``joint_idx``. @@ -200,7 +200,7 @@ Returns the maximum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`float` **get_ccdik_joint_constraint_angle_min**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_ccdik_joint_constraint_angle_min**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the minimum angle constraint for the joint at ``joint_idx``. @@ -212,7 +212,7 @@ Returns the minimum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_ccdik_joint_enable_constraint**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_ccdik_joint_enable_constraint**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether angle constraints on the CCDIK joint at ``joint_idx`` are enabled. @@ -224,7 +224,7 @@ Returns whether angle constraints on the CCDIK joint at ``joint_idx`` are enable .. rst-class:: classref-method -:ref:`bool` **get_ccdik_joint_rotate_from_joint**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_ccdik_joint_rotate_from_joint**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the joint at ``joint_idx`` is set to rotate from the joint, ``true``, or to rotate from the tip, ``false``. The default is to rotate from the tip. @@ -236,7 +236,7 @@ Returns whether the joint at ``joint_idx`` is set to rotate from the joint, ``tr .. rst-class:: classref-method -|void| **set_ccdik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) +|void| **set_ccdik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint_idx``. @@ -248,7 +248,7 @@ Sets the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint .. rst-class:: classref-method -|void| **set_ccdik_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) +|void| **set_ccdik_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) :ref:`🔗` Sets the bone index, ``bone_idx``, of the CCDIK joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the CCDIK joint based on data provided by the linked skeleton. @@ -260,7 +260,7 @@ Sets the bone index, ``bone_idx``, of the CCDIK joint at ``joint_idx``. When pos .. rst-class:: classref-method -|void| **set_ccdik_joint_constraint_angle_invert**\ (\ joint_idx\: :ref:`int`, invert\: :ref:`bool`\ ) +|void| **set_ccdik_joint_constraint_angle_invert**\ (\ joint_idx\: :ref:`int`, invert\: :ref:`bool`\ ) :ref:`🔗` Sets whether the CCDIK joint at ``joint_idx`` uses an inverted joint constraint. @@ -274,7 +274,7 @@ An inverted joint constraint only constraints the CCDIK joint to the angles *out .. rst-class:: classref-method -|void| **set_ccdik_joint_constraint_angle_max**\ (\ joint_idx\: :ref:`int`, angle_max\: :ref:`float`\ ) +|void| **set_ccdik_joint_constraint_angle_max**\ (\ joint_idx\: :ref:`int`, angle_max\: :ref:`float`\ ) :ref:`🔗` Sets the maximum angle constraint for the joint at ``joint_idx``. @@ -286,7 +286,7 @@ Sets the maximum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_ccdik_joint_constraint_angle_min**\ (\ joint_idx\: :ref:`int`, angle_min\: :ref:`float`\ ) +|void| **set_ccdik_joint_constraint_angle_min**\ (\ joint_idx\: :ref:`int`, angle_min\: :ref:`float`\ ) :ref:`🔗` Sets the minimum angle constraint for the joint at ``joint_idx``. @@ -298,7 +298,7 @@ Sets the minimum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_ccdik_joint_enable_constraint**\ (\ joint_idx\: :ref:`int`, enable_constraint\: :ref:`bool`\ ) +|void| **set_ccdik_joint_enable_constraint**\ (\ joint_idx\: :ref:`int`, enable_constraint\: :ref:`bool`\ ) :ref:`🔗` Determines whether angle constraints on the CCDIK joint at ``joint_idx`` are enabled. When ``true``, constraints will be enabled and taken into account when solving. @@ -310,7 +310,7 @@ Determines whether angle constraints on the CCDIK joint at ``joint_idx`` are ena .. rst-class:: classref-method -|void| **set_ccdik_joint_rotate_from_joint**\ (\ joint_idx\: :ref:`int`, rotate_from_joint\: :ref:`bool`\ ) +|void| **set_ccdik_joint_rotate_from_joint**\ (\ joint_idx\: :ref:`int`, rotate_from_joint\: :ref:`bool`\ ) :ref:`🔗` Sets whether the joint at ``joint_idx`` is set to rotate from the joint, ``true``, or to rotate from the tip, ``false``. diff --git a/classes/class_skeletonmodification2dfabrik.rst b/classes/class_skeletonmodification2dfabrik.rst index b95ccdf1702..ff216f5e432 100644 --- a/classes/class_skeletonmodification2dfabrik.rst +++ b/classes/class_skeletonmodification2dfabrik.rst @@ -84,7 +84,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **fabrik_data_chain_length** = ``0`` +:ref:`int` **fabrik_data_chain_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ The number of FABRIK joints in the FABRIK modification. .. rst-class:: classref-property -:ref:`NodePath` **target_nodepath** = ``NodePath("")`` +:ref:`NodePath` **target_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_fabrik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_fabrik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Bone2D` node assigned to the FABRIK joint at ``joint_idx``. @@ -135,7 +135,7 @@ Returns the :ref:`Bone2D` node assigned to the FABRIK joint at ``j .. rst-class:: classref-method -:ref:`int` **get_fabrik_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_fabrik_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the index of the :ref:`Bone2D` node assigned to the FABRIK joint at ``joint_idx``. @@ -147,7 +147,7 @@ Returns the index of the :ref:`Bone2D` node assigned to the FABRIK .. rst-class:: classref-method -:ref:`Vector2` **get_fabrik_joint_magnet_position**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_fabrik_joint_magnet_position**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the magnet position vector for the joint at ``joint_idx``. @@ -159,7 +159,7 @@ Returns the magnet position vector for the joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_fabrik_joint_use_target_rotation**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_fabrik_joint_use_target_rotation**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the joint is using the target's rotation rather than allowing FABRIK to rotate the joint. This option only applies to the tip/final joint in the chain. @@ -171,7 +171,7 @@ Returns whether the joint is using the target's rotation rather than allowing FA .. rst-class:: classref-method -|void| **set_fabrik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) +|void| **set_fabrik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`Bone2D` node assigned to the FABRIK joint at ``joint_idx``. @@ -183,7 +183,7 @@ Sets the :ref:`Bone2D` node assigned to the FABRIK joint at ``join .. rst-class:: classref-method -|void| **set_fabrik_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) +|void| **set_fabrik_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) :ref:`🔗` Sets the bone index, ``bone_idx``, of the FABRIK joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the FABRIK joint based on data provided by the linked skeleton. @@ -195,7 +195,7 @@ Sets the bone index, ``bone_idx``, of the FABRIK joint at ``joint_idx``. When po .. rst-class:: classref-method -|void| **set_fabrik_joint_magnet_position**\ (\ joint_idx\: :ref:`int`, magnet_position\: :ref:`Vector2`\ ) +|void| **set_fabrik_joint_magnet_position**\ (\ joint_idx\: :ref:`int`, magnet_position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the magnet position vector for the joint at ``joint_idx``. @@ -207,7 +207,7 @@ Sets the magnet position vector for the joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_fabrik_joint_use_target_rotation**\ (\ joint_idx\: :ref:`int`, use_target_rotation\: :ref:`bool`\ ) +|void| **set_fabrik_joint_use_target_rotation**\ (\ joint_idx\: :ref:`int`, use_target_rotation\: :ref:`bool`\ ) :ref:`🔗` Sets whether the joint at ``joint_idx`` will use the target node's rotation rather than letting FABRIK rotate the node. diff --git a/classes/class_skeletonmodification2djiggle.rst b/classes/class_skeletonmodification2djiggle.rst index 5c877d6859a..1accb67ef84 100644 --- a/classes/class_skeletonmodification2djiggle.rst +++ b/classes/class_skeletonmodification2djiggle.rst @@ -114,7 +114,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **damping** = ``0.75`` +:ref:`float` **damping** = ``0.75`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ The default amount of damping applied to the Jiggle joints, if they are not over .. rst-class:: classref-property -:ref:`Vector2` **gravity** = ``Vector2(0, 6)`` +:ref:`Vector2` **gravity** = ``Vector2(0, 6)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ The default amount of gravity applied to the Jiggle joints, if they are not over .. rst-class:: classref-property -:ref:`int` **jiggle_data_chain_length** = ``0`` +:ref:`int` **jiggle_data_chain_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -165,7 +165,7 @@ The amount of Jiggle joints in the Jiggle modification. .. rst-class:: classref-property -:ref:`float` **mass** = ``0.75`` +:ref:`float` **mass** = ``0.75`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -182,7 +182,7 @@ The default amount of mass assigned to the Jiggle joints, if they are not overri .. rst-class:: classref-property -:ref:`float` **stiffness** = ``3.0`` +:ref:`float` **stiffness** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -199,7 +199,7 @@ The default amount of stiffness assigned to the Jiggle joints, if they are not o .. rst-class:: classref-property -:ref:`NodePath` **target_nodepath** = ``NodePath("")`` +:ref:`NodePath` **target_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -216,7 +216,7 @@ The NodePath to the node that is the target for the Jiggle modification. This no .. rst-class:: classref-property -:ref:`bool` **use_gravity** = ``false`` +:ref:`bool` **use_gravity** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_collision_mask**\ (\ ) |const| +:ref:`int` **get_collision_mask**\ (\ ) |const| :ref:`🔗` Returns the collision mask used by the Jiggle modifier when collisions are enabled. @@ -250,7 +250,7 @@ Returns the collision mask used by the Jiggle modifier when collisions are enabl .. rst-class:: classref-method -:ref:`NodePath` **get_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Bone2D` node assigned to the Jiggle joint at ``joint_idx``. @@ -262,7 +262,7 @@ Returns the :ref:`Bone2D` node assigned to the Jiggle joint at ``j .. rst-class:: classref-method -:ref:`int` **get_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the index of the :ref:`Bone2D` node assigned to the Jiggle joint at ``joint_idx``. @@ -274,7 +274,7 @@ Returns the index of the :ref:`Bone2D` node assigned to the Jiggle .. rst-class:: classref-method -:ref:`float` **get_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the amount of damping of the Jiggle joint at ``joint_idx``. @@ -286,7 +286,7 @@ Returns the amount of damping of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`Vector2` **get_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`Vector2` representing the amount of gravity the Jiggle joint at ``joint_idx`` is influenced by. @@ -298,7 +298,7 @@ Returns a :ref:`Vector2` representing the amount of gravity the J .. rst-class:: classref-method -:ref:`float` **get_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the amount of mass of the jiggle joint at ``joint_idx``. @@ -310,7 +310,7 @@ Returns the amount of mass of the jiggle joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_jiggle_joint_override**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_jiggle_joint_override**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a boolean that indicates whether the joint at ``joint_idx`` is overriding the default Jiggle joint data defined in the modification. @@ -322,7 +322,7 @@ Returns a boolean that indicates whether the joint at ``joint_idx`` is overridin .. rst-class:: classref-method -:ref:`float` **get_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`float` **get_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the stiffness of the Jiggle joint at ``joint_idx``. @@ -334,7 +334,7 @@ Returns the stiffness of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`bool` **get_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a boolean that indicates whether the joint at ``joint_idx`` is using gravity or not. @@ -346,7 +346,7 @@ Returns a boolean that indicates whether the joint at ``joint_idx`` is using gra .. rst-class:: classref-method -:ref:`bool` **get_use_colliders**\ (\ ) |const| +:ref:`bool` **get_use_colliders**\ (\ ) |const| :ref:`🔗` Returns whether the jiggle modifier is taking physics colliders into account when solving. @@ -358,7 +358,7 @@ Returns whether the jiggle modifier is taking physics colliders into account whe .. rst-class:: classref-method -|void| **set_collision_mask**\ (\ collision_mask\: :ref:`int`\ ) +|void| **set_collision_mask**\ (\ collision_mask\: :ref:`int`\ ) :ref:`🔗` Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account. @@ -370,7 +370,7 @@ Sets the collision mask that the Jiggle modifier will use when reacting to colli .. rst-class:: classref-method -|void| **set_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_node\: :ref:`NodePath`\ ) +|void| **set_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_node\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`Bone2D` node assigned to the Jiggle joint at ``joint_idx``. @@ -382,7 +382,7 @@ Sets the :ref:`Bone2D` node assigned to the Jiggle joint at ``join .. rst-class:: classref-method -|void| **set_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) +|void| **set_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) :ref:`🔗` Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the Jiggle joint based on data provided by the linked skeleton. @@ -394,7 +394,7 @@ Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When po .. rst-class:: classref-method -|void| **set_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int`, damping\: :ref:`float`\ ) +|void| **set_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int`, damping\: :ref:`float`\ ) :ref:`🔗` Sets the amount of damping of the Jiggle joint at ``joint_idx``. @@ -406,7 +406,7 @@ Sets the amount of damping of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int`, gravity\: :ref:`Vector2`\ ) +|void| **set_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int`, gravity\: :ref:`Vector2`\ ) :ref:`🔗` Sets the gravity vector of the Jiggle joint at ``joint_idx``. @@ -418,7 +418,7 @@ Sets the gravity vector of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int`, mass\: :ref:`float`\ ) +|void| **set_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int`, mass\: :ref:`float`\ ) :ref:`🔗` Sets the of mass of the Jiggle joint at ``joint_idx``. @@ -430,7 +430,7 @@ Sets the of mass of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_jiggle_joint_override**\ (\ joint_idx\: :ref:`int`, override\: :ref:`bool`\ ) +|void| **set_jiggle_joint_override**\ (\ joint_idx\: :ref:`int`, override\: :ref:`bool`\ ) :ref:`🔗` Sets whether the Jiggle joint at ``joint_idx`` should override the default Jiggle joint settings. Setting this to ``true`` will make the joint use its own settings rather than the default ones attached to the modification. @@ -442,7 +442,7 @@ Sets whether the Jiggle joint at ``joint_idx`` should override the default Jiggl .. rst-class:: classref-method -|void| **set_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int`, stiffness\: :ref:`float`\ ) +|void| **set_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int`, stiffness\: :ref:`float`\ ) :ref:`🔗` Sets the of stiffness of the Jiggle joint at ``joint_idx``. @@ -454,7 +454,7 @@ Sets the of stiffness of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -|void| **set_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int`, use_gravity\: :ref:`bool`\ ) +|void| **set_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int`, use_gravity\: :ref:`bool`\ ) :ref:`🔗` Sets whether the Jiggle joint at ``joint_idx`` should use gravity. @@ -466,7 +466,7 @@ Sets whether the Jiggle joint at ``joint_idx`` should use gravity. .. rst-class:: classref-method -|void| **set_use_colliders**\ (\ use_colliders\: :ref:`bool`\ ) +|void| **set_use_colliders**\ (\ use_colliders\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects. diff --git a/classes/class_skeletonmodification2dlookat.rst b/classes/class_skeletonmodification2dlookat.rst index a4cf3f595a4..ba1d83982d3 100644 --- a/classes/class_skeletonmodification2dlookat.rst +++ b/classes/class_skeletonmodification2dlookat.rst @@ -82,7 +82,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **bone2d_node** = ``NodePath("")`` +:ref:`NodePath` **bone2d_node** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ The :ref:`Bone2D` node that the modification will operate on. .. rst-class:: classref-property -:ref:`int` **bone_index** = ``-1`` +:ref:`int` **bone_index** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ The index of the :ref:`Bone2D` node that the modification will ope .. rst-class:: classref-property -:ref:`NodePath` **target_nodepath** = ``NodePath("")`` +:ref:`NodePath` **target_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_additional_rotation**\ (\ ) |const| +:ref:`float` **get_additional_rotation**\ (\ ) |const| :ref:`🔗` Returns the amount of additional rotation that is applied after the LookAt modification executes. @@ -150,7 +150,7 @@ Returns the amount of additional rotation that is applied after the LookAt modif .. rst-class:: classref-method -:ref:`bool` **get_constraint_angle_invert**\ (\ ) |const| +:ref:`bool` **get_constraint_angle_invert**\ (\ ) |const| :ref:`🔗` Returns whether the constraints to this modification are inverted or not. @@ -162,7 +162,7 @@ Returns whether the constraints to this modification are inverted or not. .. rst-class:: classref-method -:ref:`float` **get_constraint_angle_max**\ (\ ) |const| +:ref:`float` **get_constraint_angle_max**\ (\ ) |const| :ref:`🔗` Returns the constraint's maximum allowed angle. @@ -174,7 +174,7 @@ Returns the constraint's maximum allowed angle. .. rst-class:: classref-method -:ref:`float` **get_constraint_angle_min**\ (\ ) |const| +:ref:`float` **get_constraint_angle_min**\ (\ ) |const| :ref:`🔗` Returns the constraint's minimum allowed angle. @@ -186,7 +186,7 @@ Returns the constraint's minimum allowed angle. .. rst-class:: classref-method -:ref:`bool` **get_enable_constraint**\ (\ ) |const| +:ref:`bool` **get_enable_constraint**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the LookAt modification is using constraints. @@ -198,7 +198,7 @@ Returns ``true`` if the LookAt modification is using constraints. .. rst-class:: classref-method -|void| **set_additional_rotation**\ (\ rotation\: :ref:`float`\ ) +|void| **set_additional_rotation**\ (\ rotation\: :ref:`float`\ ) :ref:`🔗` Sets the amount of additional rotation that is to be applied after executing the modification. This allows for offsetting the results by the inputted rotation amount. @@ -210,7 +210,7 @@ Sets the amount of additional rotation that is to be applied after executing the .. rst-class:: classref-method -|void| **set_constraint_angle_invert**\ (\ invert\: :ref:`bool`\ ) +|void| **set_constraint_angle_invert**\ (\ invert\: :ref:`bool`\ ) :ref:`🔗` When ``true``, the modification will use an inverted joint constraint. @@ -224,7 +224,7 @@ An inverted joint constraint only constraints the :ref:`Bone2D` to .. rst-class:: classref-method -|void| **set_constraint_angle_max**\ (\ angle_max\: :ref:`float`\ ) +|void| **set_constraint_angle_max**\ (\ angle_max\: :ref:`float`\ ) :ref:`🔗` Sets the constraint's maximum allowed angle. @@ -236,7 +236,7 @@ Sets the constraint's maximum allowed angle. .. rst-class:: classref-method -|void| **set_constraint_angle_min**\ (\ angle_min\: :ref:`float`\ ) +|void| **set_constraint_angle_min**\ (\ angle_min\: :ref:`float`\ ) :ref:`🔗` Sets the constraint's minimum allowed angle. @@ -248,7 +248,7 @@ Sets the constraint's minimum allowed angle. .. rst-class:: classref-method -|void| **set_enable_constraint**\ (\ enable_constraint\: :ref:`bool`\ ) +|void| **set_enable_constraint**\ (\ enable_constraint\: :ref:`bool`\ ) :ref:`🔗` Sets whether this modification will use constraints or not. When ``true``, constraints will be applied when solving the LookAt modification. diff --git a/classes/class_skeletonmodification2dphysicalbones.rst b/classes/class_skeletonmodification2dphysicalbones.rst index 1a8d6a948d8..6c51c8cde02 100644 --- a/classes/class_skeletonmodification2dphysicalbones.rst +++ b/classes/class_skeletonmodification2dphysicalbones.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **physical_bone_chain_length** = ``0`` +:ref:`int` **physical_bone_chain_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **fetch_physical_bones**\ (\ ) +|void| **fetch_physical_bones**\ (\ ) :ref:`🔗` Empties the list of :ref:`PhysicalBone2D` nodes and populates it with all :ref:`PhysicalBone2D` nodes that are children of the :ref:`Skeleton2D`. @@ -102,7 +102,7 @@ Empties the list of :ref:`PhysicalBone2D` nodes and popula .. rst-class:: classref-method -:ref:`NodePath` **get_physical_bone_node**\ (\ joint_idx\: :ref:`int`\ ) |const| +:ref:`NodePath` **get_physical_bone_node**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`PhysicalBone2D` node at ``joint_idx``. @@ -114,7 +114,7 @@ Returns the :ref:`PhysicalBone2D` node at ``joint_idx``. .. rst-class:: classref-method -|void| **set_physical_bone_node**\ (\ joint_idx\: :ref:`int`, physicalbone2d_node\: :ref:`NodePath`\ ) +|void| **set_physical_bone_node**\ (\ joint_idx\: :ref:`int`, physicalbone2d_node\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`PhysicalBone2D` node at ``joint_idx``. @@ -128,7 +128,7 @@ Sets the :ref:`PhysicalBone2D` node at ``joint_idx``. .. rst-class:: classref-method -|void| **start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) +|void| **start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` Tell the :ref:`PhysicalBone2D` nodes to start simulating and interacting with the physics world. @@ -142,7 +142,7 @@ Optionally, an array of bone names can be passed to this function, and that will .. rst-class:: classref-method -|void| **stop_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) +|void| **stop_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` Tell the :ref:`PhysicalBone2D` nodes to stop simulating and interacting with the physics world. diff --git a/classes/class_skeletonmodification2dstackholder.rst b/classes/class_skeletonmodification2dstackholder.rst index a17d97310f6..a87735a9fb6 100644 --- a/classes/class_skeletonmodification2dstackholder.rst +++ b/classes/class_skeletonmodification2dstackholder.rst @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`SkeletonModificationStack2D` **get_held_modification_stack**\ (\ ) |const| +:ref:`SkeletonModificationStack2D` **get_held_modification_stack**\ (\ ) |const| :ref:`🔗` Returns the :ref:`SkeletonModificationStack2D` that this modification is holding. @@ -64,7 +64,7 @@ Returns the :ref:`SkeletonModificationStack2D .. rst-class:: classref-method -|void| **set_held_modification_stack**\ (\ held_modification_stack\: :ref:`SkeletonModificationStack2D`\ ) +|void| **set_held_modification_stack**\ (\ held_modification_stack\: :ref:`SkeletonModificationStack2D`\ ) :ref:`🔗` Sets the :ref:`SkeletonModificationStack2D` that this modification is holding. This modification stack will then be executed when this modification is executed. diff --git a/classes/class_skeletonmodification2dtwoboneik.rst b/classes/class_skeletonmodification2dtwoboneik.rst index de58e168922..bee760edb01 100644 --- a/classes/class_skeletonmodification2dtwoboneik.rst +++ b/classes/class_skeletonmodification2dtwoboneik.rst @@ -82,7 +82,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **flip_bend_direction** = ``false`` +:ref:`bool` **flip_bend_direction** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ If ``true``, the bones in the modification will blend outward as opposed to inwa .. rst-class:: classref-property -:ref:`float` **target_maximum_distance** = ``0.0`` +:ref:`float` **target_maximum_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ The maximum distance the target can be at. If the target is farther than this di .. rst-class:: classref-property -:ref:`float` **target_minimum_distance** = ``0.0`` +:ref:`float` **target_minimum_distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The minimum distance the target can be at. If the target is closer than this dis .. rst-class:: classref-property -:ref:`NodePath` **target_nodepath** = ``NodePath("")`` +:ref:`NodePath` **target_nodepath** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_joint_one_bone2d_node**\ (\ ) |const| +:ref:`NodePath` **get_joint_one_bone2d_node**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -167,7 +167,7 @@ Returns the :ref:`Bone2D` node that is being used as the first bon .. rst-class:: classref-method -:ref:`int` **get_joint_one_bone_idx**\ (\ ) |const| +:ref:`int` **get_joint_one_bone_idx**\ (\ ) |const| :ref:`🔗` Returns the index of the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -179,7 +179,7 @@ Returns the index of the :ref:`Bone2D` node that is being used as .. rst-class:: classref-method -:ref:`NodePath` **get_joint_two_bone2d_node**\ (\ ) |const| +:ref:`NodePath` **get_joint_two_bone2d_node**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -191,7 +191,7 @@ Returns the :ref:`Bone2D` node that is being used as the second bo .. rst-class:: classref-method -:ref:`int` **get_joint_two_bone_idx**\ (\ ) |const| +:ref:`int` **get_joint_two_bone_idx**\ (\ ) |const| :ref:`🔗` Returns the index of the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -203,7 +203,7 @@ Returns the index of the :ref:`Bone2D` node that is being used as .. rst-class:: classref-method -|void| **set_joint_one_bone2d_node**\ (\ bone2d_node\: :ref:`NodePath`\ ) +|void| **set_joint_one_bone2d_node**\ (\ bone2d_node\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -215,7 +215,7 @@ Sets the :ref:`Bone2D` node that is being used as the first bone i .. rst-class:: classref-method -|void| **set_joint_one_bone_idx**\ (\ bone_idx\: :ref:`int`\ ) +|void| **set_joint_one_bone_idx**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Sets the index of the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -227,7 +227,7 @@ Sets the index of the :ref:`Bone2D` node that is being used as the .. rst-class:: classref-method -|void| **set_joint_two_bone2d_node**\ (\ bone2d_node\: :ref:`NodePath`\ ) +|void| **set_joint_two_bone2d_node**\ (\ bone2d_node\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -239,7 +239,7 @@ Sets the :ref:`Bone2D` node that is being used as the second bone .. rst-class:: classref-method -|void| **set_joint_two_bone_idx**\ (\ bone_idx\: :ref:`int`\ ) +|void| **set_joint_two_bone_idx**\ (\ bone_idx\: :ref:`int`\ ) :ref:`🔗` Sets the index of the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. diff --git a/classes/class_skeletonmodificationstack2d.rst b/classes/class_skeletonmodificationstack2d.rst index 4f80b5abf6d..a8f7f4382a1 100644 --- a/classes/class_skeletonmodificationstack2d.rst +++ b/classes/class_skeletonmodificationstack2d.rst @@ -84,7 +84,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **enabled** = ``false`` +:ref:`bool` **enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ If ``true``, the modification's in the stack will be called. This is handled aut .. rst-class:: classref-property -:ref:`int` **modification_count** = ``0`` +:ref:`int` **modification_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -118,7 +118,7 @@ The number of modifications in the stack. .. rst-class:: classref-property -:ref:`float` **strength** = ``1.0`` +:ref:`float` **strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -140,7 +140,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_modification**\ (\ modification\: :ref:`SkeletonModification2D`\ ) +|void| **add_modification**\ (\ modification\: :ref:`SkeletonModification2D`\ ) :ref:`🔗` Adds the passed-in :ref:`SkeletonModification2D` to the stack. @@ -152,7 +152,7 @@ Adds the passed-in :ref:`SkeletonModification2D` t .. rst-class:: classref-method -|void| **delete_modification**\ (\ mod_idx\: :ref:`int`\ ) +|void| **delete_modification**\ (\ mod_idx\: :ref:`int`\ ) :ref:`🔗` Deletes the :ref:`SkeletonModification2D` at the index position ``mod_idx``, if it exists. @@ -164,7 +164,7 @@ Deletes the :ref:`SkeletonModification2D` at the i .. rst-class:: classref-method -|void| **enable_all_modifications**\ (\ enabled\: :ref:`bool`\ ) +|void| **enable_all_modifications**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` Enables all :ref:`SkeletonModification2D`\ s in the stack. @@ -176,7 +176,7 @@ Enables all :ref:`SkeletonModification2D`\ s in th .. rst-class:: classref-method -|void| **execute**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) +|void| **execute**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) :ref:`🔗` Executes all of the :ref:`SkeletonModification2D`\ s in the stack that use the same execution mode as the passed-in ``execution_mode``, starting from index ``0`` to :ref:`modification_count`. @@ -190,7 +190,7 @@ Executes all of the :ref:`SkeletonModification2D`\ .. rst-class:: classref-method -:ref:`bool` **get_is_setup**\ (\ ) |const| +:ref:`bool` **get_is_setup**\ (\ ) |const| :ref:`🔗` Returns a boolean that indicates whether the modification stack is setup and can execute. @@ -202,7 +202,7 @@ Returns a boolean that indicates whether the modification stack is setup and can .. rst-class:: classref-method -:ref:`SkeletonModification2D` **get_modification**\ (\ mod_idx\: :ref:`int`\ ) |const| +:ref:`SkeletonModification2D` **get_modification**\ (\ mod_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`SkeletonModification2D` at the passed-in index, ``mod_idx``. @@ -214,7 +214,7 @@ Returns the :ref:`SkeletonModification2D` at the p .. rst-class:: classref-method -:ref:`Skeleton2D` **get_skeleton**\ (\ ) |const| +:ref:`Skeleton2D` **get_skeleton**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Skeleton2D` node that the SkeletonModificationStack2D is bound to. @@ -226,7 +226,7 @@ Returns the :ref:`Skeleton2D` node that the SkeletonModificati .. rst-class:: classref-method -|void| **set_modification**\ (\ mod_idx\: :ref:`int`, modification\: :ref:`SkeletonModification2D`\ ) +|void| **set_modification**\ (\ mod_idx\: :ref:`int`, modification\: :ref:`SkeletonModification2D`\ ) :ref:`🔗` Sets the modification at ``mod_idx`` to the passed-in modification, ``modification``. @@ -238,7 +238,7 @@ Sets the modification at ``mod_idx`` to the passed-in modification, ``modificati .. rst-class:: classref-method -|void| **setup**\ (\ ) +|void| **setup**\ (\ ) :ref:`🔗` Sets up the modification stack so it can execute. This function should be called by :ref:`Skeleton2D` and shouldn't be manually called unless you know what you are doing. diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst index 63104ee795c..2095f6ca5a0 100644 --- a/classes/class_skeletonmodifier3d.rst +++ b/classes/class_skeletonmodifier3d.rst @@ -66,7 +66,7 @@ Signals .. rst-class:: classref-signal -**modification_processed**\ (\ ) +**modification_processed**\ (\ ) :ref:`🔗` Notifies when the modification have been finished. @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **active** = ``true`` +:ref:`bool` **active** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ If ``true``, the **SkeletonModifier3D** will be processing. .. rst-class:: classref-property -:ref:`float` **influence** = ``1.0`` +:ref:`float` **influence** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -126,7 +126,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_process_modification**\ (\ ) |virtual| +|void| **_process_modification**\ (\ ) |virtual| :ref:`🔗` Override this virtual method to implement a custom skeleton modifier. You should do things like get the :ref:`Skeleton3D`'s current pose and apply the pose here. diff --git a/classes/class_skeletonprofile.rst b/classes/class_skeletonprofile.rst index 95864a8c079..ae02036601e 100644 --- a/classes/class_skeletonprofile.rst +++ b/classes/class_skeletonprofile.rst @@ -115,7 +115,7 @@ Signals .. rst-class:: classref-signal -**profile_updated**\ (\ ) +**profile_updated**\ (\ ) :ref:`🔗` This signal is emitted when change the value in profile. This is used to update key name in the :ref:`BoneMap` and to redraw the :ref:`BoneMap` editor. @@ -134,7 +134,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TailDirection**: +enum **TailDirection**: :ref:`🔗` .. _class_SkeletonProfile_constant_TAIL_DIRECTION_AVERAGE_CHILDREN: @@ -173,7 +173,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **bone_size** = ``0`` +:ref:`int` **bone_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ The size of elements in :ref:`BoneMap` updates when changing this .. rst-class:: classref-property -:ref:`int` **group_size** = ``0`` +:ref:`int` **group_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -211,7 +211,7 @@ This property exists to separate the bone list into several sections in the edit .. rst-class:: classref-property -:ref:`StringName` **root_bone** = ``&""`` +:ref:`StringName` **root_bone** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -228,7 +228,7 @@ A bone name that will be used as the root bone in :ref:`AnimationTree` **scale_base_bone** = ``&""`` +:ref:`StringName` **scale_base_bone** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -250,7 +250,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **find_bone**\ (\ bone_name\: :ref:`StringName`\ ) |const| +:ref:`int` **find_bone**\ (\ bone_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the bone index that matches ``bone_name`` as its name. @@ -262,7 +262,7 @@ Returns the bone index that matches ``bone_name`` as its name. .. rst-class:: classref-method -:ref:`StringName` **get_bone_name**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_bone_name**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the bone at ``bone_idx`` that will be the key name in the :ref:`BoneMap`. @@ -276,7 +276,7 @@ In the retargeting process, the returned bone name is the bone name of the targe .. rst-class:: classref-method -:ref:`StringName` **get_bone_parent**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_bone_parent**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the bone which is the parent to the bone at ``bone_idx``. The result is empty if the bone has no parent. @@ -288,7 +288,7 @@ Returns the name of the bone which is the parent to the bone at ``bone_idx``. Th .. rst-class:: classref-method -:ref:`StringName` **get_bone_tail**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_bone_tail**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the bone which is the tail of the bone at ``bone_idx``. @@ -300,7 +300,7 @@ Returns the name of the bone which is the tail of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`StringName` **get_group**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_group**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the group of the bone at ``bone_idx``. @@ -312,7 +312,7 @@ Returns the group of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`StringName` **get_group_name**\ (\ group_idx\: :ref:`int`\ ) |const| +:ref:`StringName` **get_group_name**\ (\ group_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the group at ``group_idx`` that will be the drawing group in the :ref:`BoneMap` editor. @@ -324,7 +324,7 @@ Returns the name of the group at ``group_idx`` that will be the drawing group in .. rst-class:: classref-method -:ref:`Vector2` **get_handle_offset**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_handle_offset**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the offset of the bone at ``bone_idx`` that will be the button position in the :ref:`BoneMap` editor. @@ -338,7 +338,7 @@ This is the offset with origin at the top left corner of the square. .. rst-class:: classref-method -:ref:`Transform3D` **get_reference_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_reference_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the reference pose transform for bone ``bone_idx``. @@ -350,7 +350,7 @@ Returns the reference pose transform for bone ``bone_idx``. .. rst-class:: classref-method -:ref:`TailDirection` **get_tail_direction**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`TailDirection` **get_tail_direction**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tail direction of the bone at ``bone_idx``. @@ -362,7 +362,7 @@ Returns the tail direction of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`Texture2D` **get_texture**\ (\ group_idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_texture**\ (\ group_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the texture of the group at ``group_idx`` that will be the drawing group background image in the :ref:`BoneMap` editor. @@ -374,7 +374,7 @@ Returns the texture of the group at ``group_idx`` that will be the drawing group .. rst-class:: classref-method -:ref:`bool` **is_required**\ (\ bone_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_required**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the bone at ``bone_idx`` is required for retargeting. @@ -388,7 +388,7 @@ This value is used by the bone map editor. If this method returns ``true``, and .. rst-class:: classref-method -|void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`StringName`\ ) +|void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`StringName`\ ) :ref:`🔗` Sets the name of the bone at ``bone_idx`` that will be the key name in the :ref:`BoneMap`. @@ -402,7 +402,7 @@ In the retargeting process, the setting bone name is the bone name of the target .. rst-class:: classref-method -|void| **set_bone_parent**\ (\ bone_idx\: :ref:`int`, bone_parent\: :ref:`StringName`\ ) +|void| **set_bone_parent**\ (\ bone_idx\: :ref:`int`, bone_parent\: :ref:`StringName`\ ) :ref:`🔗` Sets the bone with name ``bone_parent`` as the parent of the bone at ``bone_idx``. If an empty string is passed, then the bone has no parent. @@ -414,7 +414,7 @@ Sets the bone with name ``bone_parent`` as the parent of the bone at ``bone_idx` .. rst-class:: classref-method -|void| **set_bone_tail**\ (\ bone_idx\: :ref:`int`, bone_tail\: :ref:`StringName`\ ) +|void| **set_bone_tail**\ (\ bone_idx\: :ref:`int`, bone_tail\: :ref:`StringName`\ ) :ref:`🔗` Sets the bone with name ``bone_tail`` as the tail of the bone at ``bone_idx``. @@ -426,7 +426,7 @@ Sets the bone with name ``bone_tail`` as the tail of the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_group**\ (\ bone_idx\: :ref:`int`, group\: :ref:`StringName`\ ) +|void| **set_group**\ (\ bone_idx\: :ref:`int`, group\: :ref:`StringName`\ ) :ref:`🔗` Sets the group of the bone at ``bone_idx``. @@ -438,7 +438,7 @@ Sets the group of the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_group_name**\ (\ group_idx\: :ref:`int`, group_name\: :ref:`StringName`\ ) +|void| **set_group_name**\ (\ group_idx\: :ref:`int`, group_name\: :ref:`StringName`\ ) :ref:`🔗` Sets the name of the group at ``group_idx`` that will be the drawing group in the :ref:`BoneMap` editor. @@ -450,7 +450,7 @@ Sets the name of the group at ``group_idx`` that will be the drawing group in th .. rst-class:: classref-method -|void| **set_handle_offset**\ (\ bone_idx\: :ref:`int`, handle_offset\: :ref:`Vector2`\ ) +|void| **set_handle_offset**\ (\ bone_idx\: :ref:`int`, handle_offset\: :ref:`Vector2`\ ) :ref:`🔗` Sets the offset of the bone at ``bone_idx`` that will be the button position in the :ref:`BoneMap` editor. @@ -464,7 +464,7 @@ This is the offset with origin at the top left corner of the square. .. rst-class:: classref-method -|void| **set_reference_pose**\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`Transform3D`\ ) +|void| **set_reference_pose**\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the reference pose transform for bone ``bone_idx``. @@ -476,7 +476,7 @@ Sets the reference pose transform for bone ``bone_idx``. .. rst-class:: classref-method -|void| **set_required**\ (\ bone_idx\: :ref:`int`, required\: :ref:`bool`\ ) +|void| **set_required**\ (\ bone_idx\: :ref:`int`, required\: :ref:`bool`\ ) :ref:`🔗` Sets the required status for bone ``bone_idx`` to ``required``. @@ -488,7 +488,7 @@ Sets the required status for bone ``bone_idx`` to ``required``. .. rst-class:: classref-method -|void| **set_tail_direction**\ (\ bone_idx\: :ref:`int`, tail_direction\: :ref:`TailDirection`\ ) +|void| **set_tail_direction**\ (\ bone_idx\: :ref:`int`, tail_direction\: :ref:`TailDirection`\ ) :ref:`🔗` Sets the tail direction of the bone at ``bone_idx``. @@ -502,7 +502,7 @@ Sets the tail direction of the bone at ``bone_idx``. .. rst-class:: classref-method -|void| **set_texture**\ (\ group_idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) +|void| **set_texture**\ (\ group_idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the texture of the group at ``group_idx`` that will be the drawing group background image in the :ref:`BoneMap` editor. diff --git a/classes/class_skin.rst b/classes/class_skin.rst index b6b247932c6..9f128b34107 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_bind**\ (\ bone\: :ref:`int`, pose\: :ref:`Transform3D`\ ) +|void| **add_bind**\ (\ bone\: :ref:`int`, pose\: :ref:`Transform3D`\ ) :ref:`🔗` .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_named_bind**\ (\ name\: :ref:`String`, pose\: :ref:`Transform3D`\ ) +|void| **add_named_bind**\ (\ name\: :ref:`String`, pose\: :ref:`Transform3D`\ ) :ref:`🔗` .. container:: contribute @@ -89,7 +89,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_binds**\ (\ ) +|void| **clear_binds**\ (\ ) :ref:`🔗` .. container:: contribute @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_bind_bone**\ (\ bind_index\: :ref:`int`\ ) |const| +:ref:`int` **get_bind_bone**\ (\ bind_index\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -117,7 +117,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_bind_count**\ (\ ) |const| +:ref:`int` **get_bind_count**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -131,7 +131,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **get_bind_name**\ (\ bind_index\: :ref:`int`\ ) |const| +:ref:`StringName` **get_bind_name**\ (\ bind_index\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -145,7 +145,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **get_bind_pose**\ (\ bind_index\: :ref:`int`\ ) |const| +:ref:`Transform3D` **get_bind_pose**\ (\ bind_index\: :ref:`int`\ ) |const| :ref:`🔗` .. container:: contribute @@ -159,7 +159,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_bind_bone**\ (\ bind_index\: :ref:`int`, bone\: :ref:`int`\ ) +|void| **set_bind_bone**\ (\ bind_index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute @@ -173,7 +173,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_bind_count**\ (\ bind_count\: :ref:`int`\ ) +|void| **set_bind_count**\ (\ bind_count\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute @@ -187,7 +187,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_bind_name**\ (\ bind_index\: :ref:`int`, name\: :ref:`StringName`\ ) +|void| **set_bind_name**\ (\ bind_index\: :ref:`int`, name\: :ref:`StringName`\ ) :ref:`🔗` .. container:: contribute @@ -201,7 +201,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **set_bind_pose**\ (\ bind_index\: :ref:`int`, pose\: :ref:`Transform3D`\ ) +|void| **set_bind_pose**\ (\ bind_index\: :ref:`int`, pose\: :ref:`Transform3D`\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index 178488890ca..57379e5d441 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_skeleton**\ (\ ) |const| +:ref:`RID` **get_skeleton**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` owned by this SkinReference, as returned by :ref:`RenderingServer.skeleton_create`. @@ -68,7 +68,7 @@ Returns the :ref:`RID` owned by this SkinReference, as returned by :r .. rst-class:: classref-method -:ref:`Skin` **get_skin**\ (\ ) |const| +:ref:`Skin` **get_skin**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Skin` connected to this SkinReference. In the case of :ref:`MeshInstance3D` with no :ref:`MeshInstance3D.skin` assigned, this will reference an internal default :ref:`Skin` owned by that :ref:`MeshInstance3D`. diff --git a/classes/class_sky.rst b/classes/class_sky.rst index f5a9c55204e..a4a1ceba2d8 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **RadianceSize**: +enum **RadianceSize**: :ref:`🔗` .. _class_Sky_constant_RADIANCE_SIZE_32: @@ -124,7 +124,7 @@ Represents the size of the :ref:`RadianceSize` enum. .. rst-class:: classref-enumeration -enum **ProcessMode**: +enum **ProcessMode**: :ref:`🔗` .. _class_Sky_constant_PROCESS_MODE_AUTOMATIC: @@ -173,7 +173,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ProcessMode` **process_mode** = ``0`` +:ref:`ProcessMode` **process_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ Sets the method for generating the radiance map from the sky. The radiance map i .. rst-class:: classref-property -:ref:`RadianceSize` **radiance_size** = ``3`` +:ref:`RadianceSize` **radiance_size** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -211,7 +211,7 @@ See :ref:`RadianceSize` constants for values. .. rst-class:: classref-property -:ref:`Material` **sky_material** +:ref:`Material` **sky_material** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 0abfba2ec03..89ae4594a2a 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -86,7 +86,7 @@ Signals .. rst-class:: classref-signal -**drag_ended**\ (\ value_changed\: :ref:`bool`\ ) +**drag_ended**\ (\ value_changed\: :ref:`bool`\ ) :ref:`🔗` Emitted when dragging stops. If ``value_changed`` is true, :ref:`Range.value` is different from the value when you started the dragging. @@ -98,7 +98,7 @@ Emitted when dragging stops. If ``value_changed`` is true, :ref:`Range.value` Emitted when dragging is started. This is emitted before the corresponding :ref:`Range.value_changed` signal. @@ -115,7 +115,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **editable** = ``true`` +:ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ If ``true``, the slider can be interacted with. If ``false``, the value can be c .. rst-class:: classref-property -:ref:`bool` **scrollable** = ``true`` +:ref:`bool` **scrollable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ If ``true``, the value can be changed using the mouse wheel. .. rst-class:: classref-property -:ref:`int` **tick_count** = ``0`` +:ref:`int` **tick_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ Number of ticks displayed on the slider, including border ticks. Ticks are unifo .. rst-class:: classref-property -:ref:`bool` **ticks_on_borders** = ``false`` +:ref:`bool` **ticks_on_borders** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **center_grabber** = ``0`` +:ref:`int` **center_grabber** = ``0`` :ref:`🔗` Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position. @@ -200,7 +200,7 @@ Boolean constant. If ``1``, the grabber texture size will be ignored and it will .. rst-class:: classref-themeproperty -:ref:`int` **grabber_offset** = ``0`` +:ref:`int` **grabber_offset** = ``0`` :ref:`🔗` Vertical or horizontal offset of the grabber. @@ -212,7 +212,7 @@ Vertical or horizontal offset of the grabber. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **grabber** +:ref:`Texture2D` **grabber** :ref:`🔗` The texture for the grabber (the draggable element). @@ -224,7 +224,7 @@ The texture for the grabber (the draggable element). .. rst-class:: classref-themeproperty -:ref:`Texture2D` **grabber_disabled** +:ref:`Texture2D` **grabber_disabled** :ref:`🔗` The texture for the grabber when it's disabled. @@ -236,7 +236,7 @@ The texture for the grabber when it's disabled. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **grabber_highlight** +:ref:`Texture2D` **grabber_highlight** :ref:`🔗` The texture for the grabber when it's focused. @@ -248,7 +248,7 @@ The texture for the grabber when it's focused. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **tick** +:ref:`Texture2D` **tick** :ref:`🔗` The texture for the ticks, visible when :ref:`tick_count` is greater than 0. @@ -260,7 +260,7 @@ The texture for the ticks, visible when :ref:`tick_count` **grabber_area** +:ref:`StyleBox` **grabber_area** :ref:`🔗` The background of the area to the left or bottom of the grabber. @@ -272,7 +272,7 @@ The background of the area to the left or bottom of the grabber. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **grabber_area_highlight** +:ref:`StyleBox` **grabber_area_highlight** :ref:`🔗` The background of the area to the left or bottom of the grabber that displays when it's being hovered or focused. @@ -284,7 +284,7 @@ The background of the area to the left or bottom of the grabber that displays wh .. rst-class:: classref-themeproperty -:ref:`StyleBox` **slider** +:ref:`StyleBox` **slider** :ref:`🔗` The background for the whole slider. Affects the height or width of the :ref:`grabber_area`. diff --git a/classes/class_sliderjoint3d.rst b/classes/class_sliderjoint3d.rst index 360c9eff0ae..be0cfc2b0da 100644 --- a/classes/class_sliderjoint3d.rst +++ b/classes/class_sliderjoint3d.rst @@ -102,7 +102,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Param**: +enum **Param**: :ref:`🔗` .. _class_SliderJoint3D_constant_PARAM_LINEAR_LIMIT_UPPER: @@ -301,7 +301,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **angular_limit/damping** = ``0.0`` +:ref:`float` **angular_limit/damping** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -320,7 +320,7 @@ A lower damping value allows a rotation initiated by body A to travel to body B .. rst-class:: classref-property -:ref:`float` **angular_limit/lower_angle** = ``0.0`` +:ref:`float` **angular_limit/lower_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -337,7 +337,7 @@ The lower limit of rotation in the slider. .. rst-class:: classref-property -:ref:`float` **angular_limit/restitution** = ``0.7`` +:ref:`float` **angular_limit/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +356,7 @@ Does not affect damping. .. rst-class:: classref-property -:ref:`float` **angular_limit/softness** = ``1.0`` +:ref:`float` **angular_limit/softness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -375,7 +375,7 @@ Makes all rotation slower when between 0 and 1. .. rst-class:: classref-property -:ref:`float` **angular_limit/upper_angle** = ``0.0`` +:ref:`float` **angular_limit/upper_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -392,7 +392,7 @@ The upper limit of rotation in the slider. .. rst-class:: classref-property -:ref:`float` **angular_motion/damping** = ``1.0`` +:ref:`float` **angular_motion/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -409,7 +409,7 @@ The amount of damping of the rotation in the limits. .. rst-class:: classref-property -:ref:`float` **angular_motion/restitution** = ``0.7`` +:ref:`float` **angular_motion/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -426,7 +426,7 @@ The amount of restitution of the rotation in the limits. .. rst-class:: classref-property -:ref:`float` **angular_motion/softness** = ``1.0`` +:ref:`float` **angular_motion/softness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -443,7 +443,7 @@ A factor applied to the all rotation in the limits. .. rst-class:: classref-property -:ref:`float` **angular_ortho/damping** = ``1.0`` +:ref:`float` **angular_ortho/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -460,7 +460,7 @@ The amount of damping of the rotation across axes orthogonal to the slider. .. rst-class:: classref-property -:ref:`float` **angular_ortho/restitution** = ``0.7`` +:ref:`float` **angular_ortho/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -477,7 +477,7 @@ The amount of restitution of the rotation across axes orthogonal to the slider. .. rst-class:: classref-property -:ref:`float` **angular_ortho/softness** = ``1.0`` +:ref:`float` **angular_ortho/softness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -494,7 +494,7 @@ A factor applied to the all rotation across axes orthogonal to the slider. .. rst-class:: classref-property -:ref:`float` **linear_limit/damping** = ``1.0`` +:ref:`float` **linear_limit/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -511,7 +511,7 @@ The amount of damping that happens once the limit defined by :ref:`linear_limit/ .. rst-class:: classref-property -:ref:`float` **linear_limit/lower_distance** = ``-1.0`` +:ref:`float` **linear_limit/lower_distance** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -528,7 +528,7 @@ The minimum difference between the pivot points on their X axis before damping h .. rst-class:: classref-property -:ref:`float` **linear_limit/restitution** = ``0.7`` +:ref:`float` **linear_limit/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -545,7 +545,7 @@ The amount of restitution once the limits are surpassed. The lower, the more vel .. rst-class:: classref-property -:ref:`float` **linear_limit/softness** = ``1.0`` +:ref:`float` **linear_limit/softness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -562,7 +562,7 @@ A factor applied to the movement across the slider axis once the limits get surp .. rst-class:: classref-property -:ref:`float` **linear_limit/upper_distance** = ``1.0`` +:ref:`float` **linear_limit/upper_distance** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -579,7 +579,7 @@ The maximum difference between the pivot points on their X axis before damping h .. rst-class:: classref-property -:ref:`float` **linear_motion/damping** = ``0.0`` +:ref:`float` **linear_motion/damping** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -596,7 +596,7 @@ The amount of damping inside the slider limits. .. rst-class:: classref-property -:ref:`float` **linear_motion/restitution** = ``0.7`` +:ref:`float` **linear_motion/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -613,7 +613,7 @@ The amount of restitution inside the slider limits. .. rst-class:: classref-property -:ref:`float` **linear_motion/softness** = ``1.0`` +:ref:`float` **linear_motion/softness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -630,7 +630,7 @@ A factor applied to the movement across the slider axis as long as the slider is .. rst-class:: classref-property -:ref:`float` **linear_ortho/damping** = ``1.0`` +:ref:`float` **linear_ortho/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -647,7 +647,7 @@ The amount of damping when movement is across axes orthogonal to the slider. .. rst-class:: classref-property -:ref:`float` **linear_ortho/restitution** = ``0.7`` +:ref:`float` **linear_ortho/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -664,7 +664,7 @@ The amount of restitution when movement is across axes orthogonal to the slider. .. rst-class:: classref-property -:ref:`float` **linear_ortho/softness** = ``1.0`` +:ref:`float` **linear_ortho/softness** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -686,7 +686,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the given parameter (see :ref:`Param` constants). @@ -698,7 +698,7 @@ Returns the value of the given parameter (see :ref:`Param`, value\: :ref:`float`\ ) +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Assigns ``value`` to the given parameter (see :ref:`Param` constants). diff --git a/classes/class_softbody3d.rst b/classes/class_softbody3d.rst index 2983a198b01..7c7125e2abd 100644 --- a/classes/class_softbody3d.rst +++ b/classes/class_softbody3d.rst @@ -109,7 +109,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DisableMode**: +enum **DisableMode**: :ref:`🔗` .. _class_SoftBody3D_constant_DISABLE_MODE_REMOVE: @@ -142,7 +142,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **collision_layer** = ``1`` +:ref:`int` **collision_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ The physics layers this SoftBody3D **is in**. Collision objects can exist in one .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -180,7 +180,7 @@ The physics layers this SoftBody3D **scans**. Collision objects can scan one or .. rst-class:: classref-property -:ref:`float` **damping_coefficient** = ``0.01`` +:ref:`float` **damping_coefficient** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -197,7 +197,7 @@ The body's damping coefficient. Higher values will slow down the body more notic .. rst-class:: classref-property -:ref:`DisableMode` **disable_mode** = ``0`` +:ref:`DisableMode` **disable_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,7 +214,7 @@ Defines the behavior in physics when :ref:`Node.process_mode` **drag_coefficient** = ``0.0`` +:ref:`float` **drag_coefficient** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -233,7 +233,7 @@ The body's drag coefficient. Higher values increase this body's air resistance. .. rst-class:: classref-property -:ref:`float` **linear_stiffness** = ``0.5`` +:ref:`float` **linear_stiffness** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -250,7 +250,7 @@ Higher values will result in a stiffer body, while lower values will increase th .. rst-class:: classref-property -:ref:`NodePath` **parent_collision_ignore** = ``NodePath("")`` +:ref:`NodePath` **parent_collision_ignore** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -267,7 +267,7 @@ Higher values will result in a stiffer body, while lower values will increase th .. rst-class:: classref-property -:ref:`float` **pressure_coefficient** = ``0.0`` +:ref:`float` **pressure_coefficient** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -284,7 +284,7 @@ The pressure coefficient of this soft body. Simulate pressure build-up from insi .. rst-class:: classref-property -:ref:`bool` **ray_pickable** = ``true`` +:ref:`bool` **ray_pickable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -301,7 +301,7 @@ If ``true``, the **SoftBody3D** will respond to :ref:`RayCast3D .. rst-class:: classref-property -:ref:`int` **simulation_precision** = ``5`` +:ref:`int` **simulation_precision** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -318,7 +318,7 @@ Increasing this value will improve the resulting simulation, but can affect perf .. rst-class:: classref-property -:ref:`float` **total_mass** = ``1.0`` +:ref:`float` **total_mass** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -340,7 +340,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) +|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Adds a body to the list of bodies that this body can't collide with. @@ -352,7 +352,7 @@ Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) +:ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) :ref:`🔗` Returns an array of nodes that were added as collision exceptions for this body. @@ -364,7 +364,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -376,7 +376,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -388,7 +388,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_physics_rid**\ (\ ) |const| +:ref:`RID` **get_physics_rid**\ (\ ) |const| :ref:`🔗` Returns the internal :ref:`RID` used by the :ref:`PhysicsServer3D` for this body. @@ -400,7 +400,7 @@ Returns the internal :ref:`RID` used by the :ref:`PhysicsServer3D` **get_point_transform**\ (\ point_index\: :ref:`int`\ ) +:ref:`Vector3` **get_point_transform**\ (\ point_index\: :ref:`int`\ ) :ref:`🔗` Returns local translation of a vertex in the surface array. @@ -412,7 +412,7 @@ Returns local translation of a vertex in the surface array. .. rst-class:: classref-method -:ref:`bool` **is_point_pinned**\ (\ point_index\: :ref:`int`\ ) |const| +:ref:`bool` **is_point_pinned**\ (\ point_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if vertex is set to pinned. @@ -424,7 +424,7 @@ Returns ``true`` if vertex is set to pinned. .. rst-class:: classref-method -|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) +|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Removes a body from the list of bodies that this body can't collide with. @@ -436,7 +436,7 @@ Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-method -|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -448,7 +448,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -460,7 +460,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -|void| **set_point_pinned**\ (\ point_index\: :ref:`int`, pinned\: :ref:`bool`, attachment_path\: :ref:`NodePath` = NodePath("")\ ) +|void| **set_point_pinned**\ (\ point_index\: :ref:`int`, pinned\: :ref:`bool`, attachment_path\: :ref:`NodePath` = NodePath("")\ ) :ref:`🔗` Sets the pinned state of a surface vertex. When set to ``true``, the optional ``attachment_path`` can define a :ref:`Node3D` the pinned vertex will be attached to. diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index bf1735dfd83..fd3e36f36a0 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **height** = ``1.0`` +:ref:`float` **height** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ Full height of the sphere. .. rst-class:: classref-property -:ref:`bool` **is_hemisphere** = ``false`` +:ref:`bool` **is_hemisphere** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ If ``true``, a hemisphere is created rather than a full sphere. .. rst-class:: classref-property -:ref:`int` **radial_segments** = ``64`` +:ref:`int` **radial_segments** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ Number of radial segments on the sphere. .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -124,7 +124,7 @@ Radius of sphere. .. rst-class:: classref-property -:ref:`int` **rings** = ``32`` +:ref:`int` **rings** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_sphereoccluder3d.rst b/classes/class_sphereoccluder3d.rst index 2843f9e4ea6..936936a944e 100644 --- a/classes/class_sphereoccluder3d.rst +++ b/classes/class_sphereoccluder3d.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **radius** = ``1.0`` +:ref:`float` **radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_sphereshape3d.rst b/classes/class_sphereshape3d.rst index 3c8818a9bc0..3c0fb86bd5a 100644 --- a/classes/class_sphereshape3d.rst +++ b/classes/class_sphereshape3d.rst @@ -55,7 +55,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 0fd2246249a..fe44c94d495 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -124,7 +124,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`HorizontalAlignment` **alignment** = ``0`` +:ref:`HorizontalAlignment` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -141,7 +141,7 @@ Changes the alignment of the underlying :ref:`LineEdit`. .. rst-class:: classref-property -:ref:`float` **custom_arrow_step** = ``0.0`` +:ref:`float` **custom_arrow_step** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -158,7 +158,7 @@ If not ``0``, :ref:`Range.value` will always be roun .. rst-class:: classref-property -:ref:`bool` **editable** = ``true`` +:ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -175,7 +175,7 @@ If ``true``, the **SpinBox** will be editable. Otherwise, it will be read only. .. rst-class:: classref-property -:ref:`String` **prefix** = ``""`` +:ref:`String` **prefix** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ Adds the specified prefix string before the numerical value of the **SpinBox**. .. rst-class:: classref-property -:ref:`bool` **select_all_on_focus** = ``false`` +:ref:`bool` **select_all_on_focus** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -209,7 +209,7 @@ If ``true``, the **SpinBox** will select the whole text when the :ref:`LineEdit< .. rst-class:: classref-property -:ref:`String` **suffix** = ``""`` +:ref:`String` **suffix** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ Adds the specified suffix string after the numerical value of the **SpinBox**. .. rst-class:: classref-property -:ref:`bool` **update_on_text_changed** = ``false`` +:ref:`bool` **update_on_text_changed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -248,7 +248,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **apply**\ (\ ) +|void| **apply**\ (\ ) :ref:`🔗` Applies the current value of this **SpinBox**. @@ -260,7 +260,7 @@ Applies the current value of this **SpinBox**. .. rst-class:: classref-method -:ref:`LineEdit` **get_line_edit**\ (\ ) +:ref:`LineEdit` **get_line_edit**\ (\ ) :ref:`🔗` Returns the :ref:`LineEdit` instance from this **SpinBox**. You can use it to access properties and methods of :ref:`LineEdit`. @@ -279,7 +279,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Texture2D` **updown** +:ref:`Texture2D` **updown** :ref:`🔗` Sets a custom :ref:`Texture2D` for up and down arrows of the **SpinBox**. diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 8166de4e852..1871031539d 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -95,7 +95,7 @@ Signals .. rst-class:: classref-signal -**dragged**\ (\ offset\: :ref:`int`\ ) +**dragged**\ (\ offset\: :ref:`int`\ ) :ref:`🔗` Emitted when the dragger is dragged by user. @@ -112,7 +112,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DraggerVisibility**: +enum **DraggerVisibility**: :ref:`🔗` .. _class_SplitContainer_constant_DRAGGER_VISIBLE: @@ -151,7 +151,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collapsed** = ``false`` +:ref:`bool` **collapsed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -168,7 +168,7 @@ If ``true``, the area of the first :ref:`Control` will be collaps .. rst-class:: classref-property -:ref:`DraggerVisibility` **dragger_visibility** = ``0`` +:ref:`DraggerVisibility` **dragger_visibility** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ Determines the dragger's visibility. See :ref:`DraggerVisibility` **split_offset** = ``0`` +:ref:`int` **split_offset** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ The initial offset of the splitting between the two :ref:`Control .. rst-class:: classref-property -:ref:`bool` **vertical** = ``false`` +:ref:`bool` **vertical** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clamp_split_offset**\ (\ ) +|void| **clamp_split_offset**\ (\ ) :ref:`🔗` Clamps the :ref:`split_offset` value to not go outside the currently possible minimal and maximum values. @@ -243,7 +243,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`int` **autohide** = ``1`` +:ref:`int` **autohide** = ``1`` :ref:`🔗` Boolean value. If 1 (``true``), the grabber will hide automatically when it isn't under the cursor. If 0 (``false``), it's always visible. @@ -255,7 +255,7 @@ Boolean value. If 1 (``true``), the grabber will hide automatically when it isn' .. rst-class:: classref-themeproperty -:ref:`int` **minimum_grab_thickness** = ``6`` +:ref:`int` **minimum_grab_thickness** = ``6`` :ref:`🔗` The minimum thickness of the area users can click on to grab the splitting line. If :ref:`separation` or :ref:`h_grabber` / :ref:`v_grabber`'s thickness are too small, this ensure that the splitting line can still be dragged. @@ -267,7 +267,7 @@ The minimum thickness of the area users can click on to grab the splitting line. .. rst-class:: classref-themeproperty -:ref:`int` **separation** = ``12`` +:ref:`int` **separation** = ``12`` :ref:`🔗` The space between sides of the container. @@ -279,7 +279,7 @@ The space between sides of the container. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **grabber** +:ref:`Texture2D` **grabber** :ref:`🔗` The icon used for the grabber drawn in the middle area. @@ -291,7 +291,7 @@ The icon used for the grabber drawn in the middle area. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **h_grabber** +:ref:`Texture2D` **h_grabber** :ref:`🔗` The icon used for the grabber drawn in the middle area when :ref:`vertical` is ``false``. @@ -303,7 +303,7 @@ The icon used for the grabber drawn in the middle area when :ref:`vertical` **v_grabber** +:ref:`Texture2D` **v_grabber** :ref:`🔗` The icon used for the grabber drawn in the middle area when :ref:`vertical` is ``true``. diff --git a/classes/class_spotlight3d.rst b/classes/class_spotlight3d.rst index 92f89b7f5b8..ba97cfc0c98 100644 --- a/classes/class_spotlight3d.rst +++ b/classes/class_spotlight3d.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **spot_angle** = ``45.0`` +:ref:`float` **spot_angle** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The spotlight's angle in degrees. .. rst-class:: classref-property -:ref:`float` **spot_angle_attenuation** = ``1.0`` +:ref:`float` **spot_angle_attenuation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The spotlight's *angular* attenuation curve. See also :ref:`spot_attenuation` **spot_attenuation** = ``1.0`` +:ref:`float` **spot_attenuation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ A value of ``0.0`` smoothly attenuates light at the edge of the range. A value o .. rst-class:: classref-property -:ref:`float` **spot_range** = ``5.0`` +:ref:`float` **spot_range** = ``5.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_springarm3d.rst b/classes/class_springarm3d.rst index 7a8e1b823b9..1c204ee4b81 100644 --- a/classes/class_springarm3d.rst +++ b/classes/class_springarm3d.rst @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **collision_mask** = ``1`` +:ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -87,7 +87,7 @@ The layers against which the collision check shall be done. See `Collision layer .. rst-class:: classref-property -:ref:`float` **margin** = ``0.01`` +:ref:`float` **margin** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ This margin is useful for when the SpringArm3D has a :ref:`Camera3D` **shape** +:ref:`Shape3D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ When the shape is set, the SpringArm3D will cast the :ref:`Shape3D` **spring_length** = ``1.0`` +:ref:`float` **spring_length** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_excluded_object**\ (\ RID\: :ref:`RID`\ ) +|void| **add_excluded_object**\ (\ RID\: :ref:`RID`\ ) :ref:`🔗` Adds the :ref:`PhysicsBody3D` object with the given :ref:`RID` to the list of :ref:`PhysicsBody3D` objects excluded from the collision check. @@ -163,7 +163,7 @@ Adds the :ref:`PhysicsBody3D` object with the given :ref:`R .. rst-class:: classref-method -|void| **clear_excluded_objects**\ (\ ) +|void| **clear_excluded_objects**\ (\ ) :ref:`🔗` Clears the list of :ref:`PhysicsBody3D` objects excluded from the collision check. @@ -175,7 +175,7 @@ Clears the list of :ref:`PhysicsBody3D` objects excluded fr .. rst-class:: classref-method -:ref:`float` **get_hit_length**\ (\ ) +:ref:`float` **get_hit_length**\ (\ ) :ref:`🔗` Returns the spring arm's current length. @@ -187,7 +187,7 @@ Returns the spring arm's current length. .. rst-class:: classref-method -:ref:`bool` **remove_excluded_object**\ (\ RID\: :ref:`RID`\ ) +:ref:`bool` **remove_excluded_object**\ (\ RID\: :ref:`RID`\ ) :ref:`🔗` Removes the given :ref:`RID` from the list of :ref:`PhysicsBody3D` objects excluded from the collision check. diff --git a/classes/class_sprite2d.rst b/classes/class_sprite2d.rst index c19fa0203c0..4040bce9faa 100644 --- a/classes/class_sprite2d.rst +++ b/classes/class_sprite2d.rst @@ -89,7 +89,7 @@ Signals .. rst-class:: classref-signal -**frame_changed**\ (\ ) +**frame_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`frame` changes. @@ -101,7 +101,7 @@ Emitted when the :ref:`frame` changes. .. rst-class:: classref-signal -**texture_changed**\ (\ ) +**texture_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`texture` changes. @@ -118,7 +118,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **centered** = ``true`` +:ref:`bool` **centered** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ If ``true``, texture is centered. .. rst-class:: classref-property -:ref:`bool` **flip_h** = ``false`` +:ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property -:ref:`bool` **flip_v** = ``false`` +:ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property -:ref:`int` **frame** = ``0`` +:ref:`int` **frame** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Current frame to display from sprite sheet. :ref:`hframes` **frame_coords** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **frame_coords** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ Coordinates of the frame to display from sprite sheet. This is as an alias for t .. rst-class:: classref-property -:ref:`int` **hframes** = ``1`` +:ref:`int` **hframes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ The number of columns in the sprite sheet. When this property is changed, :ref:` .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ The texture's drawing offset. .. rst-class:: classref-property -:ref:`bool` **region_enabled** = ``false`` +:ref:`bool` **region_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -256,7 +256,7 @@ If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect` **region_filter_clip_enabled** = ``false`` +:ref:`bool` **region_filter_clip_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -273,7 +273,7 @@ If ``true``, the outermost pixels get blurred out. :ref:`region_enabled` **region_rect** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ The region of the atlas texture to display. :ref:`region_enabled` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -307,7 +307,7 @@ The region of the atlas texture to display. :ref:`region_enabled` **vframes** = ``1`` +:ref:`int` **vframes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -329,7 +329,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_rect**\ (\ ) |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Rect2` representing the Sprite2D's boundary in local coordinates. Can be used to detect if the Sprite2D was clicked. @@ -371,7 +371,7 @@ Returns a :ref:`Rect2` representing the Sprite2D's boundary in loca .. rst-class:: classref-method -:ref:`bool` **is_pixel_opaque**\ (\ pos\: :ref:`Vector2`\ ) |const| +:ref:`bool` **is_pixel_opaque**\ (\ pos\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. The position is in local coordinates. diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 437f6ad1d05..30972f22d09 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -58,7 +58,7 @@ Signals .. rst-class:: classref-signal -**frame_changed**\ (\ ) +**frame_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`frame` changes. @@ -70,7 +70,7 @@ Emitted when the :ref:`frame` changes. .. rst-class:: classref-signal -**texture_changed**\ (\ ) +**texture_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`texture` changes. @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **frame** = ``0`` +:ref:`int` **frame** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ Current frame to display from sprite sheet. :ref:`hframes` **frame_coords** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **frame_coords** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -121,7 +121,7 @@ Coordinates of the frame to display from sprite sheet. This is as an alias for t .. rst-class:: classref-property -:ref:`int` **hframes** = ``1`` +:ref:`int` **hframes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -138,7 +138,7 @@ The number of columns in the sprite sheet. When this property is changed, :ref:` .. rst-class:: classref-property -:ref:`bool` **region_enabled** = ``false`` +:ref:`bool` **region_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ If ``true``, the sprite will use :ref:`region_rect` **region_rect** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ The region of the atlas texture to display. :ref:`region_enabled` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ The region of the atlas texture to display. :ref:`region_enabled` **vframes** = ``1`` +:ref:`int` **vframes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index e60f73576c3..ff686ec8032 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -104,7 +104,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DrawFlags**: +enum **DrawFlags**: :ref:`🔗` .. _class_SpriteBase3D_constant_FLAG_TRANSPARENT: @@ -162,7 +162,7 @@ Represents the size of the :ref:`DrawFlags` enum. .. rst-class:: classref-enumeration -enum **AlphaCutMode**: +enum **AlphaCutMode**: :ref:`🔗` .. _class_SpriteBase3D_constant_ALPHA_CUT_DISABLED: @@ -209,7 +209,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **alpha_antialiasing_edge** = ``0.0`` +:ref:`float` **alpha_antialiasing_edge** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ Threshold at which antialiasing will be applied on the alpha channel. .. rst-class:: classref-property -:ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** = ``0`` +:ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -243,7 +243,7 @@ The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing` **alpha_cut** = ``0`` +:ref:`AlphaCutMode` **alpha_cut** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ The alpha cutting mode to use for the sprite. See :ref:`AlphaCutMode` **alpha_hash_scale** = ``1.0`` +:ref:`float` **alpha_hash_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. .. rst-class:: classref-property -:ref:`float` **alpha_scissor_threshold** = ``0.5`` +:ref:`float` **alpha_scissor_threshold** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -294,7 +294,7 @@ Threshold at which the alpha scissor will discard values. .. rst-class:: classref-property -Vector3.Axis **axis** = ``2`` +Vector3.Axis **axis** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -311,7 +311,7 @@ The direction in which the front of the texture faces. .. rst-class:: classref-property -:ref:`BillboardMode` **billboard** = ``0`` +:ref:`BillboardMode` **billboard** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -330,7 +330,7 @@ The billboard mode to use for the sprite. See :ref:`BillboardMode` **centered** = ``true`` +:ref:`bool` **centered** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +347,7 @@ If ``true``, texture will be centered. .. rst-class:: classref-property -:ref:`bool` **double_sided** = ``true`` +:ref:`bool` **double_sided** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -364,7 +364,7 @@ If ``true``, texture can be seen from the back as well, if ``false``, it is invi .. rst-class:: classref-property -:ref:`bool` **fixed_size** = ``false`` +:ref:`bool` **fixed_size** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -381,7 +381,7 @@ If ``true``, the label is rendered at the same size regardless of distance. .. rst-class:: classref-property -:ref:`bool` **flip_h** = ``false`` +:ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -398,7 +398,7 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property -:ref:`bool` **flip_v** = ``false`` +:ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -415,7 +415,7 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property -:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -436,7 +436,7 @@ A color value used to *multiply* the texture's colors. Can be used for mood-colo .. rst-class:: classref-property -:ref:`bool` **no_depth_test** = ``false`` +:ref:`bool` **no_depth_test** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -453,7 +453,7 @@ If ``true``, depth testing is disabled and the object will be drawn in render or .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -470,7 +470,7 @@ The texture's drawing offset. .. rst-class:: classref-property -:ref:`float` **pixel_size** = ``0.01`` +:ref:`float` **pixel_size** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -487,7 +487,7 @@ The size of one pixel's width on the sprite to scale it in 3D. .. rst-class:: classref-property -:ref:`int` **render_priority** = ``0`` +:ref:`int` **render_priority** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -508,7 +508,7 @@ Sets the render priority for the sprite. Higher priority objects will be sorted .. rst-class:: classref-property -:ref:`bool` **shaded** = ``false`` +:ref:`bool` **shaded** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -525,7 +525,7 @@ If ``true``, the :ref:`Light3D` in the :ref:`Environment` **texture_filter** = ``3`` +:ref:`TextureFilter` **texture_filter** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -544,7 +544,7 @@ Filter flags for the texture. See :ref:`TextureFilter` **transparent** = ``true`` +:ref:`bool` **transparent** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -566,7 +566,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| +:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| :ref:`🔗` Returns a :ref:`TriangleMesh` with the sprite's vertices following its current configuration (such as its :ref:`axis` and :ref:`pixel_size`). @@ -578,7 +578,7 @@ Returns a :ref:`TriangleMesh` with the sprite's vertices fol .. rst-class:: classref-method -:ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| +:ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| :ref:`🔗` Returns the value of the specified flag. @@ -590,7 +590,7 @@ Returns the value of the specified flag. .. rst-class:: classref-method -:ref:`Rect2` **get_item_rect**\ (\ ) |const| +:ref:`Rect2` **get_item_rect**\ (\ ) |const| :ref:`🔗` Returns the rectangle representing this sprite. @@ -602,7 +602,7 @@ Returns the rectangle representing this sprite. .. rst-class:: classref-method -|void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +|void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the specified flag will be enabled. See :ref:`DrawFlags` for a list of flags. diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index f4430c30a87..5476c1006e2 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -78,7 +78,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_animation**\ (\ anim\: :ref:`StringName`\ ) +|void| **add_animation**\ (\ anim\: :ref:`StringName`\ ) :ref:`🔗` Adds a new ``anim`` animation to the library. @@ -90,7 +90,7 @@ Adds a new ``anim`` animation to the library. .. rst-class:: classref-method -|void| **add_frame**\ (\ anim\: :ref:`StringName`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0, at_position\: :ref:`int` = -1\ ) +|void| **add_frame**\ (\ anim\: :ref:`StringName`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0, at_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a frame to the ``anim`` animation. If ``at_position`` is ``-1``, the frame will be added to the end of the animation. @@ -102,7 +102,7 @@ Adds a frame to the ``anim`` animation. If ``at_position`` is ``-1``, the frame .. rst-class:: classref-method -|void| **clear**\ (\ anim\: :ref:`StringName`\ ) +|void| **clear**\ (\ anim\: :ref:`StringName`\ ) :ref:`🔗` Removes all frames from the ``anim`` animation. @@ -114,7 +114,7 @@ Removes all frames from the ``anim`` animation. .. rst-class:: classref-method -|void| **clear_all**\ (\ ) +|void| **clear_all**\ (\ ) :ref:`🔗` Removes all animations. An empty ``default`` animation will be created. @@ -126,7 +126,7 @@ Removes all animations. An empty ``default`` animation will be created. .. rst-class:: classref-method -:ref:`bool` **get_animation_loop**\ (\ anim\: :ref:`StringName`\ ) |const| +:ref:`bool` **get_animation_loop**\ (\ anim\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the given animation is configured to loop when it finishes playing. Otherwise, returns ``false``. @@ -138,7 +138,7 @@ Returns ``true`` if the given animation is configured to loop when it finishes p .. rst-class:: classref-method -:ref:`PackedStringArray` **get_animation_names**\ (\ ) |const| +:ref:`PackedStringArray` **get_animation_names**\ (\ ) |const| :ref:`🔗` Returns an array containing the names associated to each animation. Values are placed in alphabetical order. @@ -150,7 +150,7 @@ Returns an array containing the names associated to each animation. Values are p .. rst-class:: classref-method -:ref:`float` **get_animation_speed**\ (\ anim\: :ref:`StringName`\ ) |const| +:ref:`float` **get_animation_speed**\ (\ anim\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the speed in frames per second for the ``anim`` animation. @@ -162,7 +162,7 @@ Returns the speed in frames per second for the ``anim`` animation. .. rst-class:: classref-method -:ref:`int` **get_frame_count**\ (\ anim\: :ref:`StringName`\ ) |const| +:ref:`int` **get_frame_count**\ (\ anim\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the number of frames for the ``anim`` animation. @@ -174,7 +174,7 @@ Returns the number of frames for the ``anim`` animation. .. rst-class:: classref-method -:ref:`float` **get_frame_duration**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| +:ref:`float` **get_frame_duration**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns a relative duration of the frame ``idx`` in the ``anim`` animation (defaults to ``1.0``). For example, a frame with a duration of ``2.0`` is displayed twice as long as a frame with a duration of ``1.0``. You can calculate the absolute duration (in seconds) of a frame using the following formula: @@ -192,7 +192,7 @@ In this example, ``playing_speed`` refers to either :ref:`AnimatedSprite2D.get_p .. rst-class:: classref-method -:ref:`Texture2D` **get_frame_texture**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_frame_texture**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the texture of the frame ``idx`` in the ``anim`` animation. @@ -204,7 +204,7 @@ Returns the texture of the frame ``idx`` in the ``anim`` animation. .. rst-class:: classref-method -:ref:`bool` **has_animation**\ (\ anim\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_animation**\ (\ anim\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the ``anim`` animation exists. @@ -216,7 +216,7 @@ Returns ``true`` if the ``anim`` animation exists. .. rst-class:: classref-method -|void| **remove_animation**\ (\ anim\: :ref:`StringName`\ ) +|void| **remove_animation**\ (\ anim\: :ref:`StringName`\ ) :ref:`🔗` Removes the ``anim`` animation. @@ -228,7 +228,7 @@ Removes the ``anim`` animation. .. rst-class:: classref-method -|void| **remove_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) +|void| **remove_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) :ref:`🔗` Removes the ``anim`` animation's frame ``idx``. @@ -240,7 +240,7 @@ Removes the ``anim`` animation's frame ``idx``. .. rst-class:: classref-method -|void| **rename_animation**\ (\ anim\: :ref:`StringName`, newname\: :ref:`StringName`\ ) +|void| **rename_animation**\ (\ anim\: :ref:`StringName`, newname\: :ref:`StringName`\ ) :ref:`🔗` Changes the ``anim`` animation's name to ``newname``. @@ -252,7 +252,7 @@ Changes the ``anim`` animation's name to ``newname``. .. rst-class:: classref-method -|void| **set_animation_loop**\ (\ anim\: :ref:`StringName`, loop\: :ref:`bool`\ ) +|void| **set_animation_loop**\ (\ anim\: :ref:`StringName`, loop\: :ref:`bool`\ ) :ref:`🔗` If ``loop`` is ``true``, the ``anim`` animation will loop when it reaches the end, or the start if it is played in reverse. @@ -264,7 +264,7 @@ If ``loop`` is ``true``, the ``anim`` animation will loop when it reaches the en .. rst-class:: classref-method -|void| **set_animation_speed**\ (\ anim\: :ref:`StringName`, fps\: :ref:`float`\ ) +|void| **set_animation_speed**\ (\ anim\: :ref:`StringName`, fps\: :ref:`float`\ ) :ref:`🔗` Sets the speed for the ``anim`` animation in frames per second. @@ -276,7 +276,7 @@ Sets the speed for the ``anim`` animation in frames per second. .. rst-class:: classref-method -|void| **set_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0\ ) +|void| **set_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0\ ) :ref:`🔗` Sets the ``texture`` and the ``duration`` of the frame ``idx`` in the ``anim`` animation. diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 30a3a5245e3..0c82395dd64 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -56,7 +56,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **constant_angular_velocity** = ``0.0`` +:ref:`float` **constant_angular_velocity** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -73,7 +73,7 @@ The body's constant angular velocity. This does not rotate the body, but affects .. rst-class:: classref-property -:ref:`Vector2` **constant_linear_velocity** = ``Vector2(0, 0)`` +:ref:`Vector2` **constant_linear_velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -90,7 +90,7 @@ The body's constant linear velocity. This does not move the body, but affects to .. rst-class:: classref-property -:ref:`PhysicsMaterial` **physics_material_override** +:ref:`PhysicsMaterial` **physics_material_override** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_staticbody3d.rst b/classes/class_staticbody3d.rst index 1ce9f0f2192..8bf936497ce 100644 --- a/classes/class_staticbody3d.rst +++ b/classes/class_staticbody3d.rst @@ -67,7 +67,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **constant_angular_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **constant_angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -84,7 +84,7 @@ The body's constant angular velocity. This does not rotate the body, but affects .. rst-class:: classref-property -:ref:`Vector3` **constant_linear_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **constant_linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ The body's constant linear velocity. This does not move the body, but affects to .. rst-class:: classref-property -:ref:`PhysicsMaterial` **physics_material_override** +:ref:`PhysicsMaterial` **physics_material_override** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_statusindicator.rst b/classes/class_statusindicator.rst index 50f751e1c68..b490a065ab7 100644 --- a/classes/class_statusindicator.rst +++ b/classes/class_statusindicator.rst @@ -62,7 +62,7 @@ Signals .. rst-class:: classref-signal -**pressed**\ (\ mouse_button\: :ref:`int`, mouse_position\: :ref:`Vector2i`\ ) +**pressed**\ (\ mouse_button\: :ref:`int`, mouse_position\: :ref:`Vector2i`\ ) :ref:`🔗` Emitted when the status indicator is pressed. @@ -79,7 +79,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture2D` **icon** +:ref:`Texture2D` **icon** :ref:`🔗` .. rst-class:: classref-property-setget @@ -96,7 +96,7 @@ Status indicator icon. .. rst-class:: classref-property -:ref:`NodePath` **menu** = ``NodePath("")`` +:ref:`NodePath` **menu** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ Status indicator native popup menu. If this is set, the :ref:`pressed` **tooltip** = ``""`` +:ref:`String` **tooltip** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ Status indicator tooltip. .. rst-class:: classref-property -:ref:`bool` **visible** = ``true`` +:ref:`bool` **visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_rect**\ (\ ) |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| :ref:`🔗` Returns the status indicator rectangle in screen coordinates. If this status indicator is not visible, returns an empty :ref:`Rect2`. diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index ed5055fca14..6b11ffd7ab3 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -122,7 +122,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **big_endian** = ``false`` +:ref:`bool` **big_endian** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_8**\ (\ ) +:ref:`int` **get_8**\ (\ ) :ref:`🔗` Gets a signed byte from the stream. @@ -156,7 +156,7 @@ Gets a signed byte from the stream. .. rst-class:: classref-method -:ref:`int` **get_16**\ (\ ) +:ref:`int` **get_16**\ (\ ) :ref:`🔗` Gets a signed 16-bit value from the stream. @@ -168,7 +168,7 @@ Gets a signed 16-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_32**\ (\ ) +:ref:`int` **get_32**\ (\ ) :ref:`🔗` Gets a signed 32-bit value from the stream. @@ -180,7 +180,7 @@ Gets a signed 32-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_64**\ (\ ) +:ref:`int` **get_64**\ (\ ) :ref:`🔗` Gets a signed 64-bit value from the stream. @@ -192,7 +192,7 @@ Gets a signed 64-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_available_bytes**\ (\ ) |const| +:ref:`int` **get_available_bytes**\ (\ ) |const| :ref:`🔗` Returns the number of bytes this **StreamPeer** has available. @@ -204,7 +204,7 @@ Returns the number of bytes this **StreamPeer** has available. .. rst-class:: classref-method -:ref:`Array` **get_data**\ (\ bytes\: :ref:`int`\ ) +:ref:`Array` **get_data**\ (\ bytes\: :ref:`int`\ ) :ref:`🔗` Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the ``bytes`` argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an :ref:`Error` code and a data array. @@ -216,7 +216,7 @@ Returns a chunk data with the received bytes. The number of bytes to be received .. rst-class:: classref-method -:ref:`float` **get_double**\ (\ ) +:ref:`float` **get_double**\ (\ ) :ref:`🔗` Gets a double-precision float from the stream. @@ -228,7 +228,7 @@ Gets a double-precision float from the stream. .. rst-class:: classref-method -:ref:`float` **get_float**\ (\ ) +:ref:`float` **get_float**\ (\ ) :ref:`🔗` Gets a single-precision float from the stream. @@ -240,7 +240,7 @@ Gets a single-precision float from the stream. .. rst-class:: classref-method -:ref:`Array` **get_partial_data**\ (\ bytes\: :ref:`int`\ ) +:ref:`Array` **get_partial_data**\ (\ bytes\: :ref:`int`\ ) :ref:`🔗` Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an :ref:`Error` code, and a data array. @@ -252,7 +252,7 @@ Returns a chunk data with the received bytes. The number of bytes to be received .. rst-class:: classref-method -:ref:`String` **get_string**\ (\ bytes\: :ref:`int` = -1\ ) +:ref:`String` **get_string**\ (\ bytes\: :ref:`int` = -1\ ) :ref:`🔗` Gets an ASCII string with byte-length ``bytes`` from the stream. If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_string`. @@ -264,7 +264,7 @@ Gets an ASCII string with byte-length ``bytes`` from the stream. If ``bytes`` is .. rst-class:: classref-method -:ref:`int` **get_u8**\ (\ ) +:ref:`int` **get_u8**\ (\ ) :ref:`🔗` Gets an unsigned byte from the stream. @@ -276,7 +276,7 @@ Gets an unsigned byte from the stream. .. rst-class:: classref-method -:ref:`int` **get_u16**\ (\ ) +:ref:`int` **get_u16**\ (\ ) :ref:`🔗` Gets an unsigned 16-bit value from the stream. @@ -288,7 +288,7 @@ Gets an unsigned 16-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_u32**\ (\ ) +:ref:`int` **get_u32**\ (\ ) :ref:`🔗` Gets an unsigned 32-bit value from the stream. @@ -300,7 +300,7 @@ Gets an unsigned 32-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_u64**\ (\ ) +:ref:`int` **get_u64**\ (\ ) :ref:`🔗` Gets an unsigned 64-bit value from the stream. @@ -312,7 +312,7 @@ Gets an unsigned 64-bit value from the stream. .. rst-class:: classref-method -:ref:`String` **get_utf8_string**\ (\ bytes\: :ref:`int` = -1\ ) +:ref:`String` **get_utf8_string**\ (\ bytes\: :ref:`int` = -1\ ) :ref:`🔗` Gets a UTF-8 string with byte-length ``bytes`` from the stream (this decodes the string sent as UTF-8). If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_utf8_string`. @@ -324,7 +324,7 @@ Gets a UTF-8 string with byte-length ``bytes`` from the stream (this decodes the .. rst-class:: classref-method -:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) +:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) :ref:`🔗` Gets a Variant from the stream. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -340,7 +340,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -|void| **put_8**\ (\ value\: :ref:`int`\ ) +|void| **put_8**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts a signed byte into the stream. @@ -352,7 +352,7 @@ Puts a signed byte into the stream. .. rst-class:: classref-method -|void| **put_16**\ (\ value\: :ref:`int`\ ) +|void| **put_16**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts a signed 16-bit value into the stream. @@ -364,7 +364,7 @@ Puts a signed 16-bit value into the stream. .. rst-class:: classref-method -|void| **put_32**\ (\ value\: :ref:`int`\ ) +|void| **put_32**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts a signed 32-bit value into the stream. @@ -376,7 +376,7 @@ Puts a signed 32-bit value into the stream. .. rst-class:: classref-method -|void| **put_64**\ (\ value\: :ref:`int`\ ) +|void| **put_64**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts a signed 64-bit value into the stream. @@ -388,7 +388,7 @@ Puts a signed 64-bit value into the stream. .. rst-class:: classref-method -:ref:`Error` **put_data**\ (\ data\: :ref:`PackedByteArray`\ ) +:ref:`Error` **put_data**\ (\ data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an :ref:`Error` code. @@ -400,7 +400,7 @@ Sends a chunk of data through the connection, blocking if necessary until the da .. rst-class:: classref-method -|void| **put_double**\ (\ value\: :ref:`float`\ ) +|void| **put_double**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Puts a double-precision float into the stream. @@ -412,7 +412,7 @@ Puts a double-precision float into the stream. .. rst-class:: classref-method -|void| **put_float**\ (\ value\: :ref:`float`\ ) +|void| **put_float**\ (\ value\: :ref:`float`\ ) :ref:`🔗` Puts a single-precision float into the stream. @@ -424,7 +424,7 @@ Puts a single-precision float into the stream. .. rst-class:: classref-method -:ref:`Array` **put_partial_data**\ (\ data\: :ref:`PackedByteArray`\ ) +:ref:`Array` **put_partial_data**\ (\ data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an :ref:`Error` code and an integer, describing how much data was actually sent. @@ -436,7 +436,7 @@ Sends a chunk of data through the connection. If all the data could not be sent .. rst-class:: classref-method -|void| **put_string**\ (\ value\: :ref:`String`\ ) +|void| **put_string**\ (\ value\: :ref:`String`\ ) :ref:`🔗` Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. @@ -463,7 +463,7 @@ Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsign .. rst-class:: classref-method -|void| **put_u8**\ (\ value\: :ref:`int`\ ) +|void| **put_u8**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts an unsigned byte into the stream. @@ -475,7 +475,7 @@ Puts an unsigned byte into the stream. .. rst-class:: classref-method -|void| **put_u16**\ (\ value\: :ref:`int`\ ) +|void| **put_u16**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts an unsigned 16-bit value into the stream. @@ -487,7 +487,7 @@ Puts an unsigned 16-bit value into the stream. .. rst-class:: classref-method -|void| **put_u32**\ (\ value\: :ref:`int`\ ) +|void| **put_u32**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts an unsigned 32-bit value into the stream. @@ -499,7 +499,7 @@ Puts an unsigned 32-bit value into the stream. .. rst-class:: classref-method -|void| **put_u64**\ (\ value\: :ref:`int`\ ) +|void| **put_u64**\ (\ value\: :ref:`int`\ ) :ref:`🔗` Puts an unsigned 64-bit value into the stream. @@ -511,7 +511,7 @@ Puts an unsigned 64-bit value into the stream. .. rst-class:: classref-method -|void| **put_utf8_string**\ (\ value\: :ref:`String`\ ) +|void| **put_utf8_string**\ (\ value\: :ref:`String`\ ) :ref:`🔗` Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. @@ -538,7 +538,7 @@ Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsig .. rst-class:: classref-method -|void| **put_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) +|void| **put_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) :ref:`🔗` Puts a Variant into the stream. If ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index c4b6388e540..909083fa8a7 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -70,7 +70,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedByteArray` **data_array** = ``PackedByteArray()`` +:ref:`PackedByteArray` **data_array** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -94,7 +94,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the :ref:`data_array` and resets the cursor. @@ -106,7 +106,7 @@ Clears the :ref:`data_array` and res .. rst-class:: classref-method -:ref:`StreamPeerBuffer` **duplicate**\ (\ ) |const| +:ref:`StreamPeerBuffer` **duplicate**\ (\ ) |const| :ref:`🔗` Returns a new **StreamPeerBuffer** with the same :ref:`data_array` content. @@ -118,7 +118,7 @@ Returns a new **StreamPeerBuffer** with the same :ref:`data_array` **get_position**\ (\ ) |const| +:ref:`int` **get_position**\ (\ ) |const| :ref:`🔗` Returns the current cursor position. @@ -130,7 +130,7 @@ Returns the current cursor position. .. rst-class:: classref-method -:ref:`int` **get_size**\ (\ ) |const| +:ref:`int` **get_size**\ (\ ) |const| :ref:`🔗` Returns the size of :ref:`data_array`. @@ -142,7 +142,7 @@ Returns the size of :ref:`data_array .. rst-class:: classref-method -|void| **resize**\ (\ size\: :ref:`int`\ ) +|void| **resize**\ (\ size\: :ref:`int`\ ) :ref:`🔗` Resizes the :ref:`data_array`. This *doesn't* update the cursor. @@ -154,7 +154,7 @@ Resizes the :ref:`data_array`. This .. rst-class:: classref-method -|void| **seek**\ (\ position\: :ref:`int`\ ) +|void| **seek**\ (\ position\: :ref:`int`\ ) :ref:`🔗` Moves the cursor to the specified position. ``position`` must be a valid index of :ref:`data_array`. diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 2233bf51cc9..80012860d00 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -49,7 +49,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_available_bytes**\ (\ ) |virtual| |const| +:ref:`int` **_get_available_bytes**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -63,7 +63,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_data**\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_get_data**\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -77,7 +77,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_partial_data**\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_get_partial_data**\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -91,7 +91,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_data**\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_put_data**\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -105,7 +105,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_partial_data**\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_put_partial_data**\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute diff --git a/classes/class_streampeergzip.rst b/classes/class_streampeergzip.rst index 880f22d7f69..853765553ea 100644 --- a/classes/class_streampeergzip.rst +++ b/classes/class_streampeergzip.rst @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears this stream, resetting the internal state. @@ -68,7 +68,7 @@ Clears this stream, resetting the internal state. .. rst-class:: classref-method -:ref:`Error` **finish**\ (\ ) +:ref:`Error` **finish**\ (\ ) :ref:`🔗` Finalizes the stream, compressing or decompressing any buffered chunk left. @@ -80,7 +80,7 @@ Finalizes the stream, compressing or decompressing any buffered chunk left. .. rst-class:: classref-method -:ref:`Error` **start_compression**\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) +:ref:`Error` **start_compression**\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) :ref:`🔗` Start the stream in compression mode with the given ``buffer_size``, if ``use_deflate`` is ``true`` uses deflate instead of GZIP. @@ -92,7 +92,7 @@ Start the stream in compression mode with the given ``buffer_size``, if ``use_de .. rst-class:: classref-method -:ref:`Error` **start_decompression**\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) +:ref:`Error` **start_decompression**\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) :ref:`🔗` Start the stream in decompression mode with the given ``buffer_size``, if ``use_deflate`` is ``true`` uses deflate instead of GZIP. diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 5b68b692be0..eb67657b1b7 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -64,7 +64,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Status**: +enum **Status**: :ref:`🔗` .. _class_StreamPeerTCP_constant_STATUS_NONE: @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **bind**\ (\ port\: :ref:`int`, host\: :ref:`String` = "*"\ ) +:ref:`Error` **bind**\ (\ port\: :ref:`int`, host\: :ref:`String` = "*"\ ) :ref:`🔗` Opens the TCP socket, and binds it to the specified local address. @@ -125,7 +125,7 @@ This method is generally not needed, and only used to force the subsequent call .. rst-class:: classref-method -:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) +:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Connects to the specified ``host:port`` pair. A hostname will be resolved if valid. Returns :ref:`@GlobalScope.OK` on success. @@ -137,7 +137,7 @@ Connects to the specified ``host:port`` pair. A hostname will be resolved if val .. rst-class:: classref-method -|void| **disconnect_from_host**\ (\ ) +|void| **disconnect_from_host**\ (\ ) :ref:`🔗` Disconnects from host. @@ -149,7 +149,7 @@ Disconnects from host. .. rst-class:: classref-method -:ref:`String` **get_connected_host**\ (\ ) |const| +:ref:`String` **get_connected_host**\ (\ ) |const| :ref:`🔗` Returns the IP of this peer. @@ -161,7 +161,7 @@ Returns the IP of this peer. .. rst-class:: classref-method -:ref:`int` **get_connected_port**\ (\ ) |const| +:ref:`int` **get_connected_port**\ (\ ) |const| :ref:`🔗` Returns the port of this peer. @@ -173,7 +173,7 @@ Returns the port of this peer. .. rst-class:: classref-method -:ref:`int` **get_local_port**\ (\ ) |const| +:ref:`int` **get_local_port**\ (\ ) |const| :ref:`🔗` Returns the local port to which this peer is bound. @@ -185,7 +185,7 @@ Returns the local port to which this peer is bound. .. rst-class:: classref-method -:ref:`Status` **get_status**\ (\ ) |const| +:ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` Returns the status of the connection, see :ref:`Status`. @@ -197,7 +197,7 @@ Returns the status of the connection, see :ref:`Status` **poll**\ (\ ) +:ref:`Error` **poll**\ (\ ) :ref:`🔗` Poll the socket, updating its state. See :ref:`get_status`. @@ -209,7 +209,7 @@ Poll the socket, updating its state. See :ref:`get_status`\ ) +|void| **set_no_delay**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, packets will be sent immediately. If ``enabled`` is ``false`` (the default), packet transfers will be delayed and combined using `Nagle's algorithm `__. diff --git a/classes/class_streampeertls.rst b/classes/class_streampeertls.rst index eb578c3cd46..7d3b3f1a25c 100644 --- a/classes/class_streampeertls.rst +++ b/classes/class_streampeertls.rst @@ -65,7 +65,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Status**: +enum **Status**: :ref:`🔗` .. _class_StreamPeerTLS_constant_STATUS_DISCONNECTED: @@ -120,7 +120,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **accept_stream**\ (\ stream\: :ref:`StreamPeer`, server_options\: :ref:`TLSOptions`\ ) +:ref:`Error` **accept_stream**\ (\ stream\: :ref:`StreamPeer`, server_options\: :ref:`TLSOptions`\ ) :ref:`🔗` Accepts a peer connection as a server using the given ``server_options``. See :ref:`TLSOptions.server`. @@ -132,7 +132,7 @@ Accepts a peer connection as a server using the given ``server_options``. See :r .. rst-class:: classref-method -:ref:`Error` **connect_to_stream**\ (\ stream\: :ref:`StreamPeer`, common_name\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **connect_to_stream**\ (\ stream\: :ref:`StreamPeer`, common_name\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Connects to a peer using an underlying :ref:`StreamPeer` ``stream`` and verifying the remote certificate is correctly signed for the given ``common_name``. You can pass the optional ``client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -144,7 +144,7 @@ Connects to a peer using an underlying :ref:`StreamPeer` ``str .. rst-class:: classref-method -|void| **disconnect_from_stream**\ (\ ) +|void| **disconnect_from_stream**\ (\ ) :ref:`🔗` Disconnects from host. @@ -156,7 +156,7 @@ Disconnects from host. .. rst-class:: classref-method -:ref:`Status` **get_status**\ (\ ) |const| +:ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` Returns the status of the connection. See :ref:`Status` for values. @@ -168,7 +168,7 @@ Returns the status of the connection. See :ref:`Status` **get_stream**\ (\ ) |const| +:ref:`StreamPeer` **get_stream**\ (\ ) |const| :ref:`🔗` Returns the underlying :ref:`StreamPeer` connection, used in :ref:`accept_stream` or :ref:`connect_to_stream`. @@ -180,7 +180,7 @@ Returns the underlying :ref:`StreamPeer` connection, used in : .. rst-class:: classref-method -|void| **poll**\ (\ ) +|void| **poll**\ (\ ) :ref:`🔗` Poll the connection to check for incoming bytes. Call this right before :ref:`StreamPeer.get_available_bytes` for it to work properly. diff --git a/classes/class_string.rst b/classes/class_string.rst index c372308bf98..c9e175f5fc5 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -323,7 +323,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`String` **String**\ (\ ) +:ref:`String` **String**\ (\ ) :ref:`🔗` Constructs an empty **String** (``""``). @@ -370,7 +370,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **begins_with**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **begins_with**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string begins with the given ``text``. See also :ref:`ends_with`. @@ -382,7 +382,7 @@ Returns ``true`` if the string begins with the given ``text``. See also :ref:`en .. rst-class:: classref-method -:ref:`PackedStringArray` **bigrams**\ (\ ) |const| +:ref:`PackedStringArray` **bigrams**\ (\ ) |const| :ref:`🔗` Returns an array containing the bigrams (pairs of consecutive characters) of this string. @@ -398,7 +398,7 @@ Returns an array containing the bigrams (pairs of consecutive characters) of thi .. rst-class:: classref-method -:ref:`int` **bin_to_int**\ (\ ) |const| +:ref:`int` **bin_to_int**\ (\ ) |const| :ref:`🔗` Converts the string representing a binary number into an :ref:`int`. The string may optionally be prefixed with ``"0b"``, and an additional ``-`` prefix for negative numbers. @@ -427,7 +427,7 @@ Converts the string representing a binary number into an :ref:`int`. .. rst-class:: classref-method -:ref:`String` **c_escape**\ (\ ) |const| +:ref:`String` **c_escape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with special characters escaped using the C language standard. @@ -439,7 +439,7 @@ Returns a copy of the string with special characters escaped using the C languag .. rst-class:: classref-method -:ref:`String` **c_unescape**\ (\ ) |const| +:ref:`String` **c_unescape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``. @@ -453,7 +453,7 @@ Returns a copy of the string with escaped characters replaced by their meanings. .. rst-class:: classref-method -:ref:`String` **capitalize**\ (\ ) |const| +:ref:`String` **capitalize**\ (\ ) |const| :ref:`🔗` Changes the appearance of the string: replaces underscores (``_``) with spaces, adds spaces before uppercase letters in the middle of a word, converts all letters to lowercase, then converts the first one and each one following a space to uppercase. @@ -482,7 +482,7 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, .. rst-class:: classref-method -:ref:`int` **casecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **casecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" and "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -498,7 +498,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`String` **chr**\ (\ char\: :ref:`int`\ ) |static| +:ref:`String` **chr**\ (\ char\: :ref:`int`\ ) |static| :ref:`🔗` Returns a single Unicode character from the decimal ``char``. You may use `unicodelookup.com `__ or `unicode.org `__ as points of reference. @@ -515,7 +515,7 @@ Returns a single Unicode character from the decimal ``char``. You may use `unico .. rst-class:: classref-method -:ref:`bool` **contains**\ (\ what\: :ref:`String`\ ) |const| +:ref:`bool` **contains**\ (\ what\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string contains ``what``. In GDScript, this corresponds to the ``in`` operator. @@ -545,7 +545,7 @@ If you need to know where ``what`` is within the string, use :ref:`find` **containsn**\ (\ what\: :ref:`String`\ ) |const| +:ref:`bool` **containsn**\ (\ what\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string contains ``what``, **ignoring case**. @@ -559,7 +559,7 @@ If you need to know where ``what`` is within the string, use :ref:`findn` **count**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| +:ref:`int` **count**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions. If ``to`` is 0, the search continues until the end of the string. @@ -571,7 +571,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`int` **countn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| +:ref:`int` **countn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions, **ignoring case**. If ``to`` is 0, the search continues until the end of the string. @@ -583,7 +583,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`String` **dedent**\ (\ ) |const| +:ref:`String` **dedent**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with indentation (leading tabs and spaces) removed. See also :ref:`indent` to add indentation. @@ -595,7 +595,7 @@ Returns a copy of the string with indentation (leading tabs and spaces) removed. .. rst-class:: classref-method -:ref:`bool` **ends_with**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **ends_with**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string ends with the given ``text``. See also :ref:`begins_with`. @@ -607,7 +607,7 @@ Returns ``true`` if the string ends with the given ``text``. See also :ref:`begi .. rst-class:: classref-method -:ref:`String` **erase**\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| +:ref:`String` **erase**\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| :ref:`🔗` Returns a string with ``chars`` characters erased starting from ``position``. If ``chars`` goes beyond the string's length given the specified ``position``, fewer characters will be erased from the returned string. Returns an empty string if either ``position`` or ``chars`` is negative. Returns the original string unmodified if ``chars`` is ``0``. @@ -619,7 +619,7 @@ Returns a string with ``chars`` characters erased starting from ``position``. If .. rst-class:: classref-method -:ref:`int` **filecasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **filecasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Like :ref:`naturalcasecmp_to` but prioritizes strings that begin with periods (``.``) and underscores (``_``) before any other character. Useful when sorting folders or file names. @@ -633,7 +633,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **filenocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **filenocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Like :ref:`naturalnocasecmp_to` but prioritizes strings that begin with periods (``.``) and underscores (``_``) before any other character. Useful when sorting folders or file names. @@ -647,7 +647,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **find**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the index of the **first** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the end of the string. @@ -682,7 +682,7 @@ Returns the index of the **first** occurrence of ``what`` in this string, or ``- .. rst-class:: classref-method -:ref:`int` **findn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **findn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the index of the **first** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the end of the string. @@ -694,7 +694,7 @@ Returns the index of the **first** **case-insensitive** occurrence of ``what`` i .. rst-class:: classref-method -:ref:`String` **format**\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| +:ref:`String` **format**\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| :ref:`🔗` Formats the string by replacing all occurrences of ``placeholder`` with the elements of ``values``. @@ -738,7 +738,7 @@ See also the :doc:`GDScript format string <../tutorials/scripting/gdscript/gdscr .. rst-class:: classref-method -:ref:`String` **get_base_dir**\ (\ ) |const| +:ref:`String` **get_base_dir**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, returns the base directory name. @@ -754,7 +754,7 @@ If the string is a valid file path, returns the base directory name. .. rst-class:: classref-method -:ref:`String` **get_basename**\ (\ ) |const| +:ref:`String` **get_basename**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, returns the full file path, without the extension. @@ -770,7 +770,7 @@ If the string is a valid file path, returns the full file path, without the exte .. rst-class:: classref-method -:ref:`String` **get_extension**\ (\ ) |const| +:ref:`String` **get_extension**\ (\ ) |const| :ref:`🔗` If the string is a valid file name or path, returns the file extension without the leading period (``.``). Otherwise, returns an empty string. @@ -794,7 +794,7 @@ If the string is a valid file name or path, returns the file extension without t .. rst-class:: classref-method -:ref:`String` **get_file**\ (\ ) |const| +:ref:`String` **get_file**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, returns the file name, including the extension. @@ -810,7 +810,7 @@ If the string is a valid file path, returns the file name, including the extensi .. rst-class:: classref-method -:ref:`String` **get_slice**\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| +:ref:`String` **get_slice**\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| :ref:`🔗` Splits the string using a ``delimiter`` and returns the substring at index ``slice``. Returns the original string if ``delimiter`` does not occur in the string. Returns an empty string if the ``slice`` does not exist. @@ -830,7 +830,7 @@ This is faster than :ref:`split`, if you only need on .. rst-class:: classref-method -:ref:`int` **get_slice_count**\ (\ delimiter\: :ref:`String`\ ) |const| +:ref:`int` **get_slice_count**\ (\ delimiter\: :ref:`String`\ ) |const| :ref:`🔗` Returns the total number of slices when the string is split with the given ``delimiter`` (see :ref:`split`). @@ -842,7 +842,7 @@ Returns the total number of slices when the string is split with the given ``del .. rst-class:: classref-method -:ref:`String` **get_slicec**\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| +:ref:`String` **get_slicec**\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| :ref:`🔗` Splits the string using a Unicode character with code ``delimiter`` and returns the substring at index ``slice``. Returns an empty string if the ``slice`` does not exist. @@ -856,7 +856,7 @@ This is faster than :ref:`split`, if you only need on .. rst-class:: classref-method -:ref:`int` **hash**\ (\ ) |const| +:ref:`int` **hash**\ (\ ) |const| :ref:`🔗` Returns the 32-bit hash value representing the string's contents. @@ -870,7 +870,7 @@ Returns the 32-bit hash value representing the string's contents. .. rst-class:: classref-method -:ref:`PackedByteArray` **hex_decode**\ (\ ) |const| +:ref:`PackedByteArray` **hex_decode**\ (\ ) |const| :ref:`🔗` Decodes a hexadecimal string as a :ref:`PackedByteArray`. @@ -899,7 +899,7 @@ Decodes a hexadecimal string as a :ref:`PackedByteArray`. .. rst-class:: classref-method -:ref:`int` **hex_to_int**\ (\ ) |const| +:ref:`int` **hex_to_int**\ (\ ) |const| :ref:`🔗` Converts the string representing a hexadecimal number into an :ref:`int`. The string may be optionally prefixed with ``"0x"``, and an additional ``-`` prefix for negative numbers. @@ -926,7 +926,7 @@ Converts the string representing a hexadecimal number into an :ref:`int` **humanize_size**\ (\ size\: :ref:`int`\ ) |static| +:ref:`String` **humanize_size**\ (\ size\: :ref:`int`\ ) |static| :ref:`🔗` Converts ``size`` which represents a number of bytes into a human-readable form. @@ -940,7 +940,7 @@ The result is in `IEC prefix format ` **indent**\ (\ prefix\: :ref:`String`\ ) |const| +:ref:`String` **indent**\ (\ prefix\: :ref:`String`\ ) |const| :ref:`🔗` Indents every line of the string with the given ``prefix``. Empty lines are not indented. See also :ref:`dedent` to remove indentation. @@ -954,7 +954,7 @@ For example, the string can be indented with two tabulations using ``"\t\t"``, o .. rst-class:: classref-method -:ref:`String` **insert**\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| +:ref:`String` **insert**\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| :ref:`🔗` Inserts ``what`` at the given ``position`` in the string. @@ -966,7 +966,7 @@ Inserts ``what`` at the given ``position`` in the string. .. rst-class:: classref-method -:ref:`bool` **is_absolute_path**\ (\ ) |const| +:ref:`bool` **is_absolute_path**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the string is a path to a file or directory, and its starting point is explicitly defined. This method is the opposite of :ref:`is_relative_path`. @@ -980,7 +980,7 @@ This includes all paths starting with ``"res://"``, ``"user://"``, ``"C:\"``, `` .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length`. @@ -992,7 +992,7 @@ Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length .. rst-class:: classref-method -:ref:`bool` **is_relative_path**\ (\ ) |const| +:ref:`bool` **is_relative_path**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the string is a path, and its starting point is dependent on context. The path could begin from the current directory, or the current :ref:`Node` (if the string is derived from a :ref:`NodePath`), and may sometimes be prefixed with ``"./"``. This method is the opposite of :ref:`is_absolute_path`. @@ -1004,7 +1004,7 @@ Returns ``true`` if the string is a path, and its starting point is dependent on .. rst-class:: classref-method -:ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if all characters of this string can be found in ``text`` in their original order. @@ -1025,7 +1025,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**. @@ -1037,7 +1037,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_valid_filename**\ (\ ) |const| +:ref:`bool` **is_valid_filename**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string does not contain characters that are not allowed in file names (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). @@ -1049,7 +1049,7 @@ Returns ``true`` if this string does not contain characters that are not allowed .. rst-class:: classref-method -:ref:`bool` **is_valid_float**\ (\ ) |const| +:ref:`bool` **is_valid_float**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string represents a valid floating-point number. A valid float may contain only digits, one decimal point (``.``), and the exponent letter (``e``). It may also be prefixed with a positive (``+``) or negative (``-``) sign. Any valid integer is also a valid float (see :ref:`is_valid_int`). See also :ref:`to_float`. @@ -1068,7 +1068,7 @@ Returns ``true`` if this string represents a valid floating-point number. A vali .. rst-class:: classref-method -:ref:`bool` **is_valid_hex_number**\ (\ with_prefix\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_valid_hex_number**\ (\ with_prefix\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if this string is a valid hexadecimal number. A valid hexadecimal number only contains digits or letters ``A`` to ``F`` (either uppercase or lowercase), and may be prefixed with a positive (``+``) or negative (``-``) sign. @@ -1090,7 +1090,7 @@ If ``with_prefix`` is ``true``, the hexadecimal number needs to prefixed by ``"0 .. rst-class:: classref-method -:ref:`bool` **is_valid_html_color**\ (\ ) |const| +:ref:`bool` **is_valid_html_color**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string is a valid color in hexadecimal HTML notation. The string must be a hexadecimal value (see :ref:`is_valid_hex_number`) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). Other HTML notations for colors, such as names or ``hsl()``, are not considered valid. See also :ref:`Color.html`. @@ -1102,7 +1102,7 @@ Returns ``true`` if this string is a valid color in hexadecimal HTML notation. T .. rst-class:: classref-method -:ref:`bool` **is_valid_identifier**\ (\ ) |const| +:ref:`bool` **is_valid_identifier**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``), and the first character may not be a digit. @@ -1121,7 +1121,7 @@ Returns ``true`` if this string is a valid identifier. A valid identifier may co .. rst-class:: classref-method -:ref:`bool` **is_valid_int**\ (\ ) |const| +:ref:`bool` **is_valid_int**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string represents a valid integer. A valid integer only contains digits, and may be prefixed with a positive (``+``) or negative (``-``) sign. See also :ref:`to_int`. @@ -1141,7 +1141,7 @@ Returns ``true`` if this string represents a valid integer. A valid integer only .. rst-class:: classref-method -:ref:`bool` **is_valid_ip_address**\ (\ ) |const| +:ref:`bool` **is_valid_ip_address**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address. This method considers `reserved IP addresses `__ such as ``"0.0.0.0"`` and ``"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"`` as valid. @@ -1153,7 +1153,7 @@ Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address .. rst-class:: classref-method -:ref:`String` **join**\ (\ parts\: :ref:`PackedStringArray`\ ) |const| +:ref:`String` **join**\ (\ parts\: :ref:`PackedStringArray`\ ) |const| :ref:`🔗` Returns the concatenation of ``parts``' elements, with each element separated by the string calling this method. This method is the opposite of :ref:`split`. @@ -1187,7 +1187,7 @@ Returns the concatenation of ``parts``' elements, with each element separated by .. rst-class:: classref-method -:ref:`String` **json_escape**\ (\ ) |const| +:ref:`String` **json_escape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with special characters escaped using the JSON standard. Because it closely matches the C standard, it is possible to use :ref:`c_unescape` to unescape the string, if necessary. @@ -1199,7 +1199,7 @@ Returns a copy of the string with special characters escaped using the JSON stan .. rst-class:: classref-method -:ref:`String` **left**\ (\ length\: :ref:`int`\ ) |const| +:ref:`String` **left**\ (\ length\: :ref:`int`\ ) |const| :ref:`🔗` Returns the first ``length`` characters from the beginning of the string. If ``length`` is negative, strips the last ``length`` characters from the string's end. @@ -1216,7 +1216,7 @@ Returns the first ``length`` characters from the beginning of the string. If ``l .. rst-class:: classref-method -:ref:`int` **length**\ (\ ) |const| +:ref:`int` **length**\ (\ ) |const| :ref:`🔗` Returns the number of characters in the string. Empty strings (``""``) always return ``0``. See also :ref:`is_empty`. @@ -1228,7 +1228,7 @@ Returns the number of characters in the string. Empty strings (``""``) always re .. rst-class:: classref-method -:ref:`String` **lpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| +:ref:`String` **lpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| :ref:`🔗` Formats the string to be at least ``min_length`` long by adding ``character``\ s to the left of the string, if necessary. See also :ref:`rpad`. @@ -1240,7 +1240,7 @@ Formats the string to be at least ``min_length`` long by adding ``character``\ s .. rst-class:: classref-method -:ref:`String` **lstrip**\ (\ chars\: :ref:`String`\ ) |const| +:ref:`String` **lstrip**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` Removes a set of characters defined in ``chars`` from the string's beginning. See also :ref:`rstrip`. @@ -1254,7 +1254,7 @@ Removes a set of characters defined in ``chars`` from the string's beginning. Se .. rst-class:: classref-method -:ref:`bool` **match**\ (\ expr\: :ref:`String`\ ) |const| +:ref:`bool` **match**\ (\ expr\: :ref:`String`\ ) |const| :ref:`🔗` Does a simple expression match (also called "glob" or "globbing"), where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1266,7 +1266,7 @@ Does a simple expression match (also called "glob" or "globbing"), where ``*`` m .. rst-class:: classref-method -:ref:`bool` **matchn**\ (\ expr\: :ref:`String`\ ) |const| +:ref:`bool` **matchn**\ (\ expr\: :ref:`String`\ ) |const| :ref:`🔗` Does a simple **case-insensitive** expression match, where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1278,7 +1278,7 @@ Does a simple **case-insensitive** expression match, where ``*`` matches zero or .. rst-class:: classref-method -:ref:`PackedByteArray` **md5_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **md5_buffer**\ (\ ) |const| :ref:`🔗` Returns the `MD5 hash `__ of the string as a :ref:`PackedByteArray`. @@ -1290,7 +1290,7 @@ Returns the `MD5 hash `__ of the string as a .. rst-class:: classref-method -:ref:`String` **md5_text**\ (\ ) |const| +:ref:`String` **md5_text**\ (\ ) |const| :ref:`🔗` Returns the `MD5 hash `__ of the string as another **String**. @@ -1302,7 +1302,7 @@ Returns the `MD5 hash `__ of the string as an .. rst-class:: classref-method -:ref:`int` **naturalcasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **naturalcasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a **case-sensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -1320,7 +1320,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **naturalnocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **naturalnocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a **case-insensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1338,7 +1338,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **nocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **nocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a **case-insensitive** comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1354,7 +1354,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`String` **num**\ (\ number\: :ref:`float`, decimals\: :ref:`int` = -1\ ) |static| +:ref:`String` **num**\ (\ number\: :ref:`float`, decimals\: :ref:`int` = -1\ ) |static| :ref:`🔗` Converts a :ref:`float` to a string representation of a decimal number, with the number of decimal places specified in ``decimals``. @@ -1386,7 +1386,7 @@ Trailing zeros are not included in the string. The last digit is rounded, not tr .. rst-class:: classref-method -:ref:`String` **num_int64**\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| +:ref:`String` **num_int64**\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| :ref:`🔗` Converts the given ``number`` to a string representation, with the given ``base``. @@ -1402,7 +1402,7 @@ If ``capitalize_hex`` is ``true``, digits higher than 9 are represented in upper .. rst-class:: classref-method -:ref:`String` **num_scientific**\ (\ number\: :ref:`float`\ ) |static| +:ref:`String` **num_scientific**\ (\ number\: :ref:`float`\ ) |static| :ref:`🔗` Converts the given ``number`` to a string representation, in scientific notation. @@ -1435,7 +1435,7 @@ Converts the given ``number`` to a string representation, in scientific notation .. rst-class:: classref-method -:ref:`String` **num_uint64**\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| +:ref:`String` **num_uint64**\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| :ref:`🔗` Converts the given unsigned :ref:`int` to a string representation, with the given ``base``. @@ -1451,7 +1451,7 @@ If ``capitalize_hex`` is ``true``, digits higher than 9 are represented in upper .. rst-class:: classref-method -:ref:`String` **pad_decimals**\ (\ digits\: :ref:`int`\ ) |const| +:ref:`String` **pad_decimals**\ (\ digits\: :ref:`int`\ ) |const| :ref:`🔗` Formats the string representing a number to have an exact number of ``digits`` *after* the decimal point. @@ -1463,7 +1463,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **pad_zeros**\ (\ digits\: :ref:`int`\ ) |const| +:ref:`String` **pad_zeros**\ (\ digits\: :ref:`int`\ ) |const| :ref:`🔗` Formats the string representing a number to have an exact number of ``digits`` *before* the decimal point. @@ -1475,7 +1475,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| +:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| :ref:`🔗` Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if necessary. @@ -1489,7 +1489,7 @@ Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if nec .. rst-class:: classref-method -:ref:`String` **repeat**\ (\ count\: :ref:`int`\ ) |const| +:ref:`String` **repeat**\ (\ count\: :ref:`int`\ ) |const| :ref:`🔗` Repeats this string a number of times. ``count`` needs to be greater than ``0``. Otherwise, returns an empty string. @@ -1501,7 +1501,7 @@ Repeats this string a number of times. ``count`` needs to be greater than ``0``. .. rst-class:: classref-method -:ref:`String` **replace**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| +:ref:`String` **replace**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| :ref:`🔗` Replaces all occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1513,7 +1513,7 @@ Replaces all occurrences of ``what`` inside the string with the given ``forwhat` .. rst-class:: classref-method -:ref:`String` **replacen**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| +:ref:`String` **replacen**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| :ref:`🔗` Replaces all **case-insensitive** occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1525,7 +1525,7 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with .. rst-class:: classref-method -:ref:`String` **reverse**\ (\ ) |const| +:ref:`String` **reverse**\ (\ ) |const| :ref:`🔗` Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis. @@ -1537,7 +1537,7 @@ Returns the copy of this string in reverse order. This operation works on unicod .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the index of the **last** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`find`. @@ -1549,7 +1549,7 @@ Returns the index of the **last** occurrence of ``what`` in this string, or ``-1 .. rst-class:: classref-method -:ref:`int` **rfindn**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfindn**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the index of the **last** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`findn`. @@ -1561,7 +1561,7 @@ Returns the index of the **last** **case-insensitive** occurrence of ``what`` in .. rst-class:: classref-method -:ref:`String` **right**\ (\ length\: :ref:`int`\ ) |const| +:ref:`String` **right**\ (\ length\: :ref:`int`\ ) |const| :ref:`🔗` Returns the last ``length`` characters from the end of the string. If ``length`` is negative, strips the first ``length`` characters from the string's beginning. @@ -1578,7 +1578,7 @@ Returns the last ``length`` characters from the end of the string. If ``length`` .. rst-class:: classref-method -:ref:`String` **rpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| +:ref:`String` **rpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| :ref:`🔗` Formats the string to be at least ``min_length`` long, by adding ``character``\ s to the right of the string, if necessary. See also :ref:`lpad`. @@ -1590,7 +1590,7 @@ Formats the string to be at least ``min_length`` long, by adding ``character``\ .. rst-class:: classref-method -:ref:`PackedStringArray` **rsplit**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| +:ref:`PackedStringArray` **rsplit**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| :ref:`🔗` Splits the string using a ``delimiter`` and returns an array of the substrings, starting from the end of the string. The splits in the returned array appear in the same order as the original string. If ``delimiter`` is an empty string, each substring will be a single character. @@ -1626,7 +1626,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`String` **rstrip**\ (\ chars\: :ref:`String`\ ) |const| +:ref:`String` **rstrip**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` Removes a set of characters defined in ``chars`` from the string's end. See also :ref:`lstrip`. @@ -1640,7 +1640,7 @@ Removes a set of characters defined in ``chars`` from the string's end. See also .. rst-class:: classref-method -:ref:`PackedByteArray` **sha1_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **sha1_buffer**\ (\ ) |const| :ref:`🔗` Returns the `SHA-1 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1652,7 +1652,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`String` **sha1_text**\ (\ ) |const| +:ref:`String` **sha1_text**\ (\ ) |const| :ref:`🔗` Returns the `SHA-1 `__ hash of the string as another **String**. @@ -1664,7 +1664,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`PackedByteArray` **sha256_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **sha256_buffer**\ (\ ) |const| :ref:`🔗` Returns the `SHA-256 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1676,7 +1676,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`String` **sha256_text**\ (\ ) |const| +:ref:`String` **sha256_text**\ (\ ) |const| :ref:`🔗` Returns the `SHA-256 `__ hash of the string as another **String**. @@ -1688,7 +1688,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`float` **similarity**\ (\ text\: :ref:`String`\ ) |const| +:ref:`float` **similarity**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns the similarity index (`Sorensen-Dice coefficient `__) of this string compared to another. A result of ``1.0`` means totally similar, while ``0.0`` means totally dissimilar. @@ -1707,7 +1707,7 @@ Returns the similarity index (`Sorensen-Dice coefficient ` **simplify_path**\ (\ ) |const| +:ref:`String` **simplify_path**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, converts the string into a canonical path. This is the shortest possible path, without ``"./"``, and all the unnecessary ``".."`` and ``"/"``. @@ -1724,7 +1724,7 @@ If the string is a valid file path, converts the string into a canonical path. T .. rst-class:: classref-method -:ref:`PackedStringArray` **split**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| +:ref:`PackedStringArray` **split**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| :ref:`🔗` Splits the string using a ``delimiter`` and returns an array of the substrings. If ``delimiter`` is an empty string, each substring will be a single character. This method is the opposite of :ref:`join`. @@ -1767,7 +1767,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`PackedFloat64Array` **split_floats**\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| +:ref:`PackedFloat64Array` **split_floats**\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| :ref:`🔗` Splits the string into floats by using a ``delimiter`` and returns a :ref:`PackedFloat64Array`. @@ -1787,7 +1787,7 @@ If ``allow_empty`` is ``false``, empty or invalid :ref:`float` conv .. rst-class:: classref-method -:ref:`String` **strip_edges**\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| +:ref:`String` **strip_edges**\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| :ref:`🔗` Strips all non-printable characters from the beginning and the end of the string. These include spaces, tabulations (``\t``), and newlines (``\n`` ``\r``). @@ -1801,7 +1801,7 @@ If ``left`` is ``false``, ignores the string's beginning. Likewise, if ``right`` .. rst-class:: classref-method -:ref:`String` **strip_escapes**\ (\ ) |const| +:ref:`String` **strip_escapes**\ (\ ) |const| :ref:`🔗` Strips all escape characters from the string. These include all non-printable control characters of the first page of the ASCII table (values from 0 to 31), such as tabulation (``\t``) and newline (``\n``, ``\r``) characters, but *not* spaces. @@ -1813,7 +1813,7 @@ Strips all escape characters from the string. These include all non-printable co .. rst-class:: classref-method -:ref:`String` **substr**\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| +:ref:`String` **substr**\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns part of the string from the position ``from`` with length ``len``. If ``len`` is ``-1`` (as by default), returns the rest of the string starting from the given position. @@ -1825,7 +1825,7 @@ Returns part of the string from the position ``from`` with length ``len``. If `` .. rst-class:: classref-method -:ref:`PackedByteArray` **to_ascii_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_ascii_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to an `ASCII `__/Latin-1 encoded :ref:`PackedByteArray`. This method is slightly faster than :ref:`to_utf8_buffer`, but replaces all unsupported characters with spaces. This is the inverse of :ref:`PackedByteArray.get_string_from_ascii`. @@ -1837,7 +1837,7 @@ Converts the string to an `ASCII `__/Latin- .. rst-class:: classref-method -:ref:`String` **to_camel_case**\ (\ ) |const| +:ref:`String` **to_camel_case**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``camelCase``. @@ -1849,7 +1849,7 @@ Returns the string converted to ``camelCase``. .. rst-class:: classref-method -:ref:`float` **to_float**\ (\ ) |const| +:ref:`float` **to_float**\ (\ ) |const| :ref:`🔗` Converts the string representing a decimal number into a :ref:`float`. This method stops on the first non-number character, except the first decimal point (``.``) and the exponent letter (``e``). See also :ref:`is_valid_float`. @@ -1869,7 +1869,7 @@ Converts the string representing a decimal number into a :ref:`float` **to_int**\ (\ ) |const| +:ref:`int` **to_int**\ (\ ) |const| :ref:`🔗` Converts the string representing an integer number into an :ref:`int`. This method removes any non-number character and stops at the first decimal point (``.``). See also :ref:`is_valid_int`. @@ -1888,7 +1888,7 @@ Converts the string representing an integer number into an :ref:`int` .. rst-class:: classref-method -:ref:`String` **to_lower**\ (\ ) |const| +:ref:`String` **to_lower**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``lowercase``. @@ -1900,7 +1900,7 @@ Returns the string converted to ``lowercase``. .. rst-class:: classref-method -:ref:`String` **to_pascal_case**\ (\ ) |const| +:ref:`String` **to_pascal_case**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``PascalCase``. @@ -1912,7 +1912,7 @@ Returns the string converted to ``PascalCase``. .. rst-class:: classref-method -:ref:`String` **to_snake_case**\ (\ ) |const| +:ref:`String` **to_snake_case**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``snake_case``. @@ -1943,7 +1943,7 @@ Returns the string converted to ``snake_case``. .. rst-class:: classref-method -:ref:`String` **to_upper**\ (\ ) |const| +:ref:`String` **to_upper**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``UPPERCASE``. @@ -1955,7 +1955,7 @@ Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf8_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_utf8_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray`. This method is slightly slower than :ref:`to_ascii_buffer`, but supports all UTF-8 characters. For most cases, prefer using this method. This is the inverse of :ref:`PackedByteArray.get_string_from_utf8`. @@ -1967,7 +1967,7 @@ Converts the string to a `UTF-8 `__ encoded .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf16_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_utf16_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `UTF-16 `__ encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_utf16`. @@ -1979,7 +1979,7 @@ Converts the string to a `UTF-16 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf32_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_utf32_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `UTF-32 `__ encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_utf32`. @@ -1991,7 +1991,7 @@ Converts the string to a `UTF-32 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_wchar_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_wchar_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_wchar`. @@ -2003,7 +2003,7 @@ Converts the string to a `wide character ` **trim_prefix**\ (\ prefix\: :ref:`String`\ ) |const| +:ref:`String` **trim_prefix**\ (\ prefix\: :ref:`String`\ ) |const| :ref:`🔗` Removes the given ``prefix`` from the start of the string, or returns the string unchanged. @@ -2015,7 +2015,7 @@ Removes the given ``prefix`` from the start of the string, or returns the string .. rst-class:: classref-method -:ref:`String` **trim_suffix**\ (\ suffix\: :ref:`String`\ ) |const| +:ref:`String` **trim_suffix**\ (\ suffix\: :ref:`String`\ ) |const| :ref:`🔗` Removes the given ``suffix`` from the end of the string, or returns the string unchanged. @@ -2027,7 +2027,7 @@ Removes the given ``suffix`` from the end of the string, or returns the string u .. rst-class:: classref-method -:ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| +:ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| :ref:`🔗` Returns the character code at position ``at``. @@ -2039,7 +2039,7 @@ Returns the character code at position ``at``. .. rst-class:: classref-method -:ref:`String` **uri_decode**\ (\ ) |const| +:ref:`String` **uri_decode**\ (\ ) |const| :ref:`🔗` Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. See also :ref:`uri_encode`. @@ -2066,7 +2066,7 @@ Decodes the string from its URL-encoded format. This method is meant to properly .. rst-class:: classref-method -:ref:`String` **uri_encode**\ (\ ) |const| +:ref:`String` **uri_encode**\ (\ ) |const| :ref:`🔗` Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. See also :ref:`uri_decode`. @@ -2097,7 +2097,7 @@ Encodes the string to URL-friendly format. This method is meant to properly enco .. rst-class:: classref-method -:ref:`String` **validate_filename**\ (\ ) |const| +:ref:`String` **validate_filename**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with all characters that are not allowed in :ref:`is_valid_filename` replaced with underscores. @@ -2109,7 +2109,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i .. rst-class:: classref-method -:ref:`String` **validate_node_name**\ (\ ) |const| +:ref:`String` **validate_node_name**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores. @@ -2121,7 +2121,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`N .. rst-class:: classref-method -:ref:`String` **xml_escape**\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| +:ref:`String` **xml_escape**\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a copy of the string with special characters escaped using the XML standard. If ``escape_quotes`` is ``true``, the single quote (``'``) and double quote (``"``) characters are also escaped. @@ -2133,7 +2133,7 @@ Returns a copy of the string with special characters escaped using the XML stand .. rst-class:: classref-method -:ref:`String` **xml_unescape**\ (\ ) |const| +:ref:`String` **xml_unescape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. @@ -2150,7 +2150,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if both strings do not contain the same sequence of characters. @@ -2162,7 +2162,7 @@ Returns ``true`` if both strings do not contain the same sequence of characters. .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if this **String** is not equivalent to the given :ref:`StringName`. @@ -2174,7 +2174,7 @@ Returns ``true`` if this **String** is not equivalent to the given :ref:`StringN .. rst-class:: classref-operator -:ref:`String` **operator %**\ (\ right\: :ref:`Variant`\ ) +:ref:`String` **operator %**\ (\ right\: :ref:`Variant`\ ) :ref:`🔗` Formats the **String**, replacing the placeholders with one or more parameters. To pass multiple parameters, ``right`` needs to be an :ref:`Array`. @@ -2199,7 +2199,7 @@ For more information, see the :doc:`GDScript format strings <../tutorials/script .. rst-class:: classref-operator -:ref:`String` **operator +**\ (\ right\: :ref:`String`\ ) +:ref:`String` **operator +**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Appends ``right`` at the end of this **String**, also known as a string concatenation. @@ -2211,7 +2211,7 @@ Appends ``right`` at the end of this **String**, also known as a string concaten .. rst-class:: classref-operator -:ref:`String` **operator +**\ (\ right\: :ref:`StringName`\ ) +:ref:`String` **operator +**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Appends ``right`` at the end of this **String**, returning a **String**. This is also known as a string concatenation. @@ -2223,7 +2223,7 @@ Appends ``right`` at the end of this **String**, returning a **String**. This is .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if the left **String** comes before ``right`` in `Unicode order `__, which roughly matches the alphabetical order. Useful for sorting. @@ -2235,7 +2235,7 @@ Returns ``true`` if the left **String** comes before ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if the left **String** comes before ``right`` in `Unicode order `__, which roughly matches the alphabetical order, or if both are equal. @@ -2247,7 +2247,7 @@ Returns ``true`` if the left **String** comes before ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if both strings contain the same sequence of characters. @@ -2259,7 +2259,7 @@ Returns ``true`` if both strings contain the same sequence of characters. .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if this **String** is equivalent to the given :ref:`StringName`. @@ -2271,7 +2271,7 @@ Returns ``true`` if this **String** is equivalent to the given :ref:`StringName< .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if the left **String** comes after ``right`` in `Unicode order `__, which roughly matches the alphabetical order. Useful for sorting. @@ -2283,7 +2283,7 @@ Returns ``true`` if the left **String** comes after ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if the left **String** comes after ``right`` in `Unicode order `__, which roughly matches the alphabetical order, or if both are equal. @@ -2295,7 +2295,7 @@ Returns ``true`` if the left **String** comes after ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`String` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`String` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns a new **String** that only contains the character at ``index``. Indices start from ``0``. If ``index`` is greater or equal to ``0``, the character is fetched starting from the beginning of the string. If ``index`` is a negative value, it is fetched starting from the end. Accessing a string out-of-bounds will cause a run-time error, pausing the project execution if run from the editor. diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index 737b478134b..3355a4ee007 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -306,7 +306,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`StringName` **StringName**\ (\ ) +:ref:`StringName` **StringName**\ (\ ) :ref:`🔗` Constructs an empty **StringName**. @@ -343,7 +343,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **begins_with**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **begins_with**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string begins with the given ``text``. See also :ref:`ends_with`. @@ -355,7 +355,7 @@ Returns ``true`` if the string begins with the given ``text``. See also :ref:`en .. rst-class:: classref-method -:ref:`PackedStringArray` **bigrams**\ (\ ) |const| +:ref:`PackedStringArray` **bigrams**\ (\ ) |const| :ref:`🔗` Returns an array containing the bigrams (pairs of consecutive characters) of this string. @@ -371,7 +371,7 @@ Returns an array containing the bigrams (pairs of consecutive characters) of thi .. rst-class:: classref-method -:ref:`int` **bin_to_int**\ (\ ) |const| +:ref:`int` **bin_to_int**\ (\ ) |const| :ref:`🔗` Converts the string representing a binary number into an :ref:`int`. The string may optionally be prefixed with ``"0b"``, and an additional ``-`` prefix for negative numbers. @@ -400,7 +400,7 @@ Converts the string representing a binary number into an :ref:`int`. .. rst-class:: classref-method -:ref:`String` **c_escape**\ (\ ) |const| +:ref:`String` **c_escape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with special characters escaped using the C language standard. @@ -412,7 +412,7 @@ Returns a copy of the string with special characters escaped using the C languag .. rst-class:: classref-method -:ref:`String` **c_unescape**\ (\ ) |const| +:ref:`String` **c_unescape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``. @@ -426,7 +426,7 @@ Returns a copy of the string with escaped characters replaced by their meanings. .. rst-class:: classref-method -:ref:`String` **capitalize**\ (\ ) |const| +:ref:`String` **capitalize**\ (\ ) |const| :ref:`🔗` Changes the appearance of the string: replaces underscores (``_``) with spaces, adds spaces before uppercase letters in the middle of a word, converts all letters to lowercase, then converts the first one and each one following a space to uppercase. @@ -455,7 +455,7 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, .. rst-class:: classref-method -:ref:`int` **casecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **casecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" and "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -471,7 +471,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`bool` **contains**\ (\ what\: :ref:`String`\ ) |const| +:ref:`bool` **contains**\ (\ what\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string contains ``what``. In GDScript, this corresponds to the ``in`` operator. @@ -501,7 +501,7 @@ If you need to know where ``what`` is within the string, use :ref:`find` **containsn**\ (\ what\: :ref:`String`\ ) |const| +:ref:`bool` **containsn**\ (\ what\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string contains ``what``, **ignoring case**. @@ -515,7 +515,7 @@ If you need to know where ``what`` is within the string, use :ref:`findn` **count**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| +:ref:`int` **count**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions. If ``to`` is 0, the search continues until the end of the string. @@ -527,7 +527,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`int` **countn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| +:ref:`int` **countn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions, **ignoring case**. If ``to`` is 0, the search continues until the end of the string. @@ -539,7 +539,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`String` **dedent**\ (\ ) |const| +:ref:`String` **dedent**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with indentation (leading tabs and spaces) removed. See also :ref:`indent` to add indentation. @@ -551,7 +551,7 @@ Returns a copy of the string with indentation (leading tabs and spaces) removed. .. rst-class:: classref-method -:ref:`bool` **ends_with**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **ends_with**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the string ends with the given ``text``. See also :ref:`begins_with`. @@ -563,7 +563,7 @@ Returns ``true`` if the string ends with the given ``text``. See also :ref:`begi .. rst-class:: classref-method -:ref:`String` **erase**\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| +:ref:`String` **erase**\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| :ref:`🔗` Returns a string with ``chars`` characters erased starting from ``position``. If ``chars`` goes beyond the string's length given the specified ``position``, fewer characters will be erased from the returned string. Returns an empty string if either ``position`` or ``chars`` is negative. Returns the original string unmodified if ``chars`` is ``0``. @@ -575,7 +575,7 @@ Returns a string with ``chars`` characters erased starting from ``position``. If .. rst-class:: classref-method -:ref:`int` **filecasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **filecasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Like :ref:`naturalcasecmp_to` but prioritizes strings that begin with periods (``.``) and underscores (``_``) before any other character. Useful when sorting folders or file names. @@ -589,7 +589,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **filenocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **filenocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Like :ref:`naturalnocasecmp_to` but prioritizes strings that begin with periods (``.``) and underscores (``_``) before any other character. Useful when sorting folders or file names. @@ -603,7 +603,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **find**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **find**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the index of the **first** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the end of the string. @@ -638,7 +638,7 @@ Returns the index of the **first** occurrence of ``what`` in this string, or ``- .. rst-class:: classref-method -:ref:`int` **findn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| +:ref:`int` **findn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the index of the **first** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the end of the string. @@ -650,7 +650,7 @@ Returns the index of the **first** **case-insensitive** occurrence of ``what`` i .. rst-class:: classref-method -:ref:`String` **format**\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| +:ref:`String` **format**\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| :ref:`🔗` Formats the string by replacing all occurrences of ``placeholder`` with the elements of ``values``. @@ -685,7 +685,7 @@ See also the :doc:`GDScript format string <../tutorials/scripting/gdscript/gdscr .. rst-class:: classref-method -:ref:`String` **get_base_dir**\ (\ ) |const| +:ref:`String` **get_base_dir**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, returns the base directory name. @@ -701,7 +701,7 @@ If the string is a valid file path, returns the base directory name. .. rst-class:: classref-method -:ref:`String` **get_basename**\ (\ ) |const| +:ref:`String` **get_basename**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, returns the full file path, without the extension. @@ -717,7 +717,7 @@ If the string is a valid file path, returns the full file path, without the exte .. rst-class:: classref-method -:ref:`String` **get_extension**\ (\ ) |const| +:ref:`String` **get_extension**\ (\ ) |const| :ref:`🔗` If the string is a valid file name or path, returns the file extension without the leading period (``.``). Otherwise, returns an empty string. @@ -741,7 +741,7 @@ If the string is a valid file name or path, returns the file extension without t .. rst-class:: classref-method -:ref:`String` **get_file**\ (\ ) |const| +:ref:`String` **get_file**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, returns the file name, including the extension. @@ -757,7 +757,7 @@ If the string is a valid file path, returns the file name, including the extensi .. rst-class:: classref-method -:ref:`String` **get_slice**\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| +:ref:`String` **get_slice**\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| :ref:`🔗` Splits the string using a ``delimiter`` and returns the substring at index ``slice``. Returns an empty string if the ``slice`` does not exist. @@ -777,7 +777,7 @@ This is faster than :ref:`split`, if you only nee .. rst-class:: classref-method -:ref:`int` **get_slice_count**\ (\ delimiter\: :ref:`String`\ ) |const| +:ref:`int` **get_slice_count**\ (\ delimiter\: :ref:`String`\ ) |const| :ref:`🔗` Returns the total number of slices when the string is split with the given ``delimiter`` (see :ref:`split`). @@ -789,7 +789,7 @@ Returns the total number of slices when the string is split with the given ``del .. rst-class:: classref-method -:ref:`String` **get_slicec**\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| +:ref:`String` **get_slicec**\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| :ref:`🔗` Splits the string using a Unicode character with code ``delimiter`` and returns the substring at index ``slice``. Returns an empty string if the ``slice`` does not exist. @@ -803,7 +803,7 @@ This is faster than :ref:`split`, if you only nee .. rst-class:: classref-method -:ref:`int` **hash**\ (\ ) |const| +:ref:`int` **hash**\ (\ ) |const| :ref:`🔗` Returns the 32-bit hash value representing the string's contents. @@ -817,7 +817,7 @@ Returns the 32-bit hash value representing the string's contents. .. rst-class:: classref-method -:ref:`PackedByteArray` **hex_decode**\ (\ ) |const| +:ref:`PackedByteArray` **hex_decode**\ (\ ) |const| :ref:`🔗` Decodes a hexadecimal string as a :ref:`PackedByteArray`. @@ -846,7 +846,7 @@ Decodes a hexadecimal string as a :ref:`PackedByteArray`. .. rst-class:: classref-method -:ref:`int` **hex_to_int**\ (\ ) |const| +:ref:`int` **hex_to_int**\ (\ ) |const| :ref:`🔗` Converts the string representing a hexadecimal number into an :ref:`int`. The string may be optionally prefixed with ``"0x"``, and an additional ``-`` prefix for negative numbers. @@ -873,7 +873,7 @@ Converts the string representing a hexadecimal number into an :ref:`int` **indent**\ (\ prefix\: :ref:`String`\ ) |const| +:ref:`String` **indent**\ (\ prefix\: :ref:`String`\ ) |const| :ref:`🔗` Indents every line of the string with the given ``prefix``. Empty lines are not indented. See also :ref:`dedent` to remove indentation. @@ -887,7 +887,7 @@ For example, the string can be indented with two tabulations using ``"\t\t"``, o .. rst-class:: classref-method -:ref:`String` **insert**\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| +:ref:`String` **insert**\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| :ref:`🔗` Inserts ``what`` at the given ``position`` in the string. @@ -899,7 +899,7 @@ Inserts ``what`` at the given ``position`` in the string. .. rst-class:: classref-method -:ref:`bool` **is_absolute_path**\ (\ ) |const| +:ref:`bool` **is_absolute_path**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the string is a path to a file or directory, and its starting point is explicitly defined. This method is the opposite of :ref:`is_relative_path`. @@ -913,7 +913,7 @@ This includes all paths starting with ``"res://"``, ``"user://"``, ``"C:\"``, `` .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length`. @@ -925,7 +925,7 @@ Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length .. rst-class:: classref-method -:ref:`bool` **is_relative_path**\ (\ ) |const| +:ref:`bool` **is_relative_path**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the string is a path, and its starting point is dependent on context. The path could begin from the current directory, or the current :ref:`Node` (if the string is derived from a :ref:`NodePath`), and may sometimes be prefixed with ``"./"``. This method is the opposite of :ref:`is_absolute_path`. @@ -937,7 +937,7 @@ Returns ``true`` if the string is a path, and its starting point is dependent on .. rst-class:: classref-method -:ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if all characters of this string can be found in ``text`` in their original order. @@ -958,7 +958,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| +:ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**. @@ -970,7 +970,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_valid_filename**\ (\ ) |const| +:ref:`bool` **is_valid_filename**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string does not contain characters that are not allowed in file names (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). @@ -982,7 +982,7 @@ Returns ``true`` if this string does not contain characters that are not allowed .. rst-class:: classref-method -:ref:`bool` **is_valid_float**\ (\ ) |const| +:ref:`bool` **is_valid_float**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string represents a valid floating-point number. A valid float may contain only digits, one decimal point (``.``), and the exponent letter (``e``). It may also be prefixed with a positive (``+``) or negative (``-``) sign. Any valid integer is also a valid float (see :ref:`is_valid_int`). See also :ref:`to_float`. @@ -1001,7 +1001,7 @@ Returns ``true`` if this string represents a valid floating-point number. A vali .. rst-class:: classref-method -:ref:`bool` **is_valid_hex_number**\ (\ with_prefix\: :ref:`bool` = false\ ) |const| +:ref:`bool` **is_valid_hex_number**\ (\ with_prefix\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if this string is a valid hexadecimal number. A valid hexadecimal number only contains digits or letters ``A`` to ``F`` (either uppercase or lowercase), and may be prefixed with a positive (``+``) or negative (``-``) sign. @@ -1023,7 +1023,7 @@ If ``with_prefix`` is ``true``, the hexadecimal number needs to prefixed by ``"0 .. rst-class:: classref-method -:ref:`bool` **is_valid_html_color**\ (\ ) |const| +:ref:`bool` **is_valid_html_color**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string is a valid color in hexadecimal HTML notation. The string must be a hexadecimal value (see :ref:`is_valid_hex_number`) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). Other HTML notations for colors, such as names or ``hsl()``, are not considered valid. See also :ref:`Color.html`. @@ -1035,7 +1035,7 @@ Returns ``true`` if this string is a valid color in hexadecimal HTML notation. T .. rst-class:: classref-method -:ref:`bool` **is_valid_identifier**\ (\ ) |const| +:ref:`bool` **is_valid_identifier**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``), and the first character may not be a digit. @@ -1054,7 +1054,7 @@ Returns ``true`` if this string is a valid identifier. A valid identifier may co .. rst-class:: classref-method -:ref:`bool` **is_valid_int**\ (\ ) |const| +:ref:`bool` **is_valid_int**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string represents a valid integer. A valid integer only contains digits, and may be prefixed with a positive (``+``) or negative (``-``) sign. See also :ref:`to_int`. @@ -1074,7 +1074,7 @@ Returns ``true`` if this string represents a valid integer. A valid integer only .. rst-class:: classref-method -:ref:`bool` **is_valid_ip_address**\ (\ ) |const| +:ref:`bool` **is_valid_ip_address**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address. This method considers `reserved IP addresses `__ such as ``"0.0.0.0"`` and ``"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"`` as valid. @@ -1086,7 +1086,7 @@ Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address .. rst-class:: classref-method -:ref:`String` **join**\ (\ parts\: :ref:`PackedStringArray`\ ) |const| +:ref:`String` **join**\ (\ parts\: :ref:`PackedStringArray`\ ) |const| :ref:`🔗` Returns the concatenation of ``parts``' elements, with each element separated by the string calling this method. This method is the opposite of :ref:`split`. @@ -1120,7 +1120,7 @@ Returns the concatenation of ``parts``' elements, with each element separated by .. rst-class:: classref-method -:ref:`String` **json_escape**\ (\ ) |const| +:ref:`String` **json_escape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with special characters escaped using the JSON standard. Because it closely matches the C standard, it is possible to use :ref:`c_unescape` to unescape the string, if necessary. @@ -1132,7 +1132,7 @@ Returns a copy of the string with special characters escaped using the JSON stan .. rst-class:: classref-method -:ref:`String` **left**\ (\ length\: :ref:`int`\ ) |const| +:ref:`String` **left**\ (\ length\: :ref:`int`\ ) |const| :ref:`🔗` Returns the first ``length`` characters from the beginning of the string. If ``length`` is negative, strips the last ``length`` characters from the string's end. @@ -1149,7 +1149,7 @@ Returns the first ``length`` characters from the beginning of the string. If ``l .. rst-class:: classref-method -:ref:`int` **length**\ (\ ) |const| +:ref:`int` **length**\ (\ ) |const| :ref:`🔗` Returns the number of characters in the string. Empty strings (``""``) always return ``0``. See also :ref:`is_empty`. @@ -1161,7 +1161,7 @@ Returns the number of characters in the string. Empty strings (``""``) always re .. rst-class:: classref-method -:ref:`String` **lpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| +:ref:`String` **lpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| :ref:`🔗` Formats the string to be at least ``min_length`` long by adding ``character``\ s to the left of the string, if necessary. See also :ref:`rpad`. @@ -1173,7 +1173,7 @@ Formats the string to be at least ``min_length`` long by adding ``character``\ s .. rst-class:: classref-method -:ref:`String` **lstrip**\ (\ chars\: :ref:`String`\ ) |const| +:ref:`String` **lstrip**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` Removes a set of characters defined in ``chars`` from the string's beginning. See also :ref:`rstrip`. @@ -1187,7 +1187,7 @@ Removes a set of characters defined in ``chars`` from the string's beginning. Se .. rst-class:: classref-method -:ref:`bool` **match**\ (\ expr\: :ref:`String`\ ) |const| +:ref:`bool` **match**\ (\ expr\: :ref:`String`\ ) |const| :ref:`🔗` Does a simple expression match (also called "glob" or "globbing"), where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1199,7 +1199,7 @@ Does a simple expression match (also called "glob" or "globbing"), where ``*`` m .. rst-class:: classref-method -:ref:`bool` **matchn**\ (\ expr\: :ref:`String`\ ) |const| +:ref:`bool` **matchn**\ (\ expr\: :ref:`String`\ ) |const| :ref:`🔗` Does a simple **case-insensitive** expression match, where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1211,7 +1211,7 @@ Does a simple **case-insensitive** expression match, where ``*`` matches zero or .. rst-class:: classref-method -:ref:`PackedByteArray` **md5_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **md5_buffer**\ (\ ) |const| :ref:`🔗` Returns the `MD5 hash `__ of the string as a :ref:`PackedByteArray`. @@ -1223,7 +1223,7 @@ Returns the `MD5 hash `__ of the string as a .. rst-class:: classref-method -:ref:`String` **md5_text**\ (\ ) |const| +:ref:`String` **md5_text**\ (\ ) |const| :ref:`🔗` Returns the `MD5 hash `__ of the string as another :ref:`String`. @@ -1235,7 +1235,7 @@ Returns the `MD5 hash `__ of the string as an .. rst-class:: classref-method -:ref:`int` **naturalcasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **naturalcasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a **case-sensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -1253,7 +1253,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **naturalnocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **naturalnocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a **case-insensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1271,7 +1271,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **nocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| +:ref:`int` **nocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| :ref:`🔗` Performs a **case-insensitive** comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1287,7 +1287,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`String` **pad_decimals**\ (\ digits\: :ref:`int`\ ) |const| +:ref:`String` **pad_decimals**\ (\ digits\: :ref:`int`\ ) |const| :ref:`🔗` Formats the string representing a number to have an exact number of ``digits`` *after* the decimal point. @@ -1299,7 +1299,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **pad_zeros**\ (\ digits\: :ref:`int`\ ) |const| +:ref:`String` **pad_zeros**\ (\ digits\: :ref:`int`\ ) |const| :ref:`🔗` Formats the string representing a number to have an exact number of ``digits`` *before* the decimal point. @@ -1311,7 +1311,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| +:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| :ref:`🔗` Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if necessary. @@ -1325,7 +1325,7 @@ Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if nec .. rst-class:: classref-method -:ref:`String` **repeat**\ (\ count\: :ref:`int`\ ) |const| +:ref:`String` **repeat**\ (\ count\: :ref:`int`\ ) |const| :ref:`🔗` Repeats this string a number of times. ``count`` needs to be greater than ``0``. Otherwise, returns an empty string. @@ -1337,7 +1337,7 @@ Repeats this string a number of times. ``count`` needs to be greater than ``0``. .. rst-class:: classref-method -:ref:`String` **replace**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| +:ref:`String` **replace**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| :ref:`🔗` Replaces all occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1349,7 +1349,7 @@ Replaces all occurrences of ``what`` inside the string with the given ``forwhat` .. rst-class:: classref-method -:ref:`String` **replacen**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| +:ref:`String` **replacen**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| :ref:`🔗` Replaces all **case-insensitive** occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1361,7 +1361,7 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with .. rst-class:: classref-method -:ref:`String` **reverse**\ (\ ) |const| +:ref:`String` **reverse**\ (\ ) |const| :ref:`🔗` Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis. @@ -1373,7 +1373,7 @@ Returns the copy of this string in reverse order. This operation works on unicod .. rst-class:: classref-method -:ref:`int` **rfind**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfind**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the index of the **last** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`find`. @@ -1385,7 +1385,7 @@ Returns the index of the **last** occurrence of ``what`` in this string, or ``-1 .. rst-class:: classref-method -:ref:`int` **rfindn**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| +:ref:`int` **rfindn**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the index of the **last** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`findn`. @@ -1397,7 +1397,7 @@ Returns the index of the **last** **case-insensitive** occurrence of ``what`` in .. rst-class:: classref-method -:ref:`String` **right**\ (\ length\: :ref:`int`\ ) |const| +:ref:`String` **right**\ (\ length\: :ref:`int`\ ) |const| :ref:`🔗` Returns the last ``length`` characters from the end of the string. If ``length`` is negative, strips the first ``length`` characters from the string's beginning. @@ -1414,7 +1414,7 @@ Returns the last ``length`` characters from the end of the string. If ``length`` .. rst-class:: classref-method -:ref:`String` **rpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| +:ref:`String` **rpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| :ref:`🔗` Formats the string to be at least ``min_length`` long, by adding ``character``\ s to the right of the string, if necessary. See also :ref:`lpad`. @@ -1426,7 +1426,7 @@ Formats the string to be at least ``min_length`` long, by adding ``character``\ .. rst-class:: classref-method -:ref:`PackedStringArray` **rsplit**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| +:ref:`PackedStringArray` **rsplit**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| :ref:`🔗` Splits the string using a ``delimiter`` and returns an array of the substrings, starting from the end of the string. The splits in the returned array appear in the same order as the original string. If ``delimiter`` is an empty string, each substring will be a single character. @@ -1462,7 +1462,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`String` **rstrip**\ (\ chars\: :ref:`String`\ ) |const| +:ref:`String` **rstrip**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` Removes a set of characters defined in ``chars`` from the string's end. See also :ref:`lstrip`. @@ -1476,7 +1476,7 @@ Removes a set of characters defined in ``chars`` from the string's end. See also .. rst-class:: classref-method -:ref:`PackedByteArray` **sha1_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **sha1_buffer**\ (\ ) |const| :ref:`🔗` Returns the `SHA-1 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1488,7 +1488,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`String` **sha1_text**\ (\ ) |const| +:ref:`String` **sha1_text**\ (\ ) |const| :ref:`🔗` Returns the `SHA-1 `__ hash of the string as another :ref:`String`. @@ -1500,7 +1500,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`PackedByteArray` **sha256_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **sha256_buffer**\ (\ ) |const| :ref:`🔗` Returns the `SHA-256 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1512,7 +1512,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`String` **sha256_text**\ (\ ) |const| +:ref:`String` **sha256_text**\ (\ ) |const| :ref:`🔗` Returns the `SHA-256 `__ hash of the string as another :ref:`String`. @@ -1524,7 +1524,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`float` **similarity**\ (\ text\: :ref:`String`\ ) |const| +:ref:`float` **similarity**\ (\ text\: :ref:`String`\ ) |const| :ref:`🔗` Returns the similarity index (`Sorensen-Dice coefficient `__) of this string compared to another. A result of ``1.0`` means totally similar, while ``0.0`` means totally dissimilar. @@ -1543,7 +1543,7 @@ Returns the similarity index (`Sorensen-Dice coefficient ` **simplify_path**\ (\ ) |const| +:ref:`String` **simplify_path**\ (\ ) |const| :ref:`🔗` If the string is a valid file path, converts the string into a canonical path. This is the shortest possible path, without ``"./"``, and all the unnecessary ``".."`` and ``"/"``. @@ -1560,7 +1560,7 @@ If the string is a valid file path, converts the string into a canonical path. T .. rst-class:: classref-method -:ref:`PackedStringArray` **split**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| +:ref:`PackedStringArray` **split**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| :ref:`🔗` Splits the string using a ``delimiter`` and returns an array of the substrings. If ``delimiter`` is an empty string, each substring will be a single character. This method is the opposite of :ref:`join`. @@ -1603,7 +1603,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`PackedFloat64Array` **split_floats**\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| +:ref:`PackedFloat64Array` **split_floats**\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| :ref:`🔗` Splits the string into floats by using a ``delimiter`` and returns a :ref:`PackedFloat64Array`. @@ -1623,7 +1623,7 @@ If ``allow_empty`` is ``false``, empty or invalid :ref:`float` conv .. rst-class:: classref-method -:ref:`String` **strip_edges**\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| +:ref:`String` **strip_edges**\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| :ref:`🔗` Strips all non-printable characters from the beginning and the end of the string. These include spaces, tabulations (``\t``), and newlines (``\n`` ``\r``). @@ -1637,7 +1637,7 @@ If ``left`` is ``false``, ignores the string's beginning. Likewise, if ``right`` .. rst-class:: classref-method -:ref:`String` **strip_escapes**\ (\ ) |const| +:ref:`String` **strip_escapes**\ (\ ) |const| :ref:`🔗` Strips all escape characters from the string. These include all non-printable control characters of the first page of the ASCII table (values from 0 to 31), such as tabulation (``\t``) and newline (``\n``, ``\r``) characters, but *not* spaces. @@ -1649,7 +1649,7 @@ Strips all escape characters from the string. These include all non-printable co .. rst-class:: classref-method -:ref:`String` **substr**\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| +:ref:`String` **substr**\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns part of the string from the position ``from`` with length ``len``. If ``len`` is ``-1`` (as by default), returns the rest of the string starting from the given position. @@ -1661,7 +1661,7 @@ Returns part of the string from the position ``from`` with length ``len``. If `` .. rst-class:: classref-method -:ref:`PackedByteArray` **to_ascii_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_ascii_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to an `ASCII `__/Latin-1 encoded :ref:`PackedByteArray`. This method is slightly faster than :ref:`to_utf8_buffer`, but replaces all unsupported characters with spaces. @@ -1673,7 +1673,7 @@ Converts the string to an `ASCII `__/Latin- .. rst-class:: classref-method -:ref:`String` **to_camel_case**\ (\ ) |const| +:ref:`String` **to_camel_case**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``camelCase``. @@ -1685,7 +1685,7 @@ Returns the string converted to ``camelCase``. .. rst-class:: classref-method -:ref:`float` **to_float**\ (\ ) |const| +:ref:`float` **to_float**\ (\ ) |const| :ref:`🔗` Converts the string representing a decimal number into a :ref:`float`. This method stops on the first non-number character, except the first decimal point (``.``) and the exponent letter (``e``). See also :ref:`is_valid_float`. @@ -1705,7 +1705,7 @@ Converts the string representing a decimal number into a :ref:`float` **to_int**\ (\ ) |const| +:ref:`int` **to_int**\ (\ ) |const| :ref:`🔗` Converts the string representing an integer number into an :ref:`int`. This method removes any non-number character and stops at the first decimal point (``.``). See also :ref:`is_valid_int`. @@ -1724,7 +1724,7 @@ Converts the string representing an integer number into an :ref:`int` .. rst-class:: classref-method -:ref:`String` **to_lower**\ (\ ) |const| +:ref:`String` **to_lower**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``lowercase``. @@ -1736,7 +1736,7 @@ Returns the string converted to ``lowercase``. .. rst-class:: classref-method -:ref:`String` **to_pascal_case**\ (\ ) |const| +:ref:`String` **to_pascal_case**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``PascalCase``. @@ -1748,7 +1748,7 @@ Returns the string converted to ``PascalCase``. .. rst-class:: classref-method -:ref:`String` **to_snake_case**\ (\ ) |const| +:ref:`String` **to_snake_case**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``snake_case``. @@ -1779,7 +1779,7 @@ Returns the string converted to ``snake_case``. .. rst-class:: classref-method -:ref:`String` **to_upper**\ (\ ) |const| +:ref:`String` **to_upper**\ (\ ) |const| :ref:`🔗` Returns the string converted to ``UPPERCASE``. @@ -1791,7 +1791,7 @@ Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf8_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_utf8_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray`. This method is slightly slower than :ref:`to_ascii_buffer`, but supports all UTF-8 characters. For most cases, prefer using this method. @@ -1803,7 +1803,7 @@ Converts the string to a `UTF-8 `__ encoded .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf16_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_utf16_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `UTF-16 `__ encoded :ref:`PackedByteArray`. @@ -1815,7 +1815,7 @@ Converts the string to a `UTF-16 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf32_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_utf32_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `UTF-32 `__ encoded :ref:`PackedByteArray`. @@ -1827,7 +1827,7 @@ Converts the string to a `UTF-32 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_wchar_buffer**\ (\ ) |const| +:ref:`PackedByteArray` **to_wchar_buffer**\ (\ ) |const| :ref:`🔗` Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. @@ -1839,7 +1839,7 @@ Converts the string to a `wide character ` **trim_prefix**\ (\ prefix\: :ref:`String`\ ) |const| +:ref:`String` **trim_prefix**\ (\ prefix\: :ref:`String`\ ) |const| :ref:`🔗` Removes the given ``prefix`` from the start of the string, or returns the string unchanged. @@ -1851,7 +1851,7 @@ Removes the given ``prefix`` from the start of the string, or returns the string .. rst-class:: classref-method -:ref:`String` **trim_suffix**\ (\ suffix\: :ref:`String`\ ) |const| +:ref:`String` **trim_suffix**\ (\ suffix\: :ref:`String`\ ) |const| :ref:`🔗` Removes the given ``suffix`` from the end of the string, or returns the string unchanged. @@ -1863,7 +1863,7 @@ Removes the given ``suffix`` from the end of the string, or returns the string u .. rst-class:: classref-method -:ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| +:ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| :ref:`🔗` Returns the character code at position ``at``. @@ -1875,7 +1875,7 @@ Returns the character code at position ``at``. .. rst-class:: classref-method -:ref:`String` **uri_decode**\ (\ ) |const| +:ref:`String` **uri_decode**\ (\ ) |const| :ref:`🔗` Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. @@ -1902,7 +1902,7 @@ Decodes the string from its URL-encoded format. This method is meant to properly .. rst-class:: classref-method -:ref:`String` **uri_encode**\ (\ ) |const| +:ref:`String` **uri_encode**\ (\ ) |const| :ref:`🔗` Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. @@ -1933,7 +1933,7 @@ Encodes the string to URL-friendly format. This method is meant to properly enco .. rst-class:: classref-method -:ref:`String` **validate_filename**\ (\ ) |const| +:ref:`String` **validate_filename**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with all characters that are not allowed in :ref:`is_valid_filename` replaced with underscores. @@ -1945,7 +1945,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i .. rst-class:: classref-method -:ref:`String` **validate_node_name**\ (\ ) |const| +:ref:`String` **validate_node_name**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores. @@ -1957,7 +1957,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`N .. rst-class:: classref-method -:ref:`String` **xml_escape**\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| +:ref:`String` **xml_escape**\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a copy of the string with special characters escaped using the XML standard. If ``escape_quotes`` is ``true``, the single quote (``'``) and double quote (``"``) characters are also escaped. @@ -1969,7 +1969,7 @@ Returns a copy of the string with special characters escaped using the XML stand .. rst-class:: classref-method -:ref:`String` **xml_unescape**\ (\ ) |const| +:ref:`String` **xml_unescape**\ (\ ) |const| :ref:`🔗` Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. @@ -1986,7 +1986,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if this **StringName** is not equivalent to the given :ref:`String`. @@ -1998,7 +1998,7 @@ Returns ``true`` if this **StringName** is not equivalent to the given :ref:`Str .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the **StringName** and ``right`` do not refer to the same name. Comparisons between **StringName**\ s are much faster than regular :ref:`String` comparisons. @@ -2010,7 +2010,7 @@ Returns ``true`` if the **StringName** and ``right`` do not refer to the same na .. rst-class:: classref-operator -:ref:`String` **operator %**\ (\ right\: :ref:`Variant`\ ) +:ref:`String` **operator %**\ (\ right\: :ref:`Variant`\ ) :ref:`🔗` Formats the **StringName**, replacing the placeholders with one or more parameters, returning a :ref:`String`. To pass multiple parameters, ``right`` needs to be an :ref:`Array`. @@ -2026,7 +2026,7 @@ For more information, see the :doc:`GDScript format strings <../tutorials/script .. rst-class:: classref-operator -:ref:`String` **operator +**\ (\ right\: :ref:`String`\ ) +:ref:`String` **operator +**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Appends ``right`` at the end of this **StringName**, returning a :ref:`String`. This is also known as a string concatenation. @@ -2038,7 +2038,7 @@ Appends ``right`` at the end of this **StringName**, returning a :ref:`String` **operator +**\ (\ right\: :ref:`StringName`\ ) +:ref:`String` **operator +**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Appends ``right`` at the end of this **StringName**, returning a :ref:`String`. This is also known as a string concatenation. @@ -2050,7 +2050,7 @@ Appends ``right`` at the end of this **StringName**, returning a :ref:`String` **operator <**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the left **StringName**'s pointer comes before ``right``. Note that this will not match their `Unicode order `__. @@ -2062,7 +2062,7 @@ Returns ``true`` if the left **StringName**'s pointer comes before ``right``. No .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the left **StringName**'s pointer comes before ``right`` or if they are the same. Note that this will not match their `Unicode order `__. @@ -2074,7 +2074,7 @@ Returns ``true`` if the left **StringName**'s pointer comes before ``right`` or .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if this **StringName** is equivalent to the given :ref:`String`. @@ -2086,7 +2086,7 @@ Returns ``true`` if this **StringName** is equivalent to the given :ref:`String< .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the **StringName** and ``right`` refer to the same name. Comparisons between **StringName**\ s are much faster than regular :ref:`String` comparisons. @@ -2098,7 +2098,7 @@ Returns ``true`` if the **StringName** and ``right`` refer to the same name. Com .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the left **StringName**'s pointer comes after ``right``. Note that this will not match their `Unicode order `__. @@ -2110,7 +2110,7 @@ Returns ``true`` if the left **StringName**'s pointer comes after ``right``. Not .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`StringName`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`StringName`\ ) :ref:`🔗` Returns ``true`` if the left **StringName**'s pointer comes after ``right`` or if they are the same. Note that this will not match their `Unicode order `__. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 788021b7cac..9f4c6290dad 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -92,7 +92,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **content_margin_bottom** = ``-1.0`` +:ref:`float` **content_margin_bottom** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ It is up to the code using this style box to decide what these contents are: for .. rst-class:: classref-property -:ref:`float` **content_margin_left** = ``-1.0`` +:ref:`float` **content_margin_left** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -134,7 +134,7 @@ Refer to :ref:`content_margin_bottom` **content_margin_right** = ``-1.0`` +:ref:`float` **content_margin_right** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -153,7 +153,7 @@ Refer to :ref:`content_margin_bottom` **content_margin_top** = ``-1.0`` +:ref:`float` **content_margin_top** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -177,7 +177,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |const| +|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -191,7 +191,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **_get_draw_rect**\ (\ rect\: :ref:`Rect2`\ ) |virtual| |const| +:ref:`Rect2` **_get_draw_rect**\ (\ rect\: :ref:`Rect2`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -205,7 +205,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **_get_minimum_size**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_minimum_size**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method to be implemented by the user. Returns a custom minimum size that the stylebox must respect when drawing. By default :ref:`get_minimum_size` only takes content margins into account. This method can be overridden to add another size restriction. A combination of the default behavior and the output of this method will be used, to account for both sizes. @@ -217,7 +217,7 @@ Virtual method to be implemented by the user. Returns a custom minimum size that .. rst-class:: classref-method -:ref:`bool` **_test_mask**\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |virtual| |const| +:ref:`bool` **_test_mask**\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -231,7 +231,7 @@ Virtual method to be implemented by the user. Returns a custom minimum size that .. rst-class:: classref-method -|void| **draw**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |const| +|void| **draw**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` Draws this stylebox using a canvas item identified by the given :ref:`RID`. @@ -245,7 +245,7 @@ The :ref:`RID` value can either be the result of :ref:`CanvasItem.get .. rst-class:: classref-method -:ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the default margin of the specified :ref:`Side`. @@ -257,7 +257,7 @@ Returns the default margin of the specified :ref:`Side`. .. rst-class:: classref-method -:ref:`CanvasItem` **get_current_item_drawn**\ (\ ) |const| +:ref:`CanvasItem` **get_current_item_drawn**\ (\ ) |const| :ref:`🔗` Returns the :ref:`CanvasItem` that handles its :ref:`CanvasItem.NOTIFICATION_DRAW` or :ref:`CanvasItem._draw` callback at this moment. @@ -269,7 +269,7 @@ Returns the :ref:`CanvasItem` that handles its :ref:`CanvasIte .. rst-class:: classref-method -:ref:`float` **get_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`float` **get_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the content margin offset for the specified :ref:`Side`. @@ -283,7 +283,7 @@ Positive values reduce size inwards, unlike :ref:`Control`'s marg .. rst-class:: classref-method -:ref:`Vector2` **get_minimum_size**\ (\ ) |const| +:ref:`Vector2` **get_minimum_size**\ (\ ) |const| :ref:`🔗` Returns the minimum size that this stylebox can be shrunk to. @@ -295,7 +295,7 @@ Returns the minimum size that this stylebox can be shrunk to. .. rst-class:: classref-method -:ref:`Vector2` **get_offset**\ (\ ) |const| +:ref:`Vector2` **get_offset**\ (\ ) |const| :ref:`🔗` Returns the "offset" of a stylebox. This helper function returns a value equivalent to ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. @@ -307,7 +307,7 @@ Returns the "offset" of a stylebox. This helper function returns a value equival .. rst-class:: classref-method -|void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) +|void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the default value of the specified :ref:`Side` to ``offset`` pixels. @@ -319,7 +319,7 @@ Sets the default value of the specified :ref:`Side` to ` .. rst-class:: classref-method -|void| **set_content_margin_all**\ (\ offset\: :ref:`float`\ ) +|void| **set_content_margin_all**\ (\ offset\: :ref:`float`\ ) :ref:`🔗` Sets the default margin to ``offset`` pixels for all sides. @@ -331,7 +331,7 @@ Sets the default margin to ``offset`` pixels for all sides. .. rst-class:: classref-method -:ref:`bool` **test_mask**\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |const| +:ref:`bool` **test_mask**\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` Test a position in a rectangle, return whether it passes the mask test. diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 0fb0426bfb7..1b8f6d7b08a 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -137,7 +137,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **anti_aliasing** = ``true`` +:ref:`bool` **anti_aliasing** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ Antialiasing draws a small ring around the edges, which fades to transparency. A .. rst-class:: classref-property -:ref:`float` **anti_aliasing_size** = ``1.0`` +:ref:`float` **anti_aliasing_size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -175,7 +175,7 @@ This changes the size of the antialiasing effect. ``1.0`` is recommended for an .. rst-class:: classref-property -:ref:`Color` **bg_color** = ``Color(0.6, 0.6, 0.6, 1)`` +:ref:`Color` **bg_color** = ``Color(0.6, 0.6, 0.6, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ The background color of the stylebox. .. rst-class:: classref-property -:ref:`bool` **border_blend** = ``false`` +:ref:`bool` **border_blend** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -209,7 +209,7 @@ If ``true``, the border will fade into the background color. .. rst-class:: classref-property -:ref:`Color` **border_color** = ``Color(0.8, 0.8, 0.8, 1)`` +:ref:`Color` **border_color** = ``Color(0.8, 0.8, 0.8, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ Sets the color of the border. .. rst-class:: classref-property -:ref:`int` **border_width_bottom** = ``0`` +:ref:`int` **border_width_bottom** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -243,7 +243,7 @@ Border width for the bottom border. .. rst-class:: classref-property -:ref:`int` **border_width_left** = ``0`` +:ref:`int` **border_width_left** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ Border width for the left border. .. rst-class:: classref-property -:ref:`int` **border_width_right** = ``0`` +:ref:`int` **border_width_right** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ Border width for the right border. .. rst-class:: classref-property -:ref:`int` **border_width_top** = ``0`` +:ref:`int` **border_width_top** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -294,7 +294,7 @@ Border width for the top border. .. rst-class:: classref-property -:ref:`int` **corner_detail** = ``8`` +:ref:`int` **corner_detail** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -315,7 +315,7 @@ A corner detail of ``1`` will result in chamfered corners instead of rounded cor .. rst-class:: classref-property -:ref:`int` **corner_radius_bottom_left** = ``0`` +:ref:`int` **corner_radius_bottom_left** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -332,7 +332,7 @@ The bottom-left corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property -:ref:`int` **corner_radius_bottom_right** = ``0`` +:ref:`int` **corner_radius_bottom_right** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -349,7 +349,7 @@ The bottom-right corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property -:ref:`int` **corner_radius_top_left** = ``0`` +:ref:`int` **corner_radius_top_left** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -366,7 +366,7 @@ The top-left corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property -:ref:`int` **corner_radius_top_right** = ``0`` +:ref:`int` **corner_radius_top_right** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -383,7 +383,7 @@ The top-right corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property -:ref:`bool` **draw_center** = ``true`` +:ref:`bool` **draw_center** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -400,7 +400,7 @@ Toggles drawing of the inner part of the stylebox. .. rst-class:: classref-property -:ref:`float` **expand_margin_bottom** = ``0.0`` +:ref:`float` **expand_margin_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -419,7 +419,7 @@ Expands the stylebox outside of the control rect on the bottom edge. Useful in c .. rst-class:: classref-property -:ref:`float` **expand_margin_left** = ``0.0`` +:ref:`float` **expand_margin_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -438,7 +438,7 @@ Expands the stylebox outside of the control rect on the left edge. Useful in com .. rst-class:: classref-property -:ref:`float` **expand_margin_right** = ``0.0`` +:ref:`float` **expand_margin_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -457,7 +457,7 @@ Expands the stylebox outside of the control rect on the right edge. Useful in co .. rst-class:: classref-property -:ref:`float` **expand_margin_top** = ``0.0`` +:ref:`float` **expand_margin_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -476,7 +476,7 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb .. rst-class:: classref-property -:ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0.6)`` +:ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0.6)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -493,7 +493,7 @@ The color of the shadow. This has no effect if :ref:`shadow_size` **shadow_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **shadow_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -510,7 +510,7 @@ The shadow offset in pixels. Adjusts the position of the shadow relatively to th .. rst-class:: classref-property -:ref:`int` **shadow_size** = ``0`` +:ref:`int` **shadow_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -527,7 +527,7 @@ The shadow size in pixels. .. rst-class:: classref-property -:ref:`Vector2` **skew** = ``Vector2(0, 0)`` +:ref:`Vector2` **skew** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -551,7 +551,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the specified :ref:`Side`'s border width. @@ -563,7 +563,7 @@ Returns the specified :ref:`Side`'s border width. .. rst-class:: classref-method -:ref:`int` **get_border_width_min**\ (\ ) |const| +:ref:`int` **get_border_width_min**\ (\ ) |const| :ref:`🔗` Returns the smallest border width out of all four borders. @@ -575,7 +575,7 @@ Returns the smallest border width out of all four borders. .. rst-class:: classref-method -:ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| +:ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| :ref:`🔗` Returns the given ``corner``'s radius. See :ref:`Corner` for possible values. @@ -587,7 +587,7 @@ Returns the given ``corner``'s radius. See :ref:`Corner` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the size of the specified :ref:`Side`'s expand margin. @@ -599,7 +599,7 @@ Returns the size of the specified :ref:`Side`'s expand m .. rst-class:: classref-method -|void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) +|void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) :ref:`🔗` Sets the specified :ref:`Side`'s border width to ``width`` pixels. @@ -611,7 +611,7 @@ Sets the specified :ref:`Side`'s border width to ``width .. rst-class:: classref-method -|void| **set_border_width_all**\ (\ width\: :ref:`int`\ ) +|void| **set_border_width_all**\ (\ width\: :ref:`int`\ ) :ref:`🔗` Sets the border width to ``width`` pixels for all sides. @@ -623,7 +623,7 @@ Sets the border width to ``width`` pixels for all sides. .. rst-class:: classref-method -|void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) +|void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) :ref:`🔗` Sets the corner radius to ``radius`` pixels for the given ``corner``. See :ref:`Corner` for possible values. @@ -635,7 +635,7 @@ Sets the corner radius to ``radius`` pixels for the given ``corner``. See :ref:` .. rst-class:: classref-method -|void| **set_corner_radius_all**\ (\ radius\: :ref:`int`\ ) +|void| **set_corner_radius_all**\ (\ radius\: :ref:`int`\ ) :ref:`🔗` Sets the corner radius to ``radius`` pixels for all corners. @@ -647,7 +647,7 @@ Sets the corner radius to ``radius`` pixels for all corners. .. rst-class:: classref-method -|void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +|void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) :ref:`🔗` Sets the expand margin to ``size`` pixels for the specified :ref:`Side`. @@ -659,7 +659,7 @@ Sets the expand margin to ``size`` pixels for the specified :ref:`Side`\ ) +|void| **set_expand_margin_all**\ (\ size\: :ref:`float`\ ) :ref:`🔗` Sets the expand margin to ``size`` pixels for all sides. diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 888e7711126..17de6eb4853 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -71,7 +71,7 @@ The line's color. .. rst-class:: classref-property -:ref:`float` **grow_begin** = ``1.0`` +:ref:`float` **grow_begin** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ The number of pixels the line will extend before the **StyleBoxLine**'s bounds. .. rst-class:: classref-property -:ref:`float` **grow_end** = ``1.0`` +:ref:`float` **grow_end** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ The number of pixels the line will extend past the **StyleBoxLine**'s bounds. If .. rst-class:: classref-property -:ref:`int` **thickness** = ``1`` +:ref:`int` **thickness** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ The line's thickness in pixels. .. rst-class:: classref-property -:ref:`bool` **vertical** = ``false`` +:ref:`bool` **vertical** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index a3b0757179f..a747551d5fd 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -94,7 +94,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AxisStretchMode**: +enum **AxisStretchMode**: :ref:`🔗` .. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_STRETCH: @@ -133,7 +133,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AxisStretchMode` **axis_stretch_horizontal** = ``0`` +:ref:`AxisStretchMode` **axis_stretch_horizontal** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ Controls how the stylebox's texture will be stretched or tiled horizontally. See .. rst-class:: classref-property -:ref:`AxisStretchMode` **axis_stretch_vertical** = ``0`` +:ref:`AxisStretchMode` **axis_stretch_vertical** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ Controls how the stylebox's texture will be stretched or tiled vertically. See : .. rst-class:: classref-property -:ref:`bool` **draw_center** = ``true`` +:ref:`bool` **draw_center** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ If ``true``, the nine-patch texture's center tile will be drawn. .. rst-class:: classref-property -:ref:`float` **expand_margin_bottom** = ``0.0`` +:ref:`float` **expand_margin_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ Expands the bottom margin of this style box when drawing, causing it to be drawn .. rst-class:: classref-property -:ref:`float` **expand_margin_left** = ``0.0`` +:ref:`float` **expand_margin_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ Expands the left margin of this style box when drawing, causing it to be drawn l .. rst-class:: classref-property -:ref:`float` **expand_margin_right** = ``0.0`` +:ref:`float` **expand_margin_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -235,7 +235,7 @@ Expands the right margin of this style box when drawing, causing it to be drawn .. rst-class:: classref-property -:ref:`float` **expand_margin_top** = ``0.0`` +:ref:`float` **expand_margin_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -252,7 +252,7 @@ Expands the top margin of this style box when drawing, causing it to be drawn la .. rst-class:: classref-property -:ref:`Color` **modulate_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **modulate_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -269,7 +269,7 @@ Modulates the color of the texture when this style box is drawn. .. rst-class:: classref-property -:ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` +:ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -290,7 +290,7 @@ If empty (``Rect2(0, 0, 0, 0)``), the whole texture will be used. .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -307,7 +307,7 @@ The texture to use when drawing this style box. .. rst-class:: classref-property -:ref:`float` **texture_margin_bottom** = ``0.0`` +:ref:`float` **texture_margin_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -328,7 +328,7 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_bottom .. rst-class:: classref-property -:ref:`float` **texture_margin_left** = ``0.0`` +:ref:`float` **texture_margin_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -349,7 +349,7 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_left` **texture_margin_right** = ``0.0`` +:ref:`float` **texture_margin_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -370,7 +370,7 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_right< .. rst-class:: classref-property -:ref:`float` **texture_margin_top** = ``0.0`` +:ref:`float` **texture_margin_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -396,7 +396,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the expand margin size of the specified :ref:`Side`. @@ -408,7 +408,7 @@ Returns the expand margin size of the specified :ref:`Side` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the margin size of the specified :ref:`Side`. @@ -420,7 +420,7 @@ Returns the margin size of the specified :ref:`Side`. .. rst-class:: classref-method -|void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +|void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) :ref:`🔗` Sets the expand margin to ``size`` pixels for the specified :ref:`Side`. @@ -432,7 +432,7 @@ Sets the expand margin to ``size`` pixels for the specified :ref:`Side`\ ) +|void| **set_expand_margin_all**\ (\ size\: :ref:`float`\ ) :ref:`🔗` Sets the expand margin to ``size`` pixels for all sides. @@ -444,7 +444,7 @@ Sets the expand margin to ``size`` pixels for all sides. .. rst-class:: classref-method -|void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +|void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) :ref:`🔗` Sets the margin to ``size`` pixels for the specified :ref:`Side`. @@ -456,7 +456,7 @@ Sets the margin to ``size`` pixels for the specified :ref:`Side`\ ) +|void| **set_texture_margin_all**\ (\ size\: :ref:`float`\ ) :ref:`🔗` Sets the margin to ``size`` pixels for all sides. diff --git a/classes/class_subviewport.rst b/classes/class_subviewport.rst index ab7fa0a65fc..d112fa6f1b8 100644 --- a/classes/class_subviewport.rst +++ b/classes/class_subviewport.rst @@ -77,7 +77,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ClearMode**: +enum **ClearMode**: :ref:`🔗` .. _class_SubViewport_constant_CLEAR_MODE_ALWAYS: @@ -111,7 +111,7 @@ Clear the render target on the next frame, then switch to :ref:`CLEAR_MODE_NEVER .. rst-class:: classref-enumeration -enum **UpdateMode**: +enum **UpdateMode**: :ref:`🔗` .. _class_SubViewport_constant_UPDATE_DISABLED: @@ -166,7 +166,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ClearMode` **render_target_clear_mode** = ``0`` +:ref:`ClearMode` **render_target_clear_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -185,7 +185,7 @@ The clear mode when the sub-viewport is used as a render target. .. rst-class:: classref-property -:ref:`UpdateMode` **render_target_update_mode** = ``2`` +:ref:`UpdateMode` **render_target_update_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -202,7 +202,7 @@ The update mode when the sub-viewport is used as a render target. .. rst-class:: classref-property -:ref:`Vector2i` **size** = ``Vector2i(512, 512)`` +:ref:`Vector2i` **size** = ``Vector2i(512, 512)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -221,7 +221,7 @@ The width and height of the sub-viewport. Must be set to a value greater than or .. rst-class:: classref-property -:ref:`Vector2i` **size_2d_override** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **size_2d_override** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -238,7 +238,7 @@ The 2D size override of the sub-viewport. If either the width or height is ``0`` .. rst-class:: classref-property -:ref:`bool` **size_2d_override_stretch** = ``false`` +:ref:`bool` **size_2d_override_stretch** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_subviewportcontainer.rst b/classes/class_subviewportcontainer.rst index 3499e89508f..687ec71e664 100644 --- a/classes/class_subviewportcontainer.rst +++ b/classes/class_subviewportcontainer.rst @@ -66,7 +66,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **stretch** = ``false`` +:ref:`bool` **stretch** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,7 +85,7 @@ If ``true``, the sub-viewport will be automatically resized to the control's siz .. rst-class:: classref-property -:ref:`int` **stretch_shrink** = ``1`` +:ref:`int` **stretch_shrink** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_propagate_input_event**\ (\ event\: :ref:`InputEvent`\ ) |virtual| |const| +:ref:`bool` **_propagate_input_event**\ (\ event\: :ref:`InputEvent`\ ) |virtual| |const| :ref:`🔗` **Experimental:** This method may be changed or removed in future versions. diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index c7373bad98d..a75b5defb59 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -150,7 +150,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **CustomFormat**: +enum **CustomFormat**: :ref:`🔗` .. _class_SurfaceTool_constant_CUSTOM_RGBA8_UNORM: @@ -232,7 +232,7 @@ Used to indicate a disabled custom channel. .. rst-class:: classref-enumeration -enum **SkinWeightCount**: +enum **SkinWeightCount**: :ref:`🔗` .. _class_SurfaceTool_constant_SKIN_4_WEIGHTS: @@ -263,7 +263,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_index**\ (\ index\: :ref:`int`\ ) +|void| **add_index**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Adds a vertex to index array if you are using indexed vertices. Does not need to be called before adding vertices. @@ -275,7 +275,7 @@ Adds a vertex to index array if you are using indexed vertices. Does not need to .. rst-class:: classref-method -|void| **add_triangle_fan**\ (\ vertices\: :ref:`PackedVector3Array`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), colors\: :ref:`PackedColorArray` = PackedColorArray(), uv2s\: :ref:`PackedVector2Array` = PackedVector2Array(), normals\: :ref:`PackedVector3Array` = PackedVector3Array(), tangents\: :ref:`Array`\[:ref:`Plane`\] = []\ ) +|void| **add_triangle_fan**\ (\ vertices\: :ref:`PackedVector3Array`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), colors\: :ref:`PackedColorArray` = PackedColorArray(), uv2s\: :ref:`PackedVector2Array` = PackedVector2Array(), normals\: :ref:`PackedVector3Array` = PackedVector3Array(), tangents\: :ref:`Array`\[:ref:`Plane`\] = []\ ) :ref:`🔗` Inserts a triangle fan made of array data into :ref:`Mesh` being constructed. @@ -289,7 +289,7 @@ Requires the primitive type be set to :ref:`Mesh.PRIMITIVE_TRIANGLES`\ ) +|void| **add_vertex**\ (\ vertex\: :ref:`Vector3`\ ) :ref:`🔗` Specifies the position of current vertex. Should be called after specifying other vertex properties (e.g. Color, UV). @@ -301,7 +301,7 @@ Specifies the position of current vertex. Should be called after specifying othe .. rst-class:: classref-method -|void| **append_from**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, transform\: :ref:`Transform3D`\ ) +|void| **append_from**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Append vertices from a given :ref:`Mesh` surface onto the current vertex array with specified :ref:`Transform3D`. @@ -313,7 +313,7 @@ Append vertices from a given :ref:`Mesh` surface onto the current ve .. rst-class:: classref-method -|void| **begin**\ (\ primitive\: :ref:`PrimitiveType`\ ) +|void| **begin**\ (\ primitive\: :ref:`PrimitiveType`\ ) :ref:`🔗` Called before adding any vertices. Takes the primitive type as an argument (e.g. :ref:`Mesh.PRIMITIVE_TRIANGLES`). @@ -325,7 +325,7 @@ Called before adding any vertices. Takes the primitive type as an argument (e.g. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clear all information passed into the surface tool so far. @@ -337,7 +337,7 @@ Clear all information passed into the surface tool so far. .. rst-class:: classref-method -:ref:`ArrayMesh` **commit**\ (\ existing\: :ref:`ArrayMesh` = null, flags\: :ref:`int` = 0\ ) +:ref:`ArrayMesh` **commit**\ (\ existing\: :ref:`ArrayMesh` = null, flags\: :ref:`int` = 0\ ) :ref:`🔗` Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. @@ -351,7 +351,7 @@ Returns a constructed :ref:`ArrayMesh` from current information .. rst-class:: classref-method -:ref:`Array` **commit_to_arrays**\ (\ ) +:ref:`Array` **commit_to_arrays**\ (\ ) :ref:`🔗` Commits the data to the same format used by :ref:`ArrayMesh.add_surface_from_arrays`, :ref:`ImporterMesh.add_surface`, and :ref:`create_from_arrays`. This way you can further process the mesh data using the :ref:`ArrayMesh` or :ref:`ImporterMesh` APIs. @@ -363,7 +363,7 @@ Commits the data to the same format used by :ref:`ArrayMesh.add_surface_from_arr .. rst-class:: classref-method -|void| **create_from**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`\ ) +|void| **create_from**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`\ ) :ref:`🔗` Creates a vertex array from an existing :ref:`Mesh`. @@ -375,7 +375,7 @@ Creates a vertex array from an existing :ref:`Mesh`. .. rst-class:: classref-method -|void| **create_from_arrays**\ (\ arrays\: :ref:`Array`, primitive_type\: :ref:`PrimitiveType` = 3\ ) +|void| **create_from_arrays**\ (\ arrays\: :ref:`Array`, primitive_type\: :ref:`PrimitiveType` = 3\ ) :ref:`🔗` Creates this SurfaceTool from existing vertex arrays such as returned by :ref:`commit_to_arrays`, :ref:`Mesh.surface_get_arrays`, :ref:`Mesh.surface_get_blend_shape_arrays`, :ref:`ImporterMesh.get_surface_arrays`, and :ref:`ImporterMesh.get_surface_blend_shape_arrays`. ``primitive_type`` controls the type of mesh data, defaulting to :ref:`Mesh.PRIMITIVE_TRIANGLES`. @@ -387,7 +387,7 @@ Creates this SurfaceTool from existing vertex arrays such as returned by :ref:`c .. rst-class:: classref-method -|void| **create_from_blend_shape**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, blend_shape\: :ref:`String`\ ) +|void| **create_from_blend_shape**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, blend_shape\: :ref:`String`\ ) :ref:`🔗` Creates a vertex array from the specified blend shape of an existing :ref:`Mesh`. This can be used to extract a specific pose from a blend shape. @@ -399,7 +399,7 @@ Creates a vertex array from the specified blend shape of an existing :ref:`Mesh< .. rst-class:: classref-method -|void| **deindex**\ (\ ) +|void| **deindex**\ (\ ) :ref:`🔗` Removes the index array by expanding the vertex array. @@ -411,7 +411,7 @@ Removes the index array by expanding the vertex array. .. rst-class:: classref-method -:ref:`PackedInt32Array` **generate_lod**\ (\ nd_threshold\: :ref:`float`, target_index_count\: :ref:`int` = 3\ ) +:ref:`PackedInt32Array` **generate_lod**\ (\ nd_threshold\: :ref:`float`, target_index_count\: :ref:`int` = 3\ ) :ref:`🔗` **Deprecated:** This method is unused internally, as it does not preserve normals or UVs. Consider using :ref:`ImporterMesh.generate_lods` instead. @@ -425,7 +425,7 @@ Generates an LOD for a given ``nd_threshold`` in linear units (square root of qu .. rst-class:: classref-method -|void| **generate_normals**\ (\ flip\: :ref:`bool` = false\ ) +|void| **generate_normals**\ (\ flip\: :ref:`bool` = false\ ) :ref:`🔗` Generates normals from vertices so you do not have to do it manually. If ``flip`` is ``true``, the resulting normals will be inverted. :ref:`generate_normals` should be called *after* generating geometry and *before* committing the mesh using :ref:`commit` or :ref:`commit_to_arrays`. For correct display of normal-mapped surfaces, you will also have to generate tangents using :ref:`generate_tangents`. @@ -441,7 +441,7 @@ Generates normals from vertices so you do not have to do it manually. If ``flip` .. rst-class:: classref-method -|void| **generate_tangents**\ (\ ) +|void| **generate_tangents**\ (\ ) :ref:`🔗` Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already (see :ref:`generate_normals`). @@ -453,7 +453,7 @@ Generates a tangent vector for each vertex. Requires that each vertex have UVs a .. rst-class:: classref-method -:ref:`AABB` **get_aabb**\ (\ ) |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| :ref:`🔗` Returns the axis-aligned bounding box of the vertex positions. @@ -465,7 +465,7 @@ Returns the axis-aligned bounding box of the vertex positions. .. rst-class:: classref-method -:ref:`CustomFormat` **get_custom_format**\ (\ channel_index\: :ref:`int`\ ) |const| +:ref:`CustomFormat` **get_custom_format**\ (\ channel_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the format for custom ``channel_index`` (currently up to 4). Returns :ref:`CUSTOM_MAX` if this custom channel is unused. @@ -477,7 +477,7 @@ Returns the format for custom ``channel_index`` (currently up to 4). Returns :re .. rst-class:: classref-method -:ref:`PrimitiveType` **get_primitive_type**\ (\ ) |const| +:ref:`PrimitiveType` **get_primitive_type**\ (\ ) |const| :ref:`🔗` Returns the type of mesh geometry, such as :ref:`Mesh.PRIMITIVE_TRIANGLES`. @@ -489,7 +489,7 @@ Returns the type of mesh geometry, such as :ref:`Mesh.PRIMITIVE_TRIANGLES` **get_skin_weight_count**\ (\ ) |const| +:ref:`SkinWeightCount` **get_skin_weight_count**\ (\ ) |const| :ref:`🔗` By default, returns :ref:`SKIN_4_WEIGHTS` to indicate only 4 bone influences per vertex are used. @@ -505,7 +505,7 @@ Returns :ref:`SKIN_8_WEIGHTS` if up t .. rst-class:: classref-method -|void| **index**\ (\ ) +|void| **index**\ (\ ) :ref:`🔗` Shrinks the vertex array by creating an index array. This can improve performance by avoiding vertex reuse. @@ -517,7 +517,7 @@ Shrinks the vertex array by creating an index array. This can improve performanc .. rst-class:: classref-method -|void| **optimize_indices_for_cache**\ (\ ) +|void| **optimize_indices_for_cache**\ (\ ) :ref:`🔗` Optimizes triangle sorting for performance. Requires that :ref:`get_primitive_type` is :ref:`Mesh.PRIMITIVE_TRIANGLES`. @@ -529,7 +529,7 @@ Optimizes triangle sorting for performance. Requires that :ref:`get_primitive_ty .. rst-class:: classref-method -|void| **set_bones**\ (\ bones\: :ref:`PackedInt32Array`\ ) +|void| **set_bones**\ (\ bones\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Specifies an array of bones to use for the *next* vertex. ``bones`` must contain 4 integers. @@ -541,7 +541,7 @@ Specifies an array of bones to use for the *next* vertex. ``bones`` must contain .. rst-class:: classref-method -|void| **set_color**\ (\ color\: :ref:`Color`\ ) +|void| **set_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` Specifies a :ref:`Color` to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -555,7 +555,7 @@ Specifies a :ref:`Color` to use for the *next* vertex. If every ver .. rst-class:: classref-method -|void| **set_custom**\ (\ channel_index\: :ref:`int`, custom_color\: :ref:`Color`\ ) +|void| **set_custom**\ (\ channel_index\: :ref:`int`, custom_color\: :ref:`Color`\ ) :ref:`🔗` Sets the custom value on this vertex for ``channel_index``. @@ -569,7 +569,7 @@ Sets the custom value on this vertex for ``channel_index``. .. rst-class:: classref-method -|void| **set_custom_format**\ (\ channel_index\: :ref:`int`, format\: :ref:`CustomFormat`\ ) +|void| **set_custom_format**\ (\ channel_index\: :ref:`int`, format\: :ref:`CustomFormat`\ ) :ref:`🔗` Sets the color format for this custom ``channel_index``. Use :ref:`CUSTOM_MAX` to disable. @@ -583,7 +583,7 @@ Must be invoked after :ref:`begin` and should be .. rst-class:: classref-method -|void| **set_material**\ (\ material\: :ref:`Material`\ ) +|void| **set_material**\ (\ material\: :ref:`Material`\ ) :ref:`🔗` Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. @@ -595,7 +595,7 @@ Sets :ref:`Material` to be used by the :ref:`Mesh` y .. rst-class:: classref-method -|void| **set_normal**\ (\ normal\: :ref:`Vector3`\ ) +|void| **set_normal**\ (\ normal\: :ref:`Vector3`\ ) :ref:`🔗` Specifies a normal to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -607,7 +607,7 @@ Specifies a normal to use for the *next* vertex. If every vertex needs to have t .. rst-class:: classref-method -|void| **set_skin_weight_count**\ (\ count\: :ref:`SkinWeightCount`\ ) +|void| **set_skin_weight_count**\ (\ count\: :ref:`SkinWeightCount`\ ) :ref:`🔗` Set to :ref:`SKIN_8_WEIGHTS` to indicate that up to 8 bone influences per vertex may be used. @@ -623,7 +623,7 @@ By default, only 4 bone influences are used (:ref:`SKIN_4_WEIGHTS`\ ) +|void| **set_smooth_group**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Specifies the smooth group to use for the *next* vertex. If this is never called, all vertices will have the default smooth group of ``0`` and will be smoothed with adjacent vertices of the same group. To produce a mesh with flat normals, set the smooth group to ``-1``. @@ -637,7 +637,7 @@ Specifies the smooth group to use for the *next* vertex. If this is never called .. rst-class:: classref-method -|void| **set_tangent**\ (\ tangent\: :ref:`Plane`\ ) +|void| **set_tangent**\ (\ tangent\: :ref:`Plane`\ ) :ref:`🔗` Specifies a tangent to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -649,7 +649,7 @@ Specifies a tangent to use for the *next* vertex. If every vertex needs to have .. rst-class:: classref-method -|void| **set_uv**\ (\ uv\: :ref:`Vector2`\ ) +|void| **set_uv**\ (\ uv\: :ref:`Vector2`\ ) :ref:`🔗` Specifies a set of UV coordinates to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -661,7 +661,7 @@ Specifies a set of UV coordinates to use for the *next* vertex. If every vertex .. rst-class:: classref-method -|void| **set_uv2**\ (\ uv2\: :ref:`Vector2`\ ) +|void| **set_uv2**\ (\ uv2\: :ref:`Vector2`\ ) :ref:`🔗` Specifies an optional second set of UV coordinates to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -673,7 +673,7 @@ Specifies an optional second set of UV coordinates to use for the *next* vertex. .. rst-class:: classref-method -|void| **set_weights**\ (\ weights\: :ref:`PackedFloat32Array`\ ) +|void| **set_weights**\ (\ weights\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Specifies weight values to use for the *next* vertex. ``weights`` must contain 4 values. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. diff --git a/classes/class_syntaxhighlighter.rst b/classes/class_syntaxhighlighter.rst index 00628b4d7d4..ae616f21cb8 100644 --- a/classes/class_syntaxhighlighter.rst +++ b/classes/class_syntaxhighlighter.rst @@ -62,7 +62,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_clear_highlighting_cache**\ (\ ) |virtual| +|void| **_clear_highlighting_cache**\ (\ ) |virtual| :ref:`🔗` Virtual method which can be overridden to clear any local caches. @@ -74,7 +74,7 @@ Virtual method which can be overridden to clear any local caches. .. rst-class:: classref-method -:ref:`Dictionary` **_get_line_syntax_highlighting**\ (\ line\: :ref:`int`\ ) |virtual| |const| +:ref:`Dictionary` **_get_line_syntax_highlighting**\ (\ line\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Virtual method which can be overridden to return syntax highlighting data. @@ -88,7 +88,7 @@ See :ref:`get_line_syntax_highlighting` Virtual method which can be overridden to update any local caches. @@ -100,7 +100,7 @@ Virtual method which can be overridden to update any local caches. .. rst-class:: classref-method -|void| **clear_highlighting_cache**\ (\ ) +|void| **clear_highlighting_cache**\ (\ ) :ref:`🔗` Clears all cached syntax highlighting data. @@ -114,7 +114,7 @@ Then calls overridable method :ref:`_clear_highlighting_cache` **get_line_syntax_highlighting**\ (\ line\: :ref:`int`\ ) +:ref:`Dictionary` **get_line_syntax_highlighting**\ (\ line\: :ref:`int`\ ) :ref:`🔗` Returns syntax highlighting data for a single line. If the line is not cached, calls :ref:`_get_line_syntax_highlighting` to calculate the data. @@ -143,7 +143,7 @@ This will color columns 0-4 red, and columns 5-eol in green. .. rst-class:: classref-method -:ref:`TextEdit` **get_text_edit**\ (\ ) |const| +:ref:`TextEdit` **get_text_edit**\ (\ ) |const| :ref:`🔗` Returns the associated :ref:`TextEdit` node. @@ -155,7 +155,7 @@ Returns the associated :ref:`TextEdit` node. .. rst-class:: classref-method -|void| **update_cache**\ (\ ) +|void| **update_cache**\ (\ ) :ref:`🔗` Clears then updates the **SyntaxHighlighter** caches. Override :ref:`_update_cache` for a callback. diff --git a/classes/class_systemfont.rst b/classes/class_systemfont.rst index 9e4e8f2205f..39fafa5c090 100644 --- a/classes/class_systemfont.rst +++ b/classes/class_systemfont.rst @@ -82,7 +82,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_system_fallback** = ``true`` +:ref:`bool` **allow_system_fallback** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-property -:ref:`FontAntialiasing` **antialiasing** = ``1`` +:ref:`FontAntialiasing` **antialiasing** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ Font anti-aliasing mode. .. rst-class:: classref-property -:ref:`bool` **disable_embedded_bitmaps** = ``true`` +:ref:`bool` **disable_embedded_bitmaps** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and co .. rst-class:: classref-property -:ref:`bool` **font_italic** = ``false`` +:ref:`bool` **font_italic** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ If set to ``true``, italic or oblique font is preferred. .. rst-class:: classref-property -:ref:`PackedStringArray` **font_names** = ``PackedStringArray()`` +:ref:`PackedStringArray` **font_names** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -169,7 +169,7 @@ Array of font family names to search, first matching font found is used. .. rst-class:: classref-property -:ref:`int` **font_stretch** = ``100`` +:ref:`int` **font_stretch** = ``100`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -186,7 +186,7 @@ Preferred font stretch amount, compared to a normal width. A percentage value be .. rst-class:: classref-property -:ref:`int` **font_weight** = ``400`` +:ref:`int` **font_weight** = ``400`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -203,7 +203,7 @@ Preferred weight (boldness) of the font. A value in the ``100...999`` range, nor .. rst-class:: classref-property -:ref:`bool` **force_autohinter** = ``false`` +:ref:`bool` **force_autohinter** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ If set to ``true``, auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-property -:ref:`bool` **generate_mipmaps** = ``false`` +:ref:`bool` **generate_mipmaps** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -237,7 +237,7 @@ If set to ``true``, generate mipmaps for the font textures. .. rst-class:: classref-property -:ref:`Hinting` **hinting** = ``1`` +:ref:`Hinting` **hinting** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ Font hinting mode. .. rst-class:: classref-property -:ref:`int` **msdf_pixel_range** = ``16`` +:ref:`int` **msdf_pixel_range** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property -:ref:`int` **msdf_size** = ``48`` +:ref:`int` **msdf_size** = ``48`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -288,7 +288,7 @@ Source font size used to generate MSDF textures. Higher values allow for more pr .. rst-class:: classref-property -:ref:`bool` **multichannel_signed_distance_field** = ``false`` +:ref:`bool` **multichannel_signed_distance_field** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -305,7 +305,7 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-property -:ref:`float` **oversampling** = ``0.0`` +:ref:`float` **oversampling** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -322,7 +322,7 @@ Font oversampling factor, if set to ``0.0`` global oversampling factor is used i .. rst-class:: classref-property -:ref:`SubpixelPositioning` **subpixel_positioning** = ``1`` +:ref:`SubpixelPositioning` **subpixel_positioning** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index f0347e9c198..ec493b93766 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -202,7 +202,7 @@ Signals .. rst-class:: classref-signal -**active_tab_rearranged**\ (\ idx_to\: :ref:`int`\ ) +**active_tab_rearranged**\ (\ idx_to\: :ref:`int`\ ) :ref:`🔗` Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. @@ -214,7 +214,7 @@ Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rear .. rst-class:: classref-signal -**tab_button_pressed**\ (\ tab\: :ref:`int`\ ) +**tab_button_pressed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab's right button is pressed. See :ref:`set_tab_button_icon`. @@ -226,7 +226,7 @@ Emitted when a tab's right button is pressed. See :ref:`set_tab_button_icon`\ ) +**tab_changed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when switching to another tab. @@ -238,7 +238,7 @@ Emitted when switching to another tab. .. rst-class:: classref-signal -**tab_clicked**\ (\ tab\: :ref:`int`\ ) +**tab_clicked**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is clicked, even if it is the current tab. @@ -250,7 +250,7 @@ Emitted when a tab is clicked, even if it is the current tab. .. rst-class:: classref-signal -**tab_close_pressed**\ (\ tab\: :ref:`int`\ ) +**tab_close_pressed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab's close button is pressed. @@ -277,7 +277,7 @@ Emitted when a tab's close button is pressed. .. rst-class:: classref-signal -**tab_hovered**\ (\ tab\: :ref:`int`\ ) +**tab_hovered**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is hovered by the mouse. @@ -289,7 +289,7 @@ Emitted when a tab is hovered by the mouse. .. rst-class:: classref-signal -**tab_rmb_clicked**\ (\ tab\: :ref:`int`\ ) +**tab_rmb_clicked**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is right-clicked. :ref:`select_with_rmb` must be enabled. @@ -301,7 +301,7 @@ Emitted when a tab is right-clicked. :ref:`select_with_rmb`\ ) +**tab_selected**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is selected via click, directional input, or script, even if it is the current tab. @@ -318,7 +318,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **AlignmentMode**: +enum **AlignmentMode**: :ref:`🔗` .. _class_TabBar_constant_ALIGNMENT_LEFT: @@ -360,7 +360,7 @@ Represents the size of the :ref:`AlignmentMode` enum. .. rst-class:: classref-enumeration -enum **CloseButtonDisplayPolicy**: +enum **CloseButtonDisplayPolicy**: :ref:`🔗` .. _class_TabBar_constant_CLOSE_BUTTON_SHOW_NEVER: @@ -407,7 +407,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **clip_tabs** = ``true`` +:ref:`bool` **clip_tabs** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -424,7 +424,7 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n .. rst-class:: classref-property -:ref:`int` **current_tab** = ``-1`` +:ref:`int` **current_tab** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -441,7 +441,7 @@ The index of the current selected tab. A value of ``-1`` means that no tab is se .. rst-class:: classref-property -:ref:`bool` **deselect_enabled** = ``false`` +:ref:`bool` **deselect_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -458,7 +458,7 @@ If ``true``, all tabs can be deselected so that no tab is selected. Click on the .. rst-class:: classref-property -:ref:`bool` **drag_to_rearrange_enabled** = ``false`` +:ref:`bool` **drag_to_rearrange_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -475,7 +475,7 @@ If ``true``, tabs can be rearranged with mouse drag. .. rst-class:: classref-property -:ref:`int` **max_tab_width** = ``0`` +:ref:`int` **max_tab_width** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -492,7 +492,7 @@ Sets the maximum width which all tabs should be limited to. Unlimited if set to .. rst-class:: classref-property -:ref:`bool` **scroll_to_selected** = ``true`` +:ref:`bool` **scroll_to_selected** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -509,7 +509,7 @@ If ``true``, the tab offset will be changed to keep the currently selected tab v .. rst-class:: classref-property -:ref:`bool` **scrolling_enabled** = ``true`` +:ref:`bool` **scrolling_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -526,7 +526,7 @@ if ``true``, the mouse's scroll wheel can be used to navigate the scroll view. .. rst-class:: classref-property -:ref:`bool` **select_with_rmb** = ``false`` +:ref:`bool` **select_with_rmb** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -543,7 +543,7 @@ If ``true``, enables selecting a tab with the right mouse button. .. rst-class:: classref-property -:ref:`AlignmentMode` **tab_alignment** = ``0`` +:ref:`AlignmentMode` **tab_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -560,7 +560,7 @@ Sets the position at which tabs will be placed. See :ref:`AlignmentMode` **tab_close_display_policy** = ``0`` +:ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -577,7 +577,7 @@ Sets when the close button will appear on the tabs. See :ref:`CloseButtonDisplay .. rst-class:: classref-property -:ref:`int` **tab_count** = ``0`` +:ref:`int` **tab_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -594,7 +594,7 @@ The number of tabs currently in the bar. .. rst-class:: classref-property -:ref:`int` **tabs_rearrange_group** = ``-1`` +:ref:`int` **tabs_rearrange_group** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -618,7 +618,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_tab**\ (\ title\: :ref:`String` = "", icon\: :ref:`Texture2D` = null\ ) +|void| **add_tab**\ (\ title\: :ref:`String` = "", icon\: :ref:`Texture2D` = null\ ) :ref:`🔗` Adds a new tab. @@ -630,7 +630,7 @@ Adds a new tab. .. rst-class:: classref-method -|void| **clear_tabs**\ (\ ) +|void| **clear_tabs**\ (\ ) :ref:`🔗` Clears all tabs. @@ -642,7 +642,7 @@ Clears all tabs. .. rst-class:: classref-method -|void| **ensure_tab_visible**\ (\ idx\: :ref:`int`\ ) +|void| **ensure_tab_visible**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Moves the scroll view to make the tab visible. @@ -654,7 +654,7 @@ Moves the scroll view to make the tab visible. .. rst-class:: classref-method -:ref:`bool` **get_offset_buttons_visible**\ (\ ) |const| +:ref:`bool` **get_offset_buttons_visible**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible. @@ -666,7 +666,7 @@ Returns ``true`` if the offset buttons (the ones that appear when there's not en .. rst-class:: classref-method -:ref:`int` **get_previous_tab**\ (\ ) |const| +:ref:`int` **get_previous_tab**\ (\ ) |const| :ref:`🔗` Returns the previously active tab index. @@ -678,7 +678,7 @@ Returns the previously active tab index. .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_button_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_tab_button_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon for the right button of the tab at index ``tab_idx`` or ``null`` if the right button has no icon. @@ -690,7 +690,7 @@ Returns the icon for the right button of the tab at index ``tab_idx`` or ``null` .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_tab_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon for the tab at index ``tab_idx`` or ``null`` if the tab has no icon. @@ -702,7 +702,7 @@ Returns the icon for the tab at index ``tab_idx`` or ``null`` if the tab has no .. rst-class:: classref-method -:ref:`int` **get_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. @@ -714,7 +714,7 @@ Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`int` **get_tab_idx_at_point**\ (\ point\: :ref:`Vector2`\ ) |const| +:ref:`int` **get_tab_idx_at_point**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if the point is outside the control boundaries or if there's no tab at the queried position. @@ -726,7 +726,7 @@ Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if t .. rst-class:: classref-method -:ref:`String` **get_tab_language**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_tab_language**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns tab title language code. @@ -738,7 +738,7 @@ Returns tab title language code. .. rst-class:: classref-method -:ref:`Variant` **get_tab_metadata**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_tab_metadata**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_tab_metadata`. If no metadata was previously set, returns ``null`` by default. @@ -750,7 +750,7 @@ Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_t .. rst-class:: classref-method -:ref:`int` **get_tab_offset**\ (\ ) |const| +:ref:`int` **get_tab_offset**\ (\ ) |const| :ref:`🔗` Returns the number of hidden tabs offsetted to the left. @@ -762,7 +762,7 @@ Returns the number of hidden tabs offsetted to the left. .. rst-class:: classref-method -:ref:`Rect2` **get_tab_rect**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Rect2` **get_tab_rect**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns tab :ref:`Rect2` with local position and size. @@ -774,7 +774,7 @@ Returns tab :ref:`Rect2` with local position and size. .. rst-class:: classref-method -:ref:`TextDirection` **get_tab_text_direction**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`TextDirection` **get_tab_text_direction**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns tab title text base writing direction. @@ -786,7 +786,7 @@ Returns tab title text base writing direction. .. rst-class:: classref-method -:ref:`String` **get_tab_title**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_tab_title**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the title of the tab at index ``tab_idx``. @@ -798,7 +798,7 @@ Returns the title of the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`String` **get_tab_tooltip**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_tab_tooltip**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip text of the tab at index ``tab_idx``. @@ -810,7 +810,7 @@ Returns the tooltip text of the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`bool` **is_tab_disabled**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_tab_disabled**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the tab at index ``tab_idx`` is disabled. @@ -822,7 +822,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. rst-class:: classref-method -:ref:`bool` **is_tab_hidden**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_tab_hidden**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the tab at index ``tab_idx`` is hidden. @@ -834,7 +834,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is hidden. .. rst-class:: classref-method -|void| **move_tab**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) +|void| **move_tab**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) :ref:`🔗` Moves a tab from ``from`` to ``to``. @@ -846,7 +846,7 @@ Moves a tab from ``from`` to ``to``. .. rst-class:: classref-method -|void| **remove_tab**\ (\ tab_idx\: :ref:`int`\ ) +|void| **remove_tab**\ (\ tab_idx\: :ref:`int`\ ) :ref:`🔗` Removes the tab at index ``tab_idx``. @@ -858,7 +858,7 @@ Removes the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`bool` **select_next_available**\ (\ ) +:ref:`bool` **select_next_available**\ (\ ) :ref:`🔗` Selects the first available tab with greater index than the currently selected. Returns ``true`` if tab selection changed. @@ -870,7 +870,7 @@ Selects the first available tab with greater index than the currently selected. .. rst-class:: classref-method -:ref:`bool` **select_previous_available**\ (\ ) +:ref:`bool` **select_previous_available**\ (\ ) :ref:`🔗` Selects the first available tab with lower index than the currently selected. Returns ``true`` if tab selection changed. @@ -882,7 +882,7 @@ Selects the first available tab with lower index than the currently selected. Re .. rst-class:: classref-method -|void| **set_tab_button_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_tab_button_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets an ``icon`` for the button of the tab at index ``tab_idx`` (located to the right, before the close button), making it visible and clickable (See :ref:`tab_button_pressed`). Giving it a ``null`` value will hide the button. @@ -894,7 +894,7 @@ Sets an ``icon`` for the button of the tab at index ``tab_idx`` (located to the .. rst-class:: classref-method -|void| **set_tab_disabled**\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_tab_disabled**\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it non-interactable. @@ -906,7 +906,7 @@ If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it no .. rst-class:: classref-method -|void| **set_tab_hidden**\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) +|void| **set_tab_hidden**\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) :ref:`🔗` If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappear from the tab area. @@ -918,7 +918,7 @@ If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappe .. rst-class:: classref-method -|void| **set_tab_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_tab_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets an ``icon`` for the tab at index ``tab_idx``. @@ -930,7 +930,7 @@ Sets an ``icon`` for the tab at index ``tab_idx``. .. rst-class:: classref-method -|void| **set_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`, width\: :ref:`int`\ ) +|void| **set_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`, width\: :ref:`int`\ ) :ref:`🔗` Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. @@ -942,7 +942,7 @@ Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. Thi .. rst-class:: classref-method -|void| **set_tab_language**\ (\ tab_idx\: :ref:`int`, language\: :ref:`String`\ ) +|void| **set_tab_language**\ (\ tab_idx\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -954,7 +954,7 @@ Sets language code of tab title used for line-breaking and text shaping algorith .. rst-class:: classref-method -|void| **set_tab_metadata**\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) +|void| **set_tab_metadata**\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved later using :ref:`get_tab_metadata`. @@ -966,7 +966,7 @@ Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved .. rst-class:: classref-method -|void| **set_tab_text_direction**\ (\ tab_idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) +|void| **set_tab_text_direction**\ (\ tab_idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) :ref:`🔗` Sets tab title base writing direction. @@ -978,7 +978,7 @@ Sets tab title base writing direction. .. rst-class:: classref-method -|void| **set_tab_title**\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) +|void| **set_tab_title**\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) :ref:`🔗` Sets a ``title`` for the tab at index ``tab_idx``. @@ -990,7 +990,7 @@ Sets a ``title`` for the tab at index ``tab_idx``. .. rst-class:: classref-method -|void| **set_tab_tooltip**\ (\ tab_idx\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_tab_tooltip**\ (\ tab_idx\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets a ``tooltip`` for tab at index ``tab_idx``. @@ -1009,7 +1009,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **drop_mark_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **drop_mark_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Modulation color for the :ref:`drop_mark` icon. @@ -1021,7 +1021,7 @@ Modulation color for the :ref:`drop_mark` ico .. rst-class:: classref-themeproperty -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Font color of disabled tabs. @@ -1033,7 +1033,7 @@ Font color of disabled tabs. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Font color of the currently hovered tab. Does not apply to the selected tab. @@ -1045,7 +1045,7 @@ Font color of the currently hovered tab. Does not apply to the selected tab. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the tab name. @@ -1057,7 +1057,7 @@ The tint of text outline of the tab name. .. rst-class:: classref-themeproperty -:ref:`Color` **font_selected_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_selected_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Font color of the currently selected tab. @@ -1069,7 +1069,7 @@ Font color of the currently selected tab. .. rst-class:: classref-themeproperty -:ref:`Color` **font_unselected_color** = ``Color(0.7, 0.7, 0.7, 1)`` +:ref:`Color` **font_unselected_color** = ``Color(0.7, 0.7, 0.7, 1)`` :ref:`🔗` Font color of the other, unselected tabs. @@ -1081,7 +1081,7 @@ Font color of the other, unselected tabs. .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal separation between the elements inside tabs. @@ -1093,7 +1093,7 @@ The horizontal separation between the elements inside tabs. .. rst-class:: classref-themeproperty -:ref:`int` **icon_max_width** = ``0`` +:ref:`int` **icon_max_width** = ``0`` :ref:`🔗` The maximum allowed width of the tab's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`set_tab_icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1105,7 +1105,7 @@ The maximum allowed width of the tab's icon. This limit is applied on top of the .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the tab text outline. @@ -1119,7 +1119,7 @@ The size of the tab text outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` The font used to draw tab names. @@ -1131,7 +1131,7 @@ The font used to draw tab names. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the tab names. @@ -1143,7 +1143,7 @@ Font size of the tab names. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **close** +:ref:`Texture2D` **close** :ref:`🔗` The icon for the close button (see :ref:`tab_close_display_policy`). @@ -1155,7 +1155,7 @@ The icon for the close button (see :ref:`tab_close_display_policy` **decrement** +:ref:`Texture2D` **decrement** :ref:`🔗` Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. @@ -1167,7 +1167,7 @@ Icon for the left arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **decrement_highlight** +:ref:`Texture2D` **decrement_highlight** :ref:`🔗` Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. @@ -1179,7 +1179,7 @@ Icon for the left arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **drop_mark** +:ref:`Texture2D` **drop_mark** :ref:`🔗` Icon shown to indicate where a dragged tab is gonna be dropped (see :ref:`drag_to_rearrange_enabled`). @@ -1191,7 +1191,7 @@ Icon shown to indicate where a dragged tab is gonna be dropped (see :ref:`drag_t .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment** +:ref:`Texture2D` **increment** :ref:`🔗` Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. @@ -1203,7 +1203,7 @@ Icon for the right arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment_highlight** +:ref:`Texture2D` **increment_highlight** :ref:`🔗` Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. @@ -1215,7 +1215,7 @@ Icon for the right arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`StyleBox` **button_highlight** +:ref:`StyleBox` **button_highlight** :ref:`🔗` Background of the tab and close buttons when they're being hovered with the cursor. @@ -1227,7 +1227,7 @@ Background of the tab and close buttons when they're being hovered with the curs .. rst-class:: classref-themeproperty -:ref:`StyleBox` **button_pressed** +:ref:`StyleBox` **button_pressed** :ref:`🔗` Background of the tab and close buttons when it's being pressed. @@ -1239,7 +1239,7 @@ Background of the tab and close buttons when it's being pressed. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_disabled** +:ref:`StyleBox` **tab_disabled** :ref:`🔗` The style of disabled tabs. @@ -1251,7 +1251,7 @@ The style of disabled tabs. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_focus** +:ref:`StyleBox` **tab_focus** :ref:`🔗` :ref:`StyleBox` used when the **TabBar** is focused. The :ref:`tab_focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox` of the selected tab, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -1263,7 +1263,7 @@ The style of disabled tabs. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_hovered** +:ref:`StyleBox` **tab_hovered** :ref:`🔗` The style of the currently hovered tab. Does not apply to the selected tab. @@ -1277,7 +1277,7 @@ The style of the currently hovered tab. Does not apply to the selected tab. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_selected** +:ref:`StyleBox` **tab_selected** :ref:`🔗` The style of the currently selected tab. @@ -1289,7 +1289,7 @@ The style of the currently selected tab. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_unselected** +:ref:`StyleBox` **tab_unselected** :ref:`🔗` The style of the other, unselected tabs. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index c99187f3de1..51abbf5d438 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -201,7 +201,7 @@ Signals .. rst-class:: classref-signal -**active_tab_rearranged**\ (\ idx_to\: :ref:`int`\ ) +**active_tab_rearranged**\ (\ idx_to\: :ref:`int`\ ) :ref:`🔗` Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. @@ -213,7 +213,7 @@ Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rear .. rst-class:: classref-signal -**pre_popup_pressed**\ (\ ) +**pre_popup_pressed**\ (\ ) :ref:`🔗` Emitted when the **TabContainer**'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. @@ -225,7 +225,7 @@ Emitted when the **TabContainer**'s :ref:`Popup` button is clicked. .. rst-class:: classref-signal -**tab_button_pressed**\ (\ tab\: :ref:`int`\ ) +**tab_button_pressed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when the user clicks on the button icon on this tab. @@ -237,7 +237,7 @@ Emitted when the user clicks on the button icon on this tab. .. rst-class:: classref-signal -**tab_changed**\ (\ tab\: :ref:`int`\ ) +**tab_changed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when switching to another tab. @@ -249,7 +249,7 @@ Emitted when switching to another tab. .. rst-class:: classref-signal -**tab_clicked**\ (\ tab\: :ref:`int`\ ) +**tab_clicked**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is clicked, even if it is the current tab. @@ -261,7 +261,7 @@ Emitted when a tab is clicked, even if it is the current tab. .. rst-class:: classref-signal -**tab_hovered**\ (\ tab\: :ref:`int`\ ) +**tab_hovered**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is hovered by the mouse. @@ -273,7 +273,7 @@ Emitted when a tab is hovered by the mouse. .. rst-class:: classref-signal -**tab_selected**\ (\ tab\: :ref:`int`\ ) +**tab_selected**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` Emitted when a tab is selected via click, directional input, or script, even if it is the current tab. @@ -290,7 +290,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TabPosition**: +enum **TabPosition**: :ref:`🔗` .. _class_TabContainer_constant_POSITION_TOP: @@ -329,7 +329,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **all_tabs_in_front** = ``false`` +:ref:`bool` **all_tabs_in_front** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -346,7 +346,7 @@ If ``true``, all tabs are drawn in front of the panel. If ``false``, inactive ta .. rst-class:: classref-property -:ref:`bool` **clip_tabs** = ``true`` +:ref:`bool` **clip_tabs** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -363,7 +363,7 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n .. rst-class:: classref-property -:ref:`int` **current_tab** = ``-1`` +:ref:`int` **current_tab** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -382,7 +382,7 @@ A value of ``-1`` means that no tab is selected. .. rst-class:: classref-property -:ref:`bool` **deselect_enabled** = ``false`` +:ref:`bool` **deselect_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -401,7 +401,7 @@ Only the tab header will be shown if no tabs are selected. .. rst-class:: classref-property -:ref:`bool` **drag_to_rearrange_enabled** = ``false`` +:ref:`bool` **drag_to_rearrange_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -418,7 +418,7 @@ If ``true``, tabs can be rearranged with mouse drag. .. rst-class:: classref-property -:ref:`AlignmentMode` **tab_alignment** = ``0`` +:ref:`AlignmentMode` **tab_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -435,7 +435,7 @@ Sets the position at which tabs will be placed. See :ref:`AlignmentMode` **tab_focus_mode** = ``2`` +:ref:`FocusMode` **tab_focus_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -452,7 +452,7 @@ The focus access mode for the internal :ref:`TabBar` node. .. rst-class:: classref-property -:ref:`TabPosition` **tabs_position** = ``0`` +:ref:`TabPosition` **tabs_position** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -469,7 +469,7 @@ Sets the position of the tab bar. See :ref:`TabPosition` **tabs_rearrange_group** = ``-1`` +:ref:`int` **tabs_rearrange_group** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -488,7 +488,7 @@ Setting this to ``-1`` will disable rearranging between **TabContainer**\ s. .. rst-class:: classref-property -:ref:`bool` **tabs_visible** = ``true`` +:ref:`bool` **tabs_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -505,7 +505,7 @@ If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden .. rst-class:: classref-property -:ref:`bool` **use_hidden_tabs_for_min_size** = ``false`` +:ref:`bool` **use_hidden_tabs_for_min_size** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -527,7 +527,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Control` **get_current_tab_control**\ (\ ) |const| +:ref:`Control` **get_current_tab_control**\ (\ ) |const| :ref:`🔗` Returns the child :ref:`Control` node located at the active tab index. @@ -539,7 +539,7 @@ Returns the child :ref:`Control` node located at the active tab i .. rst-class:: classref-method -:ref:`Popup` **get_popup**\ (\ ) |const| +:ref:`Popup` **get_popup**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. @@ -553,7 +553,7 @@ Returns the :ref:`Popup` node instance if one has been set already .. rst-class:: classref-method -:ref:`int` **get_previous_tab**\ (\ ) |const| +:ref:`int` **get_previous_tab**\ (\ ) |const| :ref:`🔗` Returns the previously active tab index. @@ -565,7 +565,7 @@ Returns the previously active tab index. .. rst-class:: classref-method -:ref:`TabBar` **get_tab_bar**\ (\ ) |const| +:ref:`TabBar` **get_tab_bar**\ (\ ) |const| :ref:`🔗` Returns the :ref:`TabBar` contained in this container. @@ -579,7 +579,7 @@ Returns the :ref:`TabBar` contained in this container. .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_button_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_tab_button_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the button icon from the tab at index ``tab_idx``. @@ -591,7 +591,7 @@ Returns the button icon from the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`Control` **get_tab_control**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Control` **get_tab_control**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Control` node from the tab at index ``tab_idx``. @@ -603,7 +603,7 @@ Returns the :ref:`Control` node from the tab at index ``tab_idx`` .. rst-class:: classref-method -:ref:`int` **get_tab_count**\ (\ ) |const| +:ref:`int` **get_tab_count**\ (\ ) |const| :ref:`🔗` Returns the number of tabs. @@ -615,7 +615,7 @@ Returns the number of tabs. .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_tab_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture2D`. @@ -627,7 +627,7 @@ Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` o .. rst-class:: classref-method -:ref:`int` **get_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`int` **get_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. @@ -639,7 +639,7 @@ Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`int` **get_tab_idx_at_point**\ (\ point\: :ref:`Vector2`\ ) |const| +:ref:`int` **get_tab_idx_at_point**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if the point is outside the control boundaries or if there's no tab at the queried position. @@ -651,7 +651,7 @@ Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if t .. rst-class:: classref-method -:ref:`int` **get_tab_idx_from_control**\ (\ control\: :ref:`Control`\ ) |const| +:ref:`int` **get_tab_idx_from_control**\ (\ control\: :ref:`Control`\ ) |const| :ref:`🔗` Returns the index of the tab tied to the given ``control``. The control must be a child of the **TabContainer**. @@ -663,7 +663,7 @@ Returns the index of the tab tied to the given ``control``. The control must be .. rst-class:: classref-method -:ref:`Variant` **get_tab_metadata**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`Variant` **get_tab_metadata**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_tab_metadata`. If no metadata was previously set, returns ``null`` by default. @@ -675,7 +675,7 @@ Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_t .. rst-class:: classref-method -:ref:`String` **get_tab_title**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_tab_title**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. @@ -687,7 +687,7 @@ Returns the title of the tab at index ``tab_idx``. Tab titles default to the nam .. rst-class:: classref-method -:ref:`String` **get_tab_tooltip**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`String` **get_tab_tooltip**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip text of the tab at index ``tab_idx``. @@ -699,7 +699,7 @@ Returns the tooltip text of the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`bool` **is_tab_disabled**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_tab_disabled**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the tab at index ``tab_idx`` is disabled. @@ -711,7 +711,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. rst-class:: classref-method -:ref:`bool` **is_tab_hidden**\ (\ tab_idx\: :ref:`int`\ ) |const| +:ref:`bool` **is_tab_hidden**\ (\ tab_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the tab at index ``tab_idx`` is hidden. @@ -723,7 +723,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is hidden. .. rst-class:: classref-method -:ref:`bool` **select_next_available**\ (\ ) +:ref:`bool` **select_next_available**\ (\ ) :ref:`🔗` Selects the first available tab with greater index than the currently selected. Returns ``true`` if tab selection changed. @@ -735,7 +735,7 @@ Selects the first available tab with greater index than the currently selected. .. rst-class:: classref-method -:ref:`bool` **select_previous_available**\ (\ ) +:ref:`bool` **select_previous_available**\ (\ ) :ref:`🔗` Selects the first available tab with lower index than the currently selected. Returns ``true`` if tab selection changed. @@ -747,7 +747,7 @@ Selects the first available tab with lower index than the currently selected. Re .. rst-class:: classref-method -|void| **set_popup**\ (\ popup\: :ref:`Node`\ ) +|void| **set_popup**\ (\ popup\: :ref:`Node`\ ) :ref:`🔗` If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the **TabContainer** (setting it to ``null`` will make it go away). Clicking it will expand the :ref:`Popup` node. @@ -759,7 +759,7 @@ If set on a :ref:`Popup` node instance, a popup menu icon appears i .. rst-class:: classref-method -|void| **set_tab_button_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_tab_button_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the button icon from the tab at index ``tab_idx``. @@ -771,7 +771,7 @@ Sets the button icon from the tab at index ``tab_idx``. .. rst-class:: classref-method -|void| **set_tab_disabled**\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_tab_disabled**\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it non-interactable. @@ -783,7 +783,7 @@ If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it no .. rst-class:: classref-method -|void| **set_tab_hidden**\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) +|void| **set_tab_hidden**\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) :ref:`🔗` If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappear from the tab area. @@ -795,7 +795,7 @@ If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappe .. rst-class:: classref-method -|void| **set_tab_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_tab_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets an icon for the tab at index ``tab_idx``. @@ -807,7 +807,7 @@ Sets an icon for the tab at index ``tab_idx``. .. rst-class:: classref-method -|void| **set_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`, width\: :ref:`int`\ ) +|void| **set_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`, width\: :ref:`int`\ ) :ref:`🔗` Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. @@ -819,7 +819,7 @@ Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. Thi .. rst-class:: classref-method -|void| **set_tab_metadata**\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) +|void| **set_tab_metadata**\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved later using :ref:`get_tab_metadata`. @@ -831,7 +831,7 @@ Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved .. rst-class:: classref-method -|void| **set_tab_title**\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) +|void| **set_tab_title**\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) :ref:`🔗` Sets a custom title for the tab at index ``tab_idx`` (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again. @@ -843,7 +843,7 @@ Sets a custom title for the tab at index ``tab_idx`` (tab titles default to the .. rst-class:: classref-method -|void| **set_tab_tooltip**\ (\ tab_idx\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_tab_tooltip**\ (\ tab_idx\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets a custom tooltip text for tab at index ``tab_idx``. @@ -862,7 +862,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **drop_mark_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **drop_mark_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Modulation color for the :ref:`drop_mark` icon. @@ -874,7 +874,7 @@ Modulation color for the :ref:`drop_mark` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Font color of disabled tabs. @@ -886,7 +886,7 @@ Font color of disabled tabs. .. rst-class:: classref-themeproperty -:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Font color of the currently hovered tab. @@ -898,7 +898,7 @@ Font color of the currently hovered tab. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the tab name. @@ -910,7 +910,7 @@ The tint of text outline of the tab name. .. rst-class:: classref-themeproperty -:ref:`Color` **font_selected_color** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **font_selected_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Font color of the currently selected tab. @@ -922,7 +922,7 @@ Font color of the currently selected tab. .. rst-class:: classref-themeproperty -:ref:`Color` **font_unselected_color** = ``Color(0.7, 0.7, 0.7, 1)`` +:ref:`Color` **font_unselected_color** = ``Color(0.7, 0.7, 0.7, 1)`` :ref:`🔗` Font color of the other, unselected tabs. @@ -934,7 +934,7 @@ Font color of the other, unselected tabs. .. rst-class:: classref-themeproperty -:ref:`int` **icon_max_width** = ``0`` +:ref:`int` **icon_max_width** = ``0`` :ref:`🔗` The maximum allowed width of the tab's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`TabBar.set_tab_icon_max_width`. The height is adjusted according to the icon's ratio. @@ -946,7 +946,7 @@ The maximum allowed width of the tab's icon. This limit is applied on top of the .. rst-class:: classref-themeproperty -:ref:`int` **icon_separation** = ``4`` +:ref:`int` **icon_separation** = ``4`` :ref:`🔗` Space between tab's name and its icon. @@ -958,7 +958,7 @@ Space between tab's name and its icon. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the tab text outline. @@ -972,7 +972,7 @@ The size of the tab text outline. .. rst-class:: classref-themeproperty -:ref:`int` **side_margin** = ``8`` +:ref:`int` **side_margin** = ``8`` :ref:`🔗` The space at the left or right edges of the tab bar, accordingly with the current :ref:`tab_alignment`. @@ -986,7 +986,7 @@ The margin is ignored with :ref:`TabBar.ALIGNMENT_RIGHT` **font** +:ref:`Font` **font** :ref:`🔗` The font used to draw tab names. @@ -998,7 +998,7 @@ The font used to draw tab names. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the tab names. @@ -1010,7 +1010,7 @@ Font size of the tab names. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **decrement** +:ref:`Texture2D` **decrement** :ref:`🔗` Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. @@ -1022,7 +1022,7 @@ Icon for the left arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **decrement_highlight** +:ref:`Texture2D` **decrement_highlight** :ref:`🔗` Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. @@ -1034,7 +1034,7 @@ Icon for the left arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **drop_mark** +:ref:`Texture2D` **drop_mark** :ref:`🔗` Icon shown to indicate where a dragged tab is gonna be dropped (see :ref:`drag_to_rearrange_enabled`). @@ -1046,7 +1046,7 @@ Icon shown to indicate where a dragged tab is gonna be dropped (see :ref:`drag_t .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment** +:ref:`Texture2D` **increment** :ref:`🔗` Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. @@ -1058,7 +1058,7 @@ Icon for the right arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **increment_highlight** +:ref:`Texture2D` **increment_highlight** :ref:`🔗` Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. @@ -1070,7 +1070,7 @@ Icon for the right arrow button that appears when there are too many tabs to fit .. rst-class:: classref-themeproperty -:ref:`Texture2D` **menu** +:ref:`Texture2D` **menu** :ref:`🔗` The icon for the menu button (see :ref:`set_popup`). @@ -1082,7 +1082,7 @@ The icon for the menu button (see :ref:`set_popup` **menu_highlight** +:ref:`Texture2D` **menu_highlight** :ref:`🔗` The icon for the menu button (see :ref:`set_popup`) when it's being hovered with the cursor. @@ -1094,7 +1094,7 @@ The icon for the menu button (see :ref:`set_popup` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The style for the background fill. @@ -1106,7 +1106,7 @@ The style for the background fill. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_disabled** +:ref:`StyleBox` **tab_disabled** :ref:`🔗` The style of disabled tabs. @@ -1118,7 +1118,7 @@ The style of disabled tabs. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_focus** +:ref:`StyleBox` **tab_focus** :ref:`🔗` :ref:`StyleBox` used when the :ref:`TabBar` is focused. The :ref:`tab_focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox` of the selected tab, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -1130,7 +1130,7 @@ The style of disabled tabs. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_hovered** +:ref:`StyleBox` **tab_hovered** :ref:`🔗` The style of the currently hovered tab. @@ -1144,7 +1144,7 @@ The style of the currently hovered tab. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_selected** +:ref:`StyleBox` **tab_selected** :ref:`🔗` The style of the currently selected tab. @@ -1156,7 +1156,7 @@ The style of the currently selected tab. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tab_unselected** +:ref:`StyleBox` **tab_unselected** :ref:`🔗` The style of the other, unselected tabs. @@ -1168,7 +1168,7 @@ The style of the other, unselected tabs. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **tabbar_background** +:ref:`StyleBox` **tabbar_background** :ref:`🔗` The style for the background fill of the :ref:`TabBar` area. diff --git a/classes/class_tcpserver.rst b/classes/class_tcpserver.rst index 95e79158765..01e36c502e8 100644 --- a/classes/class_tcpserver.rst +++ b/classes/class_tcpserver.rst @@ -58,7 +58,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_local_port**\ (\ ) |const| +:ref:`int` **get_local_port**\ (\ ) |const| :ref:`🔗` Returns the local port this server is listening to. @@ -70,7 +70,7 @@ Returns the local port this server is listening to. .. rst-class:: classref-method -:ref:`bool` **is_connection_available**\ (\ ) |const| +:ref:`bool` **is_connection_available**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a connection is available for taking. @@ -82,7 +82,7 @@ Returns ``true`` if a connection is available for taking. .. rst-class:: classref-method -:ref:`bool` **is_listening**\ (\ ) |const| +:ref:`bool` **is_listening**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the server is currently listening for connections. @@ -94,7 +94,7 @@ Returns ``true`` if the server is currently listening for connections. .. rst-class:: classref-method -:ref:`Error` **listen**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) +:ref:`Error` **listen**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) :ref:`🔗` Listen on the ``port`` binding to ``bind_address``. @@ -112,7 +112,7 @@ If ``bind_address`` is set to any valid address (e.g. ``"192.168.1.101"``, ``":: .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops listening. @@ -124,7 +124,7 @@ Stops listening. .. rst-class:: classref-method -:ref:`StreamPeerTCP` **take_connection**\ (\ ) +:ref:`StreamPeerTCP` **take_connection**\ (\ ) :ref:`🔗` If a connection is available, returns a StreamPeerTCP with the connection. diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 623f7c085e3..a5913b3b3b0 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -515,7 +515,7 @@ Signals .. rst-class:: classref-signal -**caret_changed**\ (\ ) +**caret_changed**\ (\ ) :ref:`🔗` Emitted when any caret changes position. @@ -527,7 +527,7 @@ Emitted when any caret changes position. .. rst-class:: classref-signal -**gutter_added**\ (\ ) +**gutter_added**\ (\ ) :ref:`🔗` Emitted when a gutter is added. @@ -539,7 +539,7 @@ Emitted when a gutter is added. .. rst-class:: classref-signal -**gutter_clicked**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) +**gutter_clicked**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) :ref:`🔗` Emitted when a gutter is clicked. @@ -551,7 +551,7 @@ Emitted when a gutter is clicked. .. rst-class:: classref-signal -**gutter_removed**\ (\ ) +**gutter_removed**\ (\ ) :ref:`🔗` Emitted when a gutter is removed. @@ -563,7 +563,7 @@ Emitted when a gutter is removed. .. rst-class:: classref-signal -**lines_edited_from**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) +**lines_edited_from**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) :ref:`🔗` Emitted immediately when the text changes. @@ -577,7 +577,7 @@ When text is added ``from_line`` will be less than ``to_line``. On a remove ``to .. rst-class:: classref-signal -**text_changed**\ (\ ) +**text_changed**\ (\ ) :ref:`🔗` Emitted when the text changes. @@ -589,7 +589,7 @@ Emitted when the text changes. .. rst-class:: classref-signal -**text_set**\ (\ ) +**text_set**\ (\ ) :ref:`🔗` Emitted when :ref:`clear` is called or :ref:`text` is set. @@ -606,7 +606,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MenuItems**: +enum **MenuItems**: :ref:`🔗` .. _class_TextEdit_constant_MENU_CUT: @@ -864,7 +864,7 @@ Represents the size of the :ref:`MenuItems` enum. .. rst-class:: classref-enumeration -enum **EditAction**: +enum **EditAction**: :ref:`🔗` .. _class_TextEdit_constant_ACTION_NONE: @@ -906,7 +906,7 @@ A forward delete action. .. rst-class:: classref-enumeration -enum **SearchFlags**: +enum **SearchFlags**: :ref:`🔗` .. _class_TextEdit_constant_SEARCH_MATCH_CASE: @@ -940,7 +940,7 @@ Search from end to beginning. .. rst-class:: classref-enumeration -enum **CaretType**: +enum **CaretType**: :ref:`🔗` .. _class_TextEdit_constant_CARET_TYPE_LINE: @@ -966,7 +966,7 @@ Block caret. .. rst-class:: classref-enumeration -enum **SelectionMode**: +enum **SelectionMode**: :ref:`🔗` .. _class_TextEdit_constant_SELECTION_MODE_NONE: @@ -1016,7 +1016,7 @@ Select whole lines as if the user triple clicked. .. rst-class:: classref-enumeration -enum **LineWrappingMode**: +enum **LineWrappingMode**: :ref:`🔗` .. _class_TextEdit_constant_LINE_WRAPPING_NONE: @@ -1042,7 +1042,7 @@ Line wrapping occurs at the control boundary, beyond what would normally be visi .. rst-class:: classref-enumeration -enum **GutterType**: +enum **GutterType**: :ref:`🔗` .. _class_TextEdit_constant_GUTTER_TYPE_STRING: @@ -1081,7 +1081,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AutowrapMode` **autowrap_mode** = ``3`` +:ref:`AutowrapMode` **autowrap_mode** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1098,7 +1098,7 @@ If :ref:`wrap_mode` is set to :ref:`LINE_WRAP .. rst-class:: classref-property -:ref:`bool` **caret_blink** = ``false`` +:ref:`bool` **caret_blink** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1115,7 +1115,7 @@ If ``true``, makes the caret blink. .. rst-class:: classref-property -:ref:`float` **caret_blink_interval** = ``0.65`` +:ref:`float` **caret_blink_interval** = ``0.65`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1132,7 +1132,7 @@ The interval at which the caret blinks (in seconds). .. rst-class:: classref-property -:ref:`bool` **caret_draw_when_editable_disabled** = ``false`` +:ref:`bool` **caret_draw_when_editable_disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1149,7 +1149,7 @@ If ``true``, caret will be visible when :ref:`editable` **caret_mid_grapheme** = ``false`` +:ref:`bool` **caret_mid_grapheme** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1168,7 +1168,7 @@ Allow moving caret, selecting and removing the individual composite character co .. rst-class:: classref-property -:ref:`bool` **caret_move_on_right_click** = ``true`` +:ref:`bool` **caret_move_on_right_click** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1187,7 +1187,7 @@ If ``false``, the context menu ignores mouse location. .. rst-class:: classref-property -:ref:`bool` **caret_multiple** = ``true`` +:ref:`bool` **caret_multiple** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1204,7 +1204,7 @@ Sets if multiple carets are allowed. .. rst-class:: classref-property -:ref:`CaretType` **caret_type** = ``0`` +:ref:`CaretType` **caret_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1221,7 +1221,7 @@ Set the type of caret to draw. .. rst-class:: classref-property -:ref:`bool` **context_menu_enabled** = ``true`` +:ref:`bool` **context_menu_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1238,7 +1238,7 @@ If ``true``, a right-click displays the context menu. .. rst-class:: classref-property -:ref:`bool` **deselect_on_focus_loss_enabled** = ``true`` +:ref:`bool` **deselect_on_focus_loss_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1255,7 +1255,7 @@ If ``true``, the selected text will be deselected when focus is lost. .. rst-class:: classref-property -:ref:`bool` **drag_and_drop_selection_enabled** = ``true`` +:ref:`bool` **drag_and_drop_selection_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1272,7 +1272,7 @@ If ``true``, allow drag and drop of selected text. Text can still be dropped fro .. rst-class:: classref-property -:ref:`bool` **draw_control_chars** = ``false`` +:ref:`bool` **draw_control_chars** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1289,7 +1289,7 @@ If ``true``, control characters are displayed. .. rst-class:: classref-property -:ref:`bool` **draw_spaces** = ``false`` +:ref:`bool` **draw_spaces** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1306,7 +1306,7 @@ If ``true``, the "space" character will have a visible representation. .. rst-class:: classref-property -:ref:`bool` **draw_tabs** = ``false`` +:ref:`bool` **draw_tabs** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1323,7 +1323,7 @@ If ``true``, the "tab" character will have a visible representation. .. rst-class:: classref-property -:ref:`bool` **editable** = ``true`` +:ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1340,7 +1340,7 @@ If ``false``, existing text cannot be modified and new text cannot be added. .. rst-class:: classref-property -:ref:`bool` **highlight_all_occurrences** = ``false`` +:ref:`bool` **highlight_all_occurrences** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1357,7 +1357,7 @@ If ``true``, all occurrences of the selected text will be highlighted. .. rst-class:: classref-property -:ref:`bool` **highlight_current_line** = ``false`` +:ref:`bool` **highlight_current_line** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1374,7 +1374,7 @@ If ``true``, the line containing the cursor is highlighted. .. rst-class:: classref-property -:ref:`bool` **indent_wrapped_lines** = ``false`` +:ref:`bool` **indent_wrapped_lines** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1391,7 +1391,7 @@ If ``true``, all wrapped lines are indented to the same amount as the unwrapped .. rst-class:: classref-property -:ref:`String` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1408,7 +1408,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property -:ref:`bool` **middle_mouse_paste_enabled** = ``true`` +:ref:`bool` **middle_mouse_paste_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1427,7 +1427,7 @@ If ``false``, using middle mouse button to paste clipboard will be disabled. .. rst-class:: classref-property -:ref:`bool` **minimap_draw** = ``false`` +:ref:`bool` **minimap_draw** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1444,7 +1444,7 @@ If ``true``, a minimap is shown, providing an outline of your source code. The m .. rst-class:: classref-property -:ref:`int` **minimap_width** = ``80`` +:ref:`int` **minimap_width** = ``80`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1461,7 +1461,7 @@ The width, in pixels, of the minimap. .. rst-class:: classref-property -:ref:`String` **placeholder_text** = ``""`` +:ref:`String` **placeholder_text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1478,7 +1478,7 @@ Text shown when the **TextEdit** is empty. It is **not** the **TextEdit**'s defa .. rst-class:: classref-property -:ref:`bool` **scroll_fit_content_height** = ``false`` +:ref:`bool` **scroll_fit_content_height** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1495,7 +1495,7 @@ If ``true``, **TextEdit** will disable vertical scroll and fit minimum height to .. rst-class:: classref-property -:ref:`int` **scroll_horizontal** = ``0`` +:ref:`int` **scroll_horizontal** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1512,7 +1512,7 @@ If there is a horizontal scrollbar, this determines the current horizontal scrol .. rst-class:: classref-property -:ref:`bool` **scroll_past_end_of_file** = ``false`` +:ref:`bool` **scroll_past_end_of_file** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1529,7 +1529,7 @@ Allow scrolling past the last line into "virtual" space. .. rst-class:: classref-property -:ref:`bool` **scroll_smooth** = ``false`` +:ref:`bool` **scroll_smooth** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1546,7 +1546,7 @@ Scroll smoothly over the text rather than jumping to the next location. .. rst-class:: classref-property -:ref:`float` **scroll_v_scroll_speed** = ``80.0`` +:ref:`float` **scroll_v_scroll_speed** = ``80.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1563,7 +1563,7 @@ Sets the scroll speed with the minimap or when :ref:`scroll_smooth` **scroll_vertical** = ``0.0`` +:ref:`float` **scroll_vertical** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1580,7 +1580,7 @@ If there is a vertical scrollbar, this determines the current vertical scroll va .. rst-class:: classref-property -:ref:`bool` **selecting_enabled** = ``true`` +:ref:`bool` **selecting_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1599,7 +1599,7 @@ If ``false``, text can not be selected by the user or by the :ref:`select` **shortcut_keys_enabled** = ``true`` +:ref:`bool` **shortcut_keys_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1616,7 +1616,7 @@ If ``true``, shortcut keys for context menu items are enabled, even if the conte .. rst-class:: classref-property -:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1633,7 +1633,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1650,7 +1650,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`SyntaxHighlighter` **syntax_highlighter** +:ref:`SyntaxHighlighter` **syntax_highlighter** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1667,7 +1667,7 @@ Sets the :ref:`SyntaxHighlighter` to use. .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1684,7 +1684,7 @@ String value of the **TextEdit**. .. rst-class:: classref-property -:ref:`TextDirection` **text_direction** = ``0`` +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1701,7 +1701,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`bool` **virtual_keyboard_enabled** = ``true`` +:ref:`bool` **virtual_keyboard_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1718,7 +1718,7 @@ If ``true``, the native virtual keyboard is shown when focused on platforms that .. rst-class:: classref-property -:ref:`LineWrappingMode` **wrap_mode** = ``0`` +:ref:`LineWrappingMode` **wrap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1740,7 +1740,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_backspace**\ (\ caret_index\: :ref:`int`\ ) |virtual| +|void| **_backspace**\ (\ caret_index\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user presses the backspace key. @@ -1752,7 +1752,7 @@ Override this method to define what happens when the user presses the backspace .. rst-class:: classref-method -|void| **_copy**\ (\ caret_index\: :ref:`int`\ ) |virtual| +|void| **_copy**\ (\ caret_index\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user performs a copy operation. @@ -1764,7 +1764,7 @@ Override this method to define what happens when the user performs a copy operat .. rst-class:: classref-method -|void| **_cut**\ (\ caret_index\: :ref:`int`\ ) |virtual| +|void| **_cut**\ (\ caret_index\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user performs a cut operation. @@ -1776,7 +1776,7 @@ Override this method to define what happens when the user performs a cut operati .. rst-class:: classref-method -|void| **_handle_unicode_input**\ (\ unicode_char\: :ref:`int`, caret_index\: :ref:`int`\ ) |virtual| +|void| **_handle_unicode_input**\ (\ unicode_char\: :ref:`int`, caret_index\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user types in the provided key ``unicode_char``. @@ -1788,7 +1788,7 @@ Override this method to define what happens when the user types in the provided .. rst-class:: classref-method -|void| **_paste**\ (\ caret_index\: :ref:`int`\ ) |virtual| +|void| **_paste**\ (\ caret_index\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user performs a paste operation. @@ -1800,7 +1800,7 @@ Override this method to define what happens when the user performs a paste opera .. rst-class:: classref-method -|void| **_paste_primary_clipboard**\ (\ caret_index\: :ref:`int`\ ) |virtual| +|void| **_paste_primary_clipboard**\ (\ caret_index\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to define what happens when the user performs a paste operation with middle mouse button. @@ -1814,7 +1814,7 @@ Override this method to define what happens when the user performs a paste opera .. rst-class:: classref-method -:ref:`int` **add_caret**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) +:ref:`int` **add_caret**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) :ref:`🔗` Adds a new caret at the given location. Returns the index of the new caret, or ``-1`` if the location is invalid. @@ -1826,7 +1826,7 @@ Adds a new caret at the given location. Returns the index of the new caret, or ` .. rst-class:: classref-method -|void| **add_caret_at_carets**\ (\ below\: :ref:`bool`\ ) +|void| **add_caret_at_carets**\ (\ below\: :ref:`bool`\ ) :ref:`🔗` Adds an additional caret above or below every caret. If ``below`` is ``true`` the new caret will be added below and above otherwise. @@ -1838,7 +1838,7 @@ Adds an additional caret above or below every caret. If ``below`` is ``true`` th .. rst-class:: classref-method -|void| **add_gutter**\ (\ at\: :ref:`int` = -1\ ) +|void| **add_gutter**\ (\ at\: :ref:`int` = -1\ ) :ref:`🔗` Register a new gutter to this **TextEdit**. Use ``at`` to have a specific gutter order. A value of ``-1`` appends the gutter to the right. @@ -1850,7 +1850,7 @@ Register a new gutter to this **TextEdit**. Use ``at`` to have a specific gutter .. rst-class:: classref-method -|void| **add_selection_for_next_occurrence**\ (\ ) +|void| **add_selection_for_next_occurrence**\ (\ ) :ref:`🔗` Adds a selection and a caret for the next occurrence of the current selection. If there is no active selection, selects word under caret. @@ -1862,7 +1862,7 @@ Adds a selection and a caret for the next occurrence of the current selection. I .. rst-class:: classref-method -|void| **adjust_carets_after_edit**\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) +|void| **adjust_carets_after_edit**\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** No longer necessary since methods now adjust carets themselves. @@ -1876,7 +1876,7 @@ This method does nothing. .. rst-class:: classref-method -|void| **adjust_viewport_to_caret**\ (\ caret_index\: :ref:`int` = 0\ ) +|void| **adjust_viewport_to_caret**\ (\ caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Adjust the viewport so the caret is visible. @@ -1888,7 +1888,7 @@ Adjust the viewport so the caret is visible. .. rst-class:: classref-method -|void| **apply_ime**\ (\ ) +|void| **apply_ime**\ (\ ) :ref:`🔗` Applies text from the `Input Method Editor `__ (IME) to each caret and closes the IME if it is open. @@ -1900,7 +1900,7 @@ Applies text from the `Input Method Editor ` = -1\ ) +|void| **backspace**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Called when the user presses the backspace key. Can be overridden with :ref:`_backspace`. @@ -1912,7 +1912,7 @@ Called when the user presses the backspace key. Can be overridden with :ref:`_ba .. rst-class:: classref-method -|void| **begin_complex_operation**\ (\ ) +|void| **begin_complex_operation**\ (\ ) :ref:`🔗` Starts a multipart edit. All edits will be treated as one action until :ref:`end_complex_operation` is called. @@ -1924,7 +1924,7 @@ Starts a multipart edit. All edits will be treated as one action until :ref:`end .. rst-class:: classref-method -|void| **begin_multicaret_edit**\ (\ ) +|void| **begin_multicaret_edit**\ (\ ) :ref:`🔗` Starts an edit for multiple carets. The edit must be ended with :ref:`end_multicaret_edit`. Multicaret edits can be used to edit text at multiple carets and delay merging the carets until the end, so the caret indexes aren't affected immediately. :ref:`begin_multicaret_edit` and :ref:`end_multicaret_edit` can be nested, and the merge will happen at the last :ref:`end_multicaret_edit`. @@ -1949,7 +1949,7 @@ Example usage: .. rst-class:: classref-method -|void| **cancel_ime**\ (\ ) +|void| **cancel_ime**\ (\ ) :ref:`🔗` Closes the `Input Method Editor `__ (IME) if it is open. Any text in the IME will be lost. @@ -1961,7 +1961,7 @@ Closes the `Input Method Editor `__ .. rst-class:: classref-method -|void| **center_viewport_to_caret**\ (\ caret_index\: :ref:`int` = 0\ ) +|void| **center_viewport_to_caret**\ (\ caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Centers the viewport on the line the editing caret is at. This also resets the :ref:`scroll_horizontal` value to ``0``. @@ -1973,7 +1973,7 @@ Centers the viewport on the line the editing caret is at. This also resets the : .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Performs a full reset of **TextEdit**, including undo history. @@ -1985,7 +1985,7 @@ Performs a full reset of **TextEdit**, including undo history. .. rst-class:: classref-method -|void| **clear_undo_history**\ (\ ) +|void| **clear_undo_history**\ (\ ) :ref:`🔗` Clears the undo history. @@ -1997,7 +1997,7 @@ Clears the undo history. .. rst-class:: classref-method -|void| **collapse_carets**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, inclusive\: :ref:`bool` = false\ ) +|void| **collapse_carets**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, inclusive\: :ref:`bool` = false\ ) :ref:`🔗` Collapse all carets in the given range to the ``from_line`` and ``from_column`` position. @@ -2015,7 +2015,7 @@ If :ref:`is_in_mulitcaret_edit` is .. rst-class:: classref-method -|void| **copy**\ (\ caret_index\: :ref:`int` = -1\ ) +|void| **copy**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Copies the current text selection. Can be overridden with :ref:`_copy`. @@ -2027,7 +2027,7 @@ Copies the current text selection. Can be overridden with :ref:`_copy` = -1\ ) +|void| **cut**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Cut's the current selection. Can be overridden with :ref:`_cut`. @@ -2039,7 +2039,7 @@ Cut's the current selection. Can be overridden with :ref:`_cut` = -1\ ) +|void| **delete_selection**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Deletes the selected text. @@ -2051,7 +2051,7 @@ Deletes the selected text. .. rst-class:: classref-method -|void| **deselect**\ (\ caret_index\: :ref:`int` = -1\ ) +|void| **deselect**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Deselects the current selection. @@ -2063,7 +2063,7 @@ Deselects the current selection. .. rst-class:: classref-method -|void| **end_action**\ (\ ) +|void| **end_action**\ (\ ) :ref:`🔗` Marks the end of steps in the current action started with :ref:`start_action`. @@ -2075,7 +2075,7 @@ Marks the end of steps in the current action started with :ref:`start_action` Ends a multipart edit, started with :ref:`begin_complex_operation`. If called outside a complex operation, the current operation is pushed onto the undo/redo stack. @@ -2087,7 +2087,7 @@ Ends a multipart edit, started with :ref:`begin_complex_operation` Ends an edit for multiple carets, that was started with :ref:`begin_multicaret_edit`. If this was the last :ref:`end_multicaret_edit` and :ref:`merge_overlapping_carets` was called, carets will be merged. @@ -2099,7 +2099,7 @@ Ends an edit for multiple carets, that was started with :ref:`begin_multicaret_e .. rst-class:: classref-method -:ref:`int` **get_caret_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_caret_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the column the editing caret is at. @@ -2111,7 +2111,7 @@ Returns the column the editing caret is at. .. rst-class:: classref-method -:ref:`int` **get_caret_count**\ (\ ) |const| +:ref:`int` **get_caret_count**\ (\ ) |const| :ref:`🔗` Returns the number of carets in this **TextEdit**. @@ -2123,7 +2123,7 @@ Returns the number of carets in this **TextEdit**. .. rst-class:: classref-method -:ref:`Vector2` **get_caret_draw_pos**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`Vector2` **get_caret_draw_pos**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the caret pixel draw position. @@ -2135,7 +2135,7 @@ Returns the caret pixel draw position. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_caret_index_edit_order**\ (\ ) +:ref:`PackedInt32Array` **get_caret_index_edit_order**\ (\ ) :ref:`🔗` **Deprecated:** Carets no longer need to be edited in any specific order. If the carets need to be sorted, use :ref:`get_sorted_carets` instead. @@ -2149,7 +2149,7 @@ Returns a list of caret indexes in their edit order, this done from bottom to to .. rst-class:: classref-method -:ref:`int` **get_caret_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_caret_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the line the editing caret is on. @@ -2161,7 +2161,7 @@ Returns the line the editing caret is on. .. rst-class:: classref-method -:ref:`int` **get_caret_wrap_index**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_caret_wrap_index**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the wrap index the editing caret is on. @@ -2173,7 +2173,7 @@ Returns the wrap index the editing caret is on. .. rst-class:: classref-method -:ref:`int` **get_first_non_whitespace_column**\ (\ line\: :ref:`int`\ ) |const| +:ref:`int` **get_first_non_whitespace_column**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the first column containing a non-whitespace character. @@ -2185,7 +2185,7 @@ Returns the first column containing a non-whitespace character. .. rst-class:: classref-method -:ref:`int` **get_first_visible_line**\ (\ ) |const| +:ref:`int` **get_first_visible_line**\ (\ ) |const| :ref:`🔗` Returns the first visible line. @@ -2197,7 +2197,7 @@ Returns the first visible line. .. rst-class:: classref-method -:ref:`int` **get_gutter_count**\ (\ ) |const| +:ref:`int` **get_gutter_count**\ (\ ) |const| :ref:`🔗` Returns the number of gutters registered. @@ -2209,7 +2209,7 @@ Returns the number of gutters registered. .. rst-class:: classref-method -:ref:`String` **get_gutter_name**\ (\ gutter\: :ref:`int`\ ) |const| +:ref:`String` **get_gutter_name**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the gutter at the given index. @@ -2221,7 +2221,7 @@ Returns the name of the gutter at the given index. .. rst-class:: classref-method -:ref:`GutterType` **get_gutter_type**\ (\ gutter\: :ref:`int`\ ) |const| +:ref:`GutterType` **get_gutter_type**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the type of the gutter at the given index. Gutters can contain icons, text, or custom visuals. See :ref:`GutterType` for options. @@ -2233,7 +2233,7 @@ Returns the type of the gutter at the given index. Gutters can contain icons, te .. rst-class:: classref-method -:ref:`int` **get_gutter_width**\ (\ gutter\: :ref:`int`\ ) |const| +:ref:`int` **get_gutter_width**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the width of the gutter at the given index. @@ -2245,7 +2245,7 @@ Returns the width of the gutter at the given index. .. rst-class:: classref-method -:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) |const| +:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) |const| :ref:`🔗` Returns the :ref:`HScrollBar` used by **TextEdit**. @@ -2257,7 +2257,7 @@ Returns the :ref:`HScrollBar` used by **TextEdit**. .. rst-class:: classref-method -:ref:`int` **get_indent_level**\ (\ line\: :ref:`int`\ ) |const| +:ref:`int` **get_indent_level**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of spaces and ``tab * tab_size`` before the first char. @@ -2269,7 +2269,7 @@ Returns the number of spaces and ``tab * tab_size`` before the first char. .. rst-class:: classref-method -:ref:`int` **get_last_full_visible_line**\ (\ ) |const| +:ref:`int` **get_last_full_visible_line**\ (\ ) |const| :ref:`🔗` Returns the last visible line. Use :ref:`get_last_full_visible_line_wrap_index` for the wrap index. @@ -2281,7 +2281,7 @@ Returns the last visible line. Use :ref:`get_last_full_visible_line_wrap_index` **get_last_full_visible_line_wrap_index**\ (\ ) |const| +:ref:`int` **get_last_full_visible_line_wrap_index**\ (\ ) |const| :ref:`🔗` Returns the last visible wrap index of the last visible line. @@ -2293,7 +2293,7 @@ Returns the last visible wrap index of the last visible line. .. rst-class:: classref-method -:ref:`int` **get_last_unhidden_line**\ (\ ) |const| +:ref:`int` **get_last_unhidden_line**\ (\ ) |const| :ref:`🔗` Returns the last unhidden line in the entire **TextEdit**. @@ -2305,7 +2305,7 @@ Returns the last unhidden line in the entire **TextEdit**. .. rst-class:: classref-method -:ref:`String` **get_line**\ (\ line\: :ref:`int`\ ) |const| +:ref:`String` **get_line**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text of a specific line. @@ -2317,7 +2317,7 @@ Returns the text of a specific line. .. rst-class:: classref-method -:ref:`Color` **get_line_background_color**\ (\ line\: :ref:`int`\ ) |const| +:ref:`Color` **get_line_background_color**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the current background color of the line. ``Color(0, 0, 0, 0)`` is returned if no color is set. @@ -2329,7 +2329,7 @@ Returns the current background color of the line. ``Color(0, 0, 0, 0)`` is retur .. rst-class:: classref-method -:ref:`Vector2i` **get_line_column_at_pos**\ (\ position\: :ref:`Vector2i`, allow_out_of_bounds\: :ref:`bool` = true\ ) |const| +:ref:`Vector2i` **get_line_column_at_pos**\ (\ position\: :ref:`Vector2i`, allow_out_of_bounds\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns the line and column at the given position. In the returned vector, ``x`` is the column, ``y`` is the line. If ``allow_out_of_bounds`` is ``false`` and the position is not over the text, both vector values will be set to ``-1``. @@ -2341,7 +2341,7 @@ Returns the line and column at the given position. In the returned vector, ``x`` .. rst-class:: classref-method -:ref:`int` **get_line_count**\ (\ ) |const| +:ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` Returns the number of lines in the text. @@ -2353,7 +2353,7 @@ Returns the number of lines in the text. .. rst-class:: classref-method -:ref:`Texture2D` **get_line_gutter_icon**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_line_gutter_icon**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon currently in ``gutter`` at ``line``. This only works when the gutter type is :ref:`GUTTER_TYPE_ICON` (see :ref:`set_gutter_type`). @@ -2365,7 +2365,7 @@ Returns the icon currently in ``gutter`` at ``line``. This only works when the g .. rst-class:: classref-method -:ref:`Color` **get_line_gutter_item_color**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| +:ref:`Color` **get_line_gutter_item_color**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the color currently in ``gutter`` at ``line``. @@ -2377,7 +2377,7 @@ Returns the color currently in ``gutter`` at ``line``. .. rst-class:: classref-method -:ref:`Variant` **get_line_gutter_metadata**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| +:ref:`Variant` **get_line_gutter_metadata**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata currently in ``gutter`` at ``line``. @@ -2389,7 +2389,7 @@ Returns the metadata currently in ``gutter`` at ``line``. .. rst-class:: classref-method -:ref:`String` **get_line_gutter_text**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| +:ref:`String` **get_line_gutter_text**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text currently in ``gutter`` at ``line``. This only works when the gutter type is :ref:`GUTTER_TYPE_STRING` (see :ref:`set_gutter_type`). @@ -2401,7 +2401,7 @@ Returns the text currently in ``gutter`` at ``line``. This only works when the g .. rst-class:: classref-method -:ref:`int` **get_line_height**\ (\ ) |const| +:ref:`int` **get_line_height**\ (\ ) |const| :ref:`🔗` Returns the maximum value of the line height among all lines. @@ -2415,7 +2415,7 @@ Returns the maximum value of the line height among all lines. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_line_ranges_from_carets**\ (\ only_selections\: :ref:`bool` = false, merge_adjacent\: :ref:`bool` = true\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_line_ranges_from_carets**\ (\ only_selections\: :ref:`bool` = false, merge_adjacent\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns an :ref:`Array` of line ranges where ``x`` is the first line and ``y`` is the last line. All lines within these ranges will have a caret on them or be part of a selection. Each line will only be part of one line range, even if it has multiple carets on it. @@ -2429,7 +2429,7 @@ If a selection's end column (:ref:`get_selection_to_column` **get_line_width**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = -1\ ) |const| +:ref:`int` **get_line_width**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the width in pixels of the ``wrap_index`` on ``line``. @@ -2441,7 +2441,7 @@ Returns the width in pixels of the ``wrap_index`` on ``line``. .. rst-class:: classref-method -:ref:`int` **get_line_wrap_count**\ (\ line\: :ref:`int`\ ) |const| +:ref:`int` **get_line_wrap_count**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of times the given line is wrapped. @@ -2453,7 +2453,7 @@ Returns the number of times the given line is wrapped. .. rst-class:: classref-method -:ref:`int` **get_line_wrap_index_at_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| +:ref:`int` **get_line_wrap_index_at_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the wrap index of the given line column. @@ -2465,7 +2465,7 @@ Returns the wrap index of the given line column. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_line_wrapped_text**\ (\ line\: :ref:`int`\ ) |const| +:ref:`PackedStringArray` **get_line_wrapped_text**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of :ref:`String`\ s representing each wrapped index. @@ -2477,7 +2477,7 @@ Returns an array of :ref:`String`\ s representing each wrapped ind .. rst-class:: classref-method -:ref:`Vector2` **get_local_mouse_pos**\ (\ ) |const| +:ref:`Vector2` **get_local_mouse_pos**\ (\ ) |const| :ref:`🔗` Returns the local mouse position adjusted for the text direction. @@ -2489,7 +2489,7 @@ Returns the local mouse position adjusted for the text direction. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu**\ (\ ) |const| +:ref:`PopupMenu` **get_menu**\ (\ ) |const| :ref:`🔗` Returns the :ref:`PopupMenu` of this **TextEdit**. By default, this menu is displayed when right-clicking on the **TextEdit**. @@ -2548,7 +2548,7 @@ You can add custom menu items or remove standard ones. Make sure your IDs don't .. rst-class:: classref-method -:ref:`int` **get_minimap_line_at_pos**\ (\ position\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_minimap_line_at_pos**\ (\ position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the equivalent minimap line at ``position``. @@ -2560,7 +2560,7 @@ Returns the equivalent minimap line at ``position``. .. rst-class:: classref-method -:ref:`int` **get_minimap_visible_lines**\ (\ ) |const| +:ref:`int` **get_minimap_visible_lines**\ (\ ) |const| :ref:`🔗` Returns the number of lines that may be drawn on the minimap. @@ -2572,7 +2572,7 @@ Returns the number of lines that may be drawn on the minimap. .. rst-class:: classref-method -:ref:`Vector2i` **get_next_visible_line_index_offset_from**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| +:ref:`Vector2i` **get_next_visible_line_index_offset_from**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| :ref:`🔗` Similar to :ref:`get_next_visible_line_offset_from`, but takes into account the line wrap indexes. In the returned vector, ``x`` is the line, ``y`` is the wrap index. @@ -2584,7 +2584,7 @@ Similar to :ref:`get_next_visible_line_offset_from` **get_next_visible_line_offset_from**\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| +:ref:`int` **get_next_visible_line_offset_from**\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| :ref:`🔗` Returns the count to the next visible line from ``line`` to ``line + visible_amount``. Can also count backwards. For example if a **TextEdit** has 5 lines with lines 2 and 3 hidden, calling this with ``line = 1, visible_amount = 1`` would return 3. @@ -2596,7 +2596,7 @@ Returns the count to the next visible line from ``line`` to ``line + visible_amo .. rst-class:: classref-method -:ref:`Vector2i` **get_pos_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| +:ref:`Vector2i` **get_pos_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local position for the given ``line`` and ``column``. If ``x`` or ``y`` of the returned vector equal ``-1``, the position is outside of the viewable area of the control. @@ -2610,7 +2610,7 @@ Returns the local position for the given ``line`` and ``column``. If ``x`` or `` .. rst-class:: classref-method -:ref:`Rect2i` **get_rect_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| +:ref:`Rect2i` **get_rect_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the local position and size for the grapheme at the given ``line`` and ``column``. If ``x`` or ``y`` position of the returned rect equal ``-1``, the position is outside of the viewable area of the control. @@ -2624,7 +2624,7 @@ Returns the local position and size for the grapheme at the given ``line`` and ` .. rst-class:: classref-method -:ref:`int` **get_saved_version**\ (\ ) |const| +:ref:`int` **get_saved_version**\ (\ ) |const| :ref:`🔗` Returns the last tagged saved version from :ref:`tag_saved_version`. @@ -2636,7 +2636,7 @@ Returns the last tagged saved version from :ref:`tag_saved_version` **get_scroll_pos_for_line**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) |const| +:ref:`float` **get_scroll_pos_for_line**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the scroll position for ``wrap_index`` of ``line``. @@ -2648,7 +2648,7 @@ Returns the scroll position for ``wrap_index`` of ``line``. .. rst-class:: classref-method -:ref:`String` **get_selected_text**\ (\ caret_index\: :ref:`int` = -1\ ) +:ref:`String` **get_selected_text**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Returns the text inside the selection of a caret, or all the carets if ``caret_index`` is its default value ``-1``. @@ -2660,7 +2660,7 @@ Returns the text inside the selection of a caret, or all the carets if ``caret_i .. rst-class:: classref-method -:ref:`int` **get_selection_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`, include_edges\: :ref:`bool` = true, only_selections\: :ref:`bool` = true\ ) |const| +:ref:`int` **get_selection_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`, include_edges\: :ref:`bool` = true, only_selections\: :ref:`bool` = true\ ) |const| :ref:`🔗` Returns the caret index of the selection at the given ``line`` and ``column``, or ``-1`` if there is none. @@ -2674,7 +2674,7 @@ If ``include_edges`` is ``false``, the position must be inside the selection and .. rst-class:: classref-method -:ref:`int` **get_selection_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`get_selection_origin_column` instead. @@ -2688,7 +2688,7 @@ Returns the original start column of the selection. .. rst-class:: classref-method -:ref:`int` **get_selection_from_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_from_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the selection begin column. Returns the caret column if there is no selection. @@ -2700,7 +2700,7 @@ Returns the selection begin column. Returns the caret column if there is no sele .. rst-class:: classref-method -:ref:`int` **get_selection_from_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_from_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the selection begin line. Returns the caret line if there is no selection. @@ -2712,7 +2712,7 @@ Returns the selection begin line. Returns the caret line if there is no selectio .. rst-class:: classref-method -:ref:`int` **get_selection_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`get_selection_origin_line` instead. @@ -2726,7 +2726,7 @@ Returns the original start line of the selection. .. rst-class:: classref-method -:ref:`SelectionMode` **get_selection_mode**\ (\ ) |const| +:ref:`SelectionMode` **get_selection_mode**\ (\ ) |const| :ref:`🔗` Returns the current selection mode. @@ -2738,7 +2738,7 @@ Returns the current selection mode. .. rst-class:: classref-method -:ref:`int` **get_selection_origin_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_origin_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the origin column of the selection. This is the opposite end from the caret. @@ -2750,7 +2750,7 @@ Returns the origin column of the selection. This is the opposite end from the ca .. rst-class:: classref-method -:ref:`int` **get_selection_origin_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_origin_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the origin line of the selection. This is the opposite end from the caret. @@ -2762,7 +2762,7 @@ Returns the origin line of the selection. This is the opposite end from the care .. rst-class:: classref-method -:ref:`int` **get_selection_to_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_to_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the selection end column. Returns the caret column if there is no selection. @@ -2774,7 +2774,7 @@ Returns the selection end column. Returns the caret column if there is no select .. rst-class:: classref-method -:ref:`int` **get_selection_to_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`int` **get_selection_to_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the selection end line. Returns the caret line if there is no selection. @@ -2786,7 +2786,7 @@ Returns the selection end line. Returns the caret line if there is no selection. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_sorted_carets**\ (\ include_ignored_carets\: :ref:`bool` = false\ ) |const| +:ref:`PackedInt32Array` **get_sorted_carets**\ (\ include_ignored_carets\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the carets sorted by selection beginning from lowest line and column to highest (from top to bottom of text). @@ -2800,7 +2800,7 @@ If ``include_ignored_carets`` is ``false``, carets from :ref:`multicaret_edit_ig .. rst-class:: classref-method -:ref:`int` **get_tab_size**\ (\ ) |const| +:ref:`int` **get_tab_size**\ (\ ) |const| :ref:`🔗` Returns the **TextEdit**'s' tab size. @@ -2812,7 +2812,7 @@ Returns the **TextEdit**'s' tab size. .. rst-class:: classref-method -:ref:`int` **get_total_gutter_width**\ (\ ) |const| +:ref:`int` **get_total_gutter_width**\ (\ ) |const| :ref:`🔗` Returns the total width of all gutters and internal padding. @@ -2824,7 +2824,7 @@ Returns the total width of all gutters and internal padding. .. rst-class:: classref-method -:ref:`int` **get_total_visible_line_count**\ (\ ) |const| +:ref:`int` **get_total_visible_line_count**\ (\ ) |const| :ref:`🔗` Returns the number of lines that may be drawn. @@ -2836,7 +2836,7 @@ Returns the number of lines that may be drawn. .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) |const| +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) |const| :ref:`🔗` Returns the :ref:`VScrollBar` of the **TextEdit**. @@ -2848,7 +2848,7 @@ Returns the :ref:`VScrollBar` of the **TextEdit**. .. rst-class:: classref-method -:ref:`int` **get_version**\ (\ ) |const| +:ref:`int` **get_version**\ (\ ) |const| :ref:`🔗` Returns the current version of the **TextEdit**. The version is a count of recorded operations by the undo/redo history. @@ -2860,7 +2860,7 @@ Returns the current version of the **TextEdit**. The version is a count of recor .. rst-class:: classref-method -:ref:`int` **get_visible_line_count**\ (\ ) |const| +:ref:`int` **get_visible_line_count**\ (\ ) |const| :ref:`🔗` Returns the number of visible lines, including wrapped text. @@ -2872,7 +2872,7 @@ Returns the number of visible lines, including wrapped text. .. rst-class:: classref-method -:ref:`int` **get_visible_line_count_in_range**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |const| +:ref:`int` **get_visible_line_count_in_range**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the total number of visible + wrapped lines between the two lines. @@ -2884,7 +2884,7 @@ Returns the total number of visible + wrapped lines between the two lines. .. rst-class:: classref-method -:ref:`String` **get_word_at_pos**\ (\ position\: :ref:`Vector2`\ ) |const| +:ref:`String` **get_word_at_pos**\ (\ position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the word at ``position``. @@ -2896,7 +2896,7 @@ Returns the word at ``position``. .. rst-class:: classref-method -:ref:`String` **get_word_under_caret**\ (\ caret_index\: :ref:`int` = -1\ ) |const| +:ref:`String` **get_word_under_caret**\ (\ caret_index\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns a :ref:`String` text with the word under the caret's location. @@ -2908,7 +2908,7 @@ Returns a :ref:`String` text with the word under the caret's locat .. rst-class:: classref-method -:ref:`bool` **has_ime_text**\ (\ ) |const| +:ref:`bool` **has_ime_text**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the user has text in the `Input Method Editor `__ (IME). @@ -2920,7 +2920,7 @@ Returns ``true`` if the user has text in the `Input Method Editor ` **has_redo**\ (\ ) |const| +:ref:`bool` **has_redo**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a "redo" action is available. @@ -2932,7 +2932,7 @@ Returns ``true`` if a "redo" action is available. .. rst-class:: classref-method -:ref:`bool` **has_selection**\ (\ caret_index\: :ref:`int` = -1\ ) |const| +:ref:`bool` **has_selection**\ (\ caret_index\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns ``true`` if the user has selected text. @@ -2944,7 +2944,7 @@ Returns ``true`` if the user has selected text. .. rst-class:: classref-method -:ref:`bool` **has_undo**\ (\ ) |const| +:ref:`bool` **has_undo**\ (\ ) |const| :ref:`🔗` Returns ``true`` if an "undo" action is available. @@ -2956,7 +2956,7 @@ Returns ``true`` if an "undo" action is available. .. rst-class:: classref-method -|void| **insert_line_at**\ (\ line\: :ref:`int`, text\: :ref:`String`\ ) +|void| **insert_line_at**\ (\ line\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Inserts a new line with ``text`` at ``line``. @@ -2968,7 +2968,7 @@ Inserts a new line with ``text`` at ``line``. .. rst-class:: classref-method -|void| **insert_text**\ (\ text\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`, before_selection_begin\: :ref:`bool` = true, before_selection_end\: :ref:`bool` = false\ ) +|void| **insert_text**\ (\ text\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`, before_selection_begin\: :ref:`bool` = true, before_selection_end\: :ref:`bool` = false\ ) :ref:`🔗` Inserts the ``text`` at ``line`` and ``column``. @@ -2984,7 +2984,7 @@ If ``before_selection_end`` is ``true``, selections that end at ``line`` and ``c .. rst-class:: classref-method -|void| **insert_text_at_caret**\ (\ text\: :ref:`String`, caret_index\: :ref:`int` = -1\ ) +|void| **insert_text_at_caret**\ (\ text\: :ref:`String`, caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Insert the specified text at the caret position. @@ -2996,7 +2996,7 @@ Insert the specified text at the caret position. .. rst-class:: classref-method -:ref:`bool` **is_caret_after_selection_origin**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`bool` **is_caret_after_selection_origin**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns ``true`` if the caret of the selection is after the selection origin. This can be used to determine the direction of the selection. @@ -3008,7 +3008,7 @@ Returns ``true`` if the caret of the selection is after the selection origin. Th .. rst-class:: classref-method -:ref:`bool` **is_caret_visible**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +:ref:`bool` **is_caret_visible**\ (\ caret_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns ``true`` if the caret is visible on the screen. @@ -3020,7 +3020,7 @@ Returns ``true`` if the caret is visible on the screen. .. rst-class:: classref-method -:ref:`bool` **is_dragging_cursor**\ (\ ) |const| +:ref:`bool` **is_dragging_cursor**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the user is dragging their mouse for scrolling, selecting, or text dragging. @@ -3032,7 +3032,7 @@ Returns ``true`` if the user is dragging their mouse for scrolling, selecting, o .. rst-class:: classref-method -:ref:`bool` **is_gutter_clickable**\ (\ gutter\: :ref:`int`\ ) |const| +:ref:`bool` **is_gutter_clickable**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the gutter is clickable. @@ -3044,7 +3044,7 @@ Returns whether the gutter is clickable. .. rst-class:: classref-method -:ref:`bool` **is_gutter_drawn**\ (\ gutter\: :ref:`int`\ ) |const| +:ref:`bool` **is_gutter_drawn**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the gutter is currently drawn. @@ -3056,7 +3056,7 @@ Returns whether the gutter is currently drawn. .. rst-class:: classref-method -:ref:`bool` **is_gutter_overwritable**\ (\ gutter\: :ref:`int`\ ) |const| +:ref:`bool` **is_gutter_overwritable**\ (\ gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the gutter is overwritable. @@ -3068,7 +3068,7 @@ Returns whether the gutter is overwritable. .. rst-class:: classref-method -:ref:`bool` **is_in_mulitcaret_edit**\ (\ ) |const| +:ref:`bool` **is_in_mulitcaret_edit**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a :ref:`begin_multicaret_edit` has been called and :ref:`end_multicaret_edit` has not yet been called. @@ -3080,7 +3080,7 @@ Returns ``true`` if a :ref:`begin_multicaret_edit` **is_line_gutter_clickable**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_gutter_clickable**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the gutter on the given line is clickable. @@ -3092,7 +3092,7 @@ Returns whether the gutter on the given line is clickable. .. rst-class:: classref-method -:ref:`bool` **is_line_wrapped**\ (\ line\: :ref:`int`\ ) |const| +:ref:`bool` **is_line_wrapped**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns if the given line is wrapped. @@ -3104,7 +3104,7 @@ Returns if the given line is wrapped. .. rst-class:: classref-method -:ref:`bool` **is_menu_visible**\ (\ ) |const| +:ref:`bool` **is_menu_visible**\ (\ ) |const| :ref:`🔗` Returns whether the menu is visible. Use this instead of ``get_menu().visible`` to improve performance (so the creation of the menu is avoided). @@ -3116,7 +3116,7 @@ Returns whether the menu is visible. Use this instead of ``get_menu().visible`` .. rst-class:: classref-method -:ref:`bool` **is_mouse_over_selection**\ (\ edges\: :ref:`bool`, caret_index\: :ref:`int` = -1\ ) |const| +:ref:`bool` **is_mouse_over_selection**\ (\ edges\: :ref:`bool`, caret_index\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns whether the mouse is over selection. If ``edges`` is ``true``, the edges are considered part of the selection. @@ -3128,7 +3128,7 @@ Returns whether the mouse is over selection. If ``edges`` is ``true``, the edges .. rst-class:: classref-method -:ref:`bool` **is_overtype_mode_enabled**\ (\ ) |const| +:ref:`bool` **is_overtype_mode_enabled**\ (\ ) |const| :ref:`🔗` Returns whether the user is in overtype mode. @@ -3140,7 +3140,7 @@ Returns whether the user is in overtype mode. .. rst-class:: classref-method -|void| **menu_option**\ (\ option\: :ref:`int`\ ) +|void| **menu_option**\ (\ option\: :ref:`int`\ ) :ref:`🔗` Executes a given action as defined in the :ref:`MenuItems` enum. @@ -3152,7 +3152,7 @@ Executes a given action as defined in the :ref:`MenuItems`, to_line\: :ref:`int`\ ) +|void| **merge_gutters**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) :ref:`🔗` Merge the gutters from ``from_line`` into ``to_line``. Only overwritable gutters will be copied. @@ -3164,7 +3164,7 @@ Merge the gutters from ``from_line`` into ``to_line``. Only overwritable gutters .. rst-class:: classref-method -|void| **merge_overlapping_carets**\ (\ ) +|void| **merge_overlapping_carets**\ (\ ) :ref:`🔗` Merges any overlapping carets. Will favor the newest caret, or the caret with a selection. @@ -3180,7 +3180,7 @@ If :ref:`is_in_mulitcaret_edit` is .. rst-class:: classref-method -:ref:`bool` **multicaret_edit_ignore_caret**\ (\ caret_index\: :ref:`int`\ ) |const| +:ref:`bool` **multicaret_edit_ignore_caret**\ (\ caret_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``caret_index`` should be ignored as part of a multicaret edit. See :ref:`begin_multicaret_edit` and :ref:`end_multicaret_edit`. Carets that should be ignored are ones that were part of removed text and will likely be merged at the end of the edit, or carets that were added during the edit. @@ -3194,7 +3194,7 @@ It is recommended to ``continue`` within a loop iterating on multiple carets if .. rst-class:: classref-method -|void| **paste**\ (\ caret_index\: :ref:`int` = -1\ ) +|void| **paste**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Paste at the current location. Can be overridden with :ref:`_paste`. @@ -3206,7 +3206,7 @@ Paste at the current location. Can be overridden with :ref:`_paste` = -1\ ) +|void| **paste_primary_clipboard**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Pastes the primary clipboard. @@ -3218,7 +3218,7 @@ Pastes the primary clipboard. .. rst-class:: classref-method -|void| **redo**\ (\ ) +|void| **redo**\ (\ ) :ref:`🔗` Perform redo operation. @@ -3230,7 +3230,7 @@ Perform redo operation. .. rst-class:: classref-method -|void| **remove_caret**\ (\ caret\: :ref:`int`\ ) +|void| **remove_caret**\ (\ caret\: :ref:`int`\ ) :ref:`🔗` Removes the given caret index. @@ -3244,7 +3244,7 @@ Removes the given caret index. .. rst-class:: classref-method -|void| **remove_gutter**\ (\ gutter\: :ref:`int`\ ) +|void| **remove_gutter**\ (\ gutter\: :ref:`int`\ ) :ref:`🔗` Removes the gutter from this **TextEdit**. @@ -3256,7 +3256,7 @@ Removes the gutter from this **TextEdit**. .. rst-class:: classref-method -|void| **remove_line_at**\ (\ line\: :ref:`int`, move_carets_down\: :ref:`bool` = true\ ) +|void| **remove_line_at**\ (\ line\: :ref:`int`, move_carets_down\: :ref:`bool` = true\ ) :ref:`🔗` Removes the line of text at ``line``. Carets on this line will attempt to match their previous visual x position. @@ -3270,7 +3270,7 @@ If ``move_carets_down`` is ``true`` carets will move to the next line down, othe .. rst-class:: classref-method -|void| **remove_secondary_carets**\ (\ ) +|void| **remove_secondary_carets**\ (\ ) :ref:`🔗` Removes all additional carets. @@ -3282,7 +3282,7 @@ Removes all additional carets. .. rst-class:: classref-method -|void| **remove_text**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`\ ) +|void| **remove_text**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`\ ) :ref:`🔗` Removes text between the given positions. @@ -3294,7 +3294,7 @@ Removes text between the given positions. .. rst-class:: classref-method -:ref:`Vector2i` **search**\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_column\: :ref:`int`\ ) |const| +:ref:`Vector2i` **search**\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_column\: :ref:`int`\ ) |const| :ref:`🔗` Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags` enum. @@ -3331,7 +3331,7 @@ In the returned vector, ``x`` is the column, ``y`` is the line. If no results ar .. rst-class:: classref-method -|void| **select**\ (\ origin_line\: :ref:`int`, origin_column\: :ref:`int`, caret_line\: :ref:`int`, caret_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) +|void| **select**\ (\ origin_line\: :ref:`int`, origin_column\: :ref:`int`, caret_line\: :ref:`int`, caret_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Selects text from ``origin_line`` and ``origin_column`` to ``caret_line`` and ``caret_column`` for the given ``caret_index``. This moves the selection origin and the caret. If the positions are the same, the selection will be deselected. @@ -3347,7 +3347,7 @@ If :ref:`selecting_enabled` is ``fals .. rst-class:: classref-method -|void| **select_all**\ (\ ) +|void| **select_all**\ (\ ) :ref:`🔗` Select all the text. @@ -3361,7 +3361,7 @@ If :ref:`selecting_enabled` is ``fals .. rst-class:: classref-method -|void| **select_word_under_caret**\ (\ caret_index\: :ref:`int` = -1\ ) +|void| **select_word_under_caret**\ (\ caret_index\: :ref:`int` = -1\ ) :ref:`🔗` Selects the word under the caret. @@ -3373,7 +3373,7 @@ Selects the word under the caret. .. rst-class:: classref-method -|void| **set_caret_column**\ (\ column\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, caret_index\: :ref:`int` = 0\ ) +|void| **set_caret_column**\ (\ column\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Moves the caret to the specified ``column`` index. @@ -3389,7 +3389,7 @@ If ``adjust_viewport`` is ``true``, the viewport will center at the caret positi .. rst-class:: classref-method -|void| **set_caret_line**\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) +|void| **set_caret_line**\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Moves the caret to the specified ``line`` index. The caret column will be moved to the same visual position it was at the last time :ref:`set_caret_column` was called, or clamped to the end of the line. @@ -3409,7 +3409,7 @@ If ``wrap_index`` is ``-1``, the caret column will be clamped to the ``line``'s .. rst-class:: classref-method -|void| **set_gutter_clickable**\ (\ gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) +|void| **set_gutter_clickable**\ (\ gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) :ref:`🔗` Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter. @@ -3421,7 +3421,7 @@ Sets the gutter as clickable. This will change the mouse cursor to a pointing ha .. rst-class:: classref-method -|void| **set_gutter_custom_draw**\ (\ column\: :ref:`int`, draw_callback\: :ref:`Callable`\ ) +|void| **set_gutter_custom_draw**\ (\ column\: :ref:`int`, draw_callback\: :ref:`Callable`\ ) :ref:`🔗` Set a custom draw method for the gutter. The callback method must take the following args: ``line: int, gutter: int, Area: Rect2``. This only works when the gutter type is :ref:`GUTTER_TYPE_CUSTOM` (see :ref:`set_gutter_type`). @@ -3433,7 +3433,7 @@ Set a custom draw method for the gutter. The callback method must take the follo .. rst-class:: classref-method -|void| **set_gutter_draw**\ (\ gutter\: :ref:`int`, draw\: :ref:`bool`\ ) +|void| **set_gutter_draw**\ (\ gutter\: :ref:`int`, draw\: :ref:`bool`\ ) :ref:`🔗` Sets whether the gutter should be drawn. @@ -3445,7 +3445,7 @@ Sets whether the gutter should be drawn. .. rst-class:: classref-method -|void| **set_gutter_name**\ (\ gutter\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_gutter_name**\ (\ gutter\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the gutter. @@ -3457,7 +3457,7 @@ Sets the name of the gutter. .. rst-class:: classref-method -|void| **set_gutter_overwritable**\ (\ gutter\: :ref:`int`, overwritable\: :ref:`bool`\ ) +|void| **set_gutter_overwritable**\ (\ gutter\: :ref:`int`, overwritable\: :ref:`bool`\ ) :ref:`🔗` Sets the gutter to overwritable. See :ref:`merge_gutters`. @@ -3469,7 +3469,7 @@ Sets the gutter to overwritable. See :ref:`merge_gutters`, type\: :ref:`GutterType`\ ) +|void| **set_gutter_type**\ (\ gutter\: :ref:`int`, type\: :ref:`GutterType`\ ) :ref:`🔗` Sets the type of gutter. Gutters can contain icons, text, or custom visuals. See :ref:`GutterType` for options. @@ -3481,7 +3481,7 @@ Sets the type of gutter. Gutters can contain icons, text, or custom visuals. See .. rst-class:: classref-method -|void| **set_gutter_width**\ (\ gutter\: :ref:`int`, width\: :ref:`int`\ ) +|void| **set_gutter_width**\ (\ gutter\: :ref:`int`, width\: :ref:`int`\ ) :ref:`🔗` Set the width of the gutter. @@ -3493,7 +3493,7 @@ Set the width of the gutter. .. rst-class:: classref-method -|void| **set_line**\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) +|void| **set_line**\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) :ref:`🔗` Sets the text for a specific ``line``. @@ -3507,7 +3507,7 @@ Carets on the line will attempt to keep their visual x position. .. rst-class:: classref-method -|void| **set_line_as_center_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) +|void| **set_line_as_center_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) :ref:`🔗` Positions the ``wrap_index`` of ``line`` at the center of the viewport. @@ -3519,7 +3519,7 @@ Positions the ``wrap_index`` of ``line`` at the center of the viewport. .. rst-class:: classref-method -|void| **set_line_as_first_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) +|void| **set_line_as_first_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) :ref:`🔗` Positions the ``wrap_index`` of ``line`` at the top of the viewport. @@ -3531,7 +3531,7 @@ Positions the ``wrap_index`` of ``line`` at the top of the viewport. .. rst-class:: classref-method -|void| **set_line_as_last_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) +|void| **set_line_as_last_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) :ref:`🔗` Positions the ``wrap_index`` of ``line`` at the bottom of the viewport. @@ -3543,7 +3543,7 @@ Positions the ``wrap_index`` of ``line`` at the bottom of the viewport. .. rst-class:: classref-method -|void| **set_line_background_color**\ (\ line\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_line_background_color**\ (\ line\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the current background color of the line. Set to ``Color(0, 0, 0, 0)`` for no color. @@ -3555,7 +3555,7 @@ Sets the current background color of the line. Set to ``Color(0, 0, 0, 0)`` for .. rst-class:: classref-method -|void| **set_line_gutter_clickable**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) +|void| **set_line_gutter_clickable**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) :ref:`🔗` If ``clickable`` is ``true``, makes the ``gutter`` on ``line`` clickable. See :ref:`gutter_clicked`. @@ -3567,7 +3567,7 @@ If ``clickable`` is ``true``, makes the ``gutter`` on ``line`` clickable. See :r .. rst-class:: classref-method -|void| **set_line_gutter_icon**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, icon\: :ref:`Texture2D`\ ) +|void| **set_line_gutter_icon**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, icon\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the icon for ``gutter`` on ``line`` to ``icon``. This only works when the gutter type is :ref:`GUTTER_TYPE_ICON` (see :ref:`set_gutter_type`). @@ -3579,7 +3579,7 @@ Sets the icon for ``gutter`` on ``line`` to ``icon``. This only works when the g .. rst-class:: classref-method -|void| **set_line_gutter_item_color**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_line_gutter_item_color**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color for ``gutter`` on ``line`` to ``color``. @@ -3591,7 +3591,7 @@ Sets the color for ``gutter`` on ``line`` to ``color``. .. rst-class:: classref-method -|void| **set_line_gutter_metadata**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, metadata\: :ref:`Variant`\ ) +|void| **set_line_gutter_metadata**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, metadata\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata for ``gutter`` on ``line`` to ``metadata``. @@ -3603,7 +3603,7 @@ Sets the metadata for ``gutter`` on ``line`` to ``metadata``. .. rst-class:: classref-method -|void| **set_line_gutter_text**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_line_gutter_text**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets the text for ``gutter`` on ``line`` to ``text``. This only works when the gutter type is :ref:`GUTTER_TYPE_STRING` (see :ref:`set_gutter_type`). @@ -3615,7 +3615,7 @@ Sets the text for ``gutter`` on ``line`` to ``text``. This only works when the g .. rst-class:: classref-method -|void| **set_overtype_mode_enabled**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_overtype_mode_enabled**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, sets the user into overtype mode. When the user types in this mode, it will override existing text. @@ -3627,7 +3627,7 @@ If ``true``, sets the user into overtype mode. When the user types in this mode, .. rst-class:: classref-method -|void| **set_search_flags**\ (\ flags\: :ref:`int`\ ) +|void| **set_search_flags**\ (\ flags\: :ref:`int`\ ) :ref:`🔗` Sets the search ``flags``. This is used with :ref:`set_search_text` to highlight occurrences of the searched text. Search flags can be specified from the :ref:`SearchFlags` enum. @@ -3639,7 +3639,7 @@ Sets the search ``flags``. This is used with :ref:`set_search_text`\ ) +|void| **set_search_text**\ (\ search_text\: :ref:`String`\ ) :ref:`🔗` Sets the search text. See :ref:`set_search_flags`. @@ -3651,7 +3651,7 @@ Sets the search text. See :ref:`set_search_flags`\ ) +|void| **set_selection_mode**\ (\ mode\: :ref:`SelectionMode`\ ) :ref:`🔗` Sets the current selection mode. @@ -3663,7 +3663,7 @@ Sets the current selection mode. .. rst-class:: classref-method -|void| **set_selection_origin_column**\ (\ column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) +|void| **set_selection_origin_column**\ (\ column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Sets the selection origin column to the ``column`` for the given ``caret_index``. If the selection origin is moved to the caret position, the selection will deselect. @@ -3675,7 +3675,7 @@ Sets the selection origin column to the ``column`` for the given ``caret_index`` .. rst-class:: classref-method -|void| **set_selection_origin_line**\ (\ line\: :ref:`int`, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) +|void| **set_selection_origin_line**\ (\ line\: :ref:`int`, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) :ref:`🔗` Sets the selection origin line to the ``line`` for the given ``caret_index``. If the selection origin is moved to the caret position, the selection will deselect. @@ -3691,7 +3691,7 @@ If ``wrap_index`` is ``-1``, the selection origin column will be clamped to the .. rst-class:: classref-method -|void| **set_tab_size**\ (\ size\: :ref:`int`\ ) +|void| **set_tab_size**\ (\ size\: :ref:`int`\ ) :ref:`🔗` Sets the tab size for the **TextEdit** to use. @@ -3703,7 +3703,7 @@ Sets the tab size for the **TextEdit** to use. .. rst-class:: classref-method -|void| **set_tooltip_request_func**\ (\ callback\: :ref:`Callable`\ ) +|void| **set_tooltip_request_func**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Provide custom tooltip text. The callback method must take the following args: ``hovered_word: String``. @@ -3715,7 +3715,7 @@ Provide custom tooltip text. The callback method must take the following args: ` .. rst-class:: classref-method -|void| **skip_selection_for_next_occurrence**\ (\ ) +|void| **skip_selection_for_next_occurrence**\ (\ ) :ref:`🔗` Moves a selection and a caret for the next occurrence of the current selection. If there is no active selection, moves to the next occurrence of the word under caret. @@ -3727,7 +3727,7 @@ Moves a selection and a caret for the next occurrence of the current selection. .. rst-class:: classref-method -|void| **start_action**\ (\ action\: :ref:`EditAction`\ ) +|void| **start_action**\ (\ action\: :ref:`EditAction`\ ) :ref:`🔗` Starts an action, will end the current action if ``action`` is different. @@ -3741,7 +3741,7 @@ An action will also end after a call to :ref:`end_action`, to_line\: :ref:`int`\ ) +|void| **swap_lines**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) :ref:`🔗` Swaps the two lines. Carets will be swapped with the lines. @@ -3753,7 +3753,7 @@ Swaps the two lines. Carets will be swapped with the lines. .. rst-class:: classref-method -|void| **tag_saved_version**\ (\ ) +|void| **tag_saved_version**\ (\ ) :ref:`🔗` Tag the current version as saved. @@ -3765,7 +3765,7 @@ Tag the current version as saved. .. rst-class:: classref-method -|void| **undo**\ (\ ) +|void| **undo**\ (\ ) :ref:`🔗` Perform undo operation. @@ -3782,7 +3782,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **background_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **background_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` Sets the background :ref:`Color` of this **TextEdit**. @@ -3794,7 +3794,7 @@ Sets the background :ref:`Color` of this **TextEdit**. .. rst-class:: classref-themeproperty -:ref:`Color` **caret_background_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **caret_background_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` :ref:`Color` of the text behind the caret when using a block caret. @@ -3806,7 +3806,7 @@ Sets the background :ref:`Color` of this **TextEdit**. .. rst-class:: classref-themeproperty -:ref:`Color` **caret_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **caret_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` :ref:`Color` of the caret. This can be set to a fully transparent color to hide the caret entirely. @@ -3818,7 +3818,7 @@ Sets the background :ref:`Color` of this **TextEdit**. .. rst-class:: classref-themeproperty -:ref:`Color` **current_line_color** = ``Color(0.25, 0.25, 0.26, 0.8)`` +:ref:`Color` **current_line_color** = ``Color(0.25, 0.25, 0.26, 0.8)`` :ref:`🔗` Background :ref:`Color` of the line containing the caret. @@ -3830,7 +3830,7 @@ Background :ref:`Color` of the line containing the caret. .. rst-class:: classref-themeproperty -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Sets the font :ref:`Color`. @@ -3842,7 +3842,7 @@ Sets the font :ref:`Color`. .. rst-class:: classref-themeproperty -:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the **TextEdit**. @@ -3854,7 +3854,7 @@ The tint of text outline of the **TextEdit**. .. rst-class:: classref-themeproperty -:ref:`Color` **font_placeholder_color** = ``Color(0.875, 0.875, 0.875, 0.6)`` +:ref:`Color` **font_placeholder_color** = ``Color(0.875, 0.875, 0.875, 0.6)`` :ref:`🔗` Font color for :ref:`placeholder_text`. @@ -3866,7 +3866,7 @@ Font color for :ref:`placeholder_text` .. rst-class:: classref-themeproperty -:ref:`Color` **font_readonly_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_readonly_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Sets the font :ref:`Color` when :ref:`editable` is disabled. @@ -3878,7 +3878,7 @@ Sets the font :ref:`Color` when :ref:`editable` **font_selected_color** = ``Color(0, 0, 0, 0)`` +:ref:`Color` **font_selected_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` Sets the :ref:`Color` of the selected text. If equal to ``Color(0, 0, 0, 0)``, it will be ignored. @@ -3890,7 +3890,7 @@ Sets the :ref:`Color` of the selected text. If equal to ``Color(0, .. rst-class:: classref-themeproperty -:ref:`Color` **search_result_border_color** = ``Color(0.3, 0.3, 0.3, 0.4)`` +:ref:`Color` **search_result_border_color** = ``Color(0.3, 0.3, 0.3, 0.4)`` :ref:`🔗` :ref:`Color` of the border around text that matches the search query. @@ -3902,7 +3902,7 @@ Sets the :ref:`Color` of the selected text. If equal to ``Color(0, .. rst-class:: classref-themeproperty -:ref:`Color` **search_result_color** = ``Color(0.3, 0.3, 0.3, 1)`` +:ref:`Color` **search_result_color** = ``Color(0.3, 0.3, 0.3, 1)`` :ref:`🔗` :ref:`Color` behind the text that matches the search query. @@ -3914,7 +3914,7 @@ Sets the :ref:`Color` of the selected text. If equal to ``Color(0, .. rst-class:: classref-themeproperty -:ref:`Color` **selection_color** = ``Color(0.5, 0.5, 0.5, 1)`` +:ref:`Color` **selection_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` Sets the highlight :ref:`Color` of text selections. @@ -3926,7 +3926,7 @@ Sets the highlight :ref:`Color` of text selections. .. rst-class:: classref-themeproperty -:ref:`Color` **word_highlighted_color** = ``Color(0.5, 0.5, 0.5, 0.25)`` +:ref:`Color` **word_highlighted_color** = ``Color(0.5, 0.5, 0.5, 0.25)`` :ref:`🔗` Sets the highlight :ref:`Color` of multiple occurrences. :ref:`highlight_all_occurrences` has to be enabled. @@ -3938,7 +3938,7 @@ Sets the highlight :ref:`Color` of multiple occurrences. :ref:`high .. rst-class:: classref-themeproperty -:ref:`int` **caret_width** = ``1`` +:ref:`int` **caret_width** = ``1`` :ref:`🔗` The caret's width in pixels. Greater values can be used to improve accessibility by ensuring the caret is easily visible, or to ensure consistency with a large font size. If set to ``0`` or lower, the caret width is automatically set to 1 pixel and multiplied by the display scaling factor. @@ -3950,7 +3950,7 @@ The caret's width in pixels. Greater values can be used to improve accessibility .. rst-class:: classref-themeproperty -:ref:`int` **line_spacing** = ``4`` +:ref:`int` **line_spacing** = ``4`` :ref:`🔗` Sets the spacing between the lines. @@ -3962,7 +3962,7 @@ Sets the spacing between the lines. .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -3976,7 +3976,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` Sets the default :ref:`Font`. @@ -3988,7 +3988,7 @@ Sets the default :ref:`Font`. .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Sets default font size. @@ -4000,7 +4000,7 @@ Sets default font size. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **space** +:ref:`Texture2D` **space** :ref:`🔗` Sets a custom :ref:`Texture2D` for space text characters. @@ -4012,7 +4012,7 @@ Sets a custom :ref:`Texture2D` for space text characters. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **tab** +:ref:`Texture2D` **tab** :ref:`🔗` Sets a custom :ref:`Texture2D` for tab text characters. @@ -4024,7 +4024,7 @@ Sets a custom :ref:`Texture2D` for tab text characters. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` Sets the :ref:`StyleBox` when in focus. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -4036,7 +4036,7 @@ Sets the :ref:`StyleBox` when in focus. The :ref:`focus` **normal** +:ref:`StyleBox` **normal** :ref:`🔗` Sets the :ref:`StyleBox` of this **TextEdit**. @@ -4048,7 +4048,7 @@ Sets the :ref:`StyleBox` of this **TextEdit**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **read_only** +:ref:`StyleBox` **read_only** :ref:`🔗` Sets the :ref:`StyleBox` of this **TextEdit** when :ref:`editable` is disabled. diff --git a/classes/class_textline.rst b/classes/class_textline.rst index 32266616c78..b3b5896fea1 100644 --- a/classes/class_textline.rst +++ b/classes/class_textline.rst @@ -108,7 +108,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`HorizontalAlignment` **alignment** = ``0`` +:ref:`HorizontalAlignment` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ Sets text alignment within the line as if the line was horizontal. .. rst-class:: classref-property -:ref:`Direction` **direction** = ``0`` +:ref:`Direction` **direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ Text writing direction. .. rst-class:: classref-property -:ref:`String` **ellipsis_char** = ``"…"`` +:ref:`String` **ellipsis_char** = ``"…"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Ellipsis character used for text clipping. .. rst-class:: classref-property -|bitfield|\[:ref:`JustificationFlag`\] **flags** = ``3`` +|bitfield|\[:ref:`JustificationFlag`\] **flags** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Line alignment rules. For more info see :ref:`TextServer`. .. rst-class:: classref-property -:ref:`Orientation` **orientation** = ``0`` +:ref:`Orientation` **orientation** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ Text orientation. .. rst-class:: classref-property -:ref:`bool` **preserve_control** = ``false`` +:ref:`bool` **preserve_control** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ If set to ``true`` text will display control characters. .. rst-class:: classref-property -:ref:`bool` **preserve_invalid** = ``true`` +:ref:`bool` **preserve_invalid** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -227,7 +227,7 @@ If set to ``true`` text will display invalid characters. .. rst-class:: classref-property -:ref:`OverrunBehavior` **text_overrun_behavior** = ``3`` +:ref:`OverrunBehavior` **text_overrun_behavior** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -244,7 +244,7 @@ Sets the clipping behavior when the text exceeds the text line's set width. See .. rst-class:: classref-property -:ref:`float` **width** = ``-1.0`` +:ref:`float` **width** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -266,7 +266,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **add_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) +:ref:`bool` **add_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) :ref:`🔗` Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. @@ -278,7 +278,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **add_string**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) +:ref:`bool` **add_string**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) :ref:`🔗` Adds text span and font to draw it. @@ -290,7 +290,7 @@ Adds text span and font to draw it. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears text line (removes text and inline objects). @@ -302,7 +302,7 @@ Clears text line (removes text and inline objects). .. rst-class:: classref-method -|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -314,7 +314,7 @@ Draw text into a canvas item at a given position, with ``color``. ``pos`` specif .. rst-class:: classref-method -|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -326,7 +326,7 @@ Draw text into a canvas item at a given position, with ``color``. ``pos`` specif .. rst-class:: classref-method -:ref:`float` **get_line_ascent**\ (\ ) |const| +:ref:`float` **get_line_ascent**\ (\ ) |const| :ref:`🔗` Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -338,7 +338,7 @@ Returns the text ascent (number of pixels above the baseline for horizontal layo .. rst-class:: classref-method -:ref:`float` **get_line_descent**\ (\ ) |const| +:ref:`float` **get_line_descent**\ (\ ) |const| :ref:`🔗` Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -350,7 +350,7 @@ Returns the text descent (number of pixels below the baseline for horizontal lay .. rst-class:: classref-method -:ref:`float` **get_line_underline_position**\ (\ ) |const| +:ref:`float` **get_line_underline_position**\ (\ ) |const| :ref:`🔗` Returns pixel offset of the underline below the baseline. @@ -362,7 +362,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_line_underline_thickness**\ (\ ) |const| +:ref:`float` **get_line_underline_thickness**\ (\ ) |const| :ref:`🔗` Returns thickness of the underline. @@ -374,7 +374,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **get_line_width**\ (\ ) |const| +:ref:`float` **get_line_width**\ (\ ) |const| :ref:`🔗` Returns width (for horizontal layout) or height (for vertical) of the text. @@ -386,7 +386,7 @@ Returns width (for horizontal layout) or height (for vertical) of the text. .. rst-class:: classref-method -:ref:`Rect2` **get_object_rect**\ (\ key\: :ref:`Variant`\ ) |const| +:ref:`Rect2` **get_object_rect**\ (\ key\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns bounding rectangle of the inline object. @@ -398,7 +398,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **get_objects**\ (\ ) |const| +:ref:`Array` **get_objects**\ (\ ) |const| :ref:`🔗` Returns array of inline objects. @@ -410,7 +410,7 @@ Returns array of inline objects. .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns TextServer buffer RID. @@ -422,7 +422,7 @@ Returns TextServer buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_size**\ (\ ) |const| +:ref:`Vector2` **get_size**\ (\ ) |const| :ref:`🔗` Returns size of the bounding box of the text. @@ -434,7 +434,7 @@ Returns size of the bounding box of the text. .. rst-class:: classref-method -:ref:`int` **hit_test**\ (\ coords\: :ref:`float`\ ) |const| +:ref:`int` **hit_test**\ (\ coords\: :ref:`float`\ ) |const| :ref:`🔗` Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. @@ -446,7 +446,7 @@ Returns caret character offset at the specified pixel offset at the baseline. Th .. rst-class:: classref-method -:ref:`bool` **resize_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) +:ref:`bool` **resize_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) :ref:`🔗` Sets new size and alignment of embedded object. @@ -458,7 +458,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -|void| **set_bidi_override**\ (\ override\: :ref:`Array`\ ) +|void| **set_bidi_override**\ (\ override\: :ref:`Array`\ ) :ref:`🔗` Overrides BiDi for the structured text. @@ -472,7 +472,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w .. rst-class:: classref-method -|void| **tab_align**\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) +|void| **tab_align**\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Aligns text to the given tab-stops. diff --git a/classes/class_textmesh.rst b/classes/class_textmesh.rst index 146ebf71620..5eb39463e92 100644 --- a/classes/class_textmesh.rst +++ b/classes/class_textmesh.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AutowrapMode` **autowrap_mode** = ``0`` +:ref:`AutowrapMode` **autowrap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` **curve_step** = ``0.5`` +:ref:`float` **curve_step** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ Step (in pixels) used to approximate Bézier curves. .. rst-class:: classref-property -:ref:`float` **depth** = ``0.05`` +:ref:`float` **depth** = ``0.05`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ Depths of the mesh, if set to ``0.0`` only front surface, is generated, and UV l .. rst-class:: classref-property -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Font configuration used to display text. .. rst-class:: classref-property -:ref:`int` **font_size** = ``16`` +:ref:`int` **font_size** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Font size of the **TextMesh**'s text. .. rst-class:: classref-property -:ref:`HorizontalAlignment` **horizontal_alignment** = ``1`` +:ref:`HorizontalAlignment` **horizontal_alignment** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill .. rst-class:: classref-property -|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` **language** = ``""`` +:ref:`String` **language** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -227,7 +227,7 @@ Language code used for text shaping algorithms, if left empty current locale is .. rst-class:: classref-property -:ref:`float` **line_spacing** = ``0.0`` +:ref:`float` **line_spacing** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -244,7 +244,7 @@ Vertical space between lines in multiline **TextMesh**. .. rst-class:: classref-property -:ref:`Vector2` **offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -261,7 +261,7 @@ The text drawing offset (in pixels). .. rst-class:: classref-property -:ref:`float` **pixel_size** = ``0.01`` +:ref:`float` **pixel_size** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -278,7 +278,7 @@ The size of one pixel's width on the text to scale it in 3D. .. rst-class:: classref-property -:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` +:ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -295,7 +295,7 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property -:ref:`Array` **structured_text_bidi_override_options** = ``[]`` +:ref:`Array` **structured_text_bidi_override_options** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -312,7 +312,7 @@ Set additional options for BiDi override. .. rst-class:: classref-property -:ref:`String` **text** = ``""`` +:ref:`String` **text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -331,7 +331,7 @@ The text to generate mesh from. .. rst-class:: classref-property -:ref:`Direction` **text_direction** = ``0`` +:ref:`Direction` **text_direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -348,7 +348,7 @@ Base text writing direction. .. rst-class:: classref-property -:ref:`bool` **uppercase** = ``false`` +:ref:`bool` **uppercase** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -365,7 +365,7 @@ If ``true``, all the text displays as UPPERCASE. .. rst-class:: classref-property -:ref:`VerticalAlignment` **vertical_alignment** = ``1`` +:ref:`VerticalAlignment` **vertical_alignment** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -382,7 +382,7 @@ Controls the text's vertical alignment. Supports top, center, bottom. Set it to .. rst-class:: classref-property -:ref:`float` **width** = ``500.0`` +:ref:`float` **width** = ``500.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_textparagraph.rst b/classes/class_textparagraph.rst index cab48907aa8..2309a3997fd 100644 --- a/classes/class_textparagraph.rst +++ b/classes/class_textparagraph.rst @@ -142,7 +142,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`HorizontalAlignment` **alignment** = ``0`` +:ref:`HorizontalAlignment` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ Paragraph horizontal alignment. .. rst-class:: classref-property -|bitfield|\[:ref:`LineBreakFlag`\] **break_flags** = ``3`` +|bitfield|\[:ref:`LineBreakFlag`\] **break_flags** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ Line breaking rules. For more info see :ref:`TextServer`. .. rst-class:: classref-property -:ref:`String` **custom_punctuation** = ``""`` +:ref:`String` **custom_punctuation** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ Custom punctuation character list, used for word breaking. If set to empty strin .. rst-class:: classref-property -:ref:`Direction` **direction** = ``0`` +:ref:`Direction` **direction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ Text writing direction. .. rst-class:: classref-property -:ref:`String` **ellipsis_char** = ``"…"`` +:ref:`String` **ellipsis_char** = ``"…"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -227,7 +227,7 @@ Ellipsis character used for text clipping. .. rst-class:: classref-property -|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -244,7 +244,7 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` **max_lines_visible** = ``-1`` +:ref:`int` **max_lines_visible** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -261,7 +261,7 @@ Limits the lines of text shown. .. rst-class:: classref-property -:ref:`Orientation` **orientation** = ``0`` +:ref:`Orientation` **orientation** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -278,7 +278,7 @@ Text orientation. .. rst-class:: classref-property -:ref:`bool` **preserve_control** = ``false`` +:ref:`bool` **preserve_control** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -295,7 +295,7 @@ If set to ``true`` text will display control characters. .. rst-class:: classref-property -:ref:`bool` **preserve_invalid** = ``true`` +:ref:`bool` **preserve_invalid** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -312,7 +312,7 @@ If set to ``true`` text will display invalid characters. .. rst-class:: classref-property -:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` +:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -329,7 +329,7 @@ Sets the clipping behavior when the text exceeds the paragraph's set width. See .. rst-class:: classref-property -:ref:`float` **width** = ``-1.0`` +:ref:`float` **width** = ``-1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -351,7 +351,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **add_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) +:ref:`bool` **add_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) :ref:`🔗` Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. @@ -363,7 +363,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **add_string**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) +:ref:`bool` **add_string**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) :ref:`🔗` Adds text span and font to draw it. @@ -375,7 +375,7 @@ Adds text span and font to draw it. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears text paragraph (removes text and inline objects). @@ -387,7 +387,7 @@ Clears text paragraph (removes text and inline objects). .. rst-class:: classref-method -|void| **clear_dropcap**\ (\ ) +|void| **clear_dropcap**\ (\ ) :ref:`🔗` Removes dropcap. @@ -399,7 +399,7 @@ Removes dropcap. .. rst-class:: classref-method -|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw all lines of the text and drop cap into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -411,7 +411,7 @@ Draw all lines of the text and drop cap into a canvas item at a given position, .. rst-class:: classref-method -|void| **draw_dropcap**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_dropcap**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw drop cap into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -423,7 +423,7 @@ Draw drop cap into a canvas item at a given position, with ``color``. ``pos`` sp .. rst-class:: classref-method -|void| **draw_dropcap_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_dropcap_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw drop cap outline into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -435,7 +435,7 @@ Draw drop cap outline into a canvas item at a given position, with ``color``. `` .. rst-class:: classref-method -|void| **draw_line**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_line**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw single line of text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -447,7 +447,7 @@ Draw single line of text into a canvas item at a given position, with ``color``. .. rst-class:: classref-method -|void| **draw_line_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_line_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw outline of the single line of text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -459,7 +459,7 @@ Draw outline of the single line of text into a canvas item at a given position, .. rst-class:: classref-method -|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -471,7 +471,7 @@ Draw outlines of all lines of the text and drop cap into a canvas item at a give .. rst-class:: classref-method -:ref:`int` **get_dropcap_lines**\ (\ ) |const| +:ref:`int` **get_dropcap_lines**\ (\ ) |const| :ref:`🔗` Returns number of lines used by dropcap. @@ -483,7 +483,7 @@ Returns number of lines used by dropcap. .. rst-class:: classref-method -:ref:`RID` **get_dropcap_rid**\ (\ ) |const| +:ref:`RID` **get_dropcap_rid**\ (\ ) |const| :ref:`🔗` Returns drop cap text buffer RID. @@ -495,7 +495,7 @@ Returns drop cap text buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_dropcap_size**\ (\ ) |const| +:ref:`Vector2` **get_dropcap_size**\ (\ ) |const| :ref:`🔗` Returns drop cap bounding box size. @@ -507,7 +507,7 @@ Returns drop cap bounding box size. .. rst-class:: classref-method -:ref:`float` **get_line_ascent**\ (\ line\: :ref:`int`\ ) |const| +:ref:`float` **get_line_ascent**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -519,7 +519,7 @@ Returns the text line ascent (number of pixels above the baseline for horizontal .. rst-class:: classref-method -:ref:`int` **get_line_count**\ (\ ) |const| +:ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` Returns number of lines in the paragraph. @@ -531,7 +531,7 @@ Returns number of lines in the paragraph. .. rst-class:: classref-method -:ref:`float` **get_line_descent**\ (\ line\: :ref:`int`\ ) |const| +:ref:`float` **get_line_descent**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -543,7 +543,7 @@ Returns the text line descent (number of pixels below the baseline for horizonta .. rst-class:: classref-method -:ref:`Rect2` **get_line_object_rect**\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| +:ref:`Rect2` **get_line_object_rect**\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns bounding rectangle of the inline object. @@ -555,7 +555,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **get_line_objects**\ (\ line\: :ref:`int`\ ) |const| +:ref:`Array` **get_line_objects**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns array of inline objects in the line. @@ -567,7 +567,7 @@ Returns array of inline objects in the line. .. rst-class:: classref-method -:ref:`Vector2i` **get_line_range**\ (\ line\: :ref:`int`\ ) |const| +:ref:`Vector2i` **get_line_range**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns character range of the line. @@ -579,7 +579,7 @@ Returns character range of the line. .. rst-class:: classref-method -:ref:`RID` **get_line_rid**\ (\ line\: :ref:`int`\ ) |const| +:ref:`RID` **get_line_rid**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns TextServer line buffer RID. @@ -591,7 +591,7 @@ Returns TextServer line buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_line_size**\ (\ line\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_line_size**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns size of the bounding box of the line of text. @@ -603,7 +603,7 @@ Returns size of the bounding box of the line of text. .. rst-class:: classref-method -:ref:`float` **get_line_underline_position**\ (\ line\: :ref:`int`\ ) |const| +:ref:`float` **get_line_underline_position**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns pixel offset of the underline below the baseline. @@ -615,7 +615,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_line_underline_thickness**\ (\ line\: :ref:`int`\ ) |const| +:ref:`float` **get_line_underline_thickness**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns thickness of the underline. @@ -627,7 +627,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **get_line_width**\ (\ line\: :ref:`int`\ ) |const| +:ref:`float` **get_line_width**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` Returns width (for horizontal layout) or height (for vertical) of the line of text. @@ -639,7 +639,7 @@ Returns width (for horizontal layout) or height (for vertical) of the line of te .. rst-class:: classref-method -:ref:`Vector2` **get_non_wrapped_size**\ (\ ) |const| +:ref:`Vector2` **get_non_wrapped_size**\ (\ ) |const| :ref:`🔗` Returns the size of the bounding box of the paragraph, without line breaks. @@ -651,7 +651,7 @@ Returns the size of the bounding box of the paragraph, without line breaks. .. rst-class:: classref-method -:ref:`RID` **get_rid**\ (\ ) |const| +:ref:`RID` **get_rid**\ (\ ) |const| :ref:`🔗` Returns TextServer full string buffer RID. @@ -663,7 +663,7 @@ Returns TextServer full string buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_size**\ (\ ) |const| +:ref:`Vector2` **get_size**\ (\ ) |const| :ref:`🔗` Returns the size of the bounding box of the paragraph. @@ -675,7 +675,7 @@ Returns the size of the bounding box of the paragraph. .. rst-class:: classref-method -:ref:`int` **hit_test**\ (\ coords\: :ref:`Vector2`\ ) |const| +:ref:`int` **hit_test**\ (\ coords\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns caret character offset at the specified coordinates. This function always returns a valid position. @@ -687,7 +687,7 @@ Returns caret character offset at the specified coordinates. This function alway .. rst-class:: classref-method -:ref:`bool` **resize_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) +:ref:`bool` **resize_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) :ref:`🔗` Sets new size and alignment of embedded object. @@ -699,7 +699,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -|void| **set_bidi_override**\ (\ override\: :ref:`Array`\ ) +|void| **set_bidi_override**\ (\ override\: :ref:`Array`\ ) :ref:`🔗` Overrides BiDi for the structured text. @@ -713,7 +713,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w .. rst-class:: classref-method -:ref:`bool` **set_dropcap**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) +:ref:`bool` **set_dropcap**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) :ref:`🔗` Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. @@ -725,7 +725,7 @@ Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is .. rst-class:: classref-method -|void| **tab_align**\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) +|void| **tab_align**\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Aligns paragraph to the given tab-stops. diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index ca28493607f..5c820c8c863 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -489,7 +489,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FontAntialiasing**: +enum **FontAntialiasing**: :ref:`🔗` .. _class_TextServer_constant_FONT_ANTIALIASING_NONE: @@ -527,7 +527,7 @@ LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unsca .. rst-class:: classref-enumeration -enum **FontLCDSubpixelLayout**: +enum **FontLCDSubpixelLayout**: :ref:`🔗` .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE: @@ -585,7 +585,7 @@ Represents the size of the :ref:`FontLCDSubpixelLayout` .. _class_TextServer_constant_DIRECTION_AUTO: @@ -627,7 +627,7 @@ Text writing direction is the same as base string writing direction. Used for Bi .. rst-class:: classref-enumeration -enum **Orientation**: +enum **Orientation**: :ref:`🔗` .. _class_TextServer_constant_ORIENTATION_HORIZONTAL: @@ -655,7 +655,7 @@ Right to left text is written vertically from bottom to top. .. rst-class:: classref-enumeration -flags **JustificationFlag**: +flags **JustificationFlag**: :ref:`🔗` .. _class_TextServer_constant_JUSTIFICATION_NONE: @@ -737,7 +737,7 @@ Always apply justification to the paragraphs with a single line (:ref:`JUSTIFICA .. rst-class:: classref-enumeration -enum **AutowrapMode**: +enum **AutowrapMode**: :ref:`🔗` .. _class_TextServer_constant_AUTOWRAP_OFF: @@ -779,7 +779,7 @@ Behaves similarly to :ref:`AUTOWRAP_WORD` .. _class_TextServer_constant_BREAK_NONE: @@ -845,7 +845,7 @@ Subtract first line indentation width from all lines after the first one. .. rst-class:: classref-enumeration -enum **VisibleCharactersBehavior**: +enum **VisibleCharactersBehavior**: :ref:`🔗` .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING: @@ -895,7 +895,7 @@ Displays :ref:`Label.visible_ratio` or :ref: .. rst-class:: classref-enumeration -enum **OverrunBehavior**: +enum **OverrunBehavior**: :ref:`🔗` .. _class_TextServer_constant_OVERRUN_NO_TRIMMING: @@ -945,7 +945,7 @@ Trims the text per word and adds an ellipsis to indicate that parts are hidden. .. rst-class:: classref-enumeration -flags **TextOverrunFlag**: +flags **TextOverrunFlag**: :ref:`🔗` .. _class_TextServer_constant_OVERRUN_NO_TRIM: @@ -1003,7 +1003,7 @@ Accounts for the text being justified before attempting to trim it (see :ref:`Ju .. rst-class:: classref-enumeration -flags **GraphemeFlag**: +flags **GraphemeFlag**: :ref:`🔗` .. _class_TextServer_constant_GRAPHEME_IS_VALID: @@ -1125,7 +1125,7 @@ Grapheme is a soft hyphen. .. rst-class:: classref-enumeration -enum **Hinting**: +enum **Hinting**: :ref:`🔗` .. _class_TextServer_constant_HINTING_NONE: @@ -1161,7 +1161,7 @@ Use the default font hinting mode (crisper but less smooth). .. rst-class:: classref-enumeration -enum **SubpixelPositioning**: +enum **SubpixelPositioning**: :ref:`🔗` .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED: @@ -1225,7 +1225,7 @@ Maximum font size which will use one quarter of the pixel subpixel positioning i .. rst-class:: classref-enumeration -enum **Feature**: +enum **Feature**: :ref:`🔗` .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT: @@ -1355,7 +1355,7 @@ TextServer supports `Unicode Technical Report #36 ` .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON: @@ -1389,7 +1389,7 @@ Contour point isn't on the curve, but serves as a control point for a cubic Béz .. rst-class:: classref-enumeration -enum **SpacingType**: +enum **SpacingType**: :ref:`🔗` .. _class_TextServer_constant_SPACING_GLYPH: @@ -1439,7 +1439,7 @@ Represents the size of the :ref:`SpacingType` enum. .. rst-class:: classref-enumeration -flags **FontStyle**: +flags **FontStyle**: :ref:`🔗` .. _class_TextServer_constant_FONT_BOLD: @@ -1473,7 +1473,7 @@ Font have fixed-width characters. .. rst-class:: classref-enumeration -enum **StructuredTextParser**: +enum **StructuredTextParser**: :ref:`🔗` .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT: @@ -1539,7 +1539,7 @@ User defined structured text BiDi override function. .. rst-class:: classref-enumeration -enum **FixedSizeScaleMode**: +enum **FixedSizeScaleMode**: :ref:`🔗` .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE: @@ -1578,7 +1578,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **create_font**\ (\ ) +:ref:`RID` **create_font**\ (\ ) :ref:`🔗` Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid` method. @@ -1590,7 +1590,7 @@ Creates a new, empty font cache entry resource. To free the resulting resource, .. rst-class:: classref-method -:ref:`RID` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) +:ref:`RID` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) :ref:`🔗` Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the :ref:`free_rid` method. @@ -1602,7 +1602,7 @@ Creates a new variation existing font which is reusing the same glyph cache and .. rst-class:: classref-method -:ref:`RID` **create_shaped_text**\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) +:ref:`RID` **create_shaped_text**\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) :ref:`🔗` Creates a new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`free_rid` method. @@ -1618,7 +1618,7 @@ Creates a new buffer for complex text layout, with the given ``direction`` and ` .. rst-class:: classref-method -|void| **draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |const| +|void| **draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |const| :ref:`🔗` Draws box displaying character hexadecimal code. Used for replacing missing characters. @@ -1630,7 +1630,7 @@ Draws box displaying character hexadecimal code. Used for replacing missing char .. rst-class:: classref-method -|void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) +|void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Removes all rendered glyph information from the cache entry. @@ -1644,7 +1644,7 @@ Removes all rendered glyph information from the cache entry. .. rst-class:: classref-method -|void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) +|void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) :ref:`🔗` Removes all kerning overrides. @@ -1656,7 +1656,7 @@ Removes all kerning overrides. .. rst-class:: classref-method -|void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) +|void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) :ref:`🔗` Removes all font sizes from the cache entry. @@ -1668,7 +1668,7 @@ Removes all font sizes from the cache entry. .. rst-class:: classref-method -|void| **font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) +|void| **font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Removes all textures from font cache entry. @@ -1682,7 +1682,7 @@ Removes all textures from font cache entry. .. rst-class:: classref-method -|void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``. @@ -1698,7 +1698,7 @@ Draws single glyph into a canvas item at the position, using ``font_rid`` at the .. rst-class:: classref-method -|void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``. @@ -1714,7 +1714,7 @@ Draws single glyph outline of size ``outline_size`` into a canvas item at the po .. rst-class:: classref-method -:ref:`FontAntialiasing` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`FontAntialiasing` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font anti-aliasing mode. @@ -1726,7 +1726,7 @@ Returns font anti-aliasing mode. .. rst-class:: classref-method -:ref:`float` **font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| +:ref:`float` **font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns the font ascent (number of pixels above the baseline). @@ -1738,7 +1738,7 @@ Returns the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`float` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`float` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns extra baseline offset (as a fraction of font height). @@ -1750,7 +1750,7 @@ Returns extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -:ref:`int` **font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| +:ref:`int` **font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`font_get_glyph_index`. @@ -1762,7 +1762,7 @@ Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_inde .. rst-class:: classref-method -:ref:`float` **font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| +:ref:`float` **font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns the font descent (number of pixels below the baseline). @@ -1774,7 +1774,7 @@ Returns the font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`bool` **font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`bool` **font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the font's embedded bitmap loading is disabled. @@ -1786,7 +1786,7 @@ Returns whether the font's embedded bitmap loading is disabled. .. rst-class:: classref-method -:ref:`float` **font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`float` **font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font embolden strength. @@ -1798,7 +1798,7 @@ Returns font embolden strength. .. rst-class:: classref-method -:ref:`int` **font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns number of faces in the TrueType / OpenType collection. @@ -1810,7 +1810,7 @@ Returns number of faces in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`int` **font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns an active face index in the TrueType / OpenType collection. @@ -1822,7 +1822,7 @@ Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`int` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns bitmap font fixed size. @@ -1834,7 +1834,7 @@ Returns bitmap font fixed size. .. rst-class:: classref-method -:ref:`FixedSizeScaleMode` **font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`FixedSizeScaleMode` **font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns bitmap font scaling mode. @@ -1846,7 +1846,7 @@ Returns bitmap font scaling mode. .. rst-class:: classref-method -:ref:`bool` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`bool` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if font texture mipmap generation is enabled. @@ -1858,7 +1858,7 @@ Returns ``true`` if font texture mipmap generation is enabled. .. rst-class:: classref-method -:ref:`float` **font_get_global_oversampling**\ (\ ) |const| +:ref:`float` **font_get_global_oversampling**\ (\ ) |const| :ref:`🔗` Returns the font oversampling factor, shared by all fonts in the TextServer. @@ -1870,7 +1870,7 @@ Returns the font oversampling factor, shared by all fonts in the TextServer. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns glyph advance (offset of the next glyph). @@ -1884,7 +1884,7 @@ Returns glyph advance (offset of the next glyph). .. rst-class:: classref-method -:ref:`Dictionary` **font_get_glyph_contours**\ (\ font\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |const| +:ref:`Dictionary` **font_get_glyph_contours**\ (\ font\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns outline contours of the glyph as a :ref:`Dictionary` with the following contents: @@ -1902,7 +1902,7 @@ Returns outline contours of the glyph as a :ref:`Dictionary` w .. rst-class:: classref-method -:ref:`int` **font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| +:ref:`int` **font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| :ref:`🔗` Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index`. @@ -1914,7 +1914,7 @@ Returns the glyph index of a ``char``, optionally modified by the ``variation_se .. rst-class:: classref-method -:ref:`PackedInt32Array` **font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| +:ref:`PackedInt32Array` **font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns list of rendered glyphs in the cache entry. @@ -1926,7 +1926,7 @@ Returns list of rendered glyphs in the cache entry. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns glyph offset from the baseline. @@ -1938,7 +1938,7 @@ Returns glyph offset from the baseline. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns size of the glyph. @@ -1950,7 +1950,7 @@ Returns size of the glyph. .. rst-class:: classref-method -:ref:`int` **font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`int` **font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns index of the cache texture containing the glyph. @@ -1962,7 +1962,7 @@ Returns index of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`RID` **font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`RID` **font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns resource ID of the cache texture containing the glyph. @@ -1976,7 +1976,7 @@ Returns resource ID of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Vector2` **font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns size of the cache texture containing the glyph. @@ -1990,7 +1990,7 @@ Returns size of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Rect2` **font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| +:ref:`Rect2` **font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| :ref:`🔗` Returns rectangle in the cache texture containing the glyph. @@ -2002,7 +2002,7 @@ Returns rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Hinting` **font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Hinting` **font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the font hinting mode. Used by dynamic fonts only. @@ -2014,7 +2014,7 @@ Returns the font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-method -:ref:`Vector2` **font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2` **font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns kerning for the pair of glyphs. @@ -2026,7 +2026,7 @@ Returns kerning for the pair of glyphs. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns list of the kerning overrides. @@ -2038,7 +2038,7 @@ Returns list of the kerning overrides. .. rst-class:: classref-method -:ref:`bool` **font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) +:ref:`bool` **font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if support override is enabled for the ``language``. @@ -2050,7 +2050,7 @@ Returns ``true`` if support override is enabled for the ``language``. .. rst-class:: classref-method -:ref:`PackedStringArray` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) +:ref:`PackedStringArray` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) :ref:`🔗` Returns list of language support overrides. @@ -2062,7 +2062,7 @@ Returns list of language support overrides. .. rst-class:: classref-method -:ref:`int` **font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the width of the range around the shape between the minimum and maximum representable signed distance. @@ -2074,7 +2074,7 @@ Returns the width of the range around the shape between the minimum and maximum .. rst-class:: classref-method -:ref:`int` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns source font size used to generate MSDF textures. @@ -2086,7 +2086,7 @@ Returns source font size used to generate MSDF textures. .. rst-class:: classref-method -:ref:`String` **font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`String` **font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font family name. @@ -2098,7 +2098,7 @@ Returns font family name. .. rst-class:: classref-method -:ref:`Dictionary` **font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Dictionary` **font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font OpenType feature set override. @@ -2110,7 +2110,7 @@ Returns font OpenType feature set override. .. rst-class:: classref-method -:ref:`Dictionary` **font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Dictionary` **font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns :ref:`Dictionary` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). @@ -2122,7 +2122,7 @@ Returns :ref:`Dictionary` with OpenType font name strings (loc .. rst-class:: classref-method -:ref:`float` **font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`float` **font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only. @@ -2134,7 +2134,7 @@ Returns font oversampling factor, if set to ``0.0`` global oversampling factor i .. rst-class:: classref-method -:ref:`float` **font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| +:ref:`float` **font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns scaling factor of the color bitmap font. @@ -2146,7 +2146,7 @@ Returns scaling factor of the color bitmap font. .. rst-class:: classref-method -:ref:`bool` **font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) +:ref:`bool` **font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if support override is enabled for the ``script``. @@ -2158,7 +2158,7 @@ Returns ``true`` if support override is enabled for the ``script``. .. rst-class:: classref-method -:ref:`PackedStringArray` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) +:ref:`PackedStringArray` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) :ref:`🔗` Returns list of script support overrides. @@ -2170,7 +2170,7 @@ Returns list of script support overrides. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` with font size and outline size. @@ -2182,7 +2182,7 @@ Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` **font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| +:ref:`int` **font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` Returns the spacing for ``spacing`` (see :ref:`SpacingType`) in pixels (not relative to the font size). @@ -2194,7 +2194,7 @@ Returns the spacing for ``spacing`` (see :ref:`SpacingType` **font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -2206,7 +2206,7 @@ Returns font stretch amount, compared to a normal width. A percentage value betw .. rst-class:: classref-method -|bitfield|\[:ref:`FontStyle`\] **font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |const| +|bitfield|\[:ref:`FontStyle`\] **font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font style flags, see :ref:`FontStyle`. @@ -2218,7 +2218,7 @@ Returns font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -:ref:`String` **font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`String` **font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font style name. @@ -2230,7 +2230,7 @@ Returns font style name. .. rst-class:: classref-method -:ref:`SubpixelPositioning` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`SubpixelPositioning` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns font subpixel glyph positioning mode. @@ -2242,7 +2242,7 @@ Returns font subpixel glyph positioning mode. .. rst-class:: classref-method -:ref:`String` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`String` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns a string containing all the characters available in the font. @@ -2254,7 +2254,7 @@ Returns a string containing all the characters available in the font. .. rst-class:: classref-method -:ref:`int` **font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| +:ref:`int` **font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns number of textures used by font cache entry. @@ -2266,7 +2266,7 @@ Returns number of textures used by font cache entry. .. rst-class:: classref-method -:ref:`Image` **font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| +:ref:`Image` **font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns font cache texture image data. @@ -2278,7 +2278,7 @@ Returns font cache texture image data. .. rst-class:: classref-method -:ref:`PackedInt32Array` **font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| +:ref:`PackedInt32Array` **font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns array containing glyph packing data. @@ -2290,7 +2290,7 @@ Returns array containing glyph packing data. .. rst-class:: classref-method -:ref:`Transform2D` **font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Transform2D` **font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns 2D transform applied to the font outlines. @@ -2302,7 +2302,7 @@ Returns 2D transform applied to the font outlines. .. rst-class:: classref-method -:ref:`float` **font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| +:ref:`float` **font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns pixel offset of the underline below the baseline. @@ -2314,7 +2314,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| +:ref:`float` **font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| :ref:`🔗` Returns thickness of the underline in pixels. @@ -2326,7 +2326,7 @@ Returns thickness of the underline in pixels. .. rst-class:: classref-method -:ref:`Dictionary` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Dictionary` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list` for more info. @@ -2338,7 +2338,7 @@ Returns variation coordinates for the specified font cache entry. See :ref:`font .. rst-class:: classref-method -:ref:`int` **font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`int` **font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -2350,7 +2350,7 @@ Returns weight (boldness) of the font. A value in the ``100...999`` range, norma .. rst-class:: classref-method -:ref:`bool` **font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |const| +:ref:`bool` **font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if a Unicode ``char`` is available in the font. @@ -2362,7 +2362,7 @@ Returns ``true`` if a Unicode ``char`` is available in the font. .. rst-class:: classref-method -:ref:`bool` **font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`bool` **font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if system fonts can be automatically used as fallbacks. @@ -2374,7 +2374,7 @@ Returns ``true`` if system fonts can be automatically used as fallbacks. .. rst-class:: classref-method -:ref:`bool` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`bool` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only. @@ -2386,7 +2386,7 @@ Returns ``true`` if auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-method -:ref:`bool` **font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| +:ref:`bool` **font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true``, if font supports given language (`ISO 639 `__ code). @@ -2398,7 +2398,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`bool` **font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. @@ -2410,7 +2410,7 @@ Returns ``true`` if glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-method -:ref:`bool` **font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| +:ref:`bool` **font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true``, if font supports given script (ISO 15924 code). @@ -2422,7 +2422,7 @@ Returns ``true``, if font supports given script (ISO 15924 code). .. rst-class:: classref-method -|void| **font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) +|void| **font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) :ref:`🔗` Removes specified rendered glyph information from the cache entry. @@ -2436,7 +2436,7 @@ Removes specified rendered glyph information from the cache entry. .. rst-class:: classref-method -|void| **font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) +|void| **font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) :ref:`🔗` Removes kerning override for the pair of glyphs. @@ -2448,7 +2448,7 @@ Removes kerning override for the pair of glyphs. .. rst-class:: classref-method -|void| **font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) +|void| **font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) :ref:`🔗` Remove language support override. @@ -2460,7 +2460,7 @@ Remove language support override. .. rst-class:: classref-method -|void| **font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) +|void| **font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) :ref:`🔗` Removes script support override. @@ -2472,7 +2472,7 @@ Removes script support override. .. rst-class:: classref-method -|void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) +|void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Removes specified font size from the cache entry. @@ -2484,7 +2484,7 @@ Removes specified font size from the cache entry. .. rst-class:: classref-method -|void| **font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) +|void| **font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) :ref:`🔗` Removes specified texture from the cache entry. @@ -2498,7 +2498,7 @@ Removes specified texture from the cache entry. .. rst-class:: classref-method -|void| **font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) +|void| **font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) :ref:`🔗` Renders specified glyph to the font cache texture. @@ -2510,7 +2510,7 @@ Renders specified glyph to the font cache texture. .. rst-class:: classref-method -|void| **font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) +|void| **font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) :ref:`🔗` Renders the range of characters to the font cache texture. @@ -2522,7 +2522,7 @@ Renders the range of characters to the font cache texture. .. rst-class:: classref-method -|void| **font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) +|void| **font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, system fonts can be automatically used as fallbacks. @@ -2534,7 +2534,7 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-method -|void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) +|void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) :ref:`🔗` Sets font anti-aliasing mode. @@ -2546,7 +2546,7 @@ Sets font anti-aliasing mode. .. rst-class:: classref-method -|void| **font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) +|void| **font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) :ref:`🔗` Sets the font ascent (number of pixels above the baseline). @@ -2558,7 +2558,7 @@ Sets the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -|void| **font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) +|void| **font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) :ref:`🔗` Sets extra baseline offset (as a fraction of font height). @@ -2570,7 +2570,7 @@ Sets extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -|void| **font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) +|void| **font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Sets font source data, e.g contents of the dynamic font source file. @@ -2582,7 +2582,7 @@ Sets font source data, e.g contents of the dynamic font source file. .. rst-class:: classref-method -|void| **font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) +|void| **font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) :ref:`🔗` Sets the font descent (number of pixels below the baseline). @@ -2594,7 +2594,7 @@ Sets the font descent (number of pixels below the baseline). .. rst-class:: classref-method -|void| **font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) +|void| **font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). @@ -2606,7 +2606,7 @@ If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and co .. rst-class:: classref-method -|void| **font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) +|void| **font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) :ref:`🔗` Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -2618,7 +2618,7 @@ Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the .. rst-class:: classref-method -|void| **font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) +|void| **font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) :ref:`🔗` Sets an active face index in the TrueType / OpenType collection. @@ -2630,7 +2630,7 @@ Sets an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -|void| **font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) +|void| **font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) :ref:`🔗` Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. @@ -2642,7 +2642,7 @@ Sets bitmap font fixed size. If set to value greater than zero, same cache entry .. rst-class:: classref-method -|void| **font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) +|void| **font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) :ref:`🔗` Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero. @@ -2654,7 +2654,7 @@ Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is g .. rst-class:: classref-method -|void| **font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) +|void| **font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) :ref:`🔗` If set to ``true`` auto-hinting is preferred over font built-in hinting. @@ -2666,7 +2666,7 @@ If set to ``true`` auto-hinting is preferred over font built-in hinting. .. rst-class:: classref-method -|void| **font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) +|void| **font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) :ref:`🔗` If set to ``true`` font texture mipmap generation is enabled. @@ -2678,7 +2678,7 @@ If set to ``true`` font texture mipmap generation is enabled. .. rst-class:: classref-method -|void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) +|void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) :ref:`🔗` Sets oversampling factor, shared by all font in the TextServer. @@ -2692,7 +2692,7 @@ Sets oversampling factor, shared by all font in the TextServer. .. rst-class:: classref-method -|void| **font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) +|void| **font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) :ref:`🔗` Sets glyph advance (offset of the next glyph). @@ -2706,7 +2706,7 @@ Sets glyph advance (offset of the next glyph). .. rst-class:: classref-method -|void| **font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) +|void| **font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) :ref:`🔗` Sets glyph offset from the baseline. @@ -2718,7 +2718,7 @@ Sets glyph offset from the baseline. .. rst-class:: classref-method -|void| **font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) +|void| **font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) :ref:`🔗` Sets size of the glyph. @@ -2730,7 +2730,7 @@ Sets size of the glyph. .. rst-class:: classref-method -|void| **font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) +|void| **font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) :ref:`🔗` Sets index of the cache texture containing the glyph. @@ -2742,7 +2742,7 @@ Sets index of the cache texture containing the glyph. .. rst-class:: classref-method -|void| **font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) +|void| **font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) :ref:`🔗` Sets rectangle in the cache texture containing the glyph. @@ -2754,7 +2754,7 @@ Sets rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -|void| **font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) +|void| **font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) :ref:`🔗` Sets font hinting mode. Used by dynamic fonts only. @@ -2766,7 +2766,7 @@ Sets font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-method -|void| **font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) +|void| **font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) :ref:`🔗` Sets kerning for the pair of glyphs. @@ -2778,7 +2778,7 @@ Sets kerning for the pair of glyphs. .. rst-class:: classref-method -|void| **font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) +|void| **font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) :ref:`🔗` Adds override for :ref:`font_is_language_supported`. @@ -2790,7 +2790,7 @@ Adds override for :ref:`font_is_language_supported`, msdf_pixel_range\: :ref:`int`\ ) +|void| **font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) :ref:`🔗` Sets the width of the range around the shape between the minimum and maximum representable signed distance. @@ -2802,7 +2802,7 @@ Sets the width of the range around the shape between the minimum and maximum rep .. rst-class:: classref-method -|void| **font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) +|void| **font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) :ref:`🔗` Sets source font size used to generate MSDF textures. @@ -2814,7 +2814,7 @@ Sets source font size used to generate MSDF textures. .. rst-class:: classref-method -|void| **font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) +|void| **font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. @@ -2828,7 +2828,7 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-method -|void| **font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) +|void| **font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` Sets the font family name. @@ -2840,7 +2840,7 @@ Sets the font family name. .. rst-class:: classref-method -|void| **font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) +|void| **font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) :ref:`🔗` Sets font OpenType feature set override. @@ -2852,7 +2852,7 @@ Sets font OpenType feature set override. .. rst-class:: classref-method -|void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) +|void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) :ref:`🔗` Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only. @@ -2864,7 +2864,7 @@ Sets font oversampling factor, if set to ``0.0`` global oversampling factor is u .. rst-class:: classref-method -|void| **font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) +|void| **font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) :ref:`🔗` Sets scaling factor of the color bitmap font. @@ -2876,7 +2876,7 @@ Sets scaling factor of the color bitmap font. .. rst-class:: classref-method -|void| **font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) +|void| **font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) :ref:`🔗` Adds override for :ref:`font_is_script_supported`. @@ -2888,7 +2888,7 @@ Adds override for :ref:`font_is_script_supported`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +|void| **font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). @@ -2900,7 +2900,7 @@ Sets the spacing for ``spacing`` (see :ref:`SpacingType`, weight\: :ref:`int`\ ) +|void| **font_set_stretch**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) :ref:`🔗` Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -2914,7 +2914,7 @@ Sets font stretch amount, compared to a normal width. A percentage value between .. rst-class:: classref-method -|void| **font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) +|void| **font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) :ref:`🔗` Sets the font style flags, see :ref:`FontStyle`. @@ -2928,7 +2928,7 @@ Sets the font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -|void| **font_set_style_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) +|void| **font_set_style_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` Sets the font style name. @@ -2940,7 +2940,7 @@ Sets the font style name. .. rst-class:: classref-method -|void| **font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) +|void| **font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) :ref:`🔗` Sets font subpixel glyph positioning mode. @@ -2952,7 +2952,7 @@ Sets font subpixel glyph positioning mode. .. rst-class:: classref-method -|void| **font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) +|void| **font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) :ref:`🔗` Sets font cache texture image data. @@ -2964,7 +2964,7 @@ Sets font cache texture image data. .. rst-class:: classref-method -|void| **font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) +|void| **font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) :ref:`🔗` Sets array containing glyph packing data. @@ -2976,7 +2976,7 @@ Sets array containing glyph packing data. .. rst-class:: classref-method -|void| **font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) +|void| **font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. @@ -2990,7 +2990,7 @@ For example, to simulate italic typeface by slanting, apply the following transf .. rst-class:: classref-method -|void| **font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) +|void| **font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) :ref:`🔗` Sets pixel offset of the underline below the baseline. @@ -3002,7 +3002,7 @@ Sets pixel offset of the underline below the baseline. .. rst-class:: classref-method -|void| **font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) +|void| **font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) :ref:`🔗` Sets thickness of the underline in pixels. @@ -3014,7 +3014,7 @@ Sets thickness of the underline in pixels. .. rst-class:: classref-method -|void| **font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) +|void| **font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) :ref:`🔗` Sets variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list` for more info. @@ -3026,7 +3026,7 @@ Sets variation coordinates for the specified font cache entry. See :ref:`font_su .. rst-class:: classref-method -|void| **font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) +|void| **font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) :ref:`🔗` Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -3040,7 +3040,7 @@ Sets weight (boldness) of the font. A value in the ``100...999`` range, normal f .. rst-class:: classref-method -:ref:`Dictionary` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Dictionary` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the dictionary of the supported OpenType features. @@ -3052,7 +3052,7 @@ Returns the dictionary of the supported OpenType features. .. rst-class:: classref-method -:ref:`Dictionary` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |const| +:ref:`Dictionary` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the dictionary of the supported OpenType variation coordinates. @@ -3064,7 +3064,7 @@ Returns the dictionary of the supported OpenType variation coordinates. .. rst-class:: classref-method -:ref:`String` **format_number**\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| +:ref:`String` **format_number**\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``. @@ -3078,7 +3078,7 @@ If ``language`` is omitted, the active locale will be used. .. rst-class:: classref-method -|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Frees an object created by this **TextServer**. @@ -3090,7 +3090,7 @@ Frees an object created by this **TextServer**. .. rst-class:: classref-method -:ref:`int` **get_features**\ (\ ) |const| +:ref:`int` **get_features**\ (\ ) |const| :ref:`🔗` Returns text server features, see :ref:`Feature`. @@ -3102,7 +3102,7 @@ Returns text server features, see :ref:`Feature`. .. rst-class:: classref-method -:ref:`Vector2` **get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). @@ -3114,7 +3114,7 @@ Returns size of the replacement character (box with character hexadecimal code t .. rst-class:: classref-method -:ref:`String` **get_name**\ (\ ) |const| +:ref:`String` **get_name**\ (\ ) |const| :ref:`🔗` Returns the name of the server interface. @@ -3126,7 +3126,7 @@ Returns the name of the server interface. .. rst-class:: classref-method -:ref:`String` **get_support_data_filename**\ (\ ) |const| +:ref:`String` **get_support_data_filename**\ (\ ) |const| :ref:`🔗` Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. @@ -3138,7 +3138,7 @@ Returns default TextServer database (e.g. ICU break iterators and dictionaries) .. rst-class:: classref-method -:ref:`String` **get_support_data_info**\ (\ ) |const| +:ref:`String` **get_support_data_info**\ (\ ) |const| :ref:`🔗` Returns TextServer database (e.g. ICU break iterators and dictionaries) description. @@ -3150,7 +3150,7 @@ Returns TextServer database (e.g. ICU break iterators and dictionaries) descript .. rst-class:: classref-method -:ref:`bool` **has**\ (\ rid\: :ref:`RID`\ ) +:ref:`bool` **has**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Returns ``true`` if ``rid`` is valid resource owned by this text server. @@ -3162,7 +3162,7 @@ Returns ``true`` if ``rid`` is valid resource owned by this text server. .. rst-class:: classref-method -:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| :ref:`🔗` Returns ``true`` if the server supports a feature. @@ -3174,7 +3174,7 @@ Returns ``true`` if the server supports a feature. .. rst-class:: classref-method -:ref:`int` **is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |const| +:ref:`int` **is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |const| :ref:`🔗` Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found. @@ -3190,7 +3190,7 @@ Returns index of the first string in ``dict`` which is visually confusable with .. rst-class:: classref-method -:ref:`bool` **is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |const| +:ref:`bool` **is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if locale is right-to-left. @@ -3202,7 +3202,7 @@ Returns ``true`` if locale is right-to-left. .. rst-class:: classref-method -:ref:`bool` **is_valid_identifier**\ (\ string\: :ref:`String`\ ) |const| +:ref:`bool` **is_valid_identifier**\ (\ string\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if ``string`` is a valid identifier. @@ -3230,7 +3230,7 @@ If the :ref:`FEATURE_UNICODE_IDENTIFIERS` **is_valid_letter**\ (\ unicode\: :ref:`int`\ ) |const| +:ref:`bool` **is_valid_letter**\ (\ unicode\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L". @@ -3242,7 +3242,7 @@ Returns ``true`` if the given code point is a valid letter, i.e. it belongs to t .. rst-class:: classref-method -:ref:`bool` **load_support_data**\ (\ filename\: :ref:`String`\ ) +:ref:`bool` **load_support_data**\ (\ filename\: :ref:`String`\ ) :ref:`🔗` Loads optional TextServer database (e.g. ICU break iterators and dictionaries). @@ -3256,7 +3256,7 @@ Loads optional TextServer database (e.g. ICU break iterators and dictionaries). .. rst-class:: classref-method -:ref:`int` **name_to_tag**\ (\ name\: :ref:`String`\ ) |const| +:ref:`int` **name_to_tag**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Converts readable feature, variation, script, or language name to OpenType tag. @@ -3268,7 +3268,7 @@ Converts readable feature, variation, script, or language name to OpenType tag. .. rst-class:: classref-method -:ref:`String` **parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| +:ref:`String` **parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9). @@ -3280,7 +3280,7 @@ Converts ``number`` from the numeral systems used in ``language`` to Western Ara .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector3i`\] **parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| +:ref:`Array`\[:ref:`Vector3i`\] **parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| :ref:`🔗` Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser` for more info. @@ -3292,7 +3292,7 @@ Default implementation of the BiDi algorithm override function. See :ref:`Struct .. rst-class:: classref-method -:ref:`String` **percent_sign**\ (\ language\: :ref:`String` = ""\ ) |const| +:ref:`String` **percent_sign**\ (\ language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Returns percent sign used in the ``language``. @@ -3304,7 +3304,7 @@ Returns percent sign used in the ``language``. .. rst-class:: classref-method -:ref:`bool` **save_support_data**\ (\ filename\: :ref:`String`\ ) |const| +:ref:`bool` **save_support_data**\ (\ filename\: :ref:`String`\ ) |const| :ref:`🔗` Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. @@ -3318,7 +3318,7 @@ Saves optional TextServer database (e.g. ICU break iterators and dictionaries) t .. rst-class:: classref-method -:ref:`int` **shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`int` **shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns number of text spans added using :ref:`shaped_text_add_string` or :ref:`shaped_text_add_object`. @@ -3330,7 +3330,7 @@ Returns number of text spans added using :ref:`shaped_text_add_string` **shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| +:ref:`Variant` **shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns text span metadata. @@ -3342,7 +3342,7 @@ Returns text span metadata. .. rst-class:: classref-method -|void| **shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) +|void| **shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) :ref:`🔗` Changes text span font, font size, and OpenType features, without changing the text. @@ -3354,7 +3354,7 @@ Changes text span font, font size, and OpenType features, without changing the t .. rst-class:: classref-method -:ref:`bool` **shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) +:ref:`bool` **shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) :ref:`🔗` Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. @@ -3366,7 +3366,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) +:ref:`bool` **shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) :ref:`🔗` Adds text span and font to draw it to the text buffer. @@ -3378,7 +3378,7 @@ Adds text span and font to draw it to the text buffer. .. rst-class:: classref-method -|void| **shaped_text_clear**\ (\ rid\: :ref:`RID`\ ) +|void| **shaped_text_clear**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Clears text buffer (removes text and inline objects). @@ -3390,7 +3390,7 @@ Clears text buffer (removes text and inline objects). .. rst-class:: classref-method -:ref:`int` **shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| +:ref:`int` **shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns composite character position closest to the ``pos``. @@ -3402,7 +3402,7 @@ Returns composite character position closest to the ``pos``. .. rst-class:: classref-method -|void| **shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). @@ -3414,7 +3414,7 @@ Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` .. rst-class:: classref-method -|void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| +|void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗` Draw the outline of the shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). @@ -3426,7 +3426,7 @@ Draw the outline of the shaped text into a canvas item at a given position, with .. rst-class:: classref-method -:ref:`float` **shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3\ ) +:ref:`float` **shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3\ ) :ref:`🔗` Adjusts text width to fit to specified width, returns new text width. @@ -3438,7 +3438,7 @@ Adjusts text width to fit to specified width, returns new text width. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`float` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -3452,7 +3452,7 @@ Returns the text ascent (number of pixels above the baseline for horizontal layo .. rst-class:: classref-method -:ref:`Dictionary` **shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`\ ) |const| +:ref:`Dictionary` **shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`\ ) |const| :ref:`🔗` Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle. @@ -3464,7 +3464,7 @@ Returns shapes of the carets corresponding to the character offset ``position`` .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`PackedInt32Array` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns array of the composite character boundaries. @@ -3476,7 +3476,7 @@ Returns array of the composite character boundaries. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`int` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ellipsis character used for text clipping. @@ -3488,7 +3488,7 @@ Returns ellipsis character used for text clipping. .. rst-class:: classref-method -:ref:`String` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`String` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. @@ -3500,7 +3500,7 @@ Returns custom punctuation character list, used for word breaking. If set to emp .. rst-class:: classref-method -:ref:`float` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`float` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -3514,7 +3514,7 @@ Returns the text descent (number of pixels below the baseline for horizontal lay .. rst-class:: classref-method -:ref:`Direction` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Direction` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns direction of the text. @@ -3526,7 +3526,7 @@ Returns direction of the text. .. rst-class:: classref-method -:ref:`Direction` **shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| +:ref:`Direction` **shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| :ref:`🔗` Returns dominant direction of in the range of text. @@ -3538,7 +3538,7 @@ Returns dominant direction of in the range of text. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`int` **shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns number of glyphs in the ellipsis. @@ -3550,7 +3550,7 @@ Returns number of glyphs in the ellipsis. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns array of the glyphs in the ellipsis. @@ -3562,7 +3562,7 @@ Returns array of the glyphs in the ellipsis. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`int` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns position of the ellipsis. @@ -3574,7 +3574,7 @@ Returns position of the ellipsis. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`int` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns number of glyphs in the buffer. @@ -3586,7 +3586,7 @@ Returns number of glyphs in the buffer. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns an array of glyphs in the visual order. @@ -3598,7 +3598,7 @@ Returns an array of glyphs in the visual order. .. rst-class:: classref-method -:ref:`Vector2` **shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| +:ref:`Vector2` **shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns composite character's bounds as offsets from the start of the line. @@ -3610,7 +3610,7 @@ Returns composite character's bounds as offsets from the start of the line. .. rst-class:: classref-method -:ref:`Direction` **shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Direction` **shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns direction of the text, inferred by the BiDi algorithm. @@ -3622,7 +3622,7 @@ Returns direction of the text, inferred by the BiDi algorithm. .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| +:ref:`PackedInt32Array` **shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| :ref:`🔗` Breaks text to the lines and returns character ranges for each line. @@ -3634,7 +3634,7 @@ Breaks text to the lines and returns character ranges for each line. .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| +:ref:`PackedInt32Array` **shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| :ref:`🔗` Breaks text to the lines and columns. Returns character ranges for each segment. @@ -3646,7 +3646,7 @@ Breaks text to the lines and columns. Returns character ranges for each segment. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| +:ref:`int` **shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns the glyph index of the inline object. @@ -3658,7 +3658,7 @@ Returns the glyph index of the inline object. .. rst-class:: classref-method -:ref:`Vector2i` **shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| +:ref:`Vector2i` **shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns the character range of the inline object. @@ -3670,7 +3670,7 @@ Returns the character range of the inline object. .. rst-class:: classref-method -:ref:`Rect2` **shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| +:ref:`Rect2` **shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| :ref:`🔗` Returns bounding rectangle of the inline object. @@ -3682,7 +3682,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Array` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns array of inline objects. @@ -3694,7 +3694,7 @@ Returns array of inline objects. .. rst-class:: classref-method -:ref:`Orientation` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Orientation` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns text orientation. @@ -3706,7 +3706,7 @@ Returns text orientation. .. rst-class:: classref-method -:ref:`RID` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`RID` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the parent buffer from which the substring originates. @@ -3718,7 +3718,7 @@ Returns the parent buffer from which the substring originates. .. rst-class:: classref-method -:ref:`bool` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`bool` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if text buffer is configured to display control characters. @@ -3730,7 +3730,7 @@ Returns ``true`` if text buffer is configured to display control characters. .. rst-class:: classref-method -:ref:`bool` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`bool` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters. @@ -3744,7 +3744,7 @@ Returns ``true`` if text buffer is configured to display hexadecimal codes in pl .. rst-class:: classref-method -:ref:`Vector2i` **shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Vector2i` **shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns substring buffer character range in the parent buffer. @@ -3756,7 +3756,7 @@ Returns substring buffer character range in the parent buffer. .. rst-class:: classref-method -:ref:`PackedVector2Array` **shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| +:ref:`PackedVector2Array` **shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| :ref:`🔗` Returns selection rectangles for the specified character range. @@ -3768,7 +3768,7 @@ Returns selection rectangles for the specified character range. .. rst-class:: classref-method -:ref:`Vector2` **shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`Vector2` **shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns size of the text. @@ -3780,7 +3780,7 @@ Returns size of the text. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| +:ref:`int` **shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| :ref:`🔗` Returns extra spacing added between glyphs or lines in pixels. @@ -3792,7 +3792,7 @@ Returns extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`int` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the position of the overrun trim. @@ -3804,7 +3804,7 @@ Returns the position of the overrun trim. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`float` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns pixel offset of the underline below the baseline. @@ -3816,7 +3816,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`float` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns thickness of the underline. @@ -3828,7 +3828,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`float` **shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns width (for horizontal layout) or height (for vertical) of the text. @@ -3840,7 +3840,7 @@ Returns width (for horizontal layout) or height (for vertical) of the text. .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 4\ ) |const| +:ref:`PackedInt32Array` **shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 4\ ) |const| :ref:`🔗` Breaks text into words and returns array of character ranges. Use ``grapheme_flags`` to set what characters are used for breaking (see :ref:`GraphemeFlag`). @@ -3852,7 +3852,7 @@ Breaks text into words and returns array of character ranges. Use ``grapheme_fla .. rst-class:: classref-method -:ref:`bool` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`bool` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if text buffer contains any visible characters. @@ -3864,7 +3864,7 @@ Returns ``true`` if text buffer contains any visible characters. .. rst-class:: classref-method -:ref:`int` **shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| +:ref:`int` **shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| :ref:`🔗` Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found. @@ -3876,7 +3876,7 @@ Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` .. rst-class:: classref-method -:ref:`int` **shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| +:ref:`int` **shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| :ref:`🔗` Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. @@ -3888,7 +3888,7 @@ Returns caret character offset at the specified pixel offset at the baseline. Th .. rst-class:: classref-method -:ref:`bool` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |const| +:ref:`bool` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if buffer is successfully shaped. @@ -3900,7 +3900,7 @@ Returns ``true`` if buffer is successfully shaped. .. rst-class:: classref-method -:ref:`int` **shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| +:ref:`int` **shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns composite character end position closest to the ``pos``. @@ -3912,7 +3912,7 @@ Returns composite character end position closest to the ``pos``. .. rst-class:: classref-method -:ref:`int` **shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| +:ref:`int` **shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns grapheme end position closest to the ``pos``. @@ -3924,7 +3924,7 @@ Returns grapheme end position closest to the ``pos``. .. rst-class:: classref-method -|void| **shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\] = 0\ ) +|void| **shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\] = 0\ ) :ref:`🔗` Trims text if it exceeds the given width. @@ -3936,7 +3936,7 @@ Trims text if it exceeds the given width. .. rst-class:: classref-method -:ref:`int` **shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| +:ref:`int` **shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns composite character start position closest to the ``pos``. @@ -3948,7 +3948,7 @@ Returns composite character start position closest to the ``pos``. .. rst-class:: classref-method -:ref:`int` **shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| +:ref:`int` **shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| :ref:`🔗` Returns grapheme start position closest to the ``pos``. @@ -3960,7 +3960,7 @@ Returns grapheme start position closest to the ``pos``. .. rst-class:: classref-method -:ref:`bool` **shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) +:ref:`bool` **shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) :ref:`🔗` Sets new size and alignment of embedded object. @@ -3972,7 +3972,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -|void| **shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) +|void| **shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) :ref:`🔗` Overrides BiDi for the structured text. @@ -3986,7 +3986,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w .. rst-class:: classref-method -|void| **shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) +|void| **shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) :ref:`🔗` Sets ellipsis character used for text clipping. @@ -3998,7 +3998,7 @@ Sets ellipsis character used for text clipping. .. rst-class:: classref-method -|void| **shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) +|void| **shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) :ref:`🔗` Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. @@ -4010,7 +4010,7 @@ Sets custom punctuation character list, used for word breaking. If set to empty .. rst-class:: classref-method -|void| **shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction` = 0\ ) +|void| **shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction` = 0\ ) :ref:`🔗` Sets desired text direction. If set to :ref:`DIRECTION_AUTO`, direction will be detected based on the buffer contents and current locale. @@ -4024,7 +4024,7 @@ Sets desired text direction. If set to :ref:`DIRECTION_AUTO`, orientation\: :ref:`Orientation` = 0\ ) +|void| **shaped_text_set_orientation**\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation` = 0\ ) :ref:`🔗` Sets desired text orientation. @@ -4038,7 +4038,7 @@ Sets desired text orientation. .. rst-class:: classref-method -|void| **shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If set to ``true`` text buffer will display control characters. @@ -4050,7 +4050,7 @@ If set to ``true`` text buffer will display control characters. .. rst-class:: classref-method -|void| **shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) +|void| **shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. @@ -4062,7 +4062,7 @@ If set to ``true`` text buffer will display invalid characters as hexadecimal co .. rst-class:: classref-method -|void| **shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +|void| **shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) :ref:`🔗` Sets extra spacing added between glyphs or lines in pixels. @@ -4074,7 +4074,7 @@ Sets extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-method -:ref:`bool` **shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) +:ref:`bool` **shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) :ref:`🔗` Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully. @@ -4088,7 +4088,7 @@ Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped succe .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) +:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) :ref:`🔗` Returns text glyphs in the logical order. @@ -4100,7 +4100,7 @@ Returns text glyphs in the logical order. .. rst-class:: classref-method -:ref:`RID` **shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |const| +:ref:`RID` **shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |const| :ref:`🔗` Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects). @@ -4112,7 +4112,7 @@ Returns text buffer for the substring of the text in the ``shaped`` text buffer .. rst-class:: classref-method -:ref:`float` **shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) +:ref:`float` **shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Aligns shaped text to the given tab-stops. @@ -4124,7 +4124,7 @@ Aligns shaped text to the given tab-stops. .. rst-class:: classref-method -:ref:`bool` **spoof_check**\ (\ string\: :ref:`String`\ ) |const| +:ref:`bool` **spoof_check**\ (\ string\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader. @@ -4138,7 +4138,7 @@ Returns ``true`` if ``string`` is likely to be an attempt at confusing the reade .. rst-class:: classref-method -:ref:`PackedInt32Array` **string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| +:ref:`PackedInt32Array` **string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Returns array of the composite character boundaries. @@ -4155,7 +4155,7 @@ Returns array of the composite character boundaries. .. rst-class:: classref-method -:ref:`PackedInt32Array` **string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String` = "", chars_per_line\: :ref:`int` = 0\ ) |const| +:ref:`PackedInt32Array` **string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String` = "", chars_per_line\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even. @@ -4175,7 +4175,7 @@ When ``chars_per_line`` is greater than zero, line break boundaries are returned .. rst-class:: classref-method -:ref:`String` **string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| +:ref:`String` **string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Returns the string converted to lowercase. @@ -4191,7 +4191,7 @@ Returns the string converted to lowercase. .. rst-class:: classref-method -:ref:`String` **string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| +:ref:`String` **string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Returns the string converted to title case. @@ -4207,7 +4207,7 @@ Returns the string converted to title case. .. rst-class:: classref-method -:ref:`String` **string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| +:ref:`String` **string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` Returns the string converted to uppercase. @@ -4223,7 +4223,7 @@ Returns the string converted to uppercase. .. rst-class:: classref-method -:ref:`String` **strip_diacritics**\ (\ string\: :ref:`String`\ ) |const| +:ref:`String` **strip_diacritics**\ (\ string\: :ref:`String`\ ) |const| :ref:`🔗` Strips diacritics from the string. @@ -4237,7 +4237,7 @@ Strips diacritics from the string. .. rst-class:: classref-method -:ref:`String` **tag_to_name**\ (\ tag\: :ref:`int`\ ) |const| +:ref:`String` **tag_to_name**\ (\ tag\: :ref:`int`\ ) |const| :ref:`🔗` Converts OpenType tag to readable feature, variation, script, or language name. diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 0d196e5514c..04c009aa4eb 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -478,7 +478,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_cleanup**\ (\ ) |virtual| +|void| **_cleanup**\ (\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -492,7 +492,7 @@ This method is called before text server is unregistered. .. rst-class:: classref-method -:ref:`RID` **_create_font**\ (\ ) |virtual| +:ref:`RID` **_create_font**\ (\ ) |virtual| :ref:`🔗` **Required.**\ @@ -506,7 +506,7 @@ Creates a new, empty font cache entry resource. .. rst-class:: classref-method -:ref:`RID` **_create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) |virtual| +:ref:`RID` **_create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` Optional, implement if font supports extra spacing or baseline offset. @@ -520,7 +520,7 @@ Creates a new variation existing font which is reusing the same glyph cache and .. rst-class:: classref-method -:ref:`RID` **_create_shaped_text**\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| +:ref:`RID` **_create_shaped_text**\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -534,7 +534,7 @@ Creates a new buffer for complex text layout, with the given ``direction`` and ` .. rst-class:: classref-method -|void| **_draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| +|void| **_draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -548,7 +548,7 @@ Draws box displaying character hexadecimal code. .. rst-class:: classref-method -|void| **_font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| +|void| **_font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -562,7 +562,7 @@ Removes all rendered glyph information from the cache entry. .. rst-class:: classref-method -|void| **_font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| +|void| **_font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -576,7 +576,7 @@ Removes all kerning overrides. .. rst-class:: classref-method -|void| **_font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) |virtual| +|void| **_font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -590,7 +590,7 @@ Removes all font sizes from the cache entry. .. rst-class:: classref-method -|void| **_font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| +|void| **_font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -604,7 +604,7 @@ Removes all textures from font cache entry. .. rst-class:: classref-method -|void| **_font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| +|void| **_font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -618,7 +618,7 @@ Draws single glyph into a canvas item at the position, using ``font_rid`` at the .. rst-class:: classref-method -|void| **_font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| +|void| **_font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -632,7 +632,7 @@ Draws single glyph outline of size ``outline_size`` into a canvas item at the po .. rst-class:: classref-method -:ref:`FontAntialiasing` **_font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`FontAntialiasing` **_font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -646,7 +646,7 @@ Returns font anti-aliasing mode. .. rst-class:: classref-method -:ref:`float` **_font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -660,7 +660,7 @@ Returns the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`float` **_font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -674,7 +674,7 @@ Returns extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -:ref:`int` **_font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -688,7 +688,7 @@ Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_inde .. rst-class:: classref-method -:ref:`float` **_font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -702,7 +702,7 @@ Returns the font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`bool` **_font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -716,7 +716,7 @@ Returns whether the font's embedded bitmap loading is disabled. .. rst-class:: classref-method -:ref:`float` **_font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -730,7 +730,7 @@ Returns font embolden strength. .. rst-class:: classref-method -:ref:`int` **_font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -744,7 +744,7 @@ Returns number of faces in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`int` **_font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -758,7 +758,7 @@ Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`int` **_font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -772,7 +772,7 @@ Returns bitmap font fixed size. .. rst-class:: classref-method -:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -786,7 +786,7 @@ Returns bitmap font scaling mode. .. rst-class:: classref-method -:ref:`bool` **_font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -800,7 +800,7 @@ Returns ``true`` if font texture mipmap generation is enabled. .. rst-class:: classref-method -:ref:`float` **_font_get_global_oversampling**\ (\ ) |virtual| |const| +:ref:`float` **_font_get_global_oversampling**\ (\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -814,7 +814,7 @@ Returns the font oversampling factor, shared by all fonts in the TextServer. .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -828,7 +828,7 @@ Returns glyph advance (offset of the next glyph). .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_glyph_contours**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| +:ref:`Dictionary` **_font_get_glyph_contours**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -842,7 +842,7 @@ Returns outline contours of the glyph. .. rst-class:: classref-method -:ref:`int` **_font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -856,7 +856,7 @@ Returns the glyph index of a ``char``, optionally modified by the ``variation_se .. rst-class:: classref-method -:ref:`PackedInt32Array` **_font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| +:ref:`PackedInt32Array` **_font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -870,7 +870,7 @@ Returns list of rendered glyphs in the cache entry. .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -884,7 +884,7 @@ Returns glyph offset from the baseline. .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -898,7 +898,7 @@ Returns size of the glyph. .. rst-class:: classref-method -:ref:`int` **_font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -912,7 +912,7 @@ Returns index of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`RID` **_font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -926,7 +926,7 @@ Returns resource ID of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -940,7 +940,7 @@ Returns size of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Rect2` **_font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| +:ref:`Rect2` **_font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -954,7 +954,7 @@ Returns rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Hinting` **_font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Hinting` **_font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -968,7 +968,7 @@ Returns the font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-method -:ref:`Vector2` **_font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| +:ref:`Vector2` **_font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -982,7 +982,7 @@ Returns kerning for the pair of glyphs. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **_font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Vector2i`\] **_font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -996,7 +996,7 @@ Returns list of the kerning overrides. .. rst-class:: classref-method -:ref:`bool` **_font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| +:ref:`bool` **_font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1010,7 +1010,7 @@ Returns ``true`` if support override is enabled for the ``language``. .. rst-class:: classref-method -:ref:`PackedStringArray` **_font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| +:ref:`PackedStringArray` **_font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1024,7 +1024,7 @@ Returns list of language support overrides. .. rst-class:: classref-method -:ref:`int` **_font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1038,7 +1038,7 @@ Returns the width of the range around the shape between the minimum and maximum .. rst-class:: classref-method -:ref:`int` **_font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1052,7 +1052,7 @@ Returns source font size used to generate MSDF textures. .. rst-class:: classref-method -:ref:`String` **_font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`String` **_font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1066,7 +1066,7 @@ Returns font family name. .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Dictionary` **_font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1080,7 +1080,7 @@ Returns font OpenType feature set override. .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Dictionary` **_font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1094,7 +1094,7 @@ Returns :ref:`Dictionary` with OpenType font name strings (loc .. rst-class:: classref-method -:ref:`float` **_font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1108,7 +1108,7 @@ Returns font oversampling factor, if set to ``0.0`` global oversampling factor i .. rst-class:: classref-method -:ref:`float` **_font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1122,7 +1122,7 @@ Returns scaling factor of the color bitmap font. .. rst-class:: classref-method -:ref:`bool` **_font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| +:ref:`bool` **_font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1136,7 +1136,7 @@ Returns ``true`` if support override is enabled for the ``script``. .. rst-class:: classref-method -:ref:`PackedStringArray` **_font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| +:ref:`PackedStringArray` **_font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1150,7 +1150,7 @@ Returns list of script support overrides. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **_font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Vector2i`\] **_font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1164,7 +1164,7 @@ Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` **_font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| +:ref:`int` **_font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1178,7 +1178,7 @@ Returns the spacing for ``spacing`` (see :ref:`SpacingType` **_font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1192,7 +1192,7 @@ Returns font stretch amount, compared to a normal width. A percentage value betw .. rst-class:: classref-method -|bitfield|\[:ref:`FontStyle`\] **_font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +|bitfield|\[:ref:`FontStyle`\] **_font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1206,7 +1206,7 @@ Returns font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -:ref:`String` **_font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`String` **_font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1220,7 +1220,7 @@ Returns font style name. .. rst-class:: classref-method -:ref:`SubpixelPositioning` **_font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`SubpixelPositioning` **_font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1234,7 +1234,7 @@ Returns font subpixel glyph positioning mode. .. rst-class:: classref-method -:ref:`String` **_font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`String` **_font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1248,7 +1248,7 @@ Returns a string containing all the characters available in the font. .. rst-class:: classref-method -:ref:`int` **_font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| +:ref:`int` **_font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1262,7 +1262,7 @@ Returns number of textures used by font cache entry. .. rst-class:: classref-method -:ref:`Image` **_font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| +:ref:`Image` **_font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1276,7 +1276,7 @@ Returns font cache texture image data. .. rst-class:: classref-method -:ref:`PackedInt32Array` **_font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| +:ref:`PackedInt32Array` **_font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1290,7 +1290,7 @@ Returns array containing glyph packing data. .. rst-class:: classref-method -:ref:`Transform2D` **_font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Transform2D` **_font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1304,7 +1304,7 @@ Returns 2D transform applied to the font outlines. .. rst-class:: classref-method -:ref:`float` **_font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1318,7 +1318,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **_font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| +:ref:`float` **_font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1332,7 +1332,7 @@ Returns thickness of the underline in pixels. .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Dictionary` **_font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1346,7 +1346,7 @@ Returns variation coordinates for the specified font cache entry. .. rst-class:: classref-method -:ref:`int` **_font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1360,7 +1360,7 @@ Returns weight (boldness) of the font. A value in the ``100...999`` range, norma .. rst-class:: classref-method -:ref:`bool` **_font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| +:ref:`bool` **_font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -1374,7 +1374,7 @@ Returns ``true`` if a Unicode ``char`` is available in the font. .. rst-class:: classref-method -:ref:`bool` **_font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1388,7 +1388,7 @@ Returns ``true`` if system fonts can be automatically used as fallbacks. .. rst-class:: classref-method -:ref:`bool` **_font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1402,7 +1402,7 @@ Returns ``true`` if auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-method -:ref:`bool` **_font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1416,7 +1416,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **_font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1430,7 +1430,7 @@ Returns ``true`` if glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-method -:ref:`bool` **_font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -1444,7 +1444,7 @@ Returns ``true``, if font supports given script (ISO 15924 code). .. rst-class:: classref-method -|void| **_font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| +|void| **_font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1458,7 +1458,7 @@ Removes specified rendered glyph information from the cache entry. .. rst-class:: classref-method -|void| **_font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| +|void| **_font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1472,7 +1472,7 @@ Removes kerning override for the pair of glyphs. .. rst-class:: classref-method -|void| **_font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| +|void| **_font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1486,7 +1486,7 @@ Remove language support override. .. rst-class:: classref-method -|void| **_font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| +|void| **_font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1500,7 +1500,7 @@ Removes script support override. .. rst-class:: classref-method -|void| **_font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| +|void| **_font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1514,7 +1514,7 @@ Removes specified font size from the cache entry. .. rst-class:: classref-method -|void| **_font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| +|void| **_font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1528,7 +1528,7 @@ Removes specified texture from the cache entry. .. rst-class:: classref-method -|void| **_font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| +|void| **_font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1542,7 +1542,7 @@ Renders specified glyph to the font cache texture. .. rst-class:: classref-method -|void| **_font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| +|void| **_font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1556,7 +1556,7 @@ Renders the range of characters to the font cache texture. .. rst-class:: classref-method -|void| **_font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| +|void| **_font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1570,7 +1570,7 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-method -|void| **_font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| +|void| **_font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1584,7 +1584,7 @@ Sets font anti-aliasing mode. .. rst-class:: classref-method -|void| **_font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| +|void| **_font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1598,7 +1598,7 @@ Sets the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -|void| **_font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| +|void| **_font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1612,7 +1612,7 @@ Sets extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -|void| **_font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| +|void| **_font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1626,7 +1626,7 @@ Sets font source data, e.g contents of the dynamic font source file. .. rst-class:: classref-method -|void| **_font_set_data_ptr**\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| +|void| **_font_set_data_ptr**\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1640,7 +1640,7 @@ Sets pointer to the font source data, e.g contents of the dynamic font source fi .. rst-class:: classref-method -|void| **_font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| +|void| **_font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1654,7 +1654,7 @@ Sets the font descent (number of pixels below the baseline). .. rst-class:: classref-method -|void| **_font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| +|void| **_font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1668,7 +1668,7 @@ If set to ``true``, embedded font bitmap loading is disabled. .. rst-class:: classref-method -|void| **_font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| +|void| **_font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| :ref:`🔗` Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -1680,7 +1680,7 @@ Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the .. rst-class:: classref-method -|void| **_font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| +|void| **_font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1694,7 +1694,7 @@ Sets an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -|void| **_font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| +|void| **_font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1708,7 +1708,7 @@ Sets bitmap font fixed size. If set to value greater than zero, same cache entry .. rst-class:: classref-method -|void| **_font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| +|void| **_font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1722,7 +1722,7 @@ Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is g .. rst-class:: classref-method -|void| **_font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| +|void| **_font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1736,7 +1736,7 @@ If set to ``true`` auto-hinting is preferred over font built-in hinting. .. rst-class:: classref-method -|void| **_font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| +|void| **_font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1750,7 +1750,7 @@ If set to ``true`` font texture mipmap generation is enabled. .. rst-class:: classref-method -|void| **_font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) |virtual| +|void| **_font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1764,7 +1764,7 @@ Sets oversampling factor, shared by all font in the TextServer. .. rst-class:: classref-method -|void| **_font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| +|void| **_font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1778,7 +1778,7 @@ Sets glyph advance (offset of the next glyph). .. rst-class:: classref-method -|void| **_font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| +|void| **_font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1792,7 +1792,7 @@ Sets glyph offset from the baseline. .. rst-class:: classref-method -|void| **_font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| +|void| **_font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1806,7 +1806,7 @@ Sets size of the glyph. .. rst-class:: classref-method -|void| **_font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| +|void| **_font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1820,7 +1820,7 @@ Sets index of the cache texture containing the glyph. .. rst-class:: classref-method -|void| **_font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| +|void| **_font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1834,7 +1834,7 @@ Sets rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -|void| **_font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| +|void| **_font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1848,7 +1848,7 @@ Sets font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-method -|void| **_font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| +|void| **_font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1862,7 +1862,7 @@ Sets kerning for the pair of glyphs. .. rst-class:: classref-method -|void| **_font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| +|void| **_font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1876,7 +1876,7 @@ Adds override for :ref:`_font_is_language_supported`, msdf_pixel_range\: :ref:`int`\ ) |virtual| +|void| **_font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1890,7 +1890,7 @@ Sets the width of the range around the shape between the minimum and maximum rep .. rst-class:: classref-method -|void| **_font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| +|void| **_font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1904,7 +1904,7 @@ Sets source font size used to generate MSDF textures. .. rst-class:: classref-method -|void| **_font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| +|void| **_font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1918,7 +1918,7 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-method -|void| **_font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| +|void| **_font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1932,7 +1932,7 @@ Sets the font family name. .. rst-class:: classref-method -|void| **_font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| +|void| **_font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1946,7 +1946,7 @@ Sets font OpenType feature set override. .. rst-class:: classref-method -|void| **_font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| +|void| **_font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1960,7 +1960,7 @@ Sets font oversampling factor, if set to ``0.0`` global oversampling factor is u .. rst-class:: classref-method -|void| **_font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| +|void| **_font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -1974,7 +1974,7 @@ Sets scaling factor of the color bitmap font. .. rst-class:: classref-method -|void| **_font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| +|void| **_font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -1988,7 +1988,7 @@ Adds override for :ref:`_font_is_script_supported`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| +|void| **_font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2002,7 +2002,7 @@ Sets the spacing for ``spacing`` (see :ref:`SpacingType`, stretch\: :ref:`int`\ ) |virtual| +|void| **_font_set_stretch**\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2016,7 +2016,7 @@ Sets font stretch amount, compared to a normal width. A percentage value between .. rst-class:: classref-method -|void| **_font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| +|void| **_font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2030,7 +2030,7 @@ Sets the font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -|void| **_font_set_style_name**\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| +|void| **_font_set_style_name**\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2044,7 +2044,7 @@ Sets the font style name. .. rst-class:: classref-method -|void| **_font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| +|void| **_font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2058,7 +2058,7 @@ Sets font subpixel glyph positioning mode. .. rst-class:: classref-method -|void| **_font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| +|void| **_font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2072,7 +2072,7 @@ Sets font cache texture image data. .. rst-class:: classref-method -|void| **_font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| +|void| **_font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2086,7 +2086,7 @@ Sets array containing glyph packing data. .. rst-class:: classref-method -|void| **_font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| +|void| **_font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2100,7 +2100,7 @@ Sets 2D transform, applied to the font outlines, can be used for slanting, flipp .. rst-class:: classref-method -|void| **_font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| +|void| **_font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2114,7 +2114,7 @@ Sets pixel offset of the underline below the baseline. .. rst-class:: classref-method -|void| **_font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| +|void| **_font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2128,7 +2128,7 @@ Sets thickness of the underline in pixels. .. rst-class:: classref-method -|void| **_font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| +|void| **_font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2142,7 +2142,7 @@ Sets variation coordinates for the specified font cache entry. .. rst-class:: classref-method -|void| **_font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| +|void| **_font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2156,7 +2156,7 @@ Sets weight (boldness) of the font. A value in the ``100...999`` range, normal f .. rst-class:: classref-method -:ref:`Dictionary` **_font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Dictionary` **_font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2170,7 +2170,7 @@ Returns the dictionary of the supported OpenType features. .. rst-class:: classref-method -:ref:`Dictionary` **_font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| +:ref:`Dictionary` **_font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2184,7 +2184,7 @@ Returns the dictionary of the supported OpenType variation coordinates. .. rst-class:: classref-method -:ref:`String` **_format_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_format_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2198,7 +2198,7 @@ Converts a number from the Western Arabic (0..9) to the numeral systems used in .. rst-class:: classref-method -|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2212,7 +2212,7 @@ Frees an object created by this :ref:`TextServer`. .. rst-class:: classref-method -:ref:`int` **_get_features**\ (\ ) |virtual| |const| +:ref:`int` **_get_features**\ (\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2226,7 +2226,7 @@ Returns text server features, see :ref:`Feature`. .. rst-class:: classref-method -:ref:`Vector2` **_get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2240,7 +2240,7 @@ Returns size of the replacement character (box with character hexadecimal code t .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2254,7 +2254,7 @@ Returns the name of the server interface. .. rst-class:: classref-method -:ref:`String` **_get_support_data_filename**\ (\ ) |virtual| |const| +:ref:`String` **_get_support_data_filename**\ (\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2268,7 +2268,7 @@ Returns default TextServer database (e.g. ICU break iterators and dictionaries) .. rst-class:: classref-method -:ref:`String` **_get_support_data_info**\ (\ ) |virtual| |const| +:ref:`String` **_get_support_data_info**\ (\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2282,7 +2282,7 @@ Returns TextServer database (e.g. ICU break iterators and dictionaries) descript .. rst-class:: classref-method -:ref:`bool` **_has**\ (\ rid\: :ref:`RID`\ ) |virtual| +:ref:`bool` **_has**\ (\ rid\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2296,7 +2296,7 @@ Returns ``true`` if ``rid`` is valid resource owned by this text server. .. rst-class:: classref-method -:ref:`bool` **_has_feature**\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| +:ref:`bool` **_has_feature**\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2310,7 +2310,7 @@ Returns ``true`` if the server supports a feature. .. rst-class:: classref-method -:ref:`int` **_is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| +:ref:`int` **_is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2324,7 +2324,7 @@ Returns index of the first string in ``dict`` which is visually confusable with .. rst-class:: classref-method -:ref:`bool` **_is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2338,7 +2338,7 @@ Returns ``true`` if locale is right-to-left. .. rst-class:: classref-method -:ref:`bool` **_is_valid_identifier**\ (\ string\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_is_valid_identifier**\ (\ string\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2352,7 +2352,7 @@ Returns ``true`` if ``string`` is a valid identifier. .. rst-class:: classref-method -:ref:`bool` **_is_valid_letter**\ (\ unicode\: :ref:`int`\ ) |virtual| |const| +:ref:`bool` **_is_valid_letter**\ (\ unicode\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -2366,7 +2366,7 @@ Returns ``true`` if ``string`` is a valid identifier. .. rst-class:: classref-method -:ref:`bool` **_load_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| +:ref:`bool` **_load_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2380,7 +2380,7 @@ Loads optional TextServer database (e.g. ICU break iterators and dictionaries). .. rst-class:: classref-method -:ref:`int` **_name_to_tag**\ (\ name\: :ref:`String`\ ) |virtual| |const| +:ref:`int` **_name_to_tag**\ (\ name\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2394,7 +2394,7 @@ Converts readable feature, variation, script, or language name to OpenType tag. .. rst-class:: classref-method -:ref:`String` **_parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2408,7 +2408,7 @@ Converts ``number`` from the numeral systems used in ``language`` to Western Ara .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector3i`\] **_parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| +:ref:`Array`\[:ref:`Vector3i`\] **_parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2422,7 +2422,7 @@ Default implementation of the BiDi algorithm override function. See :ref:`Struct .. rst-class:: classref-method -:ref:`String` **_percent_sign**\ (\ language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_percent_sign**\ (\ language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2436,7 +2436,7 @@ Returns percent sign used in the ``language``. .. rst-class:: classref-method -:ref:`bool` **_save_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_save_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2450,7 +2450,7 @@ Saves optional TextServer database (e.g. ICU break iterators and dictionaries) t .. rst-class:: classref-method -:ref:`int` **_shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2464,7 +2464,7 @@ Returns number of text spans added using :ref:`_shaped_text_add_string` **_shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| +:ref:`Variant` **_shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2478,7 +2478,7 @@ Returns text span metadata. .. rst-class:: classref-method -|void| **_shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| +|void| **_shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2492,7 +2492,7 @@ Changes text span font, font size, and OpenType features, without changing the t .. rst-class:: classref-method -:ref:`bool` **_shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| +:ref:`bool` **_shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2506,7 +2506,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **_shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| +:ref:`bool` **_shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2520,7 +2520,7 @@ Adds text span and font to draw it to the text buffer. .. rst-class:: classref-method -|void| **_shaped_text_clear**\ (\ shaped\: :ref:`RID`\ ) |virtual| +|void| **_shaped_text_clear**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -2534,7 +2534,7 @@ Clears text buffer (removes text and inline objects). .. rst-class:: classref-method -:ref:`int` **_shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2548,7 +2548,7 @@ Returns composite character position closest to the ``pos``. .. rst-class:: classref-method -|void| **_shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| +|void| **_shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2562,7 +2562,7 @@ Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` .. rst-class:: classref-method -|void| **_shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| +|void| **_shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2576,7 +2576,7 @@ Draw the outline of the shaped text into a canvas item at a given position, with .. rst-class:: classref-method -:ref:`float` **_shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| +:ref:`float` **_shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -2590,7 +2590,7 @@ Adjusts text width to fit to specified width, returns new text width. .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2604,7 +2604,7 @@ Returns the text ascent (number of pixels above the baseline for horizontal layo .. rst-class:: classref-method -|void| **_shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| +|void| **_shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2618,7 +2618,7 @@ Returns shapes of the carets corresponding to the character offset ``position`` .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2632,7 +2632,7 @@ Returns array of the composite character boundaries. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2646,7 +2646,7 @@ Returns ellipsis character used for text clipping. .. rst-class:: classref-method -:ref:`String` **_shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`String` **_shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2660,7 +2660,7 @@ Returns custom punctuation character list, used for word breaking. If set to emp .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2674,7 +2674,7 @@ Returns the text descent (number of pixels below the baseline for horizontal lay .. rst-class:: classref-method -:ref:`Direction` **_shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`Direction` **_shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2688,7 +2688,7 @@ Returns direction of the text. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2702,7 +2702,7 @@ Returns dominant direction of in the range of text. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2716,7 +2716,7 @@ Returns number of glyphs in the ellipsis. .. rst-class:: classref-method -``const Glyph*`` **_shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +``const Glyph*`` **_shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2730,7 +2730,7 @@ Returns array of the glyphs in the ellipsis. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2744,7 +2744,7 @@ Returns position of the ellipsis. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2758,7 +2758,7 @@ Returns number of glyphs in the buffer. .. rst-class:: classref-method -``const Glyph*`` **_shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +``const Glyph*`` **_shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2772,7 +2772,7 @@ Returns an array of glyphs in the visual order. .. rst-class:: classref-method -:ref:`Vector2` **_shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| +:ref:`Vector2` **_shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2786,7 +2786,7 @@ Returns composite character's bounds as offsets from the start of the line. .. rst-class:: classref-method -:ref:`Direction` **_shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`Direction` **_shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2800,7 +2800,7 @@ Returns direction of the text, inferred by the BiDi algorithm. .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2814,7 +2814,7 @@ Breaks text to the lines and returns character ranges for each line. .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2828,7 +2828,7 @@ Breaks text to the lines and columns. Returns character ranges for each segment. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2842,7 +2842,7 @@ Returns the glyph index of the inline object. .. rst-class:: classref-method -:ref:`Vector2i` **_shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| +:ref:`Vector2i` **_shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2856,7 +2856,7 @@ Returns the character range of the inline object. .. rst-class:: classref-method -:ref:`Rect2` **_shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| +:ref:`Rect2` **_shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2870,7 +2870,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **_shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`Array` **_shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2884,7 +2884,7 @@ Returns array of inline objects. .. rst-class:: classref-method -:ref:`Orientation` **_shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`Orientation` **_shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2898,7 +2898,7 @@ Returns text orientation. .. rst-class:: classref-method -:ref:`RID` **_shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`RID` **_shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2912,7 +2912,7 @@ Returns the parent buffer from which the substring originates. .. rst-class:: classref-method -:ref:`bool` **_shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2926,7 +2926,7 @@ Returns ``true`` if text buffer is configured to display control characters. .. rst-class:: classref-method -:ref:`bool` **_shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2940,7 +2940,7 @@ Returns ``true`` if text buffer is configured to display hexadecimal codes in pl .. rst-class:: classref-method -:ref:`Vector2i` **_shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector2i` **_shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2954,7 +2954,7 @@ Returns substring buffer character range in the parent buffer. .. rst-class:: classref-method -:ref:`PackedVector2Array` **_shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| +:ref:`PackedVector2Array` **_shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2968,7 +2968,7 @@ Returns selection rectangles for the specified character range. .. rst-class:: classref-method -:ref:`Vector2` **_shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`Vector2` **_shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -2982,7 +2982,7 @@ Returns size of the text. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -2996,7 +2996,7 @@ Returns extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`int` **_shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -3010,7 +3010,7 @@ Returns the position of the overrun trim. .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -3024,7 +3024,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -3038,7 +3038,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`float` **_shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -3052,7 +3052,7 @@ Returns width (for horizontal layout) or height (for vertical) of the text. .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\], skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\], skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3066,7 +3066,7 @@ Breaks text into words and returns array of character ranges. Use ``grapheme_fla .. rst-class:: classref-method -:ref:`int` **_shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| +:ref:`int` **_shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3080,7 +3080,7 @@ Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` .. rst-class:: classref-method -:ref:`int` **_shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| +:ref:`int` **_shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3094,7 +3094,7 @@ Returns caret character offset at the specified pixel offset at the baseline. Th .. rst-class:: classref-method -:ref:`bool` **_shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| +:ref:`bool` **_shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -3108,7 +3108,7 @@ Returns ``true`` if buffer is successfully shaped. .. rst-class:: classref-method -:ref:`int` **_shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3122,7 +3122,7 @@ Returns composite character end position closest to the ``pos``. .. rst-class:: classref-method -:ref:`int` **_shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3136,7 +3136,7 @@ Returns grapheme end position closest to the ``pos``. .. rst-class:: classref-method -|void| **_shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| +|void| **_shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3150,7 +3150,7 @@ Trims text if it exceeds the given width. .. rst-class:: classref-method -:ref:`int` **_shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3164,7 +3164,7 @@ Returns composite character start position closest to the ``pos``. .. rst-class:: classref-method -:ref:`int` **_shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3178,7 +3178,7 @@ Returns grapheme start position closest to the ``pos``. .. rst-class:: classref-method -:ref:`bool` **_shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| +:ref:`bool` **_shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -3192,7 +3192,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -|void| **_shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| +|void| **_shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3206,7 +3206,7 @@ Overrides BiDi for the structured text. .. rst-class:: classref-method -|void| **_shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| +|void| **_shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3220,7 +3220,7 @@ Sets ellipsis character used for text clipping. .. rst-class:: classref-method -|void| **_shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| +|void| **_shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3234,7 +3234,7 @@ Sets custom punctuation character list, used for word breaking. If set to empty .. rst-class:: classref-method -|void| **_shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| +|void| **_shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3248,7 +3248,7 @@ Sets desired text direction. If set to :ref:`TextServer.DIRECTION_AUTO`, orientation\: :ref:`Orientation`\ ) |virtual| +|void| **_shaped_text_set_orientation**\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3262,7 +3262,7 @@ Sets desired text orientation. .. rst-class:: classref-method -|void| **_shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| +|void| **_shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3276,7 +3276,7 @@ If set to ``true`` text buffer will display control characters. .. rst-class:: classref-method -|void| **_shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| +|void| **_shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3290,7 +3290,7 @@ If set to ``true`` text buffer will display invalid characters as hexadecimal co .. rst-class:: classref-method -|void| **_shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| +|void| **_shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3304,7 +3304,7 @@ Sets extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-method -:ref:`bool` **_shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) |virtual| +:ref:`bool` **_shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -3318,7 +3318,7 @@ Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped succe .. rst-class:: classref-method -``const Glyph*`` **_shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) |virtual| +``const Glyph*`` **_shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Required.**\ @@ -3332,7 +3332,7 @@ Returns text glyphs in the logical order. .. rst-class:: classref-method -:ref:`RID` **_shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| +:ref:`RID` **_shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Required.**\ @@ -3346,7 +3346,7 @@ Returns text buffer for the substring of the text in the ``shaped`` text buffer .. rst-class:: classref-method -:ref:`float` **_shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| +:ref:`float` **_shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3360,7 +3360,7 @@ Aligns shaped text to the given tab-stops. .. rst-class:: classref-method -:ref:`bool` **_shaped_text_update_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| +:ref:`bool` **_shaped_text_update_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3374,7 +3374,7 @@ Updates break points in the shaped text. This method is called by default implem .. rst-class:: classref-method -:ref:`bool` **_shaped_text_update_justification_ops**\ (\ shaped\: :ref:`RID`\ ) |virtual| +:ref:`bool` **_shaped_text_update_justification_ops**\ (\ shaped\: :ref:`RID`\ ) |virtual| :ref:`🔗` **Optional.**\ @@ -3388,7 +3388,7 @@ Updates justification points in the shaped text. This method is called by defaul .. rst-class:: classref-method -:ref:`bool` **_spoof_check**\ (\ string\: :ref:`String`\ ) |virtual| |const| +:ref:`bool` **_spoof_check**\ (\ string\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3402,7 +3402,7 @@ Returns ``true`` if ``string`` is likely to be an attempt at confusing the reade .. rst-class:: classref-method -:ref:`PackedInt32Array` **_string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`PackedInt32Array` **_string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3416,7 +3416,7 @@ Returns array of the composite character boundaries. .. rst-class:: classref-method -:ref:`PackedInt32Array` **_string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| +:ref:`PackedInt32Array` **_string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3430,7 +3430,7 @@ Returns an array of the word break boundaries. Elements in the returned array ar .. rst-class:: classref-method -:ref:`String` **_string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3444,7 +3444,7 @@ Returns the string converted to lowercase. .. rst-class:: classref-method -:ref:`String` **_string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3458,7 +3458,7 @@ Returns the string converted to title case. .. rst-class:: classref-method -:ref:`String` **_string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3472,7 +3472,7 @@ Returns the string converted to uppercase. .. rst-class:: classref-method -:ref:`String` **_strip_diacritics**\ (\ string\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_strip_diacritics**\ (\ string\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ @@ -3486,7 +3486,7 @@ Strips diacritics from the string. .. rst-class:: classref-method -:ref:`String` **_tag_to_name**\ (\ tag\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_tag_to_name**\ (\ tag\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` **Optional.**\ diff --git a/classes/class_textservermanager.rst b/classes/class_textservermanager.rst index 37e5319a372..95a3557ee80 100644 --- a/classes/class_textservermanager.rst +++ b/classes/class_textservermanager.rst @@ -62,7 +62,7 @@ Signals .. rst-class:: classref-signal -**interface_added**\ (\ interface_name\: :ref:`StringName`\ ) +**interface_added**\ (\ interface_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when a new interface has been added. @@ -74,7 +74,7 @@ Emitted when a new interface has been added. .. rst-class:: classref-signal -**interface_removed**\ (\ interface_name\: :ref:`StringName`\ ) +**interface_removed**\ (\ interface_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when an interface is removed. @@ -91,7 +91,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_interface**\ (\ interface\: :ref:`TextServer`\ ) +|void| **add_interface**\ (\ interface\: :ref:`TextServer`\ ) :ref:`🔗` Registers a :ref:`TextServer` interface. @@ -103,7 +103,7 @@ Registers a :ref:`TextServer` interface. .. rst-class:: classref-method -:ref:`TextServer` **find_interface**\ (\ name\: :ref:`String`\ ) |const| +:ref:`TextServer` **find_interface**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Finds an interface by its ``name``. @@ -115,7 +115,7 @@ Finds an interface by its ``name``. .. rst-class:: classref-method -:ref:`TextServer` **get_interface**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`TextServer` **get_interface**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the interface registered at a given index. @@ -127,7 +127,7 @@ Returns the interface registered at a given index. .. rst-class:: classref-method -:ref:`int` **get_interface_count**\ (\ ) |const| +:ref:`int` **get_interface_count**\ (\ ) |const| :ref:`🔗` Returns the number of interfaces currently registered. @@ -139,7 +139,7 @@ Returns the number of interfaces currently registered. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_interfaces**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_interfaces**\ (\ ) |const| :ref:`🔗` Returns a list of available interfaces, with the index and name of each interface. @@ -151,7 +151,7 @@ Returns a list of available interfaces, with the index and name of each interfac .. rst-class:: classref-method -:ref:`TextServer` **get_primary_interface**\ (\ ) |const| +:ref:`TextServer` **get_primary_interface**\ (\ ) |const| :ref:`🔗` Returns the primary :ref:`TextServer` interface currently in use. @@ -163,7 +163,7 @@ Returns the primary :ref:`TextServer` interface currently in u .. rst-class:: classref-method -|void| **remove_interface**\ (\ interface\: :ref:`TextServer`\ ) +|void| **remove_interface**\ (\ interface\: :ref:`TextServer`\ ) :ref:`🔗` Removes an interface. All fonts and shaped text caches should be freed before removing an interface. @@ -175,7 +175,7 @@ Removes an interface. All fonts and shaped text caches should be freed before re .. rst-class:: classref-method -|void| **set_primary_interface**\ (\ index\: :ref:`TextServer`\ ) +|void| **set_primary_interface**\ (\ index\: :ref:`TextServer`\ ) :ref:`🔗` Sets the primary :ref:`TextServer` interface. diff --git a/classes/class_texture2d.rst b/classes/class_texture2d.rst index a72af9a5381..6f90d931f2a 100644 --- a/classes/class_texture2d.rst +++ b/classes/class_texture2d.rst @@ -84,7 +84,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| +|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Called when the entire **Texture2D** is requested to be drawn over a :ref:`CanvasItem`, with the top-left offset specified in ``pos``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). @@ -98,7 +98,7 @@ Called when the entire **Texture2D** is requested to be drawn over a :ref:`Canva .. rst-class:: classref-method -|void| **_draw_rect**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| +|void| **_draw_rect**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Called when the **Texture2D** is requested to be drawn onto :ref:`CanvasItem`'s specified ``rect``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). @@ -112,7 +112,7 @@ Called when the **Texture2D** is requested to be drawn onto :ref:`CanvasItem`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`, clip_uv\: :ref:`bool`\ ) |virtual| |const| +|void| **_draw_rect_region**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`, clip_uv\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Called when a part of the **Texture2D** specified by ``src_rect``'s coordinates is requested to be drawn onto :ref:`CanvasItem`'s specified ``rect``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). @@ -126,7 +126,7 @@ Called when a part of the **Texture2D** specified by ``src_rect``'s coordinates .. rst-class:: classref-method -:ref:`int` **_get_height**\ (\ ) |virtual| |const| +:ref:`int` **_get_height**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture2D**'s height is queried. @@ -138,7 +138,7 @@ Called when the **Texture2D**'s height is queried. .. rst-class:: classref-method -:ref:`int` **_get_width**\ (\ ) |virtual| |const| +:ref:`int` **_get_width**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture2D**'s width is queried. @@ -150,7 +150,7 @@ Called when the **Texture2D**'s width is queried. .. rst-class:: classref-method -:ref:`bool` **_has_alpha**\ (\ ) |virtual| |const| +:ref:`bool` **_has_alpha**\ (\ ) |virtual| |const| :ref:`🔗` Called when the presence of an alpha channel in the **Texture2D** is queried. @@ -162,7 +162,7 @@ Called when the presence of an alpha channel in the **Texture2D** is queried. .. rst-class:: classref-method -:ref:`bool` **_is_pixel_opaque**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |virtual| |const| +:ref:`bool` **_is_pixel_opaque**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Called when a pixel's opaque state in the **Texture2D** is queried at the specified ``(x, y)`` position. @@ -174,7 +174,7 @@ Called when a pixel's opaque state in the **Texture2D** is queried at the specif .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderTexture2D`). @@ -186,7 +186,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderTexture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| +|void| **draw**\ (\ canvas_item\: :ref:`RID`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| :ref:`🔗` Draws the texture using a :ref:`CanvasItem` with the :ref:`RenderingServer` API at the specified ``position``. @@ -198,7 +198,7 @@ Draws the texture using a :ref:`CanvasItem` with the :ref:`Ren .. rst-class:: classref-method -|void| **draw_rect**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| +|void| **draw_rect**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| :ref:`🔗` Draws the texture using a :ref:`CanvasItem` with the :ref:`RenderingServer` API. @@ -210,7 +210,7 @@ Draws the texture using a :ref:`CanvasItem` with the :ref:`Ren .. rst-class:: classref-method -|void| **draw_rect_region**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) |const| +|void| **draw_rect_region**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) |const| :ref:`🔗` Draws a part of the texture using a :ref:`CanvasItem` with the :ref:`RenderingServer` API. @@ -222,7 +222,7 @@ Draws a part of the texture using a :ref:`CanvasItem` with the .. rst-class:: classref-method -:ref:`int` **get_height**\ (\ ) |const| +:ref:`int` **get_height**\ (\ ) |const| :ref:`🔗` Returns the texture height in pixels. @@ -234,7 +234,7 @@ Returns the texture height in pixels. .. rst-class:: classref-method -:ref:`Image` **get_image**\ (\ ) |const| +:ref:`Image` **get_image**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Image` that is a copy of data from this **Texture2D** (a new :ref:`Image` is created each time). :ref:`Image`\ s can be accessed and manipulated directly. @@ -250,7 +250,7 @@ Returns an :ref:`Image` that is a copy of data from this **Texture2 .. rst-class:: classref-method -:ref:`Vector2` **get_size**\ (\ ) |const| +:ref:`Vector2` **get_size**\ (\ ) |const| :ref:`🔗` Returns the texture size in pixels. @@ -262,7 +262,7 @@ Returns the texture size in pixels. .. rst-class:: classref-method -:ref:`int` **get_width**\ (\ ) |const| +:ref:`int` **get_width**\ (\ ) |const| :ref:`🔗` Returns the texture width in pixels. @@ -274,7 +274,7 @@ Returns the texture width in pixels. .. rst-class:: classref-method -:ref:`bool` **has_alpha**\ (\ ) |const| +:ref:`bool` **has_alpha**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Texture2D** has an alpha channel. diff --git a/classes/class_texture2darray.rst b/classes/class_texture2darray.rst index 1763b66bbe9..66e87af3296 100644 --- a/classes/class_texture2darray.rst +++ b/classes/class_texture2darray.rst @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderTexture2DArray`). diff --git a/classes/class_texture2drd.rst b/classes/class_texture2drd.rst index b058c42c322..a008425b4c6 100644 --- a/classes/class_texture2drd.rst +++ b/classes/class_texture2drd.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RID` **texture_rd_rid** +:ref:`RID` **texture_rd_rid** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index e12b281c4c2..3b0e8579984 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -76,7 +76,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array`\[:ref:`Image`\] **_get_data**\ (\ ) |virtual| |const| +:ref:`Array`\[:ref:`Image`\] **_get_data**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture3D**'s data is queried. @@ -88,7 +88,7 @@ Called when the **Texture3D**'s data is queried. .. rst-class:: classref-method -:ref:`int` **_get_depth**\ (\ ) |virtual| |const| +:ref:`int` **_get_depth**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture3D**'s depth is queried. @@ -100,7 +100,7 @@ Called when the **Texture3D**'s depth is queried. .. rst-class:: classref-method -:ref:`Format` **_get_format**\ (\ ) |virtual| |const| +:ref:`Format` **_get_format**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture3D**'s format is queried. @@ -112,7 +112,7 @@ Called when the **Texture3D**'s format is queried. .. rst-class:: classref-method -:ref:`int` **_get_height**\ (\ ) |virtual| |const| +:ref:`int` **_get_height**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture3D**'s height is queried. @@ -124,7 +124,7 @@ Called when the **Texture3D**'s height is queried. .. rst-class:: classref-method -:ref:`int` **_get_width**\ (\ ) |virtual| |const| +:ref:`int` **_get_width**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **Texture3D**'s width is queried. @@ -136,7 +136,7 @@ Called when the **Texture3D**'s width is queried. .. rst-class:: classref-method -:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| +:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| :ref:`🔗` Called when the presence of mipmaps in the **Texture3D** is queried. @@ -148,7 +148,7 @@ Called when the presence of mipmaps in the **Texture3D** is queried. .. rst-class:: classref-method -:ref:`Resource` **create_placeholder**\ (\ ) |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| :ref:`🔗` Creates a placeholder version of this resource (:ref:`PlaceholderTexture3D`). @@ -160,7 +160,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderTexture3D`\[:ref:`Image`\] **get_data**\ (\ ) |const| +:ref:`Array`\[:ref:`Image`\] **get_data**\ (\ ) |const| :ref:`🔗` Returns the **Texture3D**'s data as an array of :ref:`Image`\ s. Each :ref:`Image` represents a *slice* of the **Texture3D**, with different slices mapping to different depth (Z axis) levels. @@ -172,7 +172,7 @@ Returns the **Texture3D**'s data as an array of :ref:`Image`\ s. Ea .. rst-class:: classref-method -:ref:`int` **get_depth**\ (\ ) |const| +:ref:`int` **get_depth**\ (\ ) |const| :ref:`🔗` Returns the **Texture3D**'s depth in pixels. Depth is typically represented by the Z axis (a dimension not present in :ref:`Texture2D`). @@ -184,7 +184,7 @@ Returns the **Texture3D**'s depth in pixels. Depth is typically represented by t .. rst-class:: classref-method -:ref:`Format` **get_format**\ (\ ) |const| +:ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` Returns the current format being used by this texture. See :ref:`Format` for details. @@ -196,7 +196,7 @@ Returns the current format being used by this texture. See :ref:`Format` **get_height**\ (\ ) |const| +:ref:`int` **get_height**\ (\ ) |const| :ref:`🔗` Returns the **Texture3D**'s height in pixels. Width is typically represented by the Y axis. @@ -208,7 +208,7 @@ Returns the **Texture3D**'s height in pixels. Width is typically represented by .. rst-class:: classref-method -:ref:`int` **get_width**\ (\ ) |const| +:ref:`int` **get_width**\ (\ ) |const| :ref:`🔗` Returns the **Texture3D**'s width in pixels. Width is typically represented by the X axis. @@ -220,7 +220,7 @@ Returns the **Texture3D**'s width in pixels. Width is typically represented by t .. rst-class:: classref-method -:ref:`bool` **has_mipmaps**\ (\ ) |const| +:ref:`bool` **has_mipmaps**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the **Texture3D** has generated mipmaps. diff --git a/classes/class_texture3drd.rst b/classes/class_texture3drd.rst index 670690092b4..9a9489d9d88 100644 --- a/classes/class_texture3drd.rst +++ b/classes/class_texture3drd.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RID` **texture_rd_rid** +:ref:`RID` **texture_rd_rid** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 57cc5d956d8..e870ee00eb6 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -75,7 +75,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **StretchMode**: +enum **StretchMode**: :ref:`🔗` .. _class_TextureButton_constant_STRETCH_SCALE: @@ -146,7 +146,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **flip_h** = ``false`` +:ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -163,7 +163,7 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property -:ref:`bool` **flip_v** = ``false`` +:ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -180,7 +180,7 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property -:ref:`bool` **ignore_texture_size** = ``false`` +:ref:`bool` **ignore_texture_size** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -197,7 +197,7 @@ If ``true``, the size of the texture won't be considered for minimum size calcul .. rst-class:: classref-property -:ref:`StretchMode` **stretch_mode** = ``2`` +:ref:`StretchMode` **stretch_mode** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -214,7 +214,7 @@ Controls the texture's behavior when you resize the node's bounding rectangle. S .. rst-class:: classref-property -:ref:`BitMap` **texture_click_mask** +:ref:`BitMap` **texture_click_mask** :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ Pure black and white :ref:`BitMap` image to use for click detectio .. rst-class:: classref-property -:ref:`Texture2D` **texture_disabled** +:ref:`Texture2D` **texture_disabled** :ref:`🔗` .. rst-class:: classref-property-setget @@ -248,7 +248,7 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` **texture_focused** +:ref:`Texture2D` **texture_focused** :ref:`🔗` .. rst-class:: classref-property-setget @@ -265,7 +265,7 @@ Texture to display when the node has mouse or keyboard focus. :ref:`texture_focu .. rst-class:: classref-property -:ref:`Texture2D` **texture_hover** +:ref:`Texture2D` **texture_hover** :ref:`🔗` .. rst-class:: classref-property-setget @@ -282,7 +282,7 @@ Texture to display when the mouse hovers the node. .. rst-class:: classref-property -:ref:`Texture2D` **texture_normal** +:ref:`Texture2D` **texture_normal** :ref:`🔗` .. rst-class:: classref-property-setget @@ -299,7 +299,7 @@ Texture to display by default, when the node is **not** in the disabled, hover o .. rst-class:: classref-property -:ref:`Texture2D` **texture_pressed** +:ref:`Texture2D` **texture_pressed** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 8864b89003c..12846612420 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -82,7 +82,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **LayeredType**: +enum **LayeredType**: :ref:`🔗` .. _class_TextureLayered_constant_LAYERED_TYPE_2D_ARRAY: @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Format` **_get_format**\ (\ ) |virtual| |const| +:ref:`Format` **_get_format**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **TextureLayered**'s format is queried. @@ -133,7 +133,7 @@ Called when the **TextureLayered**'s format is queried. .. rst-class:: classref-method -:ref:`int` **_get_height**\ (\ ) |virtual| |const| +:ref:`int` **_get_height**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **TextureLayered**'s height is queried. @@ -145,7 +145,7 @@ Called when the **TextureLayered**'s height is queried. .. rst-class:: classref-method -:ref:`Image` **_get_layer_data**\ (\ layer_index\: :ref:`int`\ ) |virtual| |const| +:ref:`Image` **_get_layer_data**\ (\ layer_index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Called when the data for a layer in the **TextureLayered** is queried. @@ -157,7 +157,7 @@ Called when the data for a layer in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`int` **_get_layered_type**\ (\ ) |virtual| |const| +:ref:`int` **_get_layered_type**\ (\ ) |virtual| |const| :ref:`🔗` Called when the layers' type in the **TextureLayered** is queried. @@ -169,7 +169,7 @@ Called when the layers' type in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`int` **_get_layers**\ (\ ) |virtual| |const| +:ref:`int` **_get_layers**\ (\ ) |virtual| |const| :ref:`🔗` Called when the number of layers in the **TextureLayered** is queried. @@ -181,7 +181,7 @@ Called when the number of layers in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`int` **_get_width**\ (\ ) |virtual| |const| +:ref:`int` **_get_width**\ (\ ) |virtual| |const| :ref:`🔗` Called when the **TextureLayered**'s width queried. @@ -193,7 +193,7 @@ Called when the **TextureLayered**'s width queried. .. rst-class:: classref-method -:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| +:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| :ref:`🔗` Called when the presence of mipmaps in the **TextureLayered** is queried. @@ -205,7 +205,7 @@ Called when the presence of mipmaps in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`Format` **get_format**\ (\ ) |const| +:ref:`Format` **get_format**\ (\ ) |const| :ref:`🔗` Returns the current format being used by this texture. See :ref:`Format` for details. @@ -217,7 +217,7 @@ Returns the current format being used by this texture. See :ref:`Format` **get_height**\ (\ ) |const| +:ref:`int` **get_height**\ (\ ) |const| :ref:`🔗` Returns the height of the texture in pixels. Height is typically represented by the Y axis. @@ -229,7 +229,7 @@ Returns the height of the texture in pixels. Height is typically represented by .. rst-class:: classref-method -:ref:`Image` **get_layer_data**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`Image` **get_layer_data**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns an :ref:`Image` resource with the data from specified ``layer``. @@ -241,7 +241,7 @@ Returns an :ref:`Image` resource with the data from specified ``lay .. rst-class:: classref-method -:ref:`LayeredType` **get_layered_type**\ (\ ) |const| +:ref:`LayeredType` **get_layered_type**\ (\ ) |const| :ref:`🔗` Returns the **TextureLayered**'s type. The type determines how the data is accessed, with cubemaps having special types. @@ -253,7 +253,7 @@ Returns the **TextureLayered**'s type. The type determines how the data is acces .. rst-class:: classref-method -:ref:`int` **get_layers**\ (\ ) |const| +:ref:`int` **get_layers**\ (\ ) |const| :ref:`🔗` Returns the number of referenced :ref:`Image`\ s. @@ -265,7 +265,7 @@ Returns the number of referenced :ref:`Image`\ s. .. rst-class:: classref-method -:ref:`int` **get_width**\ (\ ) |const| +:ref:`int` **get_width**\ (\ ) |const| :ref:`🔗` Returns the width of the texture in pixels. Width is typically represented by the X axis. @@ -277,7 +277,7 @@ Returns the width of the texture in pixels. Width is typically represented by th .. rst-class:: classref-method -:ref:`bool` **has_mipmaps**\ (\ ) |const| +:ref:`bool` **has_mipmaps**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the layers have generated mipmaps. diff --git a/classes/class_texturelayeredrd.rst b/classes/class_texturelayeredrd.rst index c4db68e8321..e7945235a47 100644 --- a/classes/class_texturelayeredrd.rst +++ b/classes/class_texturelayeredrd.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RID` **texture_rd_rid** +:ref:`RID` **texture_rd_rid** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_textureprogressbar.rst b/classes/class_textureprogressbar.rst index 44284398c52..3313722734d 100644 --- a/classes/class_textureprogressbar.rst +++ b/classes/class_textureprogressbar.rst @@ -96,7 +96,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **FillMode**: +enum **FillMode**: :ref:`🔗` .. _class_TextureProgressBar_constant_FILL_LEFT_TO_RIGHT: @@ -183,7 +183,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **fill_mode** = ``0`` +:ref:`int` **fill_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -200,7 +200,7 @@ The fill direction. See :ref:`FillMode` for po .. rst-class:: classref-property -:ref:`bool` **nine_patch_stretch** = ``false`` +:ref:`bool` **nine_patch_stretch** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -217,7 +217,7 @@ If ``true``, Godot treats the bar's textures like in :ref:`NinePatchRect` **radial_center_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **radial_center_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -234,7 +234,7 @@ Offsets :ref:`texture_progress` **radial_fill_degrees** = ``360.0`` +:ref:`float` **radial_fill_degrees** = ``360.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -253,7 +253,7 @@ See :ref:`Range.value`, :ref:`Range.max_value` **radial_initial_angle** = ``0.0`` +:ref:`float` **radial_initial_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -270,7 +270,7 @@ Starting angle for the fill of :ref:`texture_progress` **stretch_margin_bottom** = ``0`` +:ref:`int` **stretch_margin_bottom** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -287,7 +287,7 @@ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's botto .. rst-class:: classref-property -:ref:`int` **stretch_margin_left** = ``0`` +:ref:`int` **stretch_margin_left** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -304,7 +304,7 @@ The width of the 9-patch's left column. Only effective if :ref:`nine_patch_stret .. rst-class:: classref-property -:ref:`int` **stretch_margin_right** = ``0`` +:ref:`int` **stretch_margin_right** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -321,7 +321,7 @@ The width of the 9-patch's right column. Only effective if :ref:`nine_patch_stre .. rst-class:: classref-property -:ref:`int` **stretch_margin_top** = ``0`` +:ref:`int` **stretch_margin_top** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -338,7 +338,7 @@ The height of the 9-patch's top row. Only effective if :ref:`nine_patch_stretch< .. rst-class:: classref-property -:ref:`Texture2D` **texture_over** +:ref:`Texture2D` **texture_over** :ref:`🔗` .. rst-class:: classref-property-setget @@ -355,7 +355,7 @@ The height of the 9-patch's top row. Only effective if :ref:`nine_patch_stretch< .. rst-class:: classref-property -:ref:`Texture2D` **texture_progress** +:ref:`Texture2D` **texture_progress** :ref:`🔗` .. rst-class:: classref-property-setget @@ -374,7 +374,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val .. rst-class:: classref-property -:ref:`Vector2` **texture_progress_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **texture_progress_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -391,7 +391,7 @@ The offset of :ref:`texture_progress` **texture_under** +:ref:`Texture2D` **texture_under** :ref:`🔗` .. rst-class:: classref-property-setget @@ -408,7 +408,7 @@ The offset of :ref:`texture_progress` **tint_over** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **tint_over** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -425,7 +425,7 @@ Multiplies the color of the bar's :ref:`texture_over` **tint_progress** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **tint_progress** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -442,7 +442,7 @@ Multiplies the color of the bar's :ref:`texture_progress` **tint_under** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **tint_under** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -464,7 +464,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| +:ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the stretch margin with the specified index. See :ref:`stretch_margin_bottom` and related properties. @@ -476,7 +476,7 @@ Returns the stretch margin with the specified index. See :ref:`stretch_margin_bo .. rst-class:: classref-method -|void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +|void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) :ref:`🔗` Sets the stretch margin with the specified index. See :ref:`stretch_margin_bottom` and related properties. diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index ab9d5711c5f..c24ac8e245e 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -63,7 +63,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ExpandMode**: +enum **ExpandMode**: :ref:`🔗` .. _class_TextureRect_constant_EXPAND_KEEP_SIZE: @@ -121,7 +121,7 @@ Same as :ref:`EXPAND_FIT_HEIGHT`, .. rst-class:: classref-enumeration -enum **StretchMode**: +enum **StretchMode**: :ref:`🔗` .. _class_TextureRect_constant_STRETCH_SCALE: @@ -192,7 +192,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ExpandMode` **expand_mode** = ``0`` +:ref:`ExpandMode` **expand_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -211,7 +211,7 @@ Defines how minimum size is determined based on the texture's size. See :ref:`Ex .. rst-class:: classref-property -:ref:`bool` **flip_h** = ``false`` +:ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -228,7 +228,7 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property -:ref:`bool` **flip_v** = ``false`` +:ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -245,7 +245,7 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property -:ref:`StretchMode` **stretch_mode** = ``0`` +:ref:`StretchMode` **stretch_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -262,7 +262,7 @@ Controls the texture's behavior when resizing the node's bounding rectangle. See .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_theme.rst b/classes/class_theme.rst index e4540977e41..12a38369b00 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -197,7 +197,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DataType**: +enum **DataType**: :ref:`🔗` .. _class_Theme_constant_DATA_TYPE_COLOR: @@ -268,7 +268,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **default_base_scale** = ``0.0`` +:ref:`float` **default_base_scale** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -287,7 +287,7 @@ Use :ref:`has_default_base_scale` to .. rst-class:: classref-property -:ref:`Font` **default_font** +:ref:`Font` **default_font** :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +306,7 @@ Use :ref:`has_default_font` to check if thi .. rst-class:: classref-property -:ref:`int` **default_font_size** = ``-1`` +:ref:`int` **default_font_size** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -330,7 +330,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_type**\ (\ theme_type\: :ref:`StringName`\ ) +|void| **add_type**\ (\ theme_type\: :ref:`StringName`\ ) :ref:`🔗` Adds an empty theme type for every valid data type. @@ -344,7 +344,7 @@ Adds an empty theme type for every valid data type. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Removes all the theme properties defined on the theme resource. @@ -356,7 +356,7 @@ Removes all the theme properties defined on the theme resource. .. rst-class:: classref-method -|void| **clear_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **clear_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the :ref:`Color` property defined by ``name`` and ``theme_type``, if it exists. @@ -370,7 +370,7 @@ Fails if it doesn't exist. Use :ref:`has_color` to .. rst-class:: classref-method -|void| **clear_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **clear_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the constant property defined by ``name`` and ``theme_type``, if it exists. @@ -384,7 +384,7 @@ Fails if it doesn't exist. Use :ref:`has_constant`, theme_type\: :ref:`StringName`\ ) +|void| **clear_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the :ref:`Font` property defined by ``name`` and ``theme_type``, if it exists. @@ -398,7 +398,7 @@ Fails if it doesn't exist. Use :ref:`has_font` to c .. rst-class:: classref-method -|void| **clear_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **clear_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the font size property defined by ``name`` and ``theme_type``, if it exists. @@ -412,7 +412,7 @@ Fails if it doesn't exist. Use :ref:`has_font_size`, theme_type\: :ref:`StringName`\ ) +|void| **clear_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the icon property defined by ``name`` and ``theme_type``, if it exists. @@ -426,7 +426,7 @@ Fails if it doesn't exist. Use :ref:`has_icon` to c .. rst-class:: classref-method -|void| **clear_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **clear_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the :ref:`StyleBox` property defined by ``name`` and ``theme_type``, if it exists. @@ -440,7 +440,7 @@ Fails if it doesn't exist. Use :ref:`has_stylebox`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **clear_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the theme property of ``data_type`` defined by ``name`` and ``theme_type``, if it exists. @@ -456,7 +456,7 @@ Fails if it doesn't exist. Use :ref:`has_theme_item`\ ) +|void| **clear_type_variation**\ (\ theme_type\: :ref:`StringName`\ ) :ref:`🔗` Unmarks ``theme_type`` as being a variation of another theme type. See :ref:`set_type_variation`. @@ -468,7 +468,7 @@ Unmarks ``theme_type`` as being a variation of another theme type. See :ref:`set .. rst-class:: classref-method -:ref:`Color` **get_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`Color` **get_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`Color` property defined by ``name`` and ``theme_type``, if it exists. @@ -482,7 +482,7 @@ Returns the default color value if the property doesn't exist. Use :ref:`has_col .. rst-class:: classref-method -:ref:`PackedStringArray` **get_color_list**\ (\ theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_color_list**\ (\ theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for :ref:`Color` properties defined with ``theme_type``. Use :ref:`get_color_type_list` to get a list of possible theme type names. @@ -494,7 +494,7 @@ Returns a list of names for :ref:`Color` properties defined with `` .. rst-class:: classref-method -:ref:`PackedStringArray` **get_color_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_color_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for :ref:`Color` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -506,7 +506,7 @@ Returns a list of all unique theme type names for :ref:`Color` prop .. rst-class:: classref-method -:ref:`int` **get_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`int` **get_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the constant property defined by ``name`` and ``theme_type``, if it exists. @@ -520,7 +520,7 @@ Returns ``0`` if the property doesn't exist. Use :ref:`has_constant` **get_constant_list**\ (\ theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_constant_list**\ (\ theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for constant properties defined with ``theme_type``. Use :ref:`get_constant_type_list` to get a list of possible theme type names. @@ -532,7 +532,7 @@ Returns a list of names for constant properties defined with ``theme_type``. Use .. rst-class:: classref-method -:ref:`PackedStringArray` **get_constant_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_constant_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for constant properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -544,7 +544,7 @@ Returns a list of all unique theme type names for constant properties. Use :ref: .. rst-class:: classref-method -:ref:`Font` **get_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`Font` **get_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`Font` property defined by ``name`` and ``theme_type``, if it exists. @@ -560,7 +560,7 @@ Returns the engine fallback font value, if neither exist (see :ref:`ThemeDB.fall .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_list**\ (\ theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_font_list**\ (\ theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for :ref:`Font` properties defined with ``theme_type``. Use :ref:`get_font_type_list` to get a list of possible theme type names. @@ -572,7 +572,7 @@ Returns a list of names for :ref:`Font` properties defined with ``th .. rst-class:: classref-method -:ref:`int` **get_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`int` **get_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the font size property defined by ``name`` and ``theme_type``, if it exists. @@ -588,7 +588,7 @@ Returns the engine fallback font size value, if neither exist (see :ref:`ThemeDB .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_size_list**\ (\ theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_font_size_list**\ (\ theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for font size properties defined with ``theme_type``. Use :ref:`get_font_size_type_list` to get a list of possible theme type names. @@ -600,7 +600,7 @@ Returns a list of names for font size properties defined with ``theme_type``. Us .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_size_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_font_size_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for font size properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -612,7 +612,7 @@ Returns a list of all unique theme type names for font size properties. Use :ref .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_font_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for :ref:`Font` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -624,7 +624,7 @@ Returns a list of all unique theme type names for :ref:`Font` proper .. rst-class:: classref-method -:ref:`Texture2D` **get_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`Texture2D` **get_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the icon property defined by ``name`` and ``theme_type``, if it exists. @@ -638,7 +638,7 @@ Returns the engine fallback icon value if the property doesn't exist (see :ref:` .. rst-class:: classref-method -:ref:`PackedStringArray` **get_icon_list**\ (\ theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_icon_list**\ (\ theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for icon properties defined with ``theme_type``. Use :ref:`get_icon_type_list` to get a list of possible theme type names. @@ -650,7 +650,7 @@ Returns a list of names for icon properties defined with ``theme_type``. Use :re .. rst-class:: classref-method -:ref:`PackedStringArray` **get_icon_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_icon_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for icon properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -662,7 +662,7 @@ Returns a list of all unique theme type names for icon properties. Use :ref:`get .. rst-class:: classref-method -:ref:`StyleBox` **get_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`StyleBox` **get_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`StyleBox` property defined by ``name`` and ``theme_type``, if it exists. @@ -676,7 +676,7 @@ Returns the engine fallback stylebox value if the property doesn't exist (see :r .. rst-class:: classref-method -:ref:`PackedStringArray` **get_stylebox_list**\ (\ theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_stylebox_list**\ (\ theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for :ref:`StyleBox` properties defined with ``theme_type``. Use :ref:`get_stylebox_type_list` to get a list of possible theme type names. @@ -688,7 +688,7 @@ Returns a list of names for :ref:`StyleBox` properties defined w .. rst-class:: classref-method -:ref:`PackedStringArray` **get_stylebox_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_stylebox_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for :ref:`StyleBox` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -700,7 +700,7 @@ Returns a list of all unique theme type names for :ref:`StyleBox .. rst-class:: classref-method -:ref:`Variant` **get_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the theme property of ``data_type`` defined by ``name`` and ``theme_type``, if it exists. @@ -716,7 +716,7 @@ Returns the engine fallback value if the property doesn't exist (see :ref:`Theme .. rst-class:: classref-method -:ref:`PackedStringArray` **get_theme_item_list**\ (\ data_type\: :ref:`DataType`, theme_type\: :ref:`String`\ ) |const| +:ref:`PackedStringArray` **get_theme_item_list**\ (\ data_type\: :ref:`DataType`, theme_type\: :ref:`String`\ ) |const| :ref:`🔗` Returns a list of names for properties of ``data_type`` defined with ``theme_type``. Use :ref:`get_theme_item_type_list` to get a list of possible theme type names. @@ -730,7 +730,7 @@ Returns a list of names for properties of ``data_type`` defined with ``theme_typ .. rst-class:: classref-method -:ref:`PackedStringArray` **get_theme_item_type_list**\ (\ data_type\: :ref:`DataType`\ ) |const| +:ref:`PackedStringArray` **get_theme_item_type_list**\ (\ data_type\: :ref:`DataType`\ ) |const| :ref:`🔗` Returns a list of all unique theme type names for ``data_type`` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -744,7 +744,7 @@ Returns a list of all unique theme type names for ``data_type`` properties. Use .. rst-class:: classref-method -:ref:`PackedStringArray` **get_type_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_type_list**\ (\ ) |const| :ref:`🔗` Returns a list of all unique theme type names. Use the appropriate ``get_*_type_list`` method to get a list of unique theme types for a single data type. @@ -756,7 +756,7 @@ Returns a list of all unique theme type names. Use the appropriate ``get_*_type_ .. rst-class:: classref-method -:ref:`StringName` **get_type_variation_base**\ (\ theme_type\: :ref:`StringName`\ ) |const| +:ref:`StringName` **get_type_variation_base**\ (\ theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the name of the base theme type if ``theme_type`` is a valid variation type. Returns an empty string otherwise. @@ -768,7 +768,7 @@ Returns the name of the base theme type if ``theme_type`` is a valid variation t .. rst-class:: classref-method -:ref:`PackedStringArray` **get_type_variation_list**\ (\ base_type\: :ref:`StringName`\ ) |const| +:ref:`PackedStringArray` **get_type_variation_list**\ (\ base_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a list of all type variations for the given ``base_type``. @@ -780,7 +780,7 @@ Returns a list of all type variations for the given ``base_type``. .. rst-class:: classref-method -:ref:`bool` **has_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`Color` property defined by ``name`` and ``theme_type`` exists. @@ -794,7 +794,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_color` **has_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the constant property defined by ``name`` and ``theme_type`` exists. @@ -808,7 +808,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_constant` **has_default_base_scale**\ (\ ) |const| +:ref:`bool` **has_default_base_scale**\ (\ ) |const| :ref:`🔗` Returns ``true`` if :ref:`default_base_scale` has a valid value. @@ -822,7 +822,7 @@ Returns ``false`` if it doesn't. The value must be greater than ``0.0`` to be co .. rst-class:: classref-method -:ref:`bool` **has_default_font**\ (\ ) |const| +:ref:`bool` **has_default_font**\ (\ ) |const| :ref:`🔗` Returns ``true`` if :ref:`default_font` has a valid value. @@ -836,7 +836,7 @@ Returns ``false`` if it doesn't. .. rst-class:: classref-method -:ref:`bool` **has_default_font_size**\ (\ ) |const| +:ref:`bool` **has_default_font_size**\ (\ ) |const| :ref:`🔗` Returns ``true`` if :ref:`default_font_size` has a valid value. @@ -850,7 +850,7 @@ Returns ``false`` if it doesn't. The value must be greater than ``0`` to be cons .. rst-class:: classref-method -:ref:`bool` **has_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`Font` property defined by ``name`` and ``theme_type`` exists, or if the default theme font is set up (see :ref:`has_default_font`). @@ -864,7 +864,7 @@ Returns ``false`` if neither exist. Use :ref:`set_font` **has_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the font size property defined by ``name`` and ``theme_type`` exists, or if the default theme font size is set up (see :ref:`has_default_font_size`). @@ -878,7 +878,7 @@ Returns ``false`` if neither exist. Use :ref:`set_font_size` **has_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the icon property defined by ``name`` and ``theme_type`` exists. @@ -892,7 +892,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_icon` **has_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`StyleBox` property defined by ``name`` and ``theme_type`` exists. @@ -906,7 +906,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_stylebox` **has_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the theme property of ``data_type`` defined by ``name`` and ``theme_type`` exists. @@ -922,7 +922,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_theme_item` **is_type_variation**\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_type_variation**\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if ``theme_type`` is marked as a variation of ``base_type``. @@ -934,7 +934,7 @@ Returns ``true`` if ``theme_type`` is marked as a variation of ``base_type``. .. rst-class:: classref-method -|void| **merge_with**\ (\ other\: :ref:`Theme`\ ) +|void| **merge_with**\ (\ other\: :ref:`Theme`\ ) :ref:`🔗` Adds missing and overrides existing definitions with values from the ``other`` theme resource. @@ -948,7 +948,7 @@ Adds missing and overrides existing definitions with values from the ``other`` t .. rst-class:: classref-method -|void| **remove_type**\ (\ theme_type\: :ref:`StringName`\ ) +|void| **remove_type**\ (\ theme_type\: :ref:`StringName`\ ) :ref:`🔗` Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base. @@ -960,7 +960,7 @@ Removes the theme type, gracefully discarding defined theme items. If the type i .. rst-class:: classref-method -|void| **rename_color**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_color**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the :ref:`Color` property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -974,7 +974,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **rename_constant**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_constant**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the constant property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -988,7 +988,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **rename_font**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_font**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the :ref:`Font` property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1002,7 +1002,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **rename_font_size**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_font_size**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the font size property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1016,7 +1016,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **rename_icon**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_icon**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the icon property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1030,7 +1030,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **rename_stylebox**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_stylebox**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the :ref:`StyleBox` property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1044,7 +1044,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **rename_theme_item**\ (\ data_type\: :ref:`DataType`, old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) +|void| **rename_theme_item**\ (\ data_type\: :ref:`DataType`, old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) :ref:`🔗` Renames the theme property of ``data_type`` defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1060,7 +1060,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -|void| **set_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, color\: :ref:`Color`\ ) +|void| **set_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, color\: :ref:`Color`\ ) :ref:`🔗` Creates or changes the value of the :ref:`Color` property defined by ``name`` and ``theme_type``. Use :ref:`clear_color` to remove the property. @@ -1072,7 +1072,7 @@ Creates or changes the value of the :ref:`Color` property defined b .. rst-class:: classref-method -|void| **set_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, constant\: :ref:`int`\ ) +|void| **set_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, constant\: :ref:`int`\ ) :ref:`🔗` Creates or changes the value of the constant property defined by ``name`` and ``theme_type``. Use :ref:`clear_constant` to remove the property. @@ -1084,7 +1084,7 @@ Creates or changes the value of the constant property defined by ``name`` and `` .. rst-class:: classref-method -|void| **set_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font\: :ref:`Font`\ ) +|void| **set_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font\: :ref:`Font`\ ) :ref:`🔗` Creates or changes the value of the :ref:`Font` property defined by ``name`` and ``theme_type``. Use :ref:`clear_font` to remove the property. @@ -1096,7 +1096,7 @@ Creates or changes the value of the :ref:`Font` property defined by .. rst-class:: classref-method -|void| **set_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font_size\: :ref:`int`\ ) +|void| **set_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font_size\: :ref:`int`\ ) :ref:`🔗` Creates or changes the value of the font size property defined by ``name`` and ``theme_type``. Use :ref:`clear_font_size` to remove the property. @@ -1108,7 +1108,7 @@ Creates or changes the value of the font size property defined by ``name`` and ` .. rst-class:: classref-method -|void| **set_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) +|void| **set_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Creates or changes the value of the icon property defined by ``name`` and ``theme_type``. Use :ref:`clear_icon` to remove the property. @@ -1120,7 +1120,7 @@ Creates or changes the value of the icon property defined by ``name`` and ``them .. rst-class:: classref-method -|void| **set_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`StyleBox`\ ) +|void| **set_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`StyleBox`\ ) :ref:`🔗` Creates or changes the value of the :ref:`StyleBox` property defined by ``name`` and ``theme_type``. Use :ref:`clear_stylebox` to remove the property. @@ -1132,7 +1132,7 @@ Creates or changes the value of the :ref:`StyleBox` property def .. rst-class:: classref-method -|void| **set_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Creates or changes the value of the theme property of ``data_type`` defined by ``name`` and ``theme_type``. Use :ref:`clear_theme_item` to remove the property. @@ -1148,7 +1148,7 @@ Fails if the ``value`` type is not accepted by ``data_type``. .. rst-class:: classref-method -|void| **set_type_variation**\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) +|void| **set_type_variation**\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) :ref:`🔗` Marks ``theme_type`` as a variation of ``base_type``. diff --git a/classes/class_themedb.rst b/classes/class_themedb.rst index 94da2332ccb..6e7785380bc 100644 --- a/classes/class_themedb.rst +++ b/classes/class_themedb.rst @@ -70,7 +70,7 @@ Signals .. rst-class:: classref-signal -**fallback_changed**\ (\ ) +**fallback_changed**\ (\ ) :ref:`🔗` Emitted when one of the fallback values had been changed. Use it to refresh the look of controls that may rely on the fallback theme items. @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **fallback_base_scale** = ``1.0`` +:ref:`float` **fallback_base_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -106,7 +106,7 @@ See also :ref:`Theme.default_base_scale .. rst-class:: classref-property -:ref:`Font` **fallback_font** +:ref:`Font` **fallback_font** :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ See also :ref:`Theme.default_font`. .. rst-class:: classref-property -:ref:`int` **fallback_font_size** = ``16`` +:ref:`int` **fallback_font_size** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ See also :ref:`Theme.default_font_size`. .. rst-class:: classref-property -:ref:`Texture2D` **fallback_icon** +:ref:`Texture2D` **fallback_icon** :ref:`🔗` .. rst-class:: classref-property-setget @@ -161,7 +161,7 @@ The fallback icon of every :ref:`Control` node and :ref:`Theme` **fallback_stylebox** +:ref:`StyleBox` **fallback_stylebox** :ref:`🔗` .. rst-class:: classref-property-setget @@ -183,7 +183,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Theme` **get_default_theme**\ (\ ) +:ref:`Theme` **get_default_theme**\ (\ ) :ref:`🔗` Returns a reference to the default engine :ref:`Theme`. This theme resource is responsible for the out-of-the-box look of :ref:`Control` nodes and cannot be overridden. @@ -195,7 +195,7 @@ Returns a reference to the default engine :ref:`Theme`. This theme .. rst-class:: classref-method -:ref:`Theme` **get_project_theme**\ (\ ) +:ref:`Theme` **get_project_theme**\ (\ ) :ref:`🔗` Returns a reference to the custom project :ref:`Theme`. This theme resources allows to override the default engine theme for every control node in the project. diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 4a99c43a32f..d8937d4689e 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -77,7 +77,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Priority**: +enum **Priority**: :ref:`🔗` .. _class_Thread_constant_PRIORITY_LOW: @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_id**\ (\ ) |const| +:ref:`String` **get_id**\ (\ ) |const| :ref:`🔗` Returns the current **Thread**'s ID, uniquely identifying it among all threads. If the **Thread** has not started running or if :ref:`wait_to_finish` has been called, this returns an empty string. @@ -128,7 +128,7 @@ Returns the current **Thread**'s ID, uniquely identifying it among all threads. .. rst-class:: classref-method -:ref:`bool` **is_alive**\ (\ ) |const| +:ref:`bool` **is_alive**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Thread** is currently running the provided function. This is useful for determining if :ref:`wait_to_finish` can be called without blocking the calling thread. @@ -142,7 +142,7 @@ To check if a **Thread** is joinable, use :ref:`is_started` **is_started**\ (\ ) |const| +:ref:`bool` **is_started**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this **Thread** has been started. Once started, this will return ``true`` until it is joined using :ref:`wait_to_finish`. For checking if a **Thread** is still executing its task, use :ref:`is_alive`. @@ -154,7 +154,7 @@ Returns ``true`` if this **Thread** has been started. Once started, this will re .. rst-class:: classref-method -|void| **set_thread_safety_checks_enabled**\ (\ enabled\: :ref:`bool`\ ) |static| +|void| **set_thread_safety_checks_enabled**\ (\ enabled\: :ref:`bool`\ ) |static| :ref:`🔗` Sets whether the thread safety checks the engine normally performs in methods of certain classes (e.g., :ref:`Node`) should happen **on the current thread**. @@ -178,7 +178,7 @@ Because of that, there may be cases where the user may want to disable them (``e .. rst-class:: classref-method -:ref:`Error` **start**\ (\ callable\: :ref:`Callable`, priority\: :ref:`Priority` = 1\ ) +:ref:`Error` **start**\ (\ callable\: :ref:`Callable`, priority\: :ref:`Priority` = 1\ ) :ref:`🔗` Starts a new **Thread** that calls ``callable``. @@ -196,7 +196,7 @@ Returns :ref:`@GlobalScope.OK` on success, or :r .. rst-class:: classref-method -:ref:`Variant` **wait_to_finish**\ (\ ) +:ref:`Variant` **wait_to_finish**\ (\ ) :ref:`🔗` Joins the **Thread** and waits for it to finish. Returns the output of the :ref:`Callable` passed to :ref:`start`. diff --git a/classes/class_tiledata.rst b/classes/class_tiledata.rst index f476383f76b..ff0db80faff 100644 --- a/classes/class_tiledata.rst +++ b/classes/class_tiledata.rst @@ -126,7 +126,7 @@ Signals .. rst-class:: classref-signal -**changed**\ (\ ) +**changed**\ (\ ) :ref:`🔗` Emitted when any of the properties are changed. @@ -143,7 +143,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **flip_h** = ``false`` +:ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -160,7 +160,7 @@ If ``true``, the tile will have its texture flipped horizontally. .. rst-class:: classref-property -:ref:`bool` **flip_v** = ``false`` +:ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -177,7 +177,7 @@ If ``true``, the tile will have its texture flipped vertically. .. rst-class:: classref-property -:ref:`Material` **material** +:ref:`Material` **material** :ref:`🔗` .. rst-class:: classref-property-setget @@ -194,7 +194,7 @@ The :ref:`Material` to use for this **TileData**. This can be a .. rst-class:: classref-property -:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -211,7 +211,7 @@ Color modulation of the tile. .. rst-class:: classref-property -:ref:`float` **probability** = ``1.0`` +:ref:`float` **probability** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -228,7 +228,7 @@ Relative probability of this tile being selected when drawing a pattern of rando .. rst-class:: classref-property -:ref:`int` **terrain** = ``-1`` +:ref:`int` **terrain** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -245,7 +245,7 @@ ID of the terrain from the terrain set that the tile uses. .. rst-class:: classref-property -:ref:`int` **terrain_set** = ``-1`` +:ref:`int` **terrain_set** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -262,7 +262,7 @@ ID of the terrain set that the tile uses. .. rst-class:: classref-property -:ref:`Vector2i` **texture_origin** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **texture_origin** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -279,7 +279,7 @@ Offsets the position of where the tile is drawn. .. rst-class:: classref-property -:ref:`bool` **transpose** = ``false`` +:ref:`bool` **transpose** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -296,7 +296,7 @@ If ``true``, the tile will display transposed, i.e. with horizontal and vertical .. rst-class:: classref-property -:ref:`int` **y_sort_origin** = ``0`` +:ref:`int` **y_sort_origin** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -313,7 +313,7 @@ Vertical point of the tile used for determining y-sorted order. .. rst-class:: classref-property -:ref:`int` **z_index** = ``0`` +:ref:`int` **z_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -335,7 +335,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_collision_polygon**\ (\ layer_id\: :ref:`int`\ ) +|void| **add_collision_polygon**\ (\ layer_id\: :ref:`int`\ ) :ref:`🔗` Adds a collision polygon to the tile on the given TileSet physics layer. @@ -347,7 +347,7 @@ Adds a collision polygon to the tile on the given TileSet physics layer. .. rst-class:: classref-method -:ref:`float` **get_collision_polygon_one_way_margin**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| +:ref:`float` **get_collision_polygon_one_way_margin**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the one-way margin (for one-way platforms) of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -359,7 +359,7 @@ Returns the one-way margin (for one-way platforms) of the polygon at index ``pol .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_collision_polygon_points**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| +:ref:`PackedVector2Array` **get_collision_polygon_points**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the points of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -371,7 +371,7 @@ Returns the points of the polygon at index ``polygon_index`` for TileSet physics .. rst-class:: classref-method -:ref:`int` **get_collision_polygons_count**\ (\ layer_id\: :ref:`int`\ ) |const| +:ref:`int` **get_collision_polygons_count**\ (\ layer_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns how many polygons the tile has for TileSet physics layer with index ``layer_id``. @@ -383,7 +383,7 @@ Returns how many polygons the tile has for TileSet physics layer with index ``la .. rst-class:: classref-method -:ref:`float` **get_constant_angular_velocity**\ (\ layer_id\: :ref:`int`\ ) |const| +:ref:`float` **get_constant_angular_velocity**\ (\ layer_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the constant angular velocity applied to objects colliding with this tile. @@ -395,7 +395,7 @@ Returns the constant angular velocity applied to objects colliding with this til .. rst-class:: classref-method -:ref:`Vector2` **get_constant_linear_velocity**\ (\ layer_id\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_constant_linear_velocity**\ (\ layer_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the constant linear velocity applied to objects colliding with this tile. @@ -407,7 +407,7 @@ Returns the constant linear velocity applied to objects colliding with this tile .. rst-class:: classref-method -:ref:`Variant` **get_custom_data**\ (\ layer_name\: :ref:`String`\ ) |const| +:ref:`Variant` **get_custom_data**\ (\ layer_name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the custom data value for custom data layer named ``layer_name``. @@ -419,7 +419,7 @@ Returns the custom data value for custom data layer named ``layer_name``. .. rst-class:: classref-method -:ref:`Variant` **get_custom_data_by_layer_id**\ (\ layer_id\: :ref:`int`\ ) |const| +:ref:`Variant` **get_custom_data_by_layer_id**\ (\ layer_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom data value for custom data layer with index ``layer_id``. @@ -431,7 +431,7 @@ Returns the custom data value for custom data layer with index ``layer_id``. .. rst-class:: classref-method -:ref:`NavigationPolygon` **get_navigation_polygon**\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| +:ref:`NavigationPolygon` **get_navigation_polygon**\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the navigation polygon of the tile for the TileSet navigation layer with index ``layer_id``. @@ -445,7 +445,7 @@ Returns the navigation polygon of the tile for the TileSet navigation layer with .. rst-class:: classref-method -:ref:`OccluderPolygon2D` **get_occluder**\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| +:ref:`OccluderPolygon2D` **get_occluder**\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the occluder polygon of the tile for the TileSet occlusion layer with index ``layer_id``. @@ -459,7 +459,7 @@ Returns the occluder polygon of the tile for the TileSet occlusion layer with in .. rst-class:: classref-method -:ref:`int` **get_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`\ ) |const| +:ref:`int` **get_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`\ ) |const| :ref:`🔗` Returns the tile's terrain bit for the given ``peering_bit`` direction. To check that a direction is valid, use :ref:`is_valid_terrain_peering_bit`. @@ -471,7 +471,7 @@ Returns the tile's terrain bit for the given ``peering_bit`` direction. To check .. rst-class:: classref-method -:ref:`bool` **is_collision_polygon_one_way**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| +:ref:`bool` **is_collision_polygon_one_way**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether one-way collisions are enabled for the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -483,7 +483,7 @@ Returns whether one-way collisions are enabled for the polygon at index ``polygo .. rst-class:: classref-method -:ref:`bool` **is_valid_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`\ ) |const| +:ref:`bool` **is_valid_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`\ ) |const| :ref:`🔗` Returns whether the given ``peering_bit`` direction is valid for this tile. @@ -495,7 +495,7 @@ Returns whether the given ``peering_bit`` direction is valid for this tile. .. rst-class:: classref-method -|void| **remove_collision_polygon**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) +|void| **remove_collision_polygon**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) :ref:`🔗` Removes the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -507,7 +507,7 @@ Removes the polygon at index ``polygon_index`` for TileSet physics layer with in .. rst-class:: classref-method -|void| **set_collision_polygon_one_way**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way\: :ref:`bool`\ ) +|void| **set_collision_polygon_one_way**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way\: :ref:`bool`\ ) :ref:`🔗` Enables/disables one-way collisions on the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -519,7 +519,7 @@ Enables/disables one-way collisions on the polygon at index ``polygon_index`` fo .. rst-class:: classref-method -|void| **set_collision_polygon_one_way_margin**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way_margin\: :ref:`float`\ ) +|void| **set_collision_polygon_one_way_margin**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way_margin\: :ref:`float`\ ) :ref:`🔗` Enables/disables one-way collisions on the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -531,7 +531,7 @@ Enables/disables one-way collisions on the polygon at index ``polygon_index`` fo .. rst-class:: classref-method -|void| **set_collision_polygon_points**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, polygon\: :ref:`PackedVector2Array`\ ) +|void| **set_collision_polygon_points**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, polygon\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Sets the points of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -543,7 +543,7 @@ Sets the points of the polygon at index ``polygon_index`` for TileSet physics la .. rst-class:: classref-method -|void| **set_collision_polygons_count**\ (\ layer_id\: :ref:`int`, polygons_count\: :ref:`int`\ ) +|void| **set_collision_polygons_count**\ (\ layer_id\: :ref:`int`, polygons_count\: :ref:`int`\ ) :ref:`🔗` Sets the polygons count for TileSet physics layer with index ``layer_id``. @@ -555,7 +555,7 @@ Sets the polygons count for TileSet physics layer with index ``layer_id``. .. rst-class:: classref-method -|void| **set_constant_angular_velocity**\ (\ layer_id\: :ref:`int`, velocity\: :ref:`float`\ ) +|void| **set_constant_angular_velocity**\ (\ layer_id\: :ref:`int`, velocity\: :ref:`float`\ ) :ref:`🔗` Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile. @@ -567,7 +567,7 @@ Sets the constant angular velocity. This does not rotate the tile. This angular .. rst-class:: classref-method -|void| **set_constant_linear_velocity**\ (\ layer_id\: :ref:`int`, velocity\: :ref:`Vector2`\ ) +|void| **set_constant_linear_velocity**\ (\ layer_id\: :ref:`int`, velocity\: :ref:`Vector2`\ ) :ref:`🔗` Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts. @@ -579,7 +579,7 @@ Sets the constant linear velocity. This does not move the tile. This linear velo .. rst-class:: classref-method -|void| **set_custom_data**\ (\ layer_name\: :ref:`String`, value\: :ref:`Variant`\ ) +|void| **set_custom_data**\ (\ layer_name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the tile's custom data value for the TileSet custom data layer with name ``layer_name``. @@ -591,7 +591,7 @@ Sets the tile's custom data value for the TileSet custom data layer with name `` .. rst-class:: classref-method -|void| **set_custom_data_by_layer_id**\ (\ layer_id\: :ref:`int`, value\: :ref:`Variant`\ ) +|void| **set_custom_data_by_layer_id**\ (\ layer_id\: :ref:`int`, value\: :ref:`Variant`\ ) :ref:`🔗` Sets the tile's custom data value for the TileSet custom data layer with index ``layer_id``. @@ -603,7 +603,7 @@ Sets the tile's custom data value for the TileSet custom data layer with index ` .. rst-class:: classref-method -|void| **set_navigation_polygon**\ (\ layer_id\: :ref:`int`, navigation_polygon\: :ref:`NavigationPolygon`\ ) +|void| **set_navigation_polygon**\ (\ layer_id\: :ref:`int`, navigation_polygon\: :ref:`NavigationPolygon`\ ) :ref:`🔗` Sets the navigation polygon for the TileSet navigation layer with index ``layer_id``. @@ -615,7 +615,7 @@ Sets the navigation polygon for the TileSet navigation layer with index ``layer_ .. rst-class:: classref-method -|void| **set_occluder**\ (\ layer_id\: :ref:`int`, occluder_polygon\: :ref:`OccluderPolygon2D`\ ) +|void| **set_occluder**\ (\ layer_id\: :ref:`int`, occluder_polygon\: :ref:`OccluderPolygon2D`\ ) :ref:`🔗` Sets the occluder for the TileSet occlusion layer with index ``layer_id``. @@ -627,7 +627,7 @@ Sets the occluder for the TileSet occlusion layer with index ``layer_id``. .. rst-class:: classref-method -|void| **set_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`, terrain\: :ref:`int`\ ) +|void| **set_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`, terrain\: :ref:`int`\ ) :ref:`🔗` Sets the tile's terrain bit for the given ``peering_bit`` direction. To check that a direction is valid, use :ref:`is_valid_terrain_peering_bit`. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 759f3bccdd7..3fb76661e5a 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -192,7 +192,7 @@ Signals .. rst-class:: classref-signal -**changed**\ (\ ) +**changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`TileSet` of this TileMap changes. @@ -209,7 +209,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **VisibilityMode**: +enum **VisibilityMode**: :ref:`🔗` .. _class_TileMap_constant_VISIBILITY_MODE_DEFAULT: @@ -248,7 +248,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collision_animatable** = ``false`` +:ref:`bool` **collision_animatable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -267,7 +267,7 @@ If enabled, the TileMap will see its collisions synced to the physics tick and c .. rst-class:: classref-property -:ref:`VisibilityMode` **collision_visibility_mode** = ``0`` +:ref:`VisibilityMode` **collision_visibility_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -284,7 +284,7 @@ Show or hide the TileMap's collision shapes. If set to :ref:`VISIBILITY_MODE_DEF .. rst-class:: classref-property -:ref:`VisibilityMode` **navigation_visibility_mode** = ``0`` +:ref:`VisibilityMode` **navigation_visibility_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -301,7 +301,7 @@ Show or hide the TileMap's navigation meshes. If set to :ref:`VISIBILITY_MODE_DE .. rst-class:: classref-property -:ref:`int` **rendering_quadrant_size** = ``16`` +:ref:`int` **rendering_quadrant_size** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -322,7 +322,7 @@ The quadrant size does not apply on Y-sorted layers, as tiles are be grouped by .. rst-class:: classref-property -:ref:`TileSet` **tile_set** +:ref:`TileSet` **tile_set** :ref:`🔗` .. rst-class:: classref-property-setget @@ -344,7 +344,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_tile_data_runtime_update**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| +|void| **_tile_data_runtime_update**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| :ref:`🔗` Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime. @@ -362,7 +362,7 @@ This method is only called if :ref:`_use_tile_data_runtime_update` **_use_tile_data_runtime_update**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) |virtual| +:ref:`bool` **_use_tile_data_runtime_update**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` Should return ``true`` if the tile at coordinates ``coords`` on layer ``layer`` requires a runtime update. @@ -378,7 +378,7 @@ Should return ``true`` if the tile at coordinates ``coords`` on layer ``layer`` .. rst-class:: classref-method -|void| **add_layer**\ (\ to_position\: :ref:`int`\ ) +|void| **add_layer**\ (\ to_position\: :ref:`int`\ ) :ref:`🔗` Adds a layer at the given position ``to_position`` in the array. If ``to_position`` is negative, the position is counted from the end, with ``-1`` adding the layer at the end of the array. @@ -390,7 +390,7 @@ Adds a layer at the given position ``to_position`` in the array. If ``to_positio .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears all cells. @@ -402,7 +402,7 @@ Clears all cells. .. rst-class:: classref-method -|void| **clear_layer**\ (\ layer\: :ref:`int`\ ) +|void| **clear_layer**\ (\ layer\: :ref:`int`\ ) :ref:`🔗` Clears all cells on the given layer. @@ -416,7 +416,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **erase_cell**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) +|void| **erase_cell**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) :ref:`🔗` Erases the cell on layer ``layer`` at coordinates ``coords``. @@ -430,7 +430,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **fix_invalid_tiles**\ (\ ) +|void| **fix_invalid_tiles**\ (\ ) :ref:`🔗` Clears cells that do not exist in the tileset. @@ -442,7 +442,7 @@ Clears cells that do not exist in the tileset. .. rst-class:: classref-method -|void| **force_update**\ (\ layer\: :ref:`int` = -1\ ) +|void| **force_update**\ (\ layer\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Use :ref:`notify_runtime_tile_data_update` and/or :ref:`update_internals` instead. @@ -456,7 +456,7 @@ Forces the TileMap and the layer ``layer`` to update. .. rst-class:: classref-method -:ref:`int` **get_cell_alternative_tile**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_cell_alternative_tile**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the tile alternative ID of the cell on layer ``layer`` at ``coords``. @@ -472,7 +472,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Vector2i` **get_cell_atlas_coords**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| +:ref:`Vector2i` **get_cell_atlas_coords**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the tile atlas coordinates ID of the cell on layer ``layer`` at coordinates ``coords``. Returns ``Vector2i(-1, -1)`` if the cell does not exist. @@ -488,7 +488,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_cell_source_id**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| +:ref:`int` **get_cell_source_id**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the tile source ID of the cell on layer ``layer`` at coordinates ``coords``. Returns ``-1`` if the cell does not exist. @@ -504,7 +504,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`TileData` **get_cell_tile_data**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| +:ref:`TileData` **get_cell_tile_data**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the :ref:`TileData` object associated with the given cell, or ``null`` if the cell does not exist or is not a :ref:`TileSetAtlasSource`. @@ -530,7 +530,7 @@ If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s til .. rst-class:: classref-method -:ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) +:ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. @@ -542,7 +542,7 @@ Returns the coordinates of the tile for given physics body RID. Such RID can be .. rst-class:: classref-method -:ref:`int` **get_layer_for_body_rid**\ (\ body\: :ref:`RID`\ ) +:ref:`int` **get_layer_for_body_rid**\ (\ body\: :ref:`RID`\ ) :ref:`🔗` Returns the tilemap layer of the tile for given physics body RID. Such RID can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. @@ -554,7 +554,7 @@ Returns the tilemap layer of the tile for given physics body RID. Such RID can b .. rst-class:: classref-method -:ref:`Color` **get_layer_modulate**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`Color` **get_layer_modulate**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns a TileMap layer's modulate. @@ -568,7 +568,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`String` **get_layer_name**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`String` **get_layer_name**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns a TileMap layer's name. @@ -582,7 +582,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`RID` **get_layer_navigation_map**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`RID` **get_layer_navigation_map**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the :ref:`NavigationServer2D` navigation map assigned to the specified TileMap layer ``layer``. @@ -600,7 +600,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_layer_y_sort_origin**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`int` **get_layer_y_sort_origin**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns a TileMap layer's Y sort origin. @@ -614,7 +614,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_layer_z_index**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`int` **get_layer_z_index**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns a TileMap layer's Z-index value. @@ -628,7 +628,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_layers_count**\ (\ ) |const| +:ref:`int` **get_layers_count**\ (\ ) |const| :ref:`🔗` Returns the number of layers in the TileMap. @@ -640,7 +640,7 @@ Returns the number of layers in the TileMap. .. rst-class:: classref-method -:ref:`RID` **get_navigation_map**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`get_layer_navigation_map` instead. @@ -654,7 +654,7 @@ Returns the :ref:`RID` of the :ref:`NavigationServer2D` **get_neighbor_cell**\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| +:ref:`Vector2i` **get_neighbor_cell**\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| :ref:`🔗` Returns the neighboring cell to the one at coordinates ``coords``, identified by the ``neighbor`` direction. This method takes into account the different layouts a TileMap can take. @@ -666,7 +666,7 @@ Returns the neighboring cell to the one at coordinates ``coords``, identified by .. rst-class:: classref-method -:ref:`TileMapPattern` **get_pattern**\ (\ layer\: :ref:`int`, coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) +:ref:`TileMapPattern` **get_pattern**\ (\ layer\: :ref:`int`, coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) :ref:`🔗` Creates a new :ref:`TileMapPattern` from the given layer and set of cells. @@ -680,7 +680,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_surrounding_cells**\ (\ coords\: :ref:`Vector2i`\ ) +:ref:`Array`\[:ref:`Vector2i`\] **get_surrounding_cells**\ (\ coords\: :ref:`Vector2i`\ ) :ref:`🔗` Returns the list of all neighbourings cells to the one at ``coords``. @@ -692,7 +692,7 @@ Returns the list of all neighbourings cells to the one at ``coords``. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns a :ref:`Vector2i` array with the positions of all cells containing a tile in the given layer. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is ``Vector2(-1, -1)`` and its alternative identifier is -1. @@ -706,7 +706,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells_by_id**\ (\ layer\: :ref:`int`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells_by_id**\ (\ layer\: :ref:`int`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns a :ref:`Vector2i` array with the positions of all cells containing a tile in the given layer. Tiles may be filtered according to their source (``source_id``), their atlas coordinates (``atlas_coords``) or alternative id (``alternative_tile``). @@ -724,7 +724,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Rect2i` **get_used_rect**\ (\ ) |const| +:ref:`Rect2i` **get_used_rect**\ (\ ) |const| :ref:`🔗` Returns a rectangle enclosing the used (non-empty) tiles of the map, including all layers. @@ -736,7 +736,7 @@ Returns a rectangle enclosing the used (non-empty) tiles of the map, including a .. rst-class:: classref-method -:ref:`bool` **is_layer_enabled**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`bool` **is_layer_enabled**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns if a layer is enabled. @@ -750,7 +750,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`bool` **is_layer_navigation_enabled**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`bool` **is_layer_navigation_enabled**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns if a layer's built-in navigation regions generation is enabled. @@ -762,7 +762,7 @@ Returns if a layer's built-in navigation regions generation is enabled. .. rst-class:: classref-method -:ref:`bool` **is_layer_y_sort_enabled**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`bool` **is_layer_y_sort_enabled**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns if a layer Y-sorts its tiles. @@ -776,7 +776,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Vector2i` **local_to_map**\ (\ local_position\: :ref:`Vector2`\ ) |const| +:ref:`Vector2i` **local_to_map**\ (\ local_position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node2D.to_local` before passing it to this method. See also :ref:`map_to_local`. @@ -788,7 +788,7 @@ Returns the map coordinates of the cell containing the given ``local_position``. .. rst-class:: classref-method -:ref:`Vector2i` **map_pattern**\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) +:ref:`Vector2i` **map_pattern**\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) :ref:`🔗` Returns for the given coordinate ``coords_in_pattern`` in a :ref:`TileMapPattern` the corresponding cell coordinates if the pattern was pasted at the ``position_in_tilemap`` coordinates (see :ref:`set_pattern`). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating ``position_in_tile_map + coords_in_pattern``. @@ -800,7 +800,7 @@ Returns for the given coordinate ``coords_in_pattern`` in a :ref:`TileMapPattern .. rst-class:: classref-method -:ref:`Vector2` **map_to_local**\ (\ map_position\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2` **map_to_local**\ (\ map_position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the centered position of a cell in the TileMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node2D.to_global`. See also :ref:`local_to_map`. @@ -814,7 +814,7 @@ Returns the centered position of a cell in the TileMap's local coordinate space. .. rst-class:: classref-method -|void| **move_layer**\ (\ layer\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_layer**\ (\ layer\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the layer at index ``layer`` to the given position ``to_position`` in the array. @@ -826,7 +826,7 @@ Moves the layer at index ``layer`` to the given position ``to_position`` in the .. rst-class:: classref-method -|void| **notify_runtime_tile_data_update**\ (\ layer\: :ref:`int` = -1\ ) +|void| **notify_runtime_tile_data_update**\ (\ layer\: :ref:`int` = -1\ ) :ref:`🔗` Notifies the TileMap node that calls to :ref:`_use_tile_data_runtime_update` or :ref:`_tile_data_runtime_update` will lead to different results. This will thus trigger a TileMap update. @@ -844,7 +844,7 @@ If ``layer`` is provided, only notifies changes for the given layer. Providing t .. rst-class:: classref-method -|void| **remove_layer**\ (\ layer\: :ref:`int`\ ) +|void| **remove_layer**\ (\ layer\: :ref:`int`\ ) :ref:`🔗` Removes the layer at index ``layer``. @@ -856,7 +856,7 @@ Removes the layer at index ``layer``. .. rst-class:: classref-method -|void| **set_cell**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) +|void| **set_cell**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) :ref:`🔗` Sets the tile identifiers for the cell on layer ``layer`` at coordinates ``coords``. Each tile of the :ref:`TileSet` is identified using three parts: @@ -878,7 +878,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_cells_terrain_connect**\ (\ layer\: :ref:`int`, cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) +|void| **set_cells_terrain_connect**\ (\ layer\: :ref:`int`, cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) :ref:`🔗` Update all the cells in the ``cells`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. @@ -896,7 +896,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_cells_terrain_path**\ (\ layer\: :ref:`int`, path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) +|void| **set_cells_terrain_path**\ (\ layer\: :ref:`int`, path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) :ref:`🔗` Update all the cells in the ``path`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. @@ -914,7 +914,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_enabled**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) +|void| **set_layer_enabled**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables the layer ``layer``. A disabled layer is not processed at all (no rendering, no physics, etc.). @@ -928,7 +928,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_modulate**\ (\ layer\: :ref:`int`, modulate\: :ref:`Color`\ ) +|void| **set_layer_modulate**\ (\ layer\: :ref:`int`, modulate\: :ref:`Color`\ ) :ref:`🔗` Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. @@ -942,7 +942,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_name**\ (\ layer\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_layer_name**\ (\ layer\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets a layer's name. This is mostly useful in the editor. @@ -956,7 +956,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_navigation_enabled**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) +|void| **set_layer_navigation_enabled**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables a layer's built-in navigation regions generation. Disable this if you need to bake navigation regions from a TileMap using a :ref:`NavigationRegion2D` node. @@ -968,7 +968,7 @@ Enables or disables a layer's built-in navigation regions generation. Disable th .. rst-class:: classref-method -|void| **set_layer_navigation_map**\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) +|void| **set_layer_navigation_map**\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) :ref:`🔗` Assigns ``map`` as a :ref:`NavigationServer2D` navigation map for the specified TileMap layer ``layer``. @@ -986,7 +986,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_y_sort_enabled**\ (\ layer\: :ref:`int`, y_sort_enabled\: :ref:`bool`\ ) +|void| **set_layer_y_sort_enabled**\ (\ layer\: :ref:`int`, y_sort_enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables a layer's Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted. @@ -1002,7 +1002,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_y_sort_origin**\ (\ layer\: :ref:`int`, y_sort_origin\: :ref:`int`\ ) +|void| **set_layer_y_sort_origin**\ (\ layer\: :ref:`int`, y_sort_origin\: :ref:`int`\ ) :ref:`🔗` Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value. @@ -1018,7 +1018,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_layer_z_index**\ (\ layer\: :ref:`int`, z_index\: :ref:`int`\ ) +|void| **set_layer_z_index**\ (\ layer\: :ref:`int`, z_index\: :ref:`int`\ ) :ref:`🔗` Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. @@ -1032,7 +1032,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) :ref:`🔗` **Deprecated:** Use :ref:`set_layer_navigation_map` instead. @@ -1046,7 +1046,7 @@ Assigns ``map`` as a :ref:`NavigationServer2D` navigat .. rst-class:: classref-method -|void| **set_pattern**\ (\ layer\: :ref:`int`, position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) +|void| **set_pattern**\ (\ layer\: :ref:`int`, position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) :ref:`🔗` Paste the given :ref:`TileMapPattern` at the given ``position`` and ``layer`` in the tile map. @@ -1060,7 +1060,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -|void| **update_internals**\ (\ ) +|void| **update_internals**\ (\ ) :ref:`🔗` Triggers a direct update of the TileMap. Usually, calling this function is not needed, as TileMap node updates automatically when one of its properties or cells is modified. diff --git a/classes/class_tilemaplayer.rst b/classes/class_tilemaplayer.rst index ed045e77aca..8b34c69a80e 100644 --- a/classes/class_tilemaplayer.rst +++ b/classes/class_tilemaplayer.rst @@ -134,7 +134,7 @@ Signals .. rst-class:: classref-signal -**changed**\ (\ ) +**changed**\ (\ ) :ref:`🔗` Emitted when this **TileMapLayer**'s properties changes. This includes modified cells, properties, or changes made to its assigned :ref:`TileSet`. @@ -153,7 +153,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **DebugVisibilityMode**: +enum **DebugVisibilityMode**: :ref:`🔗` .. _class_TileMapLayer_constant_DEBUG_VISIBILITY_MODE_DEFAULT: @@ -192,7 +192,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collision_enabled** = ``true`` +:ref:`bool` **collision_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -209,7 +209,7 @@ Enable or disable collisions. .. rst-class:: classref-property -:ref:`DebugVisibilityMode` **collision_visibility_mode** = ``0`` +:ref:`DebugVisibilityMode` **collision_visibility_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -226,7 +226,7 @@ Show or hide the **TileMapLayer**'s collision shapes. If set to :ref:`DEBUG_VISI .. rst-class:: classref-property -:ref:`bool` **enabled** = ``true`` +:ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -243,7 +243,7 @@ If ``false``, disables this **TileMapLayer** completely (rendering, collision, n .. rst-class:: classref-property -:ref:`bool` **navigation_enabled** = ``true`` +:ref:`bool` **navigation_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -260,7 +260,7 @@ If ``true``, navigation regions are enabled. .. rst-class:: classref-property -:ref:`DebugVisibilityMode` **navigation_visibility_mode** = ``0`` +:ref:`DebugVisibilityMode` **navigation_visibility_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -277,7 +277,7 @@ Show or hide the **TileMapLayer**'s navigation meshes. If set to :ref:`DEBUG_VIS .. rst-class:: classref-property -:ref:`int` **rendering_quadrant_size** = ``16`` +:ref:`int` **rendering_quadrant_size** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +298,7 @@ The quadrant size does not apply on a Y-sorted **TileMapLayer**, as tiles are be .. rst-class:: classref-property -:ref:`PackedByteArray` **tile_map_data** = ``PackedByteArray()`` +:ref:`PackedByteArray` **tile_map_data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -317,7 +317,7 @@ The raw tile map data as a byte array. .. rst-class:: classref-property -:ref:`TileSet` **tile_set** +:ref:`TileSet` **tile_set** :ref:`🔗` .. rst-class:: classref-property-setget @@ -334,7 +334,7 @@ The :ref:`TileSet` used by this layer. The textures, collisions, .. rst-class:: classref-property -:ref:`bool` **use_kinematic_bodies** = ``false`` +:ref:`bool` **use_kinematic_bodies** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -351,7 +351,7 @@ If ``true``, this **TileMapLayer** collision shapes will be instantiated as kine .. rst-class:: classref-property -:ref:`int` **y_sort_origin** = ``0`` +:ref:`int` **y_sort_origin** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -373,7 +373,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_tile_data_runtime_update**\ (\ coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| +|void| **_tile_data_runtime_update**\ (\ coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| :ref:`🔗` Called with a :ref:`TileData` object about to be used internally by the **TileMapLayer**, allowing its modification at runtime. @@ -391,7 +391,7 @@ This method is only called if :ref:`_use_tile_data_runtime_update` **_use_tile_data_runtime_update**\ (\ coords\: :ref:`Vector2i`\ ) |virtual| +:ref:`bool` **_use_tile_data_runtime_update**\ (\ coords\: :ref:`Vector2i`\ ) |virtual| :ref:`🔗` Should return ``true`` if the tile at coordinates ``coords`` requires a runtime update. @@ -407,7 +407,7 @@ Should return ``true`` if the tile at coordinates ``coords`` requires a runtime .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears all cells. @@ -419,7 +419,7 @@ Clears all cells. .. rst-class:: classref-method -|void| **erase_cell**\ (\ coords\: :ref:`Vector2i`\ ) +|void| **erase_cell**\ (\ coords\: :ref:`Vector2i`\ ) :ref:`🔗` Erases the cell at coordinates ``coords``. @@ -431,7 +431,7 @@ Erases the cell at coordinates ``coords``. .. rst-class:: classref-method -|void| **fix_invalid_tiles**\ (\ ) +|void| **fix_invalid_tiles**\ (\ ) :ref:`🔗` Clears cells containing tiles that do not exist in the :ref:`tile_set`. @@ -443,7 +443,7 @@ Clears cells containing tiles that do not exist in the :ref:`tile_set` **get_cell_alternative_tile**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_cell_alternative_tile**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile alternative ID of the cell at coordinates ``coords``. @@ -455,7 +455,7 @@ Returns the tile alternative ID of the cell at coordinates ``coords``. .. rst-class:: classref-method -:ref:`Vector2i` **get_cell_atlas_coords**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **get_cell_atlas_coords**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile atlas coordinates ID of the cell at coordinates ``coords``. Returns ``Vector2i(-1, -1)`` if the cell does not exist. @@ -467,7 +467,7 @@ Returns the tile atlas coordinates ID of the cell at coordinates ``coords``. Ret .. rst-class:: classref-method -:ref:`int` **get_cell_source_id**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_cell_source_id**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile source ID of the cell at coordinates ``coords``. Returns ``-1`` if the cell does not exist. @@ -479,7 +479,7 @@ Returns the tile source ID of the cell at coordinates ``coords``. Returns ``-1`` .. rst-class:: classref-method -:ref:`TileData` **get_cell_tile_data**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`TileData` **get_cell_tile_data**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the :ref:`TileData` object associated with the given cell, or ``null`` if the cell does not exist or is not a :ref:`TileSetAtlasSource`. @@ -501,7 +501,7 @@ Returns the :ref:`TileData` object associated with the given cel .. rst-class:: classref-method -:ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the coordinates of the tile for given physics body :ref:`RID`. Such an :ref:`RID` can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. @@ -513,7 +513,7 @@ Returns the coordinates of the tile for given physics body :ref:`RID` .. rst-class:: classref-method -:ref:`RID` **get_navigation_map**\ (\ ) |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the :ref:`NavigationServer2D` navigation used by this **TileMapLayer**. @@ -527,7 +527,7 @@ By default this returns the default :ref:`World2D` navigation map .. rst-class:: classref-method -:ref:`Vector2i` **get_neighbor_cell**\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| +:ref:`Vector2i` **get_neighbor_cell**\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| :ref:`🔗` Returns the neighboring cell to the one at coordinates ``coords``, identified by the ``neighbor`` direction. This method takes into account the different layouts a TileMap can take. @@ -539,7 +539,7 @@ Returns the neighboring cell to the one at coordinates ``coords``, identified by .. rst-class:: classref-method -:ref:`TileMapPattern` **get_pattern**\ (\ coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) +:ref:`TileMapPattern` **get_pattern**\ (\ coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) :ref:`🔗` Creates and returns a new :ref:`TileMapPattern` from the given array of cells. See also :ref:`set_pattern`. @@ -551,7 +551,7 @@ Creates and returns a new :ref:`TileMapPattern` from the g .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_surrounding_cells**\ (\ coords\: :ref:`Vector2i`\ ) +:ref:`Array`\[:ref:`Vector2i`\] **get_surrounding_cells**\ (\ coords\: :ref:`Vector2i`\ ) :ref:`🔗` Returns the list of all neighboring cells to the one at ``coords``. @@ -563,7 +563,7 @@ Returns the list of all neighboring cells to the one at ``coords``. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Vector2i` array with the positions of all cells containing a tile. A cell is considered empty if its source identifier equals ``-1``, its atlas coordinate identifier is ``Vector2(-1, -1)`` and its alternative identifier is ``-1``. @@ -575,7 +575,7 @@ Returns a :ref:`Vector2i` array with the positions of all cells .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells_by_id**\ (\ source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells_by_id**\ (\ source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns a :ref:`Vector2i` array with the positions of all cells containing a tile. Tiles may be filtered according to their source (``source_id``), their atlas coordinates (``atlas_coords``), or alternative id (``alternative_tile``). @@ -591,7 +591,7 @@ A cell is considered empty if its source identifier equals ``-1``, its atlas coo .. rst-class:: classref-method -:ref:`Rect2i` **get_used_rect**\ (\ ) |const| +:ref:`Rect2i` **get_used_rect**\ (\ ) |const| :ref:`🔗` Returns a rectangle enclosing the used (non-empty) tiles of the map. @@ -603,7 +603,7 @@ Returns a rectangle enclosing the used (non-empty) tiles of the map. .. rst-class:: classref-method -:ref:`bool` **has_body_rid**\ (\ body\: :ref:`RID`\ ) |const| +:ref:`bool` **has_body_rid**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` Returns whether the provided ``body`` :ref:`RID` belongs to one of this **TileMapLayer**'s cells. @@ -615,7 +615,7 @@ Returns whether the provided ``body`` :ref:`RID` belongs to one of th .. rst-class:: classref-method -:ref:`Vector2i` **local_to_map**\ (\ local_position\: :ref:`Vector2`\ ) |const| +:ref:`Vector2i` **local_to_map**\ (\ local_position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node2D.to_local` before passing it to this method. See also :ref:`map_to_local`. @@ -627,7 +627,7 @@ Returns the map coordinates of the cell containing the given ``local_position``. .. rst-class:: classref-method -:ref:`Vector2i` **map_pattern**\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) +:ref:`Vector2i` **map_pattern**\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) :ref:`🔗` Returns for the given coordinates ``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``. @@ -639,7 +639,7 @@ Returns for the given coordinates ``coords_in_pattern`` in a :ref:`TileMapPatter .. rst-class:: classref-method -:ref:`Vector2` **map_to_local**\ (\ map_position\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2` **map_to_local**\ (\ map_position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the centered position of a cell in the **TileMapLayer**'s local coordinate space. To convert the returned value into global coordinates, use :ref:`Node2D.to_global`. See also :ref:`local_to_map`. @@ -653,7 +653,7 @@ Returns the centered position of a cell in the **TileMapLayer**'s local coordina .. rst-class:: classref-method -|void| **notify_runtime_tile_data_update**\ (\ ) +|void| **notify_runtime_tile_data_update**\ (\ ) :ref:`🔗` Notifies the **TileMapLayer** node that calls to :ref:`_use_tile_data_runtime_update` or :ref:`_tile_data_runtime_update` will lead to different results. This will thus trigger a **TileMapLayer** update. @@ -669,7 +669,7 @@ Notifies the **TileMapLayer** node that calls to :ref:`_use_tile_data_runtime_up .. rst-class:: classref-method -|void| **set_cell**\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) +|void| **set_cell**\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) :ref:`🔗` Sets the tile identifiers for the cell at coordinates ``coords``. Each tile of the :ref:`TileSet` is identified using three parts: @@ -689,7 +689,7 @@ If ``source_id`` is set to ``-1``, ``atlas_coords`` to ``Vector2i(-1, -1)``, or .. rst-class:: classref-method -|void| **set_cells_terrain_connect**\ (\ cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) +|void| **set_cells_terrain_connect**\ (\ cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) :ref:`🔗` Update all the cells in the ``cells`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. @@ -705,7 +705,7 @@ If ``ignore_empty_terrains`` is true, empty terrains will be ignored when trying .. rst-class:: classref-method -|void| **set_cells_terrain_path**\ (\ path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) +|void| **set_cells_terrain_path**\ (\ path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) :ref:`🔗` Update all the cells in the ``path`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. @@ -721,7 +721,7 @@ If ``ignore_empty_terrains`` is true, empty terrains will be ignored when trying .. rst-class:: classref-method -|void| **set_navigation_map**\ (\ map\: :ref:`RID`\ ) +|void| **set_navigation_map**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` Sets a custom ``map`` as a :ref:`NavigationServer2D` navigation map. If not set, uses the default :ref:`World2D` navigation map instead. @@ -733,7 +733,7 @@ Sets a custom ``map`` as a :ref:`NavigationServer2D` n .. rst-class:: classref-method -|void| **set_pattern**\ (\ position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) +|void| **set_pattern**\ (\ position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) :ref:`🔗` Pastes the :ref:`TileMapPattern` at the given ``position`` in the tile map. See also :ref:`get_pattern`. @@ -745,7 +745,7 @@ Pastes the :ref:`TileMapPattern` at the given ``position`` .. rst-class:: classref-method -|void| **update_internals**\ (\ ) +|void| **update_internals**\ (\ ) :ref:`🔗` Triggers a direct update of the **TileMapLayer**. Usually, calling this function is not needed, as **TileMapLayer** node updates automatically when one of its properties or cells is modified. diff --git a/classes/class_tilemappattern.rst b/classes/class_tilemappattern.rst index afb35265924..d168dab9e19 100644 --- a/classes/class_tilemappattern.rst +++ b/classes/class_tilemappattern.rst @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_cell_alternative_tile**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_cell_alternative_tile**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile alternative ID of the cell at ``coords``. @@ -78,7 +78,7 @@ Returns the tile alternative ID of the cell at ``coords``. .. rst-class:: classref-method -:ref:`Vector2i` **get_cell_atlas_coords**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **get_cell_atlas_coords**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile atlas coordinates ID of the cell at ``coords``. @@ -90,7 +90,7 @@ Returns the tile atlas coordinates ID of the cell at ``coords``. .. rst-class:: classref-method -:ref:`int` **get_cell_source_id**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_cell_source_id**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile source ID of the cell at ``coords``. @@ -102,7 +102,7 @@ Returns the tile source ID of the cell at ``coords``. .. rst-class:: classref-method -:ref:`Vector2i` **get_size**\ (\ ) |const| +:ref:`Vector2i` **get_size**\ (\ ) |const| :ref:`🔗` Returns the size, in cells, of the pattern. @@ -114,7 +114,7 @@ Returns the size, in cells, of the pattern. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ ) |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ ) |const| :ref:`🔗` Returns the list of used cell coordinates in the pattern. @@ -126,7 +126,7 @@ Returns the list of used cell coordinates in the pattern. .. rst-class:: classref-method -:ref:`bool` **has_cell**\ (\ coords\: :ref:`Vector2i`\ ) |const| +:ref:`bool` **has_cell**\ (\ coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns whether the pattern has a tile at the given coordinates. @@ -138,7 +138,7 @@ Returns whether the pattern has a tile at the given coordinates. .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns whether the pattern is empty or not. @@ -150,7 +150,7 @@ Returns whether the pattern is empty or not. .. rst-class:: classref-method -|void| **remove_cell**\ (\ coords\: :ref:`Vector2i`, update_size\: :ref:`bool`\ ) +|void| **remove_cell**\ (\ coords\: :ref:`Vector2i`, update_size\: :ref:`bool`\ ) :ref:`🔗` Remove the cell at the given coordinates. @@ -162,7 +162,7 @@ Remove the cell at the given coordinates. .. rst-class:: classref-method -|void| **set_cell**\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) +|void| **set_cell**\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) :ref:`🔗` Sets the tile identifiers for the cell at coordinates ``coords``. See :ref:`TileMap.set_cell`. @@ -174,7 +174,7 @@ Sets the tile identifiers for the cell at coordinates ``coords``. See :ref:`Tile .. rst-class:: classref-method -|void| **set_size**\ (\ size\: :ref:`Vector2i`\ ) +|void| **set_size**\ (\ size\: :ref:`Vector2i`\ ) :ref:`🔗` Sets the size of the pattern. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index b7aec4811f6..4a8fe33b182 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -245,7 +245,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TileShape**: +enum **TileShape**: :ref:`🔗` .. _class_TileSet_constant_TILE_SHAPE_SQUARE: @@ -289,7 +289,7 @@ Hexagonal tile shape. .. rst-class:: classref-enumeration -enum **TileLayout**: +enum **TileLayout**: :ref:`🔗` .. _class_TileSet_constant_TILE_LAYOUT_STACKED: @@ -347,7 +347,7 @@ Tile coordinates layout where the horizontal axis goes down-right, and the verti .. rst-class:: classref-enumeration -enum **TileOffsetAxis**: +enum **TileOffsetAxis**: :ref:`🔗` .. _class_TileSet_constant_TILE_OFFSET_AXIS_HORIZONTAL: @@ -373,7 +373,7 @@ Vertical half-offset. .. rst-class:: classref-enumeration -enum **CellNeighbor**: +enum **CellNeighbor**: :ref:`🔗` .. _class_TileSet_constant_CELL_NEIGHBOR_RIGHT_SIDE: @@ -511,7 +511,7 @@ Neighbor in the top right corner. .. rst-class:: classref-enumeration -enum **TerrainMode**: +enum **TerrainMode**: :ref:`🔗` .. _class_TileSet_constant_TERRAIN_MODE_MATCH_CORNERS_AND_SIDES: @@ -550,7 +550,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`TileLayout` **tile_layout** = ``0`` +:ref:`TileLayout` **tile_layout** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -567,7 +567,7 @@ For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), change .. rst-class:: classref-property -:ref:`TileOffsetAxis` **tile_offset_axis** = ``0`` +:ref:`TileOffsetAxis` **tile_offset_axis** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -584,7 +584,7 @@ For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determ .. rst-class:: classref-property -:ref:`TileShape` **tile_shape** = ``0`` +:ref:`TileShape` **tile_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -601,7 +601,7 @@ The tile shape. .. rst-class:: classref-property -:ref:`Vector2i` **tile_size** = ``Vector2i(16, 16)`` +:ref:`Vector2i` **tile_size** = ``Vector2i(16, 16)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -618,7 +618,7 @@ The tile size, in pixels. For all tile shapes, this size corresponds to the enco .. rst-class:: classref-property -:ref:`bool` **uv_clipping** = ``false`` +:ref:`bool` **uv_clipping** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -640,7 +640,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_custom_data_layer**\ (\ to_position\: :ref:`int` = -1\ ) +|void| **add_custom_data_layer**\ (\ to_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a custom data layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -654,7 +654,7 @@ Custom data layers allow assigning custom properties to atlas tiles. .. rst-class:: classref-method -|void| **add_navigation_layer**\ (\ to_position\: :ref:`int` = -1\ ) +|void| **add_navigation_layer**\ (\ to_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a navigation layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -668,7 +668,7 @@ Navigation layers allow assigning a navigable area to atlas tiles. .. rst-class:: classref-method -|void| **add_occlusion_layer**\ (\ to_position\: :ref:`int` = -1\ ) +|void| **add_occlusion_layer**\ (\ to_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds an occlusion layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -682,7 +682,7 @@ Occlusion layers allow assigning occlusion polygons to atlas tiles. .. rst-class:: classref-method -:ref:`int` **add_pattern**\ (\ pattern\: :ref:`TileMapPattern`, index\: :ref:`int` = -1\ ) +:ref:`int` **add_pattern**\ (\ pattern\: :ref:`TileMapPattern`, index\: :ref:`int` = -1\ ) :ref:`🔗` Adds a :ref:`TileMapPattern` to be stored in the TileSet resource. If provided, insert it at the given ``index``. @@ -694,7 +694,7 @@ Adds a :ref:`TileMapPattern` to be stored in the TileSet r .. rst-class:: classref-method -|void| **add_physics_layer**\ (\ to_position\: :ref:`int` = -1\ ) +|void| **add_physics_layer**\ (\ to_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a physics layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -708,7 +708,7 @@ Physics layers allow assigning collision polygons to atlas tiles. .. rst-class:: classref-method -:ref:`int` **add_source**\ (\ source\: :ref:`TileSetSource`, atlas_source_id_override\: :ref:`int` = -1\ ) +:ref:`int` **add_source**\ (\ source\: :ref:`TileSetSource`, atlas_source_id_override\: :ref:`int` = -1\ ) :ref:`🔗` Adds a :ref:`TileSetSource` to the TileSet. If ``atlas_source_id_override`` is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated. @@ -724,7 +724,7 @@ The function returns the added source ID or -1 if the source could not be added. .. rst-class:: classref-method -|void| **add_terrain**\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int` = -1\ ) +|void| **add_terrain**\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new terrain to the given terrain set ``terrain_set`` at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -736,7 +736,7 @@ Adds a new terrain to the given terrain set ``terrain_set`` at the given positio .. rst-class:: classref-method -|void| **add_terrain_set**\ (\ to_position\: :ref:`int` = -1\ ) +|void| **add_terrain_set**\ (\ to_position\: :ref:`int` = -1\ ) :ref:`🔗` Adds a new terrain set at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -748,7 +748,7 @@ Adds a new terrain set at the given position ``to_position`` in the array. If `` .. rst-class:: classref-method -|void| **cleanup_invalid_tile_proxies**\ (\ ) +|void| **cleanup_invalid_tile_proxies**\ (\ ) :ref:`🔗` Clears tile proxies pointing to invalid tiles. @@ -760,7 +760,7 @@ Clears tile proxies pointing to invalid tiles. .. rst-class:: classref-method -|void| **clear_tile_proxies**\ (\ ) +|void| **clear_tile_proxies**\ (\ ) :ref:`🔗` Clears all tile proxies. @@ -772,7 +772,7 @@ Clears all tile proxies. .. rst-class:: classref-method -:ref:`Array` **get_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) +:ref:`Array` **get_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) :ref:`🔗` Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID). @@ -786,7 +786,7 @@ If the TileSet has no proxy for the given identifiers, returns an empty Array. .. rst-class:: classref-method -:ref:`Array` **get_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) +:ref:`Array` **get_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) :ref:`🔗` Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID). @@ -800,7 +800,7 @@ If the TileSet has no proxy for the given identifiers, returns an empty Array. .. rst-class:: classref-method -:ref:`int` **get_custom_data_layer_by_name**\ (\ layer_name\: :ref:`String`\ ) |const| +:ref:`int` **get_custom_data_layer_by_name**\ (\ layer_name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the index of the custom data layer identified by the given name. @@ -812,7 +812,7 @@ Returns the index of the custom data layer identified by the given name. .. rst-class:: classref-method -:ref:`String` **get_custom_data_layer_name**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`String` **get_custom_data_layer_name**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the custom data layer identified by the given index. @@ -824,7 +824,7 @@ Returns the name of the custom data layer identified by the given index. .. rst-class:: classref-method -:ref:`Variant.Type` **get_custom_data_layer_type**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`Variant.Type` **get_custom_data_layer_type**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the type of the custom data layer identified by the given index. @@ -836,7 +836,7 @@ Returns the type of the custom data layer identified by the given index. .. rst-class:: classref-method -:ref:`int` **get_custom_data_layers_count**\ (\ ) |const| +:ref:`int` **get_custom_data_layers_count**\ (\ ) |const| :ref:`🔗` Returns the custom data layers count. @@ -848,7 +848,7 @@ Returns the custom data layers count. .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_layer_value**\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_navigation_layer_layer_value**\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified navigation layer of the TileSet navigation data layer identified by the given ``layer_index`` is enabled, given a navigation_layers ``layer_number`` between 1 and 32. @@ -860,7 +860,7 @@ Returns whether or not the specified navigation layer of the TileSet navigation .. rst-class:: classref-method -:ref:`int` **get_navigation_layer_layers**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`int` **get_navigation_layer_layers**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer. @@ -872,7 +872,7 @@ Returns the navigation layers (as in the Navigation server) of the given TileSet .. rst-class:: classref-method -:ref:`int` **get_navigation_layers_count**\ (\ ) |const| +:ref:`int` **get_navigation_layers_count**\ (\ ) |const| :ref:`🔗` Returns the navigation layers count. @@ -884,7 +884,7 @@ Returns the navigation layers count. .. rst-class:: classref-method -:ref:`int` **get_next_source_id**\ (\ ) |const| +:ref:`int` **get_next_source_id**\ (\ ) |const| :ref:`🔗` Returns a new unused source ID. This generated ID is the same that a call to :ref:`add_source` would return. @@ -896,7 +896,7 @@ Returns a new unused source ID. This generated ID is the same that a call to :re .. rst-class:: classref-method -:ref:`int` **get_occlusion_layer_light_mask**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`int` **get_occlusion_layer_light_mask**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the light mask of the occlusion layer. @@ -908,7 +908,7 @@ Returns the light mask of the occlusion layer. .. rst-class:: classref-method -:ref:`bool` **get_occlusion_layer_sdf_collision**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`bool` **get_occlusion_layer_sdf_collision**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns if the occluders from this layer use ``sdf_collision``. @@ -920,7 +920,7 @@ Returns if the occluders from this layer use ``sdf_collision``. .. rst-class:: classref-method -:ref:`int` **get_occlusion_layers_count**\ (\ ) |const| +:ref:`int` **get_occlusion_layers_count**\ (\ ) |const| :ref:`🔗` Returns the occlusion layers count. @@ -932,7 +932,7 @@ Returns the occlusion layers count. .. rst-class:: classref-method -:ref:`TileMapPattern` **get_pattern**\ (\ index\: :ref:`int` = -1\ ) +:ref:`TileMapPattern` **get_pattern**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` Returns the :ref:`TileMapPattern` at the given ``index``. @@ -944,7 +944,7 @@ Returns the :ref:`TileMapPattern` at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_patterns_count**\ (\ ) +:ref:`int` **get_patterns_count**\ (\ ) :ref:`🔗` Returns the number of :ref:`TileMapPattern` this tile set handles. @@ -956,7 +956,7 @@ Returns the number of :ref:`TileMapPattern` this tile set .. rst-class:: classref-method -:ref:`int` **get_physics_layer_collision_layer**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`int` **get_physics_layer_collision_layer**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in. @@ -968,7 +968,7 @@ Returns the collision layer (as in the physics server) bodies on the given TileS .. rst-class:: classref-method -:ref:`int` **get_physics_layer_collision_mask**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`int` **get_physics_layer_collision_mask**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the collision mask of bodies on the given TileSet's physics layer. @@ -980,7 +980,7 @@ Returns the collision mask of bodies on the given TileSet's physics layer. .. rst-class:: classref-method -:ref:`PhysicsMaterial` **get_physics_layer_physics_material**\ (\ layer_index\: :ref:`int`\ ) |const| +:ref:`PhysicsMaterial` **get_physics_layer_physics_material**\ (\ layer_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the physics material of bodies on the given TileSet's physics layer. @@ -992,7 +992,7 @@ Returns the physics material of bodies on the given TileSet's physics layer. .. rst-class:: classref-method -:ref:`int` **get_physics_layers_count**\ (\ ) |const| +:ref:`int` **get_physics_layers_count**\ (\ ) |const| :ref:`🔗` Returns the physics layers count. @@ -1004,7 +1004,7 @@ Returns the physics layers count. .. rst-class:: classref-method -:ref:`TileSetSource` **get_source**\ (\ source_id\: :ref:`int`\ ) |const| +:ref:`TileSetSource` **get_source**\ (\ source_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`TileSetSource` with ID ``source_id``. @@ -1016,7 +1016,7 @@ Returns the :ref:`TileSetSource` with ID ``source_id``. .. rst-class:: classref-method -:ref:`int` **get_source_count**\ (\ ) |const| +:ref:`int` **get_source_count**\ (\ ) |const| :ref:`🔗` Returns the number of :ref:`TileSetSource` in this TileSet. @@ -1028,7 +1028,7 @@ Returns the number of :ref:`TileSetSource` in this TileSet. .. rst-class:: classref-method -:ref:`int` **get_source_id**\ (\ index\: :ref:`int`\ ) |const| +:ref:`int` **get_source_id**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the source ID for source with index ``index``. @@ -1040,7 +1040,7 @@ Returns the source ID for source with index ``index``. .. rst-class:: classref-method -:ref:`int` **get_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) +:ref:`int` **get_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) :ref:`🔗` Returns the source-level proxy for the given source identifier. @@ -1054,7 +1054,7 @@ If the TileSet has no proxy for the given identifier, returns -1. .. rst-class:: classref-method -:ref:`Color` **get_terrain_color**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| +:ref:`Color` **get_terrain_color**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns a terrain's color. @@ -1066,7 +1066,7 @@ Returns a terrain's color. .. rst-class:: classref-method -:ref:`String` **get_terrain_name**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| +:ref:`String` **get_terrain_name**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns a terrain's name. @@ -1078,7 +1078,7 @@ Returns a terrain's name. .. rst-class:: classref-method -:ref:`TerrainMode` **get_terrain_set_mode**\ (\ terrain_set\: :ref:`int`\ ) |const| +:ref:`TerrainMode` **get_terrain_set_mode**\ (\ terrain_set\: :ref:`int`\ ) |const| :ref:`🔗` Returns a terrain set mode. @@ -1090,7 +1090,7 @@ Returns a terrain set mode. .. rst-class:: classref-method -:ref:`int` **get_terrain_sets_count**\ (\ ) |const| +:ref:`int` **get_terrain_sets_count**\ (\ ) |const| :ref:`🔗` Returns the terrain sets count. @@ -1102,7 +1102,7 @@ Returns the terrain sets count. .. rst-class:: classref-method -:ref:`int` **get_terrains_count**\ (\ terrain_set\: :ref:`int`\ ) |const| +:ref:`int` **get_terrains_count**\ (\ terrain_set\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of terrains in the given terrain set. @@ -1114,7 +1114,7 @@ Returns the number of terrains in the given terrain set. .. rst-class:: classref-method -:ref:`bool` **has_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) +:ref:`bool` **has_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) :ref:`🔗` Returns if there is an alternative-level proxy for the given identifiers. @@ -1126,7 +1126,7 @@ Returns if there is an alternative-level proxy for the given identifiers. .. rst-class:: classref-method -:ref:`bool` **has_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) +:ref:`bool` **has_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) :ref:`🔗` Returns if there is a coodinates-level proxy for the given identifiers. @@ -1138,7 +1138,7 @@ Returns if there is a coodinates-level proxy for the given identifiers. .. rst-class:: classref-method -:ref:`bool` **has_source**\ (\ source_id\: :ref:`int`\ ) |const| +:ref:`bool` **has_source**\ (\ source_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns if this TileSet has a source for the given source ID. @@ -1150,7 +1150,7 @@ Returns if this TileSet has a source for the given source ID. .. rst-class:: classref-method -:ref:`bool` **has_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) +:ref:`bool` **has_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) :ref:`🔗` Returns if there is a source-level proxy for the given source ID. @@ -1162,7 +1162,7 @@ Returns if there is a source-level proxy for the given source ID. .. rst-class:: classref-method -:ref:`Array` **map_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) |const| +:ref:`Array` **map_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) |const| :ref:`🔗` According to the configured proxies, maps the provided identifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array. @@ -1178,7 +1178,7 @@ If no proxy corresponding to provided identifiers are found, returns the same va .. rst-class:: classref-method -|void| **move_custom_data_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_custom_data_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the custom data layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1190,7 +1190,7 @@ Moves the custom data layer at index ``layer_index`` to the given position ``to_ .. rst-class:: classref-method -|void| **move_navigation_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_navigation_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the navigation layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1202,7 +1202,7 @@ Moves the navigation layer at index ``layer_index`` to the given position ``to_p .. rst-class:: classref-method -|void| **move_occlusion_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_occlusion_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the occlusion layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1214,7 +1214,7 @@ Moves the occlusion layer at index ``layer_index`` to the given position ``to_po .. rst-class:: classref-method -|void| **move_physics_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_physics_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the physics layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1226,7 +1226,7 @@ Moves the physics layer at index ``layer_index`` to the given position ``to_posi .. rst-class:: classref-method -|void| **move_terrain**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_terrain**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the terrain at index ``terrain_index`` for terrain set ``terrain_set`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1238,7 +1238,7 @@ Moves the terrain at index ``terrain_index`` for terrain set ``terrain_set`` to .. rst-class:: classref-method -|void| **move_terrain_set**\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int`\ ) +|void| **move_terrain_set**\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` Moves the terrain set at index ``terrain_set`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1250,7 +1250,7 @@ Moves the terrain set at index ``terrain_set`` to the given position ``to_positi .. rst-class:: classref-method -|void| **remove_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) +|void| **remove_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) :ref:`🔗` Removes an alternative-level proxy for the given identifiers. @@ -1262,7 +1262,7 @@ Removes an alternative-level proxy for the given identifiers. .. rst-class:: classref-method -|void| **remove_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) +|void| **remove_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) :ref:`🔗` Removes a coordinates-level proxy for the given identifiers. @@ -1274,7 +1274,7 @@ Removes a coordinates-level proxy for the given identifiers. .. rst-class:: classref-method -|void| **remove_custom_data_layer**\ (\ layer_index\: :ref:`int`\ ) +|void| **remove_custom_data_layer**\ (\ layer_index\: :ref:`int`\ ) :ref:`🔗` Removes the custom data layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1286,7 +1286,7 @@ Removes the custom data layer at index ``layer_index``. Also updates the atlas t .. rst-class:: classref-method -|void| **remove_navigation_layer**\ (\ layer_index\: :ref:`int`\ ) +|void| **remove_navigation_layer**\ (\ layer_index\: :ref:`int`\ ) :ref:`🔗` Removes the navigation layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1298,7 +1298,7 @@ Removes the navigation layer at index ``layer_index``. Also updates the atlas ti .. rst-class:: classref-method -|void| **remove_occlusion_layer**\ (\ layer_index\: :ref:`int`\ ) +|void| **remove_occlusion_layer**\ (\ layer_index\: :ref:`int`\ ) :ref:`🔗` Removes the occlusion layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1310,7 +1310,7 @@ Removes the occlusion layer at index ``layer_index``. Also updates the atlas til .. rst-class:: classref-method -|void| **remove_pattern**\ (\ index\: :ref:`int`\ ) +|void| **remove_pattern**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Remove the :ref:`TileMapPattern` at the given index. @@ -1322,7 +1322,7 @@ Remove the :ref:`TileMapPattern` at the given index. .. rst-class:: classref-method -|void| **remove_physics_layer**\ (\ layer_index\: :ref:`int`\ ) +|void| **remove_physics_layer**\ (\ layer_index\: :ref:`int`\ ) :ref:`🔗` Removes the physics layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1334,7 +1334,7 @@ Removes the physics layer at index ``layer_index``. Also updates the atlas tiles .. rst-class:: classref-method -|void| **remove_source**\ (\ source_id\: :ref:`int`\ ) +|void| **remove_source**\ (\ source_id\: :ref:`int`\ ) :ref:`🔗` Removes the source with the given source ID. @@ -1346,7 +1346,7 @@ Removes the source with the given source ID. .. rst-class:: classref-method -|void| **remove_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) +|void| **remove_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) :ref:`🔗` Removes a source-level tile proxy. @@ -1358,7 +1358,7 @@ Removes a source-level tile proxy. .. rst-class:: classref-method -|void| **remove_terrain**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) +|void| **remove_terrain**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) :ref:`🔗` Removes the terrain at index ``terrain_index`` in the given terrain set ``terrain_set``. Also updates the atlas tiles accordingly. @@ -1370,7 +1370,7 @@ Removes the terrain at index ``terrain_index`` in the given terrain set ``terrai .. rst-class:: classref-method -|void| **remove_terrain_set**\ (\ terrain_set\: :ref:`int`\ ) +|void| **remove_terrain_set**\ (\ terrain_set\: :ref:`int`\ ) :ref:`🔗` Removes the terrain set at index ``terrain_set``. Also updates the atlas tiles accordingly. @@ -1382,7 +1382,7 @@ Removes the terrain set at index ``terrain_set``. Also updates the atlas tiles a .. rst-class:: classref-method -|void| **set_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`, alternative_to\: :ref:`int`\ ) +|void| **set_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`, alternative_to\: :ref:`int`\ ) :ref:`🔗` Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. @@ -1398,7 +1398,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. .. rst-class:: classref-method -|void| **set_coords_level_tile_proxy**\ (\ p_source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`\ ) +|void| **set_coords_level_tile_proxy**\ (\ p_source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`\ ) :ref:`🔗` Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. @@ -1414,7 +1414,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. .. rst-class:: classref-method -|void| **set_custom_data_layer_name**\ (\ layer_index\: :ref:`int`, layer_name\: :ref:`String`\ ) +|void| **set_custom_data_layer_name**\ (\ layer_index\: :ref:`int`, layer_name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error. @@ -1426,7 +1426,7 @@ Sets the name of the custom data layer identified by the given index. Names are .. rst-class:: classref-method -|void| **set_custom_data_layer_type**\ (\ layer_index\: :ref:`int`, layer_type\: :ref:`Variant.Type`\ ) +|void| **set_custom_data_layer_type**\ (\ layer_index\: :ref:`int`, layer_type\: :ref:`Variant.Type`\ ) :ref:`🔗` Sets the type of the custom data layer identified by the given index. @@ -1438,7 +1438,7 @@ Sets the type of the custom data layer identified by the given index. .. rst-class:: classref-method -|void| **set_navigation_layer_layer_value**\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_navigation_layer_layer_value**\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified navigation layer of the TileSet navigation data layer identified by the given ``layer_index``, given a navigation_layers ``layer_number`` between 1 and 32. @@ -1450,7 +1450,7 @@ Based on ``value``, enables or disables the specified navigation layer of the Ti .. rst-class:: classref-method -|void| **set_navigation_layer_layers**\ (\ layer_index\: :ref:`int`, layers\: :ref:`int`\ ) +|void| **set_navigation_layer_layers**\ (\ layer_index\: :ref:`int`, layers\: :ref:`int`\ ) :ref:`🔗` Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer. @@ -1462,7 +1462,7 @@ Sets the navigation layers (as in the navigation server) for navigation regions .. rst-class:: classref-method -|void| **set_occlusion_layer_light_mask**\ (\ layer_index\: :ref:`int`, light_mask\: :ref:`int`\ ) +|void| **set_occlusion_layer_light_mask**\ (\ layer_index\: :ref:`int`, light_mask\: :ref:`int`\ ) :ref:`🔗` Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer. @@ -1474,7 +1474,7 @@ Sets the occlusion layer (as in the rendering server) for occluders in the given .. rst-class:: classref-method -|void| **set_occlusion_layer_sdf_collision**\ (\ layer_index\: :ref:`int`, sdf_collision\: :ref:`bool`\ ) +|void| **set_occlusion_layer_sdf_collision**\ (\ layer_index\: :ref:`int`, sdf_collision\: :ref:`bool`\ ) :ref:`🔗` Enables or disables SDF collision for occluders in the given TileSet occlusion layer. @@ -1486,7 +1486,7 @@ Enables or disables SDF collision for occluders in the given TileSet occlusion l .. rst-class:: classref-method -|void| **set_physics_layer_collision_layer**\ (\ layer_index\: :ref:`int`, layer\: :ref:`int`\ ) +|void| **set_physics_layer_collision_layer**\ (\ layer_index\: :ref:`int`, layer\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. @@ -1498,7 +1498,7 @@ Sets the physics layer (as in the physics server) for bodies in the given TileSe .. rst-class:: classref-method -|void| **set_physics_layer_collision_mask**\ (\ layer_index\: :ref:`int`, mask\: :ref:`int`\ ) +|void| **set_physics_layer_collision_mask**\ (\ layer_index\: :ref:`int`, mask\: :ref:`int`\ ) :ref:`🔗` Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. @@ -1510,7 +1510,7 @@ Sets the physics layer (as in the physics server) for bodies in the given TileSe .. rst-class:: classref-method -|void| **set_physics_layer_physics_material**\ (\ layer_index\: :ref:`int`, physics_material\: :ref:`PhysicsMaterial`\ ) +|void| **set_physics_layer_physics_material**\ (\ layer_index\: :ref:`int`, physics_material\: :ref:`PhysicsMaterial`\ ) :ref:`🔗` Sets the physics material for bodies in the given TileSet physics layer. @@ -1522,7 +1522,7 @@ Sets the physics material for bodies in the given TileSet physics layer. .. rst-class:: classref-method -|void| **set_source_id**\ (\ source_id\: :ref:`int`, new_source_id\: :ref:`int`\ ) +|void| **set_source_id**\ (\ source_id\: :ref:`int`, new_source_id\: :ref:`int`\ ) :ref:`🔗` Changes a source's ID. @@ -1534,7 +1534,7 @@ Changes a source's ID. .. rst-class:: classref-method -|void| **set_source_level_tile_proxy**\ (\ source_from\: :ref:`int`, source_to\: :ref:`int`\ ) +|void| **set_source_level_tile_proxy**\ (\ source_from\: :ref:`int`, source_to\: :ref:`int`\ ) :ref:`🔗` Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies. @@ -1550,7 +1550,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. .. rst-class:: classref-method -|void| **set_terrain_color**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_terrain_color**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor. @@ -1562,7 +1562,7 @@ Sets a terrain's color. This color is used for identifying the different terrain .. rst-class:: classref-method -|void| **set_terrain_name**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_terrain_name**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets a terrain's name. @@ -1574,7 +1574,7 @@ Sets a terrain's name. .. rst-class:: classref-method -|void| **set_terrain_set_mode**\ (\ terrain_set\: :ref:`int`, mode\: :ref:`TerrainMode`\ ) +|void| **set_terrain_set_mode**\ (\ terrain_set\: :ref:`int`, mode\: :ref:`TerrainMode`\ ) :ref:`🔗` Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains. diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index 1ee8aea810d..57f8faa9250 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -134,7 +134,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TileAnimationMode**: +enum **TileAnimationMode**: :ref:`🔗` .. _class_TileSetAtlasSource_constant_TILE_ANIMATION_MODE_DEFAULT: @@ -173,7 +173,7 @@ Constants .. rst-class:: classref-constant -**TRANSFORM_FLIP_H** = ``4096`` +**TRANSFORM_FLIP_H** = ``4096`` :ref:`🔗` Represents cell's horizontal flip flag. Should be used directly with :ref:`TileMap` to flip placed tiles by altering their alternative IDs. @@ -199,7 +199,7 @@ Represents cell's horizontal flip flag. Should be used directly with :ref:`TileM .. rst-class:: classref-constant -**TRANSFORM_FLIP_V** = ``8192`` +**TRANSFORM_FLIP_V** = ``8192`` :ref:`🔗` Represents cell's vertical flip flag. See :ref:`TRANSFORM_FLIP_H` for usage. @@ -207,7 +207,7 @@ Represents cell's vertical flip flag. See :ref:`TRANSFORM_FLIP_H` Represents cell's transposed flag. See :ref:`TRANSFORM_FLIP_H` for usage. @@ -224,7 +224,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2i` **margins** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **margins** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ Margins, in pixels, to offset the origin of the grid in the texture. .. rst-class:: classref-property -:ref:`Vector2i` **separation** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **separation** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ Separation, in pixels, between each tile texture region of the grid. .. rst-class:: classref-property -:ref:`Texture2D` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -275,7 +275,7 @@ The atlas texture. .. rst-class:: classref-property -:ref:`Vector2i` **texture_region_size** = ``Vector2i(16, 16)`` +:ref:`Vector2i` **texture_region_size** = ``Vector2i(16, 16)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ The base tile size in the texture (in pixel). This size must be bigger than the .. rst-class:: classref-property -:ref:`bool` **use_texture_padding** = ``true`` +:ref:`bool` **use_texture_padding** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -316,7 +316,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_tiles_outside_texture**\ (\ ) +|void| **clear_tiles_outside_texture**\ (\ ) :ref:`🔗` Removes all tiles that don't fit the available texture area. This method iterates over all the source's tiles, so it's advised to use :ref:`has_tiles_outside_texture` beforehand. @@ -328,7 +328,7 @@ Removes all tiles that don't fit the available texture area. This method iterate .. rst-class:: classref-method -:ref:`int` **create_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_id_override\: :ref:`int` = -1\ ) +:ref:`int` **create_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_id_override\: :ref:`int` = -1\ ) :ref:`🔗` Creates an alternative tile for the tile at coordinates ``atlas_coords``. If ``alternative_id_override`` is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise. @@ -342,7 +342,7 @@ Returns the new alternative identifier, or -1 if the alternative could not be cr .. rst-class:: classref-method -|void| **create_tile**\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i` = Vector2i(1, 1)\ ) +|void| **create_tile**\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i` = Vector2i(1, 1)\ ) :ref:`🔗` Creates a new tile at coordinates ``atlas_coords`` with the given ``size``. @@ -354,7 +354,7 @@ Creates a new tile at coordinates ``atlas_coords`` with the given ``size``. .. rst-class:: classref-method -:ref:`Vector2i` **get_atlas_grid_size**\ (\ ) |const| +:ref:`Vector2i` **get_atlas_grid_size**\ (\ ) |const| :ref:`🔗` Returns the atlas grid size, which depends on how many tiles can fit in the texture. It thus depends on the :ref:`texture`'s size, the atlas :ref:`margins`, and the tiles' :ref:`texture_region_size`. @@ -366,7 +366,7 @@ Returns the atlas grid size, which depends on how many tiles can fit in the text .. rst-class:: classref-method -:ref:`int` **get_next_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_next_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the alternative ID a following call to :ref:`create_alternative_tile` would return. @@ -378,7 +378,7 @@ Returns the alternative ID a following call to :ref:`create_alternative_tile` **get_runtime_texture**\ (\ ) |const| +:ref:`Texture2D` **get_runtime_texture**\ (\ ) |const| :ref:`🔗` If :ref:`use_texture_padding` is ``false``, returns :ref:`texture`. Otherwise, returns and internal :ref:`ImageTexture` created that includes the padding. @@ -390,7 +390,7 @@ If :ref:`use_texture_padding` **get_runtime_tile_texture_region**\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int`\ ) |const| +:ref:`Rect2i` **get_runtime_tile_texture_region**\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int`\ ) |const| :ref:`🔗` Returns the region of the tile at coordinates ``atlas_coords`` for the given ``frame`` inside the texture returned by :ref:`get_runtime_texture`. @@ -404,7 +404,7 @@ Returns the region of the tile at coordinates ``atlas_coords`` for the given ``f .. rst-class:: classref-method -:ref:`int` **get_tile_animation_columns**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_tile_animation_columns**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns how many columns the tile at ``atlas_coords`` has in its animation layout. @@ -416,7 +416,7 @@ Returns how many columns the tile at ``atlas_coords`` has in its animation layou .. rst-class:: classref-method -:ref:`float` **get_tile_animation_frame_duration**\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`\ ) |const| +:ref:`float` **get_tile_animation_frame_duration**\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the animation frame duration of frame ``frame_index`` for the tile at coordinates ``atlas_coords``. @@ -428,7 +428,7 @@ Returns the animation frame duration of frame ``frame_index`` for the tile at co .. rst-class:: classref-method -:ref:`int` **get_tile_animation_frames_count**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_tile_animation_frames_count**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns how many animation frames has the tile at coordinates ``atlas_coords``. @@ -440,7 +440,7 @@ Returns how many animation frames has the tile at coordinates ``atlas_coords``. .. rst-class:: classref-method -:ref:`TileAnimationMode` **get_tile_animation_mode**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`TileAnimationMode` **get_tile_animation_mode**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the tile animation mode of the tile at ``atlas_coords``. See also :ref:`set_tile_animation_mode`. @@ -452,7 +452,7 @@ Returns the tile animation mode of the tile at ``atlas_coords``. See also :ref:` .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_animation_separation**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **get_tile_animation_separation**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates ``atlas_coords``. @@ -464,7 +464,7 @@ Returns the separation (as in the atlas grid) between each frame of an animated .. rst-class:: classref-method -:ref:`float` **get_tile_animation_speed**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`float` **get_tile_animation_speed**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the animation speed of the tile at coordinates ``atlas_coords``. @@ -476,7 +476,7 @@ Returns the animation speed of the tile at coordinates ``atlas_coords``. .. rst-class:: classref-method -:ref:`float` **get_tile_animation_total_duration**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`float` **get_tile_animation_total_duration**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the sum of the sum of the frame durations of the tile at coordinates ``atlas_coords``. This value needs to be divided by the animation speed to get the actual animation loop duration. @@ -488,7 +488,7 @@ Returns the sum of the sum of the frame durations of the tile at coordinates ``a .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_at_coords**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **get_tile_at_coords**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` If there is a tile covering the ``atlas_coords`` coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns ``Vector2i(-1, -1)`` otherwise. @@ -500,7 +500,7 @@ If there is a tile covering the ``atlas_coords`` coordinates, returns the top-le .. rst-class:: classref-method -:ref:`TileData` **get_tile_data**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| +:ref:`TileData` **get_tile_data**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`TileData` object for the given atlas coordinates and alternative ID. @@ -512,7 +512,7 @@ Returns the :ref:`TileData` object for the given atlas coordinat .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_size_in_atlas**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **get_tile_size_in_atlas**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the size of the tile (in the grid coordinates system) at coordinates ``atlas_coords``. @@ -524,7 +524,7 @@ Returns the size of the tile (in the grid coordinates system) at coordinates ``a .. rst-class:: classref-method -:ref:`Rect2i` **get_tile_texture_region**\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int` = 0\ ) |const| +:ref:`Rect2i` **get_tile_texture_region**\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns a tile's texture region in the atlas texture. For animated tiles, a ``frame`` argument might be provided for the different frames of the animation. @@ -536,7 +536,7 @@ Returns a tile's texture region in the atlas texture. For animated tiles, a ``fr .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_tiles_to_be_removed_on_change**\ (\ texture\: :ref:`Texture2D`, margins\: :ref:`Vector2i`, separation\: :ref:`Vector2i`, texture_region_size\: :ref:`Vector2i`\ ) +:ref:`PackedVector2Array` **get_tiles_to_be_removed_on_change**\ (\ texture\: :ref:`Texture2D`, margins\: :ref:`Vector2i`, separation\: :ref:`Vector2i`, texture_region_size\: :ref:`Vector2i`\ ) :ref:`🔗` 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. @@ -548,7 +548,7 @@ Returns an array of tiles coordinates ID that will be automatically removed when .. rst-class:: classref-method -:ref:`bool` **has_room_for_tile**\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i`, animation_columns\: :ref:`int`, animation_separation\: :ref:`Vector2i`, frames_count\: :ref:`int`, ignored_tile\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) |const| +:ref:`bool` **has_room_for_tile**\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i`, animation_columns\: :ref:`int`, animation_separation\: :ref:`Vector2i`, frames_count\: :ref:`int`, ignored_tile\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) |const| :ref:`🔗` Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If ``ignored_tile`` is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties. @@ -560,7 +560,7 @@ Returns whether there is enough room in an atlas to create/modify a tile with th .. rst-class:: classref-method -:ref:`bool` **has_tiles_outside_texture**\ (\ ) |const| +:ref:`bool` **has_tiles_outside_texture**\ (\ ) |const| :ref:`🔗` Checks if the source has any tiles that don't fit the texture area (either partially or completely). @@ -572,7 +572,7 @@ Checks if the source has any tiles that don't fit the texture area (either parti .. rst-class:: classref-method -|void| **move_tile_in_atlas**\ (\ atlas_coords\: :ref:`Vector2i`, new_atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), new_size\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) +|void| **move_tile_in_atlas**\ (\ atlas_coords\: :ref:`Vector2i`, new_atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), new_size\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) :ref:`🔗` Move the tile and its alternatives at the ``atlas_coords`` coordinates to the ``new_atlas_coords`` coordinates with the ``new_size`` size. This functions will fail if a tile is already present in the given area. @@ -588,7 +588,7 @@ To avoid an error, first check if a move is possible using :ref:`has_room_for_ti .. rst-class:: classref-method -|void| **remove_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) +|void| **remove_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) :ref:`🔗` Remove a tile's alternative with alternative ID ``alternative_tile``. @@ -602,7 +602,7 @@ Calling this function with ``alternative_tile`` equals to 0 will fail, as the ba .. rst-class:: classref-method -|void| **remove_tile**\ (\ atlas_coords\: :ref:`Vector2i`\ ) +|void| **remove_tile**\ (\ atlas_coords\: :ref:`Vector2i`\ ) :ref:`🔗` Remove a tile and its alternative at coordinates ``atlas_coords``. @@ -614,7 +614,7 @@ Remove a tile and its alternative at coordinates ``atlas_coords``. .. rst-class:: classref-method -|void| **set_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`, new_id\: :ref:`int`\ ) +|void| **set_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`, new_id\: :ref:`int`\ ) :ref:`🔗` Change a tile's alternative ID from ``alternative_tile`` to ``new_id``. @@ -628,7 +628,7 @@ Calling this function with ``new_id`` of 0 will fail, as the base tile alternati .. rst-class:: classref-method -|void| **set_tile_animation_columns**\ (\ atlas_coords\: :ref:`Vector2i`, frame_columns\: :ref:`int`\ ) +|void| **set_tile_animation_columns**\ (\ atlas_coords\: :ref:`Vector2i`, frame_columns\: :ref:`int`\ ) :ref:`🔗` Sets the number of columns in the animation layout of the tile at coordinates ``atlas_coords``. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas. @@ -640,7 +640,7 @@ Sets the number of columns in the animation layout of the tile at coordinates `` .. rst-class:: classref-method -|void| **set_tile_animation_frame_duration**\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`, duration\: :ref:`float`\ ) +|void| **set_tile_animation_frame_duration**\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`, duration\: :ref:`float`\ ) :ref:`🔗` Sets the animation frame ``duration`` of frame ``frame_index`` for the tile at coordinates ``atlas_coords``. @@ -652,7 +652,7 @@ Sets the animation frame ``duration`` of frame ``frame_index`` for the tile at c .. rst-class:: classref-method -|void| **set_tile_animation_frames_count**\ (\ atlas_coords\: :ref:`Vector2i`, frames_count\: :ref:`int`\ ) +|void| **set_tile_animation_frames_count**\ (\ atlas_coords\: :ref:`Vector2i`, frames_count\: :ref:`int`\ ) :ref:`🔗` Sets how many animation frames the tile at coordinates ``atlas_coords`` has. @@ -664,7 +664,7 @@ Sets how many animation frames the tile at coordinates ``atlas_coords`` has. .. rst-class:: classref-method -|void| **set_tile_animation_mode**\ (\ atlas_coords\: :ref:`Vector2i`, mode\: :ref:`TileAnimationMode`\ ) +|void| **set_tile_animation_mode**\ (\ atlas_coords\: :ref:`Vector2i`, mode\: :ref:`TileAnimationMode`\ ) :ref:`🔗` Sets the tile animation mode of the tile at ``atlas_coords`` to ``mode``. See also :ref:`get_tile_animation_mode`. @@ -676,7 +676,7 @@ Sets the tile animation mode of the tile at ``atlas_coords`` to ``mode``. See al .. rst-class:: classref-method -|void| **set_tile_animation_separation**\ (\ atlas_coords\: :ref:`Vector2i`, separation\: :ref:`Vector2i`\ ) +|void| **set_tile_animation_separation**\ (\ atlas_coords\: :ref:`Vector2i`, separation\: :ref:`Vector2i`\ ) :ref:`🔗` Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates ``atlas_coords`` has. @@ -688,7 +688,7 @@ Sets the margin (in grid tiles) between each tile in the animation layout of the .. rst-class:: classref-method -|void| **set_tile_animation_speed**\ (\ atlas_coords\: :ref:`Vector2i`, speed\: :ref:`float`\ ) +|void| **set_tile_animation_speed**\ (\ atlas_coords\: :ref:`Vector2i`, speed\: :ref:`float`\ ) :ref:`🔗` Sets the animation speed of the tile at coordinates ``atlas_coords`` has. diff --git a/classes/class_tilesetscenescollectionsource.rst b/classes/class_tilesetscenescollectionsource.rst index ab4e3b3d2c2..797902b7a01 100644 --- a/classes/class_tilesetscenescollectionsource.rst +++ b/classes/class_tilesetscenescollectionsource.rst @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **create_scene_tile**\ (\ packed_scene\: :ref:`PackedScene`, id_override\: :ref:`int` = -1\ ) +:ref:`int` **create_scene_tile**\ (\ packed_scene\: :ref:`PackedScene`, id_override\: :ref:`int` = -1\ ) :ref:`🔗` Creates a scene-based tile out of the given scene. @@ -82,7 +82,7 @@ Returns a newly generated unique ID. .. rst-class:: classref-method -:ref:`int` **get_next_scene_tile_id**\ (\ ) |const| +:ref:`int` **get_next_scene_tile_id**\ (\ ) |const| :ref:`🔗` Returns the scene ID a following call to :ref:`create_scene_tile` would return. @@ -94,7 +94,7 @@ Returns the scene ID a following call to :ref:`create_scene_tile` **get_scene_tile_display_placeholder**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **get_scene_tile_display_placeholder**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the scene tile with ``id`` displays a placeholder in the editor. @@ -106,7 +106,7 @@ Returns whether the scene tile with ``id`` displays a placeholder in the editor. .. rst-class:: classref-method -:ref:`int` **get_scene_tile_id**\ (\ index\: :ref:`int`\ ) +:ref:`int` **get_scene_tile_id**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the scene tile ID of the scene tile at ``index``. @@ -118,7 +118,7 @@ Returns the scene tile ID of the scene tile at ``index``. .. rst-class:: classref-method -:ref:`PackedScene` **get_scene_tile_scene**\ (\ id\: :ref:`int`\ ) |const| +:ref:`PackedScene` **get_scene_tile_scene**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`PackedScene` resource of scene tile with ``id``. @@ -130,7 +130,7 @@ Returns the :ref:`PackedScene` resource of scene tile with `` .. rst-class:: classref-method -:ref:`int` **get_scene_tiles_count**\ (\ ) +:ref:`int` **get_scene_tiles_count**\ (\ ) :ref:`🔗` Returns the number or scene tiles this TileSet source has. @@ -142,7 +142,7 @@ Returns the number or scene tiles this TileSet source has. .. rst-class:: classref-method -:ref:`bool` **has_scene_tile_id**\ (\ id\: :ref:`int`\ ) +:ref:`bool` **has_scene_tile_id**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns whether this TileSet source has a scene tile with ``id``. @@ -154,7 +154,7 @@ Returns whether this TileSet source has a scene tile with ``id``. .. rst-class:: classref-method -|void| **remove_scene_tile**\ (\ id\: :ref:`int`\ ) +|void| **remove_scene_tile**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Remove the scene tile with ``id``. @@ -166,7 +166,7 @@ Remove the scene tile with ``id``. .. rst-class:: classref-method -|void| **set_scene_tile_display_placeholder**\ (\ id\: :ref:`int`, display_placeholder\: :ref:`bool`\ ) +|void| **set_scene_tile_display_placeholder**\ (\ id\: :ref:`int`, display_placeholder\: :ref:`bool`\ ) :ref:`🔗` Sets whether or not the scene tile with ``id`` should display a placeholder in the editor. This might be useful for scenes that are not visible. @@ -178,7 +178,7 @@ Sets whether or not the scene tile with ``id`` should display a placeholder in t .. rst-class:: classref-method -|void| **set_scene_tile_id**\ (\ id\: :ref:`int`, new_id\: :ref:`int`\ ) +|void| **set_scene_tile_id**\ (\ id\: :ref:`int`, new_id\: :ref:`int`\ ) :ref:`🔗` Changes a scene tile's ID from ``id`` to ``new_id``. This will fail if there is already a tile with an ID equal to ``new_id``. @@ -190,7 +190,7 @@ Changes a scene tile's ID from ``id`` to ``new_id``. This will fail if there is .. rst-class:: classref-method -|void| **set_scene_tile_scene**\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) +|void| **set_scene_tile_scene**\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) :ref:`🔗` Assigns a :ref:`PackedScene` resource to the scene tile with ``id``. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMap. diff --git a/classes/class_tilesetsource.rst b/classes/class_tilesetsource.rst index 731f230bb3e..25a1e4c36bd 100644 --- a/classes/class_tilesetsource.rst +++ b/classes/class_tilesetsource.rst @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`, index\: :ref:`int`\ ) |const| +:ref:`int` **get_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the alternative ID for the tile with coordinates ID ``atlas_coords`` at index ``index``. @@ -78,7 +78,7 @@ Returns the alternative ID for the tile with coordinates ID ``atlas_coords`` at .. rst-class:: classref-method -:ref:`int` **get_alternative_tiles_count**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`int` **get_alternative_tiles_count**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the number of alternatives tiles for the coordinates ID ``atlas_coords``. @@ -94,7 +94,7 @@ Returns -1 if there is not tile at the given coords. .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_id**\ (\ index\: :ref:`int`\ ) |const| +:ref:`Vector2i` **get_tile_id**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tile coordinates ID of the tile with index ``index``. @@ -106,7 +106,7 @@ Returns the tile coordinates ID of the tile with index ``index``. .. rst-class:: classref-method -:ref:`int` **get_tiles_count**\ (\ ) |const| +:ref:`int` **get_tiles_count**\ (\ ) |const| :ref:`🔗` Returns how many tiles this atlas source defines (not including alternative tiles). @@ -118,7 +118,7 @@ Returns how many tiles this atlas source defines (not including alternative tile .. rst-class:: classref-method -:ref:`bool` **has_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| +:ref:`bool` **has_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| :ref:`🔗` Returns if the base tile at coordinates ``atlas_coords`` has an alternative with ID ``alternative_tile``. @@ -130,7 +130,7 @@ Returns if the base tile at coordinates ``atlas_coords`` has an alternative with .. rst-class:: classref-method -:ref:`bool` **has_tile**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| +:ref:`bool` **has_tile**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns if this atlas has a tile with coordinates ID ``atlas_coords``. diff --git a/classes/class_time.rst b/classes/class_time.rst index 7c75bf798f5..b5695a8d6b7 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -94,7 +94,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Month**: +enum **Month**: :ref:`🔗` .. _class_Time_constant_MONTH_JANUARY: @@ -200,7 +200,7 @@ The month of December, represented numerically as ``12``. .. rst-class:: classref-enumeration -enum **Weekday**: +enum **Weekday**: :ref:`🔗` .. _class_Time_constant_WEEKDAY_SUNDAY: @@ -271,7 +271,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_date_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| +:ref:`Dictionary` **get_date_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the current date as a dictionary of keys: ``year``, ``month``, ``day``, and ``weekday``. @@ -285,7 +285,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`Dictionary` **get_date_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| +:ref:`Dictionary` **get_date_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given Unix timestamp to a dictionary of keys: ``year``, ``month``, ``day``, and ``weekday``. @@ -297,7 +297,7 @@ Converts the given Unix timestamp to a dictionary of keys: ``year``, ``month``, .. rst-class:: classref-method -:ref:`String` **get_date_string_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| +:ref:`String` **get_date_string_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the current date as an ISO 8601 date string (YYYY-MM-DD). @@ -311,7 +311,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`String` **get_date_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| +:ref:`String` **get_date_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). @@ -323,7 +323,7 @@ Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). .. rst-class:: classref-method -:ref:`Dictionary` **get_datetime_dict_from_datetime_string**\ (\ datetime\: :ref:`String`, weekday\: :ref:`bool`\ ) |const| +:ref:`Dictionary` **get_datetime_dict_from_datetime_string**\ (\ datetime\: :ref:`String`, weekday\: :ref:`bool`\ ) |const| :ref:`🔗` Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``hour``, ``minute``, and ``second``. @@ -339,7 +339,7 @@ If ``weekday`` is ``false``, then the ``weekday`` entry is excluded (the calcula .. rst-class:: classref-method -:ref:`Dictionary` **get_datetime_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| +:ref:`Dictionary` **get_datetime_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the current date as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``hour``, ``minute``, ``second``, and ``dst`` (Daylight Savings Time). @@ -351,7 +351,7 @@ Returns the current date as a dictionary of keys: ``year``, ``month``, ``day``, .. rst-class:: classref-method -:ref:`Dictionary` **get_datetime_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| +:ref:`Dictionary` **get_datetime_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given Unix timestamp to a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``hour``, ``minute``, and ``second``. @@ -365,7 +365,7 @@ The returned Dictionary's values will be the same as the :ref:`get_datetime_dict .. rst-class:: classref-method -:ref:`String` **get_datetime_string_from_datetime_dict**\ (\ datetime\: :ref:`Dictionary`, use_space\: :ref:`bool`\ ) |const| +:ref:`String` **get_datetime_string_from_datetime_dict**\ (\ datetime\: :ref:`Dictionary`, use_space\: :ref:`bool`\ ) |const| :ref:`🔗` Converts the given dictionary of keys to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). @@ -383,7 +383,7 @@ If ``use_space`` is ``true``, the date and time bits are separated by an empty s .. rst-class:: classref-method -:ref:`String` **get_datetime_string_from_system**\ (\ utc\: :ref:`bool` = false, use_space\: :ref:`bool` = false\ ) |const| +:ref:`String` **get_datetime_string_from_system**\ (\ utc\: :ref:`bool` = false, use_space\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). @@ -399,7 +399,7 @@ If ``use_space`` is ``true``, the date and time bits are separated by an empty s .. rst-class:: classref-method -:ref:`String` **get_datetime_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`, use_space\: :ref:`bool` = false\ ) |const| +:ref:`String` **get_datetime_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`, use_space\: :ref:`bool` = false\ ) |const| :ref:`🔗` Converts the given Unix timestamp to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). @@ -413,7 +413,7 @@ If ``use_space`` is ``true``, the date and time bits are separated by an empty s .. rst-class:: classref-method -:ref:`String` **get_offset_string_from_offset_minutes**\ (\ offset_minutes\: :ref:`int`\ ) |const| +:ref:`String` **get_offset_string_from_offset_minutes**\ (\ offset_minutes\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given timezone offset in minutes to a timezone offset string. For example, -480 returns "-08:00", 345 returns "+05:45", and 0 returns "+00:00". @@ -425,7 +425,7 @@ Converts the given timezone offset in minutes to a timezone offset string. For e .. rst-class:: classref-method -:ref:`int` **get_ticks_msec**\ (\ ) |const| +:ref:`int` **get_ticks_msec**\ (\ ) |const| :ref:`🔗` Returns the amount of time passed in milliseconds since the engine started. @@ -439,7 +439,7 @@ Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly .. rst-class:: classref-method -:ref:`int` **get_ticks_usec**\ (\ ) |const| +:ref:`int` **get_ticks_usec**\ (\ ) |const| :ref:`🔗` Returns the amount of time passed in microseconds since the engine started. @@ -453,7 +453,7 @@ Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly .. rst-class:: classref-method -:ref:`Dictionary` **get_time_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| +:ref:`Dictionary` **get_time_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the current time as a dictionary of keys: ``hour``, ``minute``, and ``second``. @@ -467,7 +467,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`Dictionary` **get_time_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| +:ref:`Dictionary` **get_time_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given time to a dictionary of keys: ``hour``, ``minute``, and ``second``. @@ -479,7 +479,7 @@ Converts the given time to a dictionary of keys: ``hour``, ``minute``, and ``sec .. rst-class:: classref-method -:ref:`String` **get_time_string_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| +:ref:`String` **get_time_string_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the current time as an ISO 8601 time string (HH:MM:SS). @@ -493,7 +493,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`String` **get_time_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| +:ref:`String` **get_time_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). @@ -505,7 +505,7 @@ Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). .. rst-class:: classref-method -:ref:`Dictionary` **get_time_zone_from_system**\ (\ ) |const| +:ref:`Dictionary` **get_time_zone_from_system**\ (\ ) |const| :ref:`🔗` Returns the current time zone as a dictionary of keys: ``bias`` and ``name``. @@ -521,7 +521,7 @@ Returns the current time zone as a dictionary of keys: ``bias`` and ``name``. .. rst-class:: classref-method -:ref:`int` **get_unix_time_from_datetime_dict**\ (\ datetime\: :ref:`Dictionary`\ ) |const| +:ref:`int` **get_unix_time_from_datetime_dict**\ (\ datetime\: :ref:`Dictionary`\ ) |const| :ref:`🔗` Converts a dictionary of time values to a Unix timestamp. @@ -541,7 +541,7 @@ You can pass the output from :ref:`get_datetime_dict_from_unix_time` **get_unix_time_from_datetime_string**\ (\ datetime\: :ref:`String`\ ) |const| +:ref:`int` **get_unix_time_from_datetime_string**\ (\ datetime\: :ref:`String`\ ) |const| :ref:`🔗` Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. @@ -557,7 +557,7 @@ Converts the given ISO 8601 date and/or time string to a Unix timestamp. The str .. rst-class:: classref-method -:ref:`float` **get_unix_time_from_system**\ (\ ) |const| +:ref:`float` **get_unix_time_from_system**\ (\ ) |const| :ref:`🔗` Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. The Unix timestamp is the number of seconds passed since 1970-01-01 at 00:00:00, the `Unix epoch `__. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index f30a3d32323..fee0bdb49e2 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -92,7 +92,7 @@ Signals .. rst-class:: classref-signal -**timeout**\ (\ ) +**timeout**\ (\ ) :ref:`🔗` Emitted when the timer reaches the end. @@ -109,7 +109,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TimerProcessCallback**: +enum **TimerProcessCallback**: :ref:`🔗` .. _class_Timer_constant_TIMER_PROCESS_PHYSICS: @@ -140,7 +140,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **autostart** = ``false`` +:ref:`bool` **autostart** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ If ``true``, the timer will start immediately when it enters the scene tree. .. rst-class:: classref-property -:ref:`bool` **one_shot** = ``false`` +:ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ If ``true``, the timer will stop after reaching the end. Otherwise, as by defaul .. rst-class:: classref-property -:ref:`bool` **paused** +:ref:`bool` **paused** :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ If ``true``, the timer is paused. A paused timer does not process until this pro .. rst-class:: classref-property -:ref:`TimerProcessCallback` **process_callback** = ``1`` +:ref:`TimerProcessCallback` **process_callback** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -210,7 +210,7 @@ Specifies when the timer is updated during the main loop (see :ref:`TimerProcess .. rst-class:: classref-property -:ref:`float` **time_left** +:ref:`float` **time_left** :ref:`🔗` .. rst-class:: classref-property-setget @@ -228,7 +228,7 @@ The timer's remaining time in seconds. This is always ``0`` if the timer is stop .. rst-class:: classref-property -:ref:`float` **wait_time** = ``1.0`` +:ref:`float` **wait_time** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -252,7 +252,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_stopped**\ (\ ) |const| +:ref:`bool` **is_stopped**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the timer is stopped or has not started. @@ -264,7 +264,7 @@ Returns ``true`` if the timer is stopped or has not started. .. rst-class:: classref-method -|void| **start**\ (\ time_sec\: :ref:`float` = -1\ ) +|void| **start**\ (\ time_sec\: :ref:`float` = -1\ ) :ref:`🔗` Starts the timer, if it was not started already. Fails if the timer is not inside the tree. If ``time_sec`` is greater than ``0``, this value is used for the :ref:`wait_time`. @@ -278,7 +278,7 @@ Starts the timer, if it was not started already. Fails if the timer is not insid .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops the timer. diff --git a/classes/class_tlsoptions.rst b/classes/class_tlsoptions.rst index ac89b5bd773..6a20091b837 100644 --- a/classes/class_tlsoptions.rst +++ b/classes/class_tlsoptions.rst @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`TLSOptions` **client**\ (\ trusted_chain\: :ref:`X509Certificate` = null, common_name_override\: :ref:`String` = ""\ ) |static| +:ref:`TLSOptions` **client**\ (\ trusted_chain\: :ref:`X509Certificate` = null, common_name_override\: :ref:`String` = ""\ ) |static| :ref:`🔗` Creates a TLS client configuration which validates certificates and their common names (fully qualified domain names). @@ -84,7 +84,7 @@ You can specify a custom ``trusted_chain`` of certification authorities (the def .. rst-class:: classref-method -:ref:`TLSOptions` **client_unsafe**\ (\ trusted_chain\: :ref:`X509Certificate` = null\ ) |static| +:ref:`TLSOptions` **client_unsafe**\ (\ trusted_chain\: :ref:`X509Certificate` = null\ ) |static| :ref:`🔗` Creates an **unsafe** TLS client configuration where certificate validation is optional. You can optionally provide a valid ``trusted_chain``, but the common name of the certificates will never be checked. Using this configuration for purposes other than testing **is not recommended**. @@ -98,7 +98,7 @@ Creates an **unsafe** TLS client configuration where certificate validation is o .. rst-class:: classref-method -:ref:`TLSOptions` **server**\ (\ key\: :ref:`CryptoKey`, certificate\: :ref:`X509Certificate`\ ) |static| +:ref:`TLSOptions` **server**\ (\ key\: :ref:`CryptoKey`, certificate\: :ref:`X509Certificate`\ ) |static| :ref:`🔗` Creates a TLS server configuration using the provided ``key`` and ``certificate``. diff --git a/classes/class_torusmesh.rst b/classes/class_torusmesh.rst index 9da4a744887..3989092e86d 100644 --- a/classes/class_torusmesh.rst +++ b/classes/class_torusmesh.rst @@ -52,7 +52,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **inner_radius** = ``0.5`` +:ref:`float` **inner_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -69,7 +69,7 @@ The inner radius of the torus. .. rst-class:: classref-property -:ref:`float` **outer_radius** = ``1.0`` +:ref:`float` **outer_radius** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -86,7 +86,7 @@ The outer radius of the torus. .. rst-class:: classref-property -:ref:`int` **ring_segments** = ``32`` +:ref:`int` **ring_segments** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -103,7 +103,7 @@ The number of edges each ring of the torus is constructed of. .. rst-class:: classref-property -:ref:`int` **rings** = ``64`` +:ref:`int` **rings** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 15fafb45d8c..fd295be67b6 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -78,7 +78,7 @@ Signals .. rst-class:: classref-signal -**pressed**\ (\ ) +**pressed**\ (\ ) :ref:`🔗` Emitted when the button is pressed (down). @@ -90,7 +90,7 @@ Emitted when the button is pressed (down). .. rst-class:: classref-signal -**released**\ (\ ) +**released**\ (\ ) :ref:`🔗` Emitted when the button is released (up). @@ -107,7 +107,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **VisibilityMode**: +enum **VisibilityMode**: :ref:`🔗` .. _class_TouchScreenButton_constant_VISIBILITY_ALWAYS: @@ -138,7 +138,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **action** = ``""`` +:ref:`String` **action** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ The button's action. Actions can be handled with :ref:`InputEventAction` **bitmask** +:ref:`BitMap` **bitmask** :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ The button's bitmask. .. rst-class:: classref-property -:ref:`bool` **passby_press** = ``false`` +:ref:`bool` **passby_press** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ If ``true``, the :ref:`pressed` and :ref .. rst-class:: classref-property -:ref:`Shape2D` **shape** +:ref:`Shape2D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget @@ -208,7 +208,7 @@ The button's shape. .. rst-class:: classref-property -:ref:`bool` **shape_centered** = ``true`` +:ref:`bool` **shape_centered** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ If ``true``, the button's shape is centered in the provided texture. If no textu .. rst-class:: classref-property -:ref:`bool` **shape_visible** = ``true`` +:ref:`bool` **shape_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ If ``true``, the button's shape is visible in the editor. .. rst-class:: classref-property -:ref:`Texture2D` **texture_normal** +:ref:`Texture2D` **texture_normal** :ref:`🔗` .. rst-class:: classref-property-setget @@ -259,7 +259,7 @@ The button's texture for the normal state. .. rst-class:: classref-property -:ref:`Texture2D` **texture_pressed** +:ref:`Texture2D` **texture_pressed** :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ The button's texture for the pressed state. .. rst-class:: classref-property -:ref:`VisibilityMode` **visibility_mode** = ``0`` +:ref:`VisibilityMode` **visibility_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -298,7 +298,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_pressed**\ (\ ) |const| +:ref:`bool` **is_pressed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this button is currently pressed. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index c88057f0b3b..ccf25f0fbbe 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -171,7 +171,7 @@ Constants .. rst-class:: classref-constant -**IDENTITY** = ``Transform2D(1, 0, 0, 1, 0, 0)`` +**IDENTITY** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗` The identity **Transform2D** with no translation, rotation or scaling applied. When applied to other data structures, :ref:`IDENTITY` performs no transformation. @@ -179,7 +179,7 @@ The identity **Transform2D** with no translation, rotation or scaling applied. W .. rst-class:: classref-constant -**FLIP_X** = ``Transform2D(-1, 0, 0, 1, 0, 0)`` +**FLIP_X** = ``Transform2D(-1, 0, 0, 1, 0, 0)`` :ref:`🔗` The **Transform2D** that will flip something along the X axis. @@ -187,7 +187,7 @@ The **Transform2D** that will flip something along the X axis. .. rst-class:: classref-constant -**FLIP_Y** = ``Transform2D(1, 0, 0, -1, 0, 0)`` +**FLIP_Y** = ``Transform2D(1, 0, 0, -1, 0, 0)`` :ref:`🔗` The **Transform2D** that will flip something along the Y axis. @@ -204,7 +204,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **origin** = ``Vector2(0, 0)`` +:ref:`Vector2` **origin** = ``Vector2(0, 0)`` :ref:`🔗` The origin vector (column 2, the third column). Equivalent to array index ``2``. The origin vector represents translation. @@ -216,7 +216,7 @@ The origin vector (column 2, the third column). Equivalent to array index ``2``. .. rst-class:: classref-property -:ref:`Vector2` **x** = ``Vector2(1, 0)`` +:ref:`Vector2` **x** = ``Vector2(1, 0)`` :ref:`🔗` The basis matrix's X vector (column 0). Equivalent to array index ``0``. @@ -228,7 +228,7 @@ The basis matrix's X vector (column 0). Equivalent to array index ``0``. .. rst-class:: classref-property -:ref:`Vector2` **y** = ``Vector2(0, 1)`` +:ref:`Vector2` **y** = ``Vector2(0, 1)`` :ref:`🔗` The basis matrix's Y vector (column 1). Equivalent to array index ``1``. @@ -245,7 +245,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Transform2D` **Transform2D**\ (\ ) +:ref:`Transform2D` **Transform2D**\ (\ ) :ref:`🔗` Constructs a default-initialized **Transform2D** set to :ref:`IDENTITY`. @@ -302,7 +302,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform2D` **affine_inverse**\ (\ ) |const| +:ref:`Transform2D` **affine_inverse**\ (\ ) |const| :ref:`🔗` Returns the inverse of the transform, under the assumption that the basis is invertible (must have non-zero determinant). @@ -314,7 +314,7 @@ Returns the inverse of the transform, under the assumption that the basis is inv .. rst-class:: classref-method -:ref:`Vector2` **basis_xform**\ (\ v\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **basis_xform**\ (\ v\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a vector transformed (multiplied) by the basis matrix. @@ -328,7 +328,7 @@ This method does not account for translation (the :ref:`origin` **basis_xform_inv**\ (\ v\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **basis_xform_inv**\ (\ v\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a vector transformed (multiplied) by the inverse basis matrix, under the assumption that the basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -346,7 +346,7 @@ For non-orthonormal transforms (e.g. with scaling) ``transform.affine_inverse(). .. rst-class:: classref-method -:ref:`float` **determinant**\ (\ ) |const| +:ref:`float` **determinant**\ (\ ) |const| :ref:`🔗` Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor. @@ -360,7 +360,7 @@ A negative determinant means the basis was flipped, so one part of the scale is .. rst-class:: classref-method -:ref:`Vector2` **get_origin**\ (\ ) |const| +:ref:`Vector2` **get_origin**\ (\ ) |const| :ref:`🔗` Returns the transform's origin (translation). @@ -372,7 +372,7 @@ Returns the transform's origin (translation). .. rst-class:: classref-method -:ref:`float` **get_rotation**\ (\ ) |const| +:ref:`float` **get_rotation**\ (\ ) |const| :ref:`🔗` Returns the transform's rotation (in radians). @@ -384,7 +384,7 @@ Returns the transform's rotation (in radians). .. rst-class:: classref-method -:ref:`Vector2` **get_scale**\ (\ ) |const| +:ref:`Vector2` **get_scale**\ (\ ) |const| :ref:`🔗` Returns the scale. @@ -396,7 +396,7 @@ Returns the scale. .. rst-class:: classref-method -:ref:`float` **get_skew**\ (\ ) |const| +:ref:`float` **get_skew**\ (\ ) |const| :ref:`🔗` Returns the transform's skew (in radians). @@ -408,7 +408,7 @@ Returns the transform's skew (in radians). .. rst-class:: classref-method -:ref:`Transform2D` **interpolate_with**\ (\ xform\: :ref:`Transform2D`, weight\: :ref:`float`\ ) |const| +:ref:`Transform2D` **interpolate_with**\ (\ xform\: :ref:`Transform2D`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns a transform interpolated between this transform and another by a given ``weight`` (on the range of 0.0 to 1.0). @@ -420,7 +420,7 @@ Returns a transform interpolated between this transform and another by a given ` .. rst-class:: classref-method -:ref:`Transform2D` **inverse**\ (\ ) |const| +:ref:`Transform2D` **inverse**\ (\ ) |const| :ref:`🔗` Returns the inverse of the transform, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). Use :ref:`affine_inverse` for non-orthonormal transforms (e.g. with scaling). @@ -432,7 +432,7 @@ Returns the inverse of the transform, under the assumption that the transformati .. rst-class:: classref-method -:ref:`bool` **is_conformal**\ (\ ) |const| +:ref:`bool` **is_conformal**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the transform's basis is conformal, meaning it preserves angles and distance ratios, and may only be composed of rotation and uniform scale. Returns ``false`` if the transform's basis has non-uniform scale or shear/skew. This can be used to validate if the transform is non-distorted, which is important for physics and other use cases. @@ -444,7 +444,7 @@ Returns ``true`` if the transform's basis is conformal, meaning it preserves ang .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ xform\: :ref:`Transform2D`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ xform\: :ref:`Transform2D`\ ) |const| :ref:`🔗` Returns ``true`` if this transform and ``xform`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -456,7 +456,7 @@ Returns ``true`` if this transform and ``xform`` are approximately equal, by run .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -468,7 +468,7 @@ Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_f .. rst-class:: classref-method -:ref:`Transform2D` **looking_at**\ (\ target\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| +:ref:`Transform2D` **looking_at**\ (\ target\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| :ref:`🔗` Returns a copy of the transform rotated such that the rotated X-axis points towards the ``target`` position. @@ -482,7 +482,7 @@ Operations take place in global space. .. rst-class:: classref-method -:ref:`Transform2D` **orthonormalized**\ (\ ) |const| +:ref:`Transform2D` **orthonormalized**\ (\ ) |const| :ref:`🔗` Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). @@ -494,7 +494,7 @@ Returns the transform with the basis orthogonal (90 degrees), and normalized axi .. rst-class:: classref-method -:ref:`Transform2D` **rotated**\ (\ angle\: :ref:`float`\ ) |const| +:ref:`Transform2D` **rotated**\ (\ angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of the transform rotated by the given ``angle`` (in radians). @@ -510,7 +510,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform2D` **rotated_local**\ (\ angle\: :ref:`float`\ ) |const| +:ref:`Transform2D` **rotated_local**\ (\ angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of the transform rotated by the given ``angle`` (in radians). @@ -526,7 +526,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform2D` **scaled**\ (\ scale\: :ref:`Vector2`\ ) |const| +:ref:`Transform2D` **scaled**\ (\ scale\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a copy of the transform scaled by the given ``scale`` factor. @@ -542,7 +542,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform2D` **scaled_local**\ (\ scale\: :ref:`Vector2`\ ) |const| +:ref:`Transform2D` **scaled_local**\ (\ scale\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a copy of the transform scaled by the given ``scale`` factor. @@ -558,7 +558,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform2D` **translated**\ (\ offset\: :ref:`Vector2`\ ) |const| +:ref:`Transform2D` **translated**\ (\ offset\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a copy of the transform translated by the given ``offset``. @@ -574,7 +574,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform2D` **translated_local**\ (\ offset\: :ref:`Vector2`\ ) |const| +:ref:`Transform2D` **translated_local**\ (\ offset\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a copy of the transform translated by the given ``offset``. @@ -595,7 +595,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Transform2D`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Returns ``true`` if the transforms are not equal. @@ -609,7 +609,7 @@ Returns ``true`` if the transforms are not equal. .. rst-class:: classref-operator -:ref:`PackedVector2Array` **operator ***\ (\ right\: :ref:`PackedVector2Array`\ ) +:ref:`PackedVector2Array` **operator ***\ (\ right\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Transforms (multiplies) each element of the :ref:`Vector2` array by the given **Transform2D** matrix. @@ -621,7 +621,7 @@ Transforms (multiplies) each element of the :ref:`Vector2` array .. rst-class:: classref-operator -:ref:`Rect2` **operator ***\ (\ right\: :ref:`Rect2`\ ) +:ref:`Rect2` **operator ***\ (\ right\: :ref:`Rect2`\ ) :ref:`🔗` Transforms (multiplies) the :ref:`Rect2` by the given **Transform2D** matrix. @@ -633,7 +633,7 @@ Transforms (multiplies) the :ref:`Rect2` by the given **Transform2D .. rst-class:: classref-operator -:ref:`Transform2D` **operator ***\ (\ right\: :ref:`Transform2D`\ ) +:ref:`Transform2D` **operator ***\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). @@ -645,7 +645,7 @@ Composes these two transformation matrices by multiplying them together. This ha .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Transforms (multiplies) the :ref:`Vector2` by the given **Transform2D** matrix. @@ -657,7 +657,7 @@ Transforms (multiplies) the :ref:`Vector2` by the given **Transfo .. rst-class:: classref-operator -:ref:`Transform2D` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Transform2D` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` This operator multiplies all components of the **Transform2D**, including the :ref:`origin` vector, which scales it uniformly. @@ -669,7 +669,7 @@ This operator multiplies all components of the **Transform2D**, including the :r .. rst-class:: classref-operator -:ref:`Transform2D` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Transform2D` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` This operator multiplies all components of the **Transform2D**, including the :ref:`origin` vector, which scales it uniformly. @@ -681,7 +681,7 @@ This operator multiplies all components of the **Transform2D**, including the :r .. rst-class:: classref-operator -:ref:`Transform2D` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Transform2D` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` This operator divides all components of the **Transform2D**, including the :ref:`origin` vector, which inversely scales it uniformly. @@ -693,7 +693,7 @@ This operator divides all components of the **Transform2D**, including the :ref: .. rst-class:: classref-operator -:ref:`Transform2D` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Transform2D` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` This operator divides all components of the **Transform2D**, including the :ref:`origin` vector, which inversely scales it uniformly. @@ -705,7 +705,7 @@ This operator divides all components of the **Transform2D**, including the :ref: .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Transform2D`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Returns ``true`` if the transforms are exactly equal. @@ -719,7 +719,7 @@ Returns ``true`` if the transforms are exactly equal. .. rst-class:: classref-operator -:ref:`Vector2` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`Vector2` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access transform components using their index. ``t[0]`` is equivalent to ``t.x``, ``t[1]`` is equivalent to ``t.y``, and ``t[2]`` is equivalent to ``t.origin``. diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index 81bd3ebb200..d5b7f62265d 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -159,7 +159,7 @@ Constants .. rst-class:: classref-constant -**IDENTITY** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +**IDENTITY** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` A transform with no translation, no rotation, and its scale being ``1``. Its :ref:`basis` is equal to :ref:`Basis.IDENTITY`. @@ -169,7 +169,7 @@ When multiplied by another :ref:`Variant` such as :ref:`AABB` **Transform3D** with mirroring applied perpendicular to the YZ plane. Its :ref:`basis` is equal to :ref:`Basis.FLIP_X`. @@ -177,7 +177,7 @@ When multiplied by another :ref:`Variant` such as :ref:`AABB` **Transform3D** with mirroring applied perpendicular to the XZ plane. Its :ref:`basis` is equal to :ref:`Basis.FLIP_Y`. @@ -185,7 +185,7 @@ When multiplied by another :ref:`Variant` such as :ref:`AABB` **Transform3D** with mirroring applied perpendicular to the XY plane. Its :ref:`basis` is equal to :ref:`Basis.FLIP_Z`. @@ -202,7 +202,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Basis` **basis** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` +:ref:`Basis` **basis** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` :ref:`🔗` The :ref:`Basis` of this transform. It is composed by 3 axes (:ref:`Basis.x`, :ref:`Basis.y`, and :ref:`Basis.z`). Together, these represent the transform's rotation, scale, and shear. @@ -214,7 +214,7 @@ The :ref:`Basis` of this transform. It is composed by 3 axes (:ref: .. rst-class:: classref-property -:ref:`Vector3` **origin** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **origin** = ``Vector3(0, 0, 0)`` :ref:`🔗` The translation offset of this transform. In 3D space, this can be seen as the position. @@ -231,7 +231,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Transform3D` **Transform3D**\ (\ ) +:ref:`Transform3D` **Transform3D**\ (\ ) :ref:`🔗` Constructs a **Transform3D** identical to the :ref:`IDENTITY`. @@ -290,7 +290,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **affine_inverse**\ (\ ) |const| +:ref:`Transform3D` **affine_inverse**\ (\ ) |const| :ref:`🔗` Returns the inverted version of this transform. Unlike :ref:`inverse`, this method works with almost any :ref:`basis`, including non-uniform ones, but is slower. See also :ref:`Basis.inverse`. @@ -304,7 +304,7 @@ Returns the inverted version of this transform. Unlike :ref:`inverse` **interpolate_with**\ (\ xform\: :ref:`Transform3D`, weight\: :ref:`float`\ ) |const| +:ref:`Transform3D` **interpolate_with**\ (\ xform\: :ref:`Transform3D`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of the linear interpolation between this transform and ``xform`` by the given ``weight``. @@ -318,7 +318,7 @@ The ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). Values outside .. rst-class:: classref-method -:ref:`Transform3D` **inverse**\ (\ ) |const| +:ref:`Transform3D` **inverse**\ (\ ) |const| :ref:`🔗` Returns the inverted version of this transform. See also :ref:`Basis.inverse`. @@ -332,7 +332,7 @@ Returns the inverted version of this transform. See also :ref:`Basis.inverse` **is_equal_approx**\ (\ xform\: :ref:`Transform3D`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ xform\: :ref:`Transform3D`\ ) |const| :ref:`🔗` Returns ``true`` if this transform and ``xform`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -344,7 +344,7 @@ Returns ``true`` if this transform and ``xform`` are approximately equal, by run .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -356,7 +356,7 @@ Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_f .. rst-class:: classref-method -:ref:`Transform3D` **looking_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |const| +:ref:`Transform3D` **looking_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a copy of this transform rotated so that the forward axis (-Z) points towards the ``target`` position. @@ -372,7 +372,7 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw .. rst-class:: classref-method -:ref:`Transform3D` **orthonormalized**\ (\ ) |const| +:ref:`Transform3D` **orthonormalized**\ (\ ) |const| :ref:`🔗` Returns a copy of this transform with its :ref:`basis` orthonormalized. An orthonormal basis is both *orthogonal* (the axes are perpendicular to each other) and *normalized* (the axes have a length of ``1``), which also means it can only represent rotation. See also :ref:`Basis.orthonormalized`. @@ -384,7 +384,7 @@ Returns a copy of this transform with its :ref:`basis` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| +:ref:`Transform3D` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this transform rotated around the given ``axis`` by the given ``angle`` (in radians). @@ -402,7 +402,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform3D` **rotated_local**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| +:ref:`Transform3D` **rotated_local**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this transform rotated around the given ``axis`` by the given ``angle`` (in radians). @@ -420,7 +420,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform3D` **scaled**\ (\ scale\: :ref:`Vector3`\ ) |const| +:ref:`Transform3D` **scaled**\ (\ scale\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a copy of this transform scaled by the given ``scale`` factor. @@ -436,7 +436,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform3D` **scaled_local**\ (\ scale\: :ref:`Vector3`\ ) |const| +:ref:`Transform3D` **scaled_local**\ (\ scale\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a copy of this transform scaled by the given ``scale`` factor. @@ -452,7 +452,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform3D` **translated**\ (\ offset\: :ref:`Vector3`\ ) |const| +:ref:`Transform3D` **translated**\ (\ offset\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a copy of this transform translated by the given ``offset``. @@ -468,7 +468,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform3D` **translated_local**\ (\ offset\: :ref:`Vector3`\ ) |const| +:ref:`Transform3D` **translated_local**\ (\ offset\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a copy of this transform translated by the given ``offset``. @@ -489,7 +489,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Transform3D`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Returns ``true`` if the components of both transforms are not equal. @@ -503,7 +503,7 @@ Returns ``true`` if the components of both transforms are not equal. .. rst-class:: classref-operator -:ref:`AABB` **operator ***\ (\ right\: :ref:`AABB`\ ) +:ref:`AABB` **operator ***\ (\ right\: :ref:`AABB`\ ) :ref:`🔗` Transforms (multiplies) the :ref:`AABB` by this transformation matrix. @@ -515,7 +515,7 @@ Transforms (multiplies) the :ref:`AABB` by this transformation matri .. rst-class:: classref-operator -:ref:`PackedVector3Array` **operator ***\ (\ right\: :ref:`PackedVector3Array`\ ) +:ref:`PackedVector3Array` **operator ***\ (\ right\: :ref:`PackedVector3Array`\ ) :ref:`🔗` Transforms (multiplies) every :ref:`Vector3` element of the given :ref:`PackedVector3Array` by this transformation matrix. @@ -529,7 +529,7 @@ On larger arrays, this operation is much faster than transforming each :ref:`Vec .. rst-class:: classref-operator -:ref:`Plane` **operator ***\ (\ right\: :ref:`Plane`\ ) +:ref:`Plane` **operator ***\ (\ right\: :ref:`Plane`\ ) :ref:`🔗` Transforms (multiplies) the :ref:`Plane` by this transformation matrix. @@ -541,7 +541,7 @@ Transforms (multiplies) the :ref:`Plane` by this transformation mat .. rst-class:: classref-operator -:ref:`Transform3D` **operator ***\ (\ right\: :ref:`Transform3D`\ ) +:ref:`Transform3D` **operator ***\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Transforms (multiplies) this transform by the ``right`` transform. @@ -563,7 +563,7 @@ This is the operation performed between parent and child :ref:`Node3D` **operator ***\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Transforms (multiplies) the :ref:`Vector3` by this transformation matrix. @@ -575,7 +575,7 @@ Transforms (multiplies) the :ref:`Vector3` by this transformation .. rst-class:: classref-operator -:ref:`Transform3D` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Transform3D` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies all components of the **Transform3D** by the given :ref:`float`, including the :ref:`origin`. This affects the transform's scale uniformly, scaling the :ref:`basis`. @@ -587,7 +587,7 @@ Multiplies all components of the **Transform3D** by the given :ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Transform3D` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies all components of the **Transform3D** by the given :ref:`int`, including the :ref:`origin`. This affects the transform's scale uniformly, scaling the :ref:`basis`. @@ -599,7 +599,7 @@ Multiplies all components of the **Transform3D** by the given :ref:`int` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Transform3D` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides all components of the **Transform3D** by the given :ref:`float`, including the :ref:`origin`. This affects the transform's scale uniformly, scaling the :ref:`basis`. @@ -611,7 +611,7 @@ Divides all components of the **Transform3D** by the given :ref:`float` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Transform3D` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides all components of the **Transform3D** by the given :ref:`int`, including the :ref:`origin`. This affects the transform's scale uniformly, scaling the :ref:`basis`. @@ -623,7 +623,7 @@ Divides all components of the **Transform3D** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Transform3D`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Returns ``true`` if the components of both transforms are exactly equal. diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 3d2f1e3a767..56e84a449ee 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **locale** = ``"en"`` +:ref:`String` **locale** = ``"en"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -109,7 +109,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **_get_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName`\ ) |virtual| |const| +:ref:`StringName` **_get_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Virtual method to override :ref:`get_message`. @@ -121,7 +121,7 @@ Virtual method to override :ref:`get_message` **_get_plural_message**\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName`\ ) |virtual| |const| +:ref:`StringName` **_get_plural_message**\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Virtual method to override :ref:`get_plural_message`. @@ -133,7 +133,7 @@ Virtual method to override :ref:`get_plural_message`, xlated_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) +|void| **add_message**\ (\ src_message\: :ref:`StringName`, xlated_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) :ref:`🔗` Adds a message if nonexistent, followed by its translation. @@ -147,7 +147,7 @@ An additional context could be used to specify the translation context or differ .. rst-class:: classref-method -|void| **add_plural_message**\ (\ src_message\: :ref:`StringName`, xlated_messages\: :ref:`PackedStringArray`, context\: :ref:`StringName` = &""\ ) +|void| **add_plural_message**\ (\ src_message\: :ref:`StringName`, xlated_messages\: :ref:`PackedStringArray`, context\: :ref:`StringName` = &""\ ) :ref:`🔗` Adds a message involving plural translation if nonexistent, followed by its translation. @@ -161,7 +161,7 @@ An additional context could be used to specify the translation context or differ .. rst-class:: classref-method -|void| **erase_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) +|void| **erase_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) :ref:`🔗` Erases a message. @@ -173,7 +173,7 @@ Erases a message. .. rst-class:: classref-method -:ref:`StringName` **get_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| +:ref:`StringName` **get_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a message's translation. @@ -185,7 +185,7 @@ Returns a message's translation. .. rst-class:: classref-method -:ref:`int` **get_message_count**\ (\ ) |const| +:ref:`int` **get_message_count**\ (\ ) |const| :ref:`🔗` Returns the number of existing messages. @@ -197,7 +197,7 @@ Returns the number of existing messages. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_message_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_message_list**\ (\ ) |const| :ref:`🔗` Returns all the messages (keys). @@ -209,7 +209,7 @@ Returns all the messages (keys). .. rst-class:: classref-method -:ref:`StringName` **get_plural_message**\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| +:ref:`StringName` **get_plural_message**\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a message's translation involving plurals. @@ -223,7 +223,7 @@ The number ``n`` is the number or quantity of the plural object. It will be used .. rst-class:: classref-method -:ref:`PackedStringArray` **get_translated_message_list**\ (\ ) |const| +:ref:`PackedStringArray` **get_translated_message_list**\ (\ ) |const| :ref:`🔗` Returns all the messages (translated text). diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index be1aeb0c9f2..e7fc35236ef 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -107,7 +107,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **pseudolocalization_enabled** = ``false`` +:ref:`bool` **pseudolocalization_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -129,7 +129,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_translation**\ (\ translation\: :ref:`Translation`\ ) +|void| **add_translation**\ (\ translation\: :ref:`Translation`\ ) :ref:`🔗` Adds a :ref:`Translation` resource. @@ -141,7 +141,7 @@ Adds a :ref:`Translation` resource. .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the server from all translations. @@ -153,7 +153,7 @@ Clears the server from all translations. .. rst-class:: classref-method -:ref:`int` **compare_locales**\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| +:ref:`int` **compare_locales**\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| :ref:`🔗` Compares two locales and returns a similarity score between ``0`` (no match) and ``10`` (full match). @@ -165,7 +165,7 @@ Compares two locales and returns a similarity score between ``0`` (no match) and .. rst-class:: classref-method -:ref:`PackedStringArray` **get_all_countries**\ (\ ) |const| +:ref:`PackedStringArray` **get_all_countries**\ (\ ) |const| :ref:`🔗` Returns an array of known country codes. @@ -177,7 +177,7 @@ Returns an array of known country codes. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_all_languages**\ (\ ) |const| +:ref:`PackedStringArray` **get_all_languages**\ (\ ) |const| :ref:`🔗` Returns array of known language codes. @@ -189,7 +189,7 @@ Returns array of known language codes. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_all_scripts**\ (\ ) |const| +:ref:`PackedStringArray` **get_all_scripts**\ (\ ) |const| :ref:`🔗` Returns an array of known script codes. @@ -201,7 +201,7 @@ Returns an array of known script codes. .. rst-class:: classref-method -:ref:`String` **get_country_name**\ (\ country\: :ref:`String`\ ) |const| +:ref:`String` **get_country_name**\ (\ country\: :ref:`String`\ ) |const| :ref:`🔗` Returns a readable country name for the ``country`` code. @@ -213,7 +213,7 @@ Returns a readable country name for the ``country`` code. .. rst-class:: classref-method -:ref:`String` **get_language_name**\ (\ language\: :ref:`String`\ ) |const| +:ref:`String` **get_language_name**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` Returns a readable language name for the ``language`` code. @@ -225,7 +225,7 @@ Returns a readable language name for the ``language`` code. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_loaded_locales**\ (\ ) |const| +:ref:`PackedStringArray` **get_loaded_locales**\ (\ ) |const| :ref:`🔗` Returns an array of all loaded locales of the project. @@ -237,7 +237,7 @@ Returns an array of all loaded locales of the project. .. rst-class:: classref-method -:ref:`String` **get_locale**\ (\ ) |const| +:ref:`String` **get_locale**\ (\ ) |const| :ref:`🔗` Returns the current locale of the project. @@ -251,7 +251,7 @@ See also :ref:`OS.get_locale` and :ref:`OS.get_local .. rst-class:: classref-method -:ref:`String` **get_locale_name**\ (\ locale\: :ref:`String`\ ) |const| +:ref:`String` **get_locale_name**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"English (United States)"``). @@ -263,7 +263,7 @@ Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"En .. rst-class:: classref-method -:ref:`String` **get_script_name**\ (\ script\: :ref:`String`\ ) |const| +:ref:`String` **get_script_name**\ (\ script\: :ref:`String`\ ) |const| :ref:`🔗` Returns a readable script name for the ``script`` code. @@ -275,7 +275,7 @@ Returns a readable script name for the ``script`` code. .. rst-class:: classref-method -:ref:`String` **get_tool_locale**\ (\ ) +:ref:`String` **get_tool_locale**\ (\ ) :ref:`🔗` Returns the current locale of the editor. @@ -289,7 +289,7 @@ Returns the current locale of the editor. .. rst-class:: classref-method -:ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) +:ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` Returns the :ref:`Translation` instance based on the ``locale`` passed in. @@ -303,7 +303,7 @@ It will return ``null`` if there is no :ref:`Translation` ins .. rst-class:: classref-method -:ref:`StringName` **pseudolocalize**\ (\ message\: :ref:`StringName`\ ) |const| +:ref:`StringName` **pseudolocalize**\ (\ message\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the pseudolocalized string based on the ``message`` passed in. @@ -315,7 +315,7 @@ Returns the pseudolocalized string based on the ``message`` passed in. .. rst-class:: classref-method -|void| **reload_pseudolocalization**\ (\ ) +|void| **reload_pseudolocalization**\ (\ ) :ref:`🔗` Reparses the pseudolocalization options and reloads the translation. @@ -327,7 +327,7 @@ Reparses the pseudolocalization options and reloads the translation. .. rst-class:: classref-method -|void| **remove_translation**\ (\ translation\: :ref:`Translation`\ ) +|void| **remove_translation**\ (\ translation\: :ref:`Translation`\ ) :ref:`🔗` Removes the given translation from the server. @@ -339,7 +339,7 @@ Removes the given translation from the server. .. rst-class:: classref-method -|void| **set_locale**\ (\ locale\: :ref:`String`\ ) +|void| **set_locale**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` Sets the locale of the project. The ``locale`` string will be standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``). @@ -353,7 +353,7 @@ If translations have been loaded beforehand for the new locale, they will be app .. rst-class:: classref-method -:ref:`String` **standardize_locale**\ (\ locale\: :ref:`String`\ ) |const| +:ref:`String` **standardize_locale**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` Returns a ``locale`` string standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``). @@ -365,7 +365,7 @@ Returns a ``locale`` string standardized to match known locales (e.g. ``en-US`` .. rst-class:: classref-method -:ref:`StringName` **translate**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| +:ref:`StringName` **translate**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns the current locale's translation for the given message (key) and context. @@ -377,7 +377,7 @@ Returns the current locale's translation for the given message (key) and context .. rst-class:: classref-method -:ref:`StringName` **translate_plural**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| +:ref:`StringName` **translate_plural**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns the current locale's translation for the given message (key), plural message and context. diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 520acd54b4d..59e259da06a 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -327,7 +327,7 @@ Signals .. rst-class:: classref-signal -**button_clicked**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`, id\: :ref:`int`, mouse_button_index\: :ref:`int`\ ) +**button_clicked**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`, id\: :ref:`int`, mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). @@ -339,7 +339,7 @@ Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button` Emitted when a cell is selected. @@ -351,7 +351,7 @@ Emitted when a cell is selected. .. rst-class:: classref-signal -**check_propagated_to_item**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) +**check_propagated_to_item**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) :ref:`🔗` Emitted when :ref:`TreeItem.propagate_check` is called. Connect to this signal to process the items that are affected when :ref:`TreeItem.propagate_check` is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item. @@ -363,7 +363,7 @@ Emitted when :ref:`TreeItem.propagate_check`, mouse_button_index\: :ref:`int`\ ) +**column_title_clicked**\ (\ column\: :ref:`int`, mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a column's title is clicked with either :ref:`@GlobalScope.MOUSE_BUTTON_LEFT` or :ref:`@GlobalScope.MOUSE_BUTTON_RIGHT`. @@ -375,7 +375,7 @@ Emitted when a column's title is clicked with either :ref:`@GlobalScope.MOUSE_BU .. rst-class:: classref-signal -**custom_item_clicked**\ (\ mouse_button_index\: :ref:`int`\ ) +**custom_item_clicked**\ (\ mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Emitted when an item with :ref:`TreeItem.CELL_MODE_CUSTOM` is clicked with a mouse button. @@ -387,7 +387,7 @@ Emitted when an item with :ref:`TreeItem.CELL_MODE_CUSTOM`\ ) +**custom_popup_edited**\ (\ arrow_clicked\: :ref:`bool`\ ) :ref:`🔗` Emitted when a cell with the :ref:`TreeItem.CELL_MODE_CUSTOM` is clicked to be edited. @@ -399,7 +399,7 @@ Emitted when a cell with the :ref:`TreeItem.CELL_MODE_CUSTOM`, mouse_button_index\: :ref:`int`\ ) +**empty_clicked**\ (\ click_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Emitted when a mouse button is clicked in the empty space of the tree. @@ -411,7 +411,7 @@ Emitted when a mouse button is clicked in the empty space of the tree. .. rst-class:: classref-signal -**item_activated**\ (\ ) +**item_activated**\ (\ ) :ref:`🔗` Emitted when an item is double-clicked, or selected with a ``ui_accept`` input event (e.g. using :kbd:`Enter` or :kbd:`Space` on the keyboard). @@ -423,7 +423,7 @@ Emitted when an item is double-clicked, or selected with a ``ui_accept`` input e .. rst-class:: classref-signal -**item_collapsed**\ (\ item\: :ref:`TreeItem`\ ) +**item_collapsed**\ (\ item\: :ref:`TreeItem`\ ) :ref:`🔗` Emitted when an item is collapsed by a click on the folding arrow. @@ -435,7 +435,7 @@ Emitted when an item is collapsed by a click on the folding arrow. .. rst-class:: classref-signal -**item_edited**\ (\ ) +**item_edited**\ (\ ) :ref:`🔗` Emitted when an item is edited. @@ -447,7 +447,7 @@ Emitted when an item is edited. .. rst-class:: classref-signal -**item_icon_double_clicked**\ (\ ) +**item_icon_double_clicked**\ (\ ) :ref:`🔗` Emitted when an item's icon is double-clicked. For a signal that emits when any part of the item is double-clicked, see :ref:`item_activated`. @@ -459,7 +459,7 @@ Emitted when an item's icon is double-clicked. For a signal that emits when any .. rst-class:: classref-signal -**item_mouse_selected**\ (\ mouse_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) +**item_mouse_selected**\ (\ mouse_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) :ref:`🔗` Emitted when an item is selected with a mouse button. @@ -471,7 +471,7 @@ Emitted when an item is selected with a mouse button. .. rst-class:: classref-signal -**item_selected**\ (\ ) +**item_selected**\ (\ ) :ref:`🔗` Emitted when an item is selected. @@ -483,7 +483,7 @@ Emitted when an item is selected. .. rst-class:: classref-signal -**multi_selected**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`, selected\: :ref:`bool`\ ) +**multi_selected**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`, selected\: :ref:`bool`\ ) :ref:`🔗` Emitted instead of :ref:`item_selected` if :ref:`select_mode` is set to :ref:`SELECT_MULTI`. @@ -495,7 +495,7 @@ Emitted instead of :ref:`item_selected` if :ref .. rst-class:: classref-signal -**nothing_selected**\ (\ ) +**nothing_selected**\ (\ ) :ref:`🔗` Emitted when a left mouse button click does not select any item. @@ -512,7 +512,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **SelectMode**: +enum **SelectMode**: :ref:`🔗` .. _class_Tree_constant_SELECT_SINGLE: @@ -552,7 +552,7 @@ The focus cursor is visible in this mode, the item or column under the cursor is .. rst-class:: classref-enumeration -enum **DropModeFlags**: +enum **DropModeFlags**: :ref:`🔗` .. _class_Tree_constant_DROP_MODE_DISABLED: @@ -597,7 +597,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **allow_reselect** = ``false`` +:ref:`bool` **allow_reselect** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -614,7 +614,7 @@ If ``true``, the currently selected cell may be selected again. .. rst-class:: classref-property -:ref:`bool` **allow_rmb_select** = ``false`` +:ref:`bool` **allow_rmb_select** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -631,7 +631,7 @@ If ``true``, a right mouse button click can select items. .. rst-class:: classref-property -:ref:`bool` **allow_search** = ``true`` +:ref:`bool` **allow_search** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -648,7 +648,7 @@ If ``true``, allows navigating the **Tree** with letter keys through incremental .. rst-class:: classref-property -:ref:`bool` **column_titles_visible** = ``false`` +:ref:`bool` **column_titles_visible** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -665,7 +665,7 @@ If ``true``, column titles are visible. .. rst-class:: classref-property -:ref:`int` **columns** = ``1`` +:ref:`int` **columns** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -682,7 +682,7 @@ The number of columns. .. rst-class:: classref-property -:ref:`int` **drop_mode_flags** = ``0`` +:ref:`int` **drop_mode_flags** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -701,7 +701,7 @@ This controls the drop sections, i.e. the decision and drawing of possible drop .. rst-class:: classref-property -:ref:`bool` **enable_recursive_folding** = ``true`` +:ref:`bool` **enable_recursive_folding** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -718,7 +718,7 @@ If ``true``, recursive folding is enabled for this **Tree**. Holding down :kbd:` .. rst-class:: classref-property -:ref:`bool` **hide_folding** = ``false`` +:ref:`bool` **hide_folding** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -735,7 +735,7 @@ If ``true``, the folding arrow is hidden. .. rst-class:: classref-property -:ref:`bool` **hide_root** = ``false`` +:ref:`bool` **hide_root** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -752,7 +752,7 @@ If ``true``, the tree's root is hidden. .. rst-class:: classref-property -:ref:`bool` **scroll_horizontal_enabled** = ``true`` +:ref:`bool` **scroll_horizontal_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -769,7 +769,7 @@ If ``true``, enables horizontal scrolling. .. rst-class:: classref-property -:ref:`bool` **scroll_vertical_enabled** = ``true`` +:ref:`bool` **scroll_vertical_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -786,7 +786,7 @@ If ``true``, enables vertical scrolling. .. rst-class:: classref-property -:ref:`SelectMode` **select_mode** = ``0`` +:ref:`SelectMode` **select_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -808,7 +808,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear**\ (\ ) +|void| **clear**\ (\ ) :ref:`🔗` Clears the tree. This removes all items. @@ -820,7 +820,7 @@ Clears the tree. This removes all items. .. rst-class:: classref-method -:ref:`TreeItem` **create_item**\ (\ parent\: :ref:`TreeItem` = null, index\: :ref:`int` = -1\ ) +:ref:`TreeItem` **create_item**\ (\ parent\: :ref:`TreeItem` = null, index\: :ref:`int` = -1\ ) :ref:`🔗` Creates an item in the tree and adds it as a child of ``parent``, which can be either a valid :ref:`TreeItem` or ``null``. @@ -836,7 +836,7 @@ The new item will be the ``index``-th child of parent, or it will be the last ch .. rst-class:: classref-method -|void| **deselect_all**\ (\ ) +|void| **deselect_all**\ (\ ) :ref:`🔗` Deselects all tree items (rows and columns). In :ref:`SELECT_MULTI` mode also removes selection cursor. @@ -848,7 +848,7 @@ Deselects all tree items (rows and columns). In :ref:`SELECT_MULTI` **edit_selected**\ (\ force_edit\: :ref:`bool` = false\ ) +:ref:`bool` **edit_selected**\ (\ force_edit\: :ref:`bool` = false\ ) :ref:`🔗` Edits the selected tree item as if it was clicked. @@ -864,7 +864,7 @@ Returns ``true`` if the item could be edited. Fails if no item is selected. .. rst-class:: classref-method -|void| **ensure_cursor_is_visible**\ (\ ) +|void| **ensure_cursor_is_visible**\ (\ ) :ref:`🔗` Makes the currently focused cell visible. @@ -880,7 +880,7 @@ This will scroll the tree if necessary. In :ref:`SELECT_ROW` **get_button_id_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| +:ref:`int` **get_button_id_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the button ID at ``position``, or -1 if no button is there. @@ -892,7 +892,7 @@ Returns the button ID at ``position``, or -1 if no button is there. .. rst-class:: classref-method -:ref:`int` **get_column_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| +:ref:`int` **get_column_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the column index at ``position``, or -1 if no item is there. @@ -904,7 +904,7 @@ Returns the column index at ``position``, or -1 if no item is there. .. rst-class:: classref-method -:ref:`int` **get_column_expand_ratio**\ (\ column\: :ref:`int`\ ) |const| +:ref:`int` **get_column_expand_ratio**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the expand ratio assigned to the column. @@ -916,7 +916,7 @@ Returns the expand ratio assigned to the column. .. rst-class:: classref-method -:ref:`String` **get_column_title**\ (\ column\: :ref:`int`\ ) |const| +:ref:`String` **get_column_title**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the column's title. @@ -928,7 +928,7 @@ Returns the column's title. .. rst-class:: classref-method -:ref:`HorizontalAlignment` **get_column_title_alignment**\ (\ column\: :ref:`int`\ ) |const| +:ref:`HorizontalAlignment` **get_column_title_alignment**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the column title alignment. @@ -940,7 +940,7 @@ Returns the column title alignment. .. rst-class:: classref-method -:ref:`TextDirection` **get_column_title_direction**\ (\ column\: :ref:`int`\ ) |const| +:ref:`TextDirection` **get_column_title_direction**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns column title base writing direction. @@ -952,7 +952,7 @@ Returns column title base writing direction. .. rst-class:: classref-method -:ref:`String` **get_column_title_language**\ (\ column\: :ref:`int`\ ) |const| +:ref:`String` **get_column_title_language**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns column title language code. @@ -964,7 +964,7 @@ Returns column title language code. .. rst-class:: classref-method -:ref:`int` **get_column_width**\ (\ column\: :ref:`int`\ ) |const| +:ref:`int` **get_column_width**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the column's width in pixels. @@ -976,7 +976,7 @@ Returns the column's width in pixels. .. rst-class:: classref-method -:ref:`Rect2` **get_custom_popup_rect**\ (\ ) |const| +:ref:`Rect2` **get_custom_popup_rect**\ (\ ) |const| :ref:`🔗` Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode`. @@ -988,7 +988,7 @@ Returns the rectangle for custom popups. Helper to create custom cell controls t .. rst-class:: classref-method -:ref:`int` **get_drop_section_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| +:ref:`int` **get_drop_section_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the drop section at ``position``, or -100 if no item is there. @@ -1004,7 +1004,7 @@ To get the item which the returned drop section is relative to, use :ref:`get_it .. rst-class:: classref-method -:ref:`TreeItem` **get_edited**\ (\ ) |const| +:ref:`TreeItem` **get_edited**\ (\ ) |const| :ref:`🔗` Returns the currently edited item. Can be used with :ref:`item_edited` to get the item that was modified. @@ -1041,7 +1041,7 @@ Returns the currently edited item. Can be used with :ref:`item_edited` **get_edited_column**\ (\ ) |const| +:ref:`int` **get_edited_column**\ (\ ) |const| :ref:`🔗` Returns the column for the currently edited item. @@ -1053,7 +1053,7 @@ Returns the column for the currently edited item. .. rst-class:: classref-method -:ref:`Rect2` **get_item_area_rect**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int` = -1, button_index\: :ref:`int` = -1\ ) |const| +:ref:`Rect2` **get_item_area_rect**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int` = -1, button_index\: :ref:`int` = -1\ ) |const| :ref:`🔗` Returns the rectangle area for the specified :ref:`TreeItem`. If ``column`` is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. If a button index is specified, the rectangle of that button will be returned. @@ -1065,7 +1065,7 @@ Returns the rectangle area for the specified :ref:`TreeItem`. If .. rst-class:: classref-method -:ref:`TreeItem` **get_item_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| +:ref:`TreeItem` **get_item_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the tree item at the specified position (relative to the tree origin position). @@ -1077,7 +1077,7 @@ Returns the tree item at the specified position (relative to the tree origin pos .. rst-class:: classref-method -:ref:`TreeItem` **get_next_selected**\ (\ from\: :ref:`TreeItem`\ ) +:ref:`TreeItem` **get_next_selected**\ (\ from\: :ref:`TreeItem`\ ) :ref:`🔗` Returns the next selected :ref:`TreeItem` after the given one, or ``null`` if the end is reached. @@ -1091,7 +1091,7 @@ If ``from`` is ``null``, this returns the first selected item. .. rst-class:: classref-method -:ref:`int` **get_pressed_button**\ (\ ) |const| +:ref:`int` **get_pressed_button**\ (\ ) |const| :ref:`🔗` Returns the last pressed button's index. @@ -1103,7 +1103,7 @@ Returns the last pressed button's index. .. rst-class:: classref-method -:ref:`TreeItem` **get_root**\ (\ ) |const| +:ref:`TreeItem` **get_root**\ (\ ) |const| :ref:`🔗` Returns the tree's root item, or ``null`` if the tree is empty. @@ -1115,7 +1115,7 @@ Returns the tree's root item, or ``null`` if the tree is empty. .. rst-class:: classref-method -:ref:`Vector2` **get_scroll**\ (\ ) |const| +:ref:`Vector2` **get_scroll**\ (\ ) |const| :ref:`🔗` Returns the current scrolling position. @@ -1127,7 +1127,7 @@ Returns the current scrolling position. .. rst-class:: classref-method -:ref:`TreeItem` **get_selected**\ (\ ) |const| +:ref:`TreeItem` **get_selected**\ (\ ) |const| :ref:`🔗` Returns the currently focused item, or ``null`` if no item is focused. @@ -1143,7 +1143,7 @@ To get the currently selected item(s), use :ref:`get_next_selected` **get_selected_column**\ (\ ) |const| +:ref:`int` **get_selected_column**\ (\ ) |const| :ref:`🔗` Returns the currently focused column, or -1 if no column is focused. @@ -1159,7 +1159,7 @@ To tell whether a column of an item is selected, use :ref:`TreeItem.is_selected< .. rst-class:: classref-method -:ref:`bool` **is_column_clipping_content**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_column_clipping_content**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the column has enabled clipping (see :ref:`set_column_clip_content`). @@ -1171,7 +1171,7 @@ Returns ``true`` if the column has enabled clipping (see :ref:`set_column_clip_c .. rst-class:: classref-method -:ref:`bool` **is_column_expanding**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_column_expanding**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the column has enabled expanding (see :ref:`set_column_expand`). @@ -1183,7 +1183,7 @@ Returns ``true`` if the column has enabled expanding (see :ref:`set_column_expan .. rst-class:: classref-method -|void| **scroll_to_item**\ (\ item\: :ref:`TreeItem`, center_on_item\: :ref:`bool` = false\ ) +|void| **scroll_to_item**\ (\ item\: :ref:`TreeItem`, center_on_item\: :ref:`bool` = false\ ) :ref:`🔗` Causes the **Tree** to jump to the specified :ref:`TreeItem`. @@ -1195,7 +1195,7 @@ Causes the **Tree** to jump to the specified :ref:`TreeItem`. .. rst-class:: classref-method -|void| **set_column_clip_content**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_column_clip_content**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Allows to enable clipping for column's content, making the content size ignored. @@ -1207,7 +1207,7 @@ Allows to enable clipping for column's content, making the content size ignored. .. rst-class:: classref-method -|void| **set_column_custom_minimum_width**\ (\ column\: :ref:`int`, min_width\: :ref:`int`\ ) +|void| **set_column_custom_minimum_width**\ (\ column\: :ref:`int`, min_width\: :ref:`int`\ ) :ref:`🔗` Overrides the calculated minimum width of a column. It can be set to ``0`` to restore the default behavior. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to :ref:`Control.size_flags_stretch_ratio`. @@ -1219,7 +1219,7 @@ Overrides the calculated minimum width of a column. It can be set to ``0`` to re .. rst-class:: classref-method -|void| **set_column_expand**\ (\ column\: :ref:`int`, expand\: :ref:`bool`\ ) +|void| **set_column_expand**\ (\ column\: :ref:`int`, expand\: :ref:`bool`\ ) :ref:`🔗` If ``true``, the column will have the "Expand" flag of :ref:`Control`. Columns that have the "Expand" flag will use their expand ratio in a similar fashion to :ref:`Control.size_flags_stretch_ratio` (see :ref:`set_column_expand_ratio`). @@ -1231,7 +1231,7 @@ If ``true``, the column will have the "Expand" flag of :ref:`Control`, ratio\: :ref:`int`\ ) +|void| **set_column_expand_ratio**\ (\ column\: :ref:`int`, ratio\: :ref:`int`\ ) :ref:`🔗` Sets the relative expand ratio for a column. See :ref:`set_column_expand`. @@ -1243,7 +1243,7 @@ Sets the relative expand ratio for a column. See :ref:`set_column_expand`, title\: :ref:`String`\ ) +|void| **set_column_title**\ (\ column\: :ref:`int`, title\: :ref:`String`\ ) :ref:`🔗` Sets the title of a column. @@ -1255,7 +1255,7 @@ Sets the title of a column. .. rst-class:: classref-method -|void| **set_column_title_alignment**\ (\ column\: :ref:`int`, title_alignment\: :ref:`HorizontalAlignment`\ ) +|void| **set_column_title_alignment**\ (\ column\: :ref:`int`, title_alignment\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` Sets the column title alignment. Note that :ref:`@GlobalScope.HORIZONTAL_ALIGNMENT_FILL` is not supported for column titles. @@ -1267,7 +1267,7 @@ Sets the column title alignment. Note that :ref:`@GlobalScope.HORIZONTAL_ALIGNME .. rst-class:: classref-method -|void| **set_column_title_direction**\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) +|void| **set_column_title_direction**\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) :ref:`🔗` Sets column title base writing direction. @@ -1279,7 +1279,7 @@ Sets column title base writing direction. .. rst-class:: classref-method -|void| **set_column_title_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) +|void| **set_column_title_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1291,7 +1291,7 @@ Sets language code of column title used for line-breaking and text shaping algor .. rst-class:: classref-method -|void| **set_selected**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) +|void| **set_selected**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) :ref:`🔗` Selects the specified :ref:`TreeItem` and column. @@ -1308,7 +1308,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **children_hl_line_color** = ``Color(0.27, 0.27, 0.27, 1)`` +:ref:`Color` **children_hl_line_color** = ``Color(0.27, 0.27, 0.27, 1)`` :ref:`🔗` The :ref:`Color` of the relationship lines between the selected :ref:`TreeItem` and its children. @@ -1320,7 +1320,7 @@ The :ref:`Color` of the relationship lines between the selected :re .. rst-class:: classref-themeproperty -:ref:`Color` **custom_button_font_highlight** = ``Color(0.95, 0.95, 0.95, 1)`` +:ref:`Color` **custom_button_font_highlight** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Text :ref:`Color` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when it's hovered. @@ -1332,7 +1332,7 @@ Text :ref:`Color` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **drop_position_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **drop_position_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` :ref:`Color` used to draw possible drop locations. See :ref:`DropModeFlags` constants for further description of drop locations. @@ -1344,7 +1344,7 @@ Text :ref:`Color` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **font_color** = ``Color(0.7, 0.7, 0.7, 1)`` +:ref:`Color` **font_color** = ``Color(0.7, 0.7, 0.7, 1)`` :ref:`🔗` Default text :ref:`Color` of the item. @@ -1356,7 +1356,7 @@ Default text :ref:`Color` of the item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` +:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Text :ref:`Color` for a :ref:`TreeItem.CELL_MODE_CHECK` mode cell when it's non-editable (see :ref:`TreeItem.set_editable`). @@ -1368,7 +1368,7 @@ Text :ref:`Color` for a :ref:`TreeItem.CELL_MODE_CHECK` **font_outline_color** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The tint of text outline of the item. @@ -1380,7 +1380,7 @@ The tint of text outline of the item. .. rst-class:: classref-themeproperty -:ref:`Color` **font_selected_color** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **font_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` Text :ref:`Color` used when the item is selected. @@ -1392,7 +1392,7 @@ Text :ref:`Color` used when the item is selected. .. rst-class:: classref-themeproperty -:ref:`Color` **guide_color** = ``Color(0.7, 0.7, 0.7, 0.25)`` +:ref:`Color` **guide_color** = ``Color(0.7, 0.7, 0.7, 0.25)`` :ref:`🔗` :ref:`Color` of the guideline. @@ -1404,7 +1404,7 @@ Text :ref:`Color` used when the item is selected. .. rst-class:: classref-themeproperty -:ref:`Color` **parent_hl_line_color** = ``Color(0.27, 0.27, 0.27, 1)`` +:ref:`Color` **parent_hl_line_color** = ``Color(0.27, 0.27, 0.27, 1)`` :ref:`🔗` The :ref:`Color` of the relationship lines between the selected :ref:`TreeItem` and its parents. @@ -1416,7 +1416,7 @@ The :ref:`Color` of the relationship lines between the selected :re .. rst-class:: classref-themeproperty -:ref:`Color` **relationship_line_color** = ``Color(0.27, 0.27, 0.27, 1)`` +:ref:`Color` **relationship_line_color** = ``Color(0.27, 0.27, 0.27, 1)`` :ref:`🔗` The default :ref:`Color` of the relationship lines. @@ -1428,7 +1428,7 @@ The default :ref:`Color` of the relationship lines. .. rst-class:: classref-themeproperty -:ref:`Color` **title_button_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **title_button_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Default text :ref:`Color` of the title button. @@ -1440,7 +1440,7 @@ Default text :ref:`Color` of the title button. .. rst-class:: classref-themeproperty -:ref:`int` **button_margin** = ``4`` +:ref:`int` **button_margin** = ``4`` :ref:`🔗` The horizontal space between each button in a cell. @@ -1452,7 +1452,7 @@ The horizontal space between each button in a cell. .. rst-class:: classref-themeproperty -:ref:`int` **children_hl_line_width** = ``1`` +:ref:`int` **children_hl_line_width** = ``1`` :ref:`🔗` The width of the relationship lines between the selected :ref:`TreeItem` and its children. @@ -1464,7 +1464,7 @@ The width of the relationship lines between the selected :ref:`TreeItem` **draw_guides** = ``1`` +:ref:`int` **draw_guides** = ``1`` :ref:`🔗` Draws the guidelines if not zero, this acts as a boolean. The guideline is a horizontal line drawn at the bottom of each item. @@ -1476,7 +1476,7 @@ Draws the guidelines if not zero, this acts as a boolean. The guideline is a hor .. rst-class:: classref-themeproperty -:ref:`int` **draw_relationship_lines** = ``0`` +:ref:`int` **draw_relationship_lines** = ``0`` :ref:`🔗` Draws the relationship lines if not zero, this acts as a boolean. Relationship lines are drawn at the start of child items to show hierarchy. @@ -1488,7 +1488,7 @@ Draws the relationship lines if not zero, this acts as a boolean. Relationship l .. rst-class:: classref-themeproperty -:ref:`int` **h_separation** = ``4`` +:ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal space between item cells. This is also used as the margin at the start of an item when folding is disabled. @@ -1500,7 +1500,7 @@ The horizontal space between item cells. This is also used as the margin at the .. rst-class:: classref-themeproperty -:ref:`int` **icon_max_width** = ``0`` +:ref:`int` **icon_max_width** = ``0`` :ref:`🔗` The maximum allowed width of the icon in item's cells. This limit is applied on top of the default size of the icon, but before the value set with :ref:`TreeItem.set_icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1512,7 +1512,7 @@ The maximum allowed width of the icon in item's cells. This limit is applied on .. rst-class:: classref-themeproperty -:ref:`int` **inner_item_margin_bottom** = ``0`` +:ref:`int` **inner_item_margin_bottom** = ``0`` :ref:`🔗` The inner bottom margin of a cell. @@ -1524,7 +1524,7 @@ The inner bottom margin of a cell. .. rst-class:: classref-themeproperty -:ref:`int` **inner_item_margin_left** = ``0`` +:ref:`int` **inner_item_margin_left** = ``0`` :ref:`🔗` The inner left margin of a cell. @@ -1536,7 +1536,7 @@ The inner left margin of a cell. .. rst-class:: classref-themeproperty -:ref:`int` **inner_item_margin_right** = ``0`` +:ref:`int` **inner_item_margin_right** = ``0`` :ref:`🔗` The inner right margin of a cell. @@ -1548,7 +1548,7 @@ The inner right margin of a cell. .. rst-class:: classref-themeproperty -:ref:`int` **inner_item_margin_top** = ``0`` +:ref:`int` **inner_item_margin_top** = ``0`` :ref:`🔗` The inner top margin of a cell. @@ -1560,7 +1560,7 @@ The inner top margin of a cell. .. rst-class:: classref-themeproperty -:ref:`int` **item_margin** = ``16`` +:ref:`int` **item_margin** = ``16`` :ref:`🔗` The horizontal margin at the start of an item. This is used when folding is enabled for the item. @@ -1572,7 +1572,7 @@ The horizontal margin at the start of an item. This is used when folding is enab .. rst-class:: classref-themeproperty -:ref:`int` **outline_size** = ``0`` +:ref:`int` **outline_size** = ``0`` :ref:`🔗` The size of the text outline. @@ -1586,7 +1586,7 @@ The size of the text outline. .. rst-class:: classref-themeproperty -:ref:`int` **parent_hl_line_margin** = ``0`` +:ref:`int` **parent_hl_line_margin** = ``0`` :ref:`🔗` The space between the parent relationship lines for the selected :ref:`TreeItem` and the relationship lines to its siblings that are not selected. @@ -1598,7 +1598,7 @@ The space between the parent relationship lines for the selected :ref:`TreeItem< .. rst-class:: classref-themeproperty -:ref:`int` **parent_hl_line_width** = ``1`` +:ref:`int` **parent_hl_line_width** = ``1`` :ref:`🔗` The width of the relationship lines between the selected :ref:`TreeItem` and its parents. @@ -1610,7 +1610,7 @@ The width of the relationship lines between the selected :ref:`TreeItem` **relationship_line_width** = ``1`` +:ref:`int` **relationship_line_width** = ``1`` :ref:`🔗` The default width of the relationship lines. @@ -1622,7 +1622,7 @@ The default width of the relationship lines. .. rst-class:: classref-themeproperty -:ref:`int` **scroll_border** = ``4`` +:ref:`int` **scroll_border** = ``4`` :ref:`🔗` The maximum distance between the mouse cursor and the control's border to trigger border scrolling when dragging. @@ -1634,7 +1634,7 @@ The maximum distance between the mouse cursor and the control's border to trigge .. rst-class:: classref-themeproperty -:ref:`int` **scroll_speed** = ``12`` +:ref:`int` **scroll_speed** = ``12`` :ref:`🔗` The speed of border scrolling. @@ -1646,7 +1646,7 @@ The speed of border scrolling. .. rst-class:: classref-themeproperty -:ref:`int` **scrollbar_h_separation** = ``4`` +:ref:`int` **scrollbar_h_separation** = ``4`` :ref:`🔗` The horizontal separation of tree content and scrollbar. @@ -1658,7 +1658,7 @@ The horizontal separation of tree content and scrollbar. .. rst-class:: classref-themeproperty -:ref:`int` **scrollbar_margin_bottom** = ``-1`` +:ref:`int` **scrollbar_margin_bottom** = ``-1`` :ref:`🔗` The bottom margin of the scrollbars. When negative, uses :ref:`panel` bottom margin. @@ -1670,7 +1670,7 @@ The bottom margin of the scrollbars. When negative, uses :ref:`panel` **scrollbar_margin_left** = ``-1`` +:ref:`int` **scrollbar_margin_left** = ``-1`` :ref:`🔗` The left margin of the horizontal scrollbar. When negative, uses :ref:`panel` left margin. @@ -1682,7 +1682,7 @@ The left margin of the horizontal scrollbar. When negative, uses :ref:`panel` **scrollbar_margin_right** = ``-1`` +:ref:`int` **scrollbar_margin_right** = ``-1`` :ref:`🔗` The right margin of the scrollbars. When negative, uses :ref:`panel` right margin. @@ -1694,7 +1694,7 @@ The right margin of the scrollbars. When negative, uses :ref:`panel` **scrollbar_margin_top** = ``-1`` +:ref:`int` **scrollbar_margin_top** = ``-1`` :ref:`🔗` The top margin of the vertical scrollbar. When negative, uses :ref:`panel` top margin. @@ -1706,7 +1706,7 @@ The top margin of the vertical scrollbar. When negative, uses :ref:`panel` **scrollbar_v_separation** = ``4`` +:ref:`int` **scrollbar_v_separation** = ``4`` :ref:`🔗` The vertical separation of tree content and scrollbar. @@ -1718,7 +1718,7 @@ The vertical separation of tree content and scrollbar. .. rst-class:: classref-themeproperty -:ref:`int` **v_separation** = ``4`` +:ref:`int` **v_separation** = ``4`` :ref:`🔗` The vertical padding inside each item, i.e. the distance between the item's content and top/bottom border. @@ -1730,7 +1730,7 @@ The vertical padding inside each item, i.e. the distance between the item's cont .. rst-class:: classref-themeproperty -:ref:`Font` **font** +:ref:`Font` **font** :ref:`🔗` :ref:`Font` of the item's text. @@ -1742,7 +1742,7 @@ The vertical padding inside each item, i.e. the distance between the item's cont .. rst-class:: classref-themeproperty -:ref:`Font` **title_button_font** +:ref:`Font` **title_button_font** :ref:`🔗` :ref:`Font` of the title button's text. @@ -1754,7 +1754,7 @@ The vertical padding inside each item, i.e. the distance between the item's cont .. rst-class:: classref-themeproperty -:ref:`int` **font_size** +:ref:`int` **font_size** :ref:`🔗` Font size of the item's text. @@ -1766,7 +1766,7 @@ Font size of the item's text. .. rst-class:: classref-themeproperty -:ref:`int` **title_button_font_size** +:ref:`int` **title_button_font_size** :ref:`🔗` Font size of the title button's text. @@ -1778,7 +1778,7 @@ Font size of the title button's text. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **arrow** +:ref:`Texture2D` **arrow** :ref:`🔗` The arrow icon used when a foldable item is not collapsed. @@ -1790,7 +1790,7 @@ The arrow icon used when a foldable item is not collapsed. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **arrow_collapsed** +:ref:`Texture2D` **arrow_collapsed** :ref:`🔗` The arrow icon used when a foldable item is collapsed (for left-to-right layouts). @@ -1802,7 +1802,7 @@ The arrow icon used when a foldable item is collapsed (for left-to-right layouts .. rst-class:: classref-themeproperty -:ref:`Texture2D` **arrow_collapsed_mirrored** +:ref:`Texture2D` **arrow_collapsed_mirrored** :ref:`🔗` The arrow icon used when a foldable item is collapsed (for right-to-left layouts). @@ -1814,7 +1814,7 @@ The arrow icon used when a foldable item is collapsed (for right-to-left layouts .. rst-class:: classref-themeproperty -:ref:`Texture2D` **checked** +:ref:`Texture2D` **checked** :ref:`🔗` The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` mode cell is checked and editable (see :ref:`TreeItem.set_editable`). @@ -1826,7 +1826,7 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **checked_disabled** +:ref:`Texture2D` **checked_disabled** :ref:`🔗` The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` mode cell is checked and non-editable (see :ref:`TreeItem.set_editable`). @@ -1838,7 +1838,7 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **indeterminate** +:ref:`Texture2D` **indeterminate** :ref:`🔗` The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` mode cell is indeterminate and editable (see :ref:`TreeItem.set_editable`). @@ -1850,7 +1850,7 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **indeterminate_disabled** +:ref:`Texture2D` **indeterminate_disabled** :ref:`🔗` The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` mode cell is indeterminate and non-editable (see :ref:`TreeItem.set_editable`). @@ -1862,7 +1862,7 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **select_arrow** +:ref:`Texture2D` **select_arrow** :ref:`🔗` The arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` mode cell. @@ -1874,7 +1874,7 @@ The arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **unchecked** +:ref:`Texture2D` **unchecked** :ref:`🔗` The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` mode cell is unchecked and editable (see :ref:`TreeItem.set_editable`). @@ -1886,7 +1886,7 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **unchecked_disabled** +:ref:`Texture2D` **unchecked_disabled** :ref:`🔗` The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` mode cell is unchecked and non-editable (see :ref:`TreeItem.set_editable`). @@ -1898,7 +1898,7 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **updown** +:ref:`Texture2D` **updown** :ref:`🔗` The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` mode cell. @@ -1910,7 +1910,7 @@ The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **button_pressed** +:ref:`StyleBox` **button_pressed** :ref:`🔗` :ref:`StyleBox` used when a button in the tree is pressed. @@ -1922,7 +1922,7 @@ The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **cursor** +:ref:`StyleBox` **cursor** :ref:`🔗` :ref:`StyleBox` used for the cursor, when the **Tree** is being focused. @@ -1934,7 +1934,7 @@ The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **cursor_unfocused** +:ref:`StyleBox` **cursor_unfocused** :ref:`🔗` :ref:`StyleBox` used for the cursor, when the **Tree** is not being focused. @@ -1946,9 +1946,9 @@ The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **custom_button** +:ref:`StyleBox` **custom_button** :ref:`🔗` -Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell. +Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when button is enabled with :ref:`TreeItem.set_custom_as_button`. .. rst-class:: classref-item-separator @@ -1958,9 +1958,9 @@ Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **custom_button_hover** +:ref:`StyleBox` **custom_button_hover** :ref:`🔗` -:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when it's hovered. +:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode button cell when it's hovered. .. rst-class:: classref-item-separator @@ -1970,9 +1970,9 @@ Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **custom_button_pressed** +:ref:`StyleBox` **custom_button_pressed** :ref:`🔗` -:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when it's pressed. +:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode button cell when it's pressed. .. rst-class:: classref-item-separator @@ -1982,7 +1982,7 @@ Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **focus** +:ref:`StyleBox` **focus** :ref:`🔗` The focused style for the **Tree**, drawn on top of everything. @@ -1994,7 +1994,7 @@ The focused style for the **Tree**, drawn on top of everything. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **panel** +:ref:`StyleBox` **panel** :ref:`🔗` The background style for the **Tree**. @@ -2006,7 +2006,7 @@ The background style for the **Tree**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **selected** +:ref:`StyleBox` **selected** :ref:`🔗` :ref:`StyleBox` for the selected items, used when the **Tree** is not being focused. @@ -2018,7 +2018,7 @@ The background style for the **Tree**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **selected_focus** +:ref:`StyleBox` **selected_focus** :ref:`🔗` :ref:`StyleBox` for the selected items, used when the **Tree** is being focused. @@ -2030,7 +2030,7 @@ The background style for the **Tree**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **title_button_hover** +:ref:`StyleBox` **title_button_hover** :ref:`🔗` :ref:`StyleBox` used when the title button is being hovered. @@ -2042,7 +2042,7 @@ The background style for the **Tree**. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **title_button_normal** +:ref:`StyleBox` **title_button_normal** :ref:`🔗` Default :ref:`StyleBox` for the title button. @@ -2054,7 +2054,7 @@ Default :ref:`StyleBox` for the title button. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **title_button_pressed** +:ref:`StyleBox` **title_button_pressed** :ref:`🔗` :ref:`StyleBox` used when the title button is being pressed. diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index bb16f96a809..7fbbf384983 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -272,7 +272,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TreeCellMode**: +enum **TreeCellMode**: :ref:`🔗` .. _class_TreeItem_constant_CELL_MODE_STRING: @@ -280,7 +280,7 @@ enum **TreeCellMode**: :ref:`TreeCellMode` **CELL_MODE_STRING** = ``0`` -Cell contains a string. +Cell shows a string label. When editable, the text can be edited using a :ref:`LineEdit`, or a :ref:`TextEdit` popup if :ref:`set_edit_multiline` is used. .. _class_TreeItem_constant_CELL_MODE_CHECK: @@ -288,7 +288,7 @@ Cell contains a string. :ref:`TreeCellMode` **CELL_MODE_CHECK** = ``1`` -Cell contains a checkbox. +Cell shows a checkbox, optionally with text. The checkbox can be pressed, released, or indeterminate (via :ref:`set_indeterminate`). The checkbox can't be clicked unless the cell is editable. .. _class_TreeItem_constant_CELL_MODE_RANGE: @@ -296,7 +296,9 @@ Cell contains a checkbox. :ref:`TreeCellMode` **CELL_MODE_RANGE** = ``2`` -Cell contains a range. +Cell shows a numeric range. When editable, it can be edited using a range slider. Use :ref:`set_range` to set the value and :ref:`set_range_config` to configure the range. + +This cell can also be used in a text dropdown mode when you assign a text with :ref:`set_text`. Separate options with a comma, e.g. ``"Option1,Option2,Option3"``. .. _class_TreeItem_constant_CELL_MODE_ICON: @@ -304,7 +306,7 @@ Cell contains a range. :ref:`TreeCellMode` **CELL_MODE_ICON** = ``3`` -Cell contains an icon. +Cell shows an icon. It can't be edited nor display text. .. _class_TreeItem_constant_CELL_MODE_CUSTOM: @@ -312,11 +314,9 @@ Cell contains an icon. :ref:`TreeCellMode` **CELL_MODE_CUSTOM** = ``4`` -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - +Cell shows as a clickable button. It will display an arrow similar to :ref:`OptionButton`, but doesn't feature a dropdown (for that you can use :ref:`CELL_MODE_RANGE`). Clicking the button emits the :ref:`Tree.item_edited` signal. The button is flat by default, you can use :ref:`set_custom_as_button` to display it with a :ref:`StyleBox`. +This mode also supports custom drawing using :ref:`set_custom_draw_callback`. .. rst-class:: classref-section-separator @@ -331,7 +331,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **collapsed** +:ref:`bool` **collapsed** :ref:`🔗` .. rst-class:: classref-property-setget @@ -348,7 +348,7 @@ If ``true``, the TreeItem is collapsed. .. rst-class:: classref-property -:ref:`int` **custom_minimum_height** +:ref:`int` **custom_minimum_height** :ref:`🔗` .. rst-class:: classref-property-setget @@ -365,7 +365,7 @@ The custom minimum height. .. rst-class:: classref-property -:ref:`bool` **disable_folding** +:ref:`bool` **disable_folding** :ref:`🔗` .. rst-class:: classref-property-setget @@ -382,7 +382,7 @@ If ``true``, folding is disabled for this TreeItem. .. rst-class:: classref-property -:ref:`bool` **visible** +:ref:`bool` **visible** :ref:`🔗` .. rst-class:: classref-property-setget @@ -406,7 +406,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) +|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) :ref:`🔗` Adds a button with :ref:`Texture2D` ``button`` at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. @@ -418,7 +418,7 @@ Adds a button with :ref:`Texture2D` ``button`` at column ``colu .. rst-class:: classref-method -|void| **add_child**\ (\ child\: :ref:`TreeItem`\ ) +|void| **add_child**\ (\ child\: :ref:`TreeItem`\ ) :ref:`🔗` Adds a previously unparented **TreeItem** as a direct child of this one. The ``child`` item must not be a part of any :ref:`Tree` or parented to any **TreeItem**. See also :ref:`remove_child`. @@ -430,7 +430,7 @@ Adds a previously unparented **TreeItem** as a direct child of this one. The ``c .. rst-class:: classref-method -|void| **call_recursive**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| +|void| **call_recursive**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` Calls the ``method`` on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. @@ -442,7 +442,7 @@ Calls the ``method`` on the actual TreeItem and its children recursively. Pass p .. rst-class:: classref-method -|void| **clear_custom_bg_color**\ (\ column\: :ref:`int`\ ) +|void| **clear_custom_bg_color**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Resets the background color for the given column to default. @@ -454,7 +454,7 @@ Resets the background color for the given column to default. .. rst-class:: classref-method -|void| **clear_custom_color**\ (\ column\: :ref:`int`\ ) +|void| **clear_custom_color**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Resets the color for the given column to default. @@ -466,7 +466,7 @@ Resets the color for the given column to default. .. rst-class:: classref-method -:ref:`TreeItem` **create_child**\ (\ index\: :ref:`int` = -1\ ) +:ref:`TreeItem` **create_child**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` Creates an item and adds it as a child. @@ -480,7 +480,7 @@ The new item will be inserted as position ``index`` (the default value ``-1`` me .. rst-class:: classref-method -|void| **deselect**\ (\ column\: :ref:`int`\ ) +|void| **deselect**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Deselects the given column. @@ -492,7 +492,7 @@ Deselects the given column. .. rst-class:: classref-method -|void| **erase_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) +|void| **erase_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) :ref:`🔗` Removes the button at index ``button_index`` in column ``column``. @@ -504,7 +504,7 @@ Removes the button at index ``button_index`` in column ``column``. .. rst-class:: classref-method -:ref:`AutowrapMode` **get_autowrap_mode**\ (\ column\: :ref:`int`\ ) |const| +:ref:`AutowrapMode` **get_autowrap_mode**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text autowrap mode in the given ``column``. By default it is :ref:`TextServer.AUTOWRAP_OFF`. @@ -516,7 +516,7 @@ Returns the text autowrap mode in the given ``column``. By default it is :ref:`T .. rst-class:: classref-method -:ref:`Texture2D` **get_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Texture2D` of the button at index ``button_index`` in column ``column``. @@ -528,7 +528,7 @@ Returns the :ref:`Texture2D` of the button at index ``button_in .. rst-class:: classref-method -:ref:`int` **get_button_by_id**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| +:ref:`int` **get_button_by_id**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the button index if there is a button with ID ``id`` in column ``column``, otherwise returns -1. @@ -540,7 +540,7 @@ Returns the button index if there is a button with ID ``id`` in column ``column` .. rst-class:: classref-method -:ref:`Color` **get_button_color**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| +:ref:`Color` **get_button_color**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the color of the button with ID ``id`` in column ``column``. If the specified button does not exist, returns :ref:`Color.BLACK`. @@ -552,7 +552,7 @@ Returns the color of the button with ID ``id`` in column ``column``. If the spec .. rst-class:: classref-method -:ref:`int` **get_button_count**\ (\ column\: :ref:`int`\ ) |const| +:ref:`int` **get_button_count**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of buttons in column ``column``. @@ -564,7 +564,7 @@ Returns the number of buttons in column ``column``. .. rst-class:: classref-method -:ref:`int` **get_button_id**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| +:ref:`int` **get_button_id**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the ID for the button at index ``button_index`` in column ``column``. @@ -576,7 +576,7 @@ Returns the ID for the button at index ``button_index`` in column ``column``. .. rst-class:: classref-method -:ref:`String` **get_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| +:ref:`String` **get_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tooltip text for the button at index ``button_index`` in column ``column``. @@ -588,7 +588,7 @@ Returns the tooltip text for the button at index ``button_index`` in column ``co .. rst-class:: classref-method -:ref:`TreeCellMode` **get_cell_mode**\ (\ column\: :ref:`int`\ ) |const| +:ref:`TreeCellMode` **get_cell_mode**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the column's cell mode. @@ -600,7 +600,7 @@ Returns the column's cell mode. .. rst-class:: classref-method -:ref:`TreeItem` **get_child**\ (\ index\: :ref:`int`\ ) +:ref:`TreeItem` **get_child**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns a child item by its ``index`` (see :ref:`get_child_count`). This method is often used for iterating all children of an item. @@ -614,7 +614,7 @@ Negative indices access the children from the last one. .. rst-class:: classref-method -:ref:`int` **get_child_count**\ (\ ) +:ref:`int` **get_child_count**\ (\ ) :ref:`🔗` Returns the number of child items. @@ -626,7 +626,7 @@ Returns the number of child items. .. rst-class:: classref-method -:ref:`Array`\[:ref:`TreeItem`\] **get_children**\ (\ ) +:ref:`Array`\[:ref:`TreeItem`\] **get_children**\ (\ ) :ref:`🔗` Returns an array of references to the item's children. @@ -638,7 +638,7 @@ Returns an array of references to the item's children. .. rst-class:: classref-method -:ref:`Color` **get_custom_bg_color**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Color` **get_custom_bg_color**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom background color of column ``column``. @@ -650,7 +650,7 @@ Returns the custom background color of column ``column``. .. rst-class:: classref-method -:ref:`Color` **get_custom_color**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Color` **get_custom_color**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom color of column ``column``. @@ -662,7 +662,7 @@ Returns the custom color of column ``column``. .. rst-class:: classref-method -:ref:`Callable` **get_custom_draw_callback**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Callable` **get_custom_draw_callback**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom callback of column ``column``. @@ -674,7 +674,7 @@ Returns the custom callback of column ``column``. .. rst-class:: classref-method -:ref:`Font` **get_custom_font**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Font` **get_custom_font**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns custom font used to draw text in the column ``column``. @@ -686,7 +686,7 @@ Returns custom font used to draw text in the column ``column``. .. rst-class:: classref-method -:ref:`int` **get_custom_font_size**\ (\ column\: :ref:`int`\ ) |const| +:ref:`int` **get_custom_font_size**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns custom font size used to draw text in the column ``column``. @@ -698,7 +698,7 @@ Returns custom font size used to draw text in the column ``column``. .. rst-class:: classref-method -:ref:`bool` **get_expand_right**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **get_expand_right**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if ``expand_right`` is set. @@ -710,7 +710,7 @@ Returns ``true`` if ``expand_right`` is set. .. rst-class:: classref-method -:ref:`TreeItem` **get_first_child**\ (\ ) |const| +:ref:`TreeItem` **get_first_child**\ (\ ) |const| :ref:`🔗` Returns the TreeItem's first child. @@ -722,7 +722,7 @@ Returns the TreeItem's first child. .. rst-class:: classref-method -:ref:`Texture2D` **get_icon**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Texture2D` **get_icon**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's icon :ref:`Texture2D`. Error if no icon is set. @@ -734,7 +734,7 @@ Returns the given column's icon :ref:`Texture2D`. Error if no i .. rst-class:: classref-method -:ref:`int` **get_icon_max_width**\ (\ column\: :ref:`int`\ ) |const| +:ref:`int` **get_icon_max_width**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum allowed width of the icon in the given ``column``. @@ -746,7 +746,7 @@ Returns the maximum allowed width of the icon in the given ``column``. .. rst-class:: classref-method -:ref:`Color` **get_icon_modulate**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Color` **get_icon_modulate**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Color` modulating the column's icon. @@ -758,7 +758,7 @@ Returns the :ref:`Color` modulating the column's icon. .. rst-class:: classref-method -:ref:`Rect2` **get_icon_region**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Rect2` **get_icon_region**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon :ref:`Texture2D` region as :ref:`Rect2`. @@ -770,7 +770,7 @@ Returns the icon :ref:`Texture2D` region as :ref:`Rect2` **get_index**\ (\ ) +:ref:`int` **get_index**\ (\ ) :ref:`🔗` Returns the node's order in the tree. For example, if called on the first child item the position is ``0``. @@ -782,7 +782,7 @@ Returns the node's order in the tree. For example, if called on the first child .. rst-class:: classref-method -:ref:`String` **get_language**\ (\ column\: :ref:`int`\ ) |const| +:ref:`String` **get_language**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text language code. @@ -794,7 +794,7 @@ Returns item's text language code. .. rst-class:: classref-method -:ref:`Variant` **get_metadata**\ (\ column\: :ref:`int`\ ) |const| +:ref:`Variant` **get_metadata**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata value that was set for the given column using :ref:`set_metadata`. @@ -806,7 +806,7 @@ Returns the metadata value that was set for the given column using :ref:`set_met .. rst-class:: classref-method -:ref:`TreeItem` **get_next**\ (\ ) |const| +:ref:`TreeItem` **get_next**\ (\ ) |const| :ref:`🔗` Returns the next sibling TreeItem in the tree or a null object if there is none. @@ -818,7 +818,7 @@ Returns the next sibling TreeItem in the tree or a null object if there is none. .. rst-class:: classref-method -:ref:`TreeItem` **get_next_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) +:ref:`TreeItem` **get_next_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` Returns the next TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -832,7 +832,7 @@ If ``wrap`` is enabled, the method will wrap around to the first element in the .. rst-class:: classref-method -:ref:`TreeItem` **get_next_visible**\ (\ wrap\: :ref:`bool` = false\ ) +:ref:`TreeItem` **get_next_visible**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` Returns the next visible TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -846,7 +846,7 @@ If ``wrap`` is enabled, the method will wrap around to the first visible element .. rst-class:: classref-method -:ref:`TreeItem` **get_parent**\ (\ ) |const| +:ref:`TreeItem` **get_parent**\ (\ ) |const| :ref:`🔗` Returns the parent TreeItem or a null object if there is none. @@ -858,7 +858,7 @@ Returns the parent TreeItem or a null object if there is none. .. rst-class:: classref-method -:ref:`TreeItem` **get_prev**\ (\ ) +:ref:`TreeItem` **get_prev**\ (\ ) :ref:`🔗` Returns the previous sibling TreeItem in the tree or a null object if there is none. @@ -870,7 +870,7 @@ Returns the previous sibling TreeItem in the tree or a null object if there is n .. rst-class:: classref-method -:ref:`TreeItem` **get_prev_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) +:ref:`TreeItem` **get_prev_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` Returns the previous TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -884,7 +884,7 @@ If ``wrap`` is enabled, the method will wrap around to the last element in the t .. rst-class:: classref-method -:ref:`TreeItem` **get_prev_visible**\ (\ wrap\: :ref:`bool` = false\ ) +:ref:`TreeItem` **get_prev_visible**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` Returns the previous visible sibling TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -898,7 +898,7 @@ If ``wrap`` is enabled, the method will wrap around to the last visible element .. rst-class:: classref-method -:ref:`float` **get_range**\ (\ column\: :ref:`int`\ ) |const| +:ref:`float` **get_range**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of a :ref:`CELL_MODE_RANGE` column. @@ -910,7 +910,7 @@ Returns the value of a :ref:`CELL_MODE_RANGE` **get_range_config**\ (\ column\: :ref:`int`\ ) +:ref:`Dictionary` **get_range_config**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr". @@ -922,11 +922,9 @@ Returns a dictionary containing the range parameters for a given column. The key .. rst-class:: classref-method -:ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ column\: :ref:`int`\ ) |const| +:ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the BiDi algorithm override set for this cell. .. rst-class:: classref-item-separator @@ -936,11 +934,9 @@ Returns a dictionary containing the range parameters for a given column. The key .. rst-class:: classref-method -:ref:`Array` **get_structured_text_bidi_override_options**\ (\ column\: :ref:`int`\ ) |const| - -.. container:: contribute +:ref:`Array` **get_structured_text_bidi_override_options**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the additional BiDi options set for this cell. .. rst-class:: classref-item-separator @@ -950,7 +946,7 @@ Returns a dictionary containing the range parameters for a given column. The key .. rst-class:: classref-method -:ref:`String` **get_suffix**\ (\ column\: :ref:`int`\ ) |const| +:ref:`String` **get_suffix**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Gets the suffix string shown after the column value. @@ -962,7 +958,7 @@ Gets the suffix string shown after the column value. .. rst-class:: classref-method -:ref:`String` **get_text**\ (\ column\: :ref:`int`\ ) |const| +:ref:`String` **get_text**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's text. @@ -974,7 +970,7 @@ Returns the given column's text. .. rst-class:: classref-method -:ref:`HorizontalAlignment` **get_text_alignment**\ (\ column\: :ref:`int`\ ) |const| +:ref:`HorizontalAlignment` **get_text_alignment**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's text alignment. @@ -986,7 +982,7 @@ Returns the given column's text alignment. .. rst-class:: classref-method -:ref:`TextDirection` **get_text_direction**\ (\ column\: :ref:`int`\ ) |const| +:ref:`TextDirection` **get_text_direction**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text base writing direction. @@ -998,7 +994,7 @@ Returns item's text base writing direction. .. rst-class:: classref-method -:ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ column\: :ref:`int`\ ) |const| +:ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``. By default it is :ref:`TextServer.OVERRUN_TRIM_ELLIPSIS`. @@ -1010,7 +1006,7 @@ Returns the clipping behavior when the text exceeds the item's bounding rectangl .. rst-class:: classref-method -:ref:`String` **get_tooltip_text**\ (\ column\: :ref:`int`\ ) |const| +:ref:`String` **get_tooltip_text**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's tooltip text. @@ -1022,7 +1018,7 @@ Returns the given column's tooltip text. .. rst-class:: classref-method -:ref:`Tree` **get_tree**\ (\ ) |const| +:ref:`Tree` **get_tree**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Tree` that owns this TreeItem. @@ -1034,7 +1030,7 @@ Returns the :ref:`Tree` that owns this TreeItem. .. rst-class:: classref-method -:ref:`bool` **is_any_collapsed**\ (\ only_visible\: :ref:`bool` = false\ ) +:ref:`bool` **is_any_collapsed**\ (\ only_visible\: :ref:`bool` = false\ ) :ref:`🔗` Returns ``true`` if this **TreeItem**, or any of its descendants, is collapsed. @@ -1048,7 +1044,7 @@ If ``only_visible`` is ``true`` it ignores non-visible **TreeItem**\ s. .. rst-class:: classref-method -:ref:`bool` **is_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| +:ref:`bool` **is_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the button at index ``button_index`` for the given ``column`` is disabled. @@ -1060,7 +1056,7 @@ Returns ``true`` if the button at index ``button_index`` for the given ``column` .. rst-class:: classref-method -:ref:`bool` **is_checked**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_checked**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``column`` is checked. @@ -1072,11 +1068,9 @@ Returns ``true`` if the given ``column`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_custom_set_as_button**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_custom_set_as_button**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if the cell was made into a button with :ref:`set_custom_as_button`. .. rst-class:: classref-item-separator @@ -1086,7 +1080,7 @@ Returns ``true`` if the given ``column`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_edit_multiline**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_edit_multiline**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``column`` is multiline editable. @@ -1098,7 +1092,7 @@ Returns ``true`` if the given ``column`` is multiline editable. .. rst-class:: classref-method -:ref:`bool` **is_editable**\ (\ column\: :ref:`int`\ ) +:ref:`bool` **is_editable**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the given ``column`` is editable. @@ -1110,7 +1104,7 @@ Returns ``true`` if the given ``column`` is editable. .. rst-class:: classref-method -:ref:`bool` **is_indeterminate**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_indeterminate**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``column`` is indeterminate. @@ -1122,7 +1116,7 @@ Returns ``true`` if the given ``column`` is indeterminate. .. rst-class:: classref-method -:ref:`bool` **is_selectable**\ (\ column\: :ref:`int`\ ) |const| +:ref:`bool` **is_selectable**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``column`` is selectable. @@ -1134,7 +1128,7 @@ Returns ``true`` if the given ``column`` is selectable. .. rst-class:: classref-method -:ref:`bool` **is_selected**\ (\ column\: :ref:`int`\ ) +:ref:`bool` **is_selected**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the given ``column`` is selected. @@ -1146,7 +1140,7 @@ Returns ``true`` if the given ``column`` is selected. .. rst-class:: classref-method -:ref:`bool` **is_visible_in_tree**\ (\ ) |const| +:ref:`bool` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗` Returns ``true`` if :ref:`visible` is ``true`` and all its ancestors are also visible. @@ -1158,7 +1152,7 @@ Returns ``true`` if :ref:`visible` is ``true`` .. rst-class:: classref-method -|void| **move_after**\ (\ item\: :ref:`TreeItem`\ ) +|void| **move_after**\ (\ item\: :ref:`TreeItem`\ ) :ref:`🔗` Moves this TreeItem right after the given ``item``. @@ -1172,7 +1166,7 @@ Moves this TreeItem right after the given ``item``. .. rst-class:: classref-method -|void| **move_before**\ (\ item\: :ref:`TreeItem`\ ) +|void| **move_before**\ (\ item\: :ref:`TreeItem`\ ) :ref:`🔗` Moves this TreeItem right before the given ``item``. @@ -1186,7 +1180,7 @@ Moves this TreeItem right before the given ``item``. .. rst-class:: classref-method -|void| **propagate_check**\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) +|void| **propagate_check**\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) :ref:`🔗` Propagates this item's checked status to its children and parents for the given ``column``. It is possible to process the items affected by this method call by connecting to :ref:`Tree.check_propagated_to_item`. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If ``emit_signal`` is ``false``, then :ref:`Tree.check_propagated_to_item` will not be emitted. @@ -1198,7 +1192,7 @@ Propagates this item's checked status to its children and parents for the given .. rst-class:: classref-method -|void| **remove_child**\ (\ child\: :ref:`TreeItem`\ ) +|void| **remove_child**\ (\ child\: :ref:`TreeItem`\ ) :ref:`🔗` Removes the given child **TreeItem** and all its children from the :ref:`Tree`. Note that it doesn't free the item from memory, so it can be reused later (see :ref:`add_child`). To completely remove a **TreeItem** use :ref:`Object.free`. @@ -1212,7 +1206,7 @@ Removes the given child **TreeItem** and all its children from the :ref:`Tree`\ ) +|void| **select**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Selects the given ``column``. @@ -1224,7 +1218,7 @@ Selects the given ``column``. .. rst-class:: classref-method -|void| **set_autowrap_mode**\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) +|void| **set_autowrap_mode**\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) :ref:`🔗` Sets the autowrap mode in the given ``column``. If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the cell's bounding rectangle. @@ -1236,7 +1230,7 @@ Sets the autowrap mode in the given ``column``. If set to something other than : .. rst-class:: classref-method -|void| **set_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) +|void| **set_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the given column's button :ref:`Texture2D` at index ``button_index`` to ``button``. @@ -1248,7 +1242,7 @@ Sets the given column's button :ref:`Texture2D` at index ``butt .. rst-class:: classref-method -|void| **set_button_color**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_button_color**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the given column's button color at index ``button_index`` to ``color``. @@ -1260,7 +1254,7 @@ Sets the given column's button color at index ``button_index`` to ``color``. .. rst-class:: classref-method -|void| **set_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) +|void| **set_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, disables the button at index ``button_index`` in the given ``column``. @@ -1272,7 +1266,7 @@ If ``true``, disables the button at index ``button_index`` in the given ``column .. rst-class:: classref-method -|void| **set_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the tooltip text for the button at index ``button_index`` in the given ``column``. @@ -1284,9 +1278,9 @@ Sets the tooltip text for the button at index ``button_index`` in the given ``co .. rst-class:: classref-method -|void| **set_cell_mode**\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) +|void| **set_cell_mode**\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) :ref:`🔗` -Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode` constants. +Sets the given column's cell mode to ``mode``. This determines how the cell is displayed and edited. See :ref:`TreeCellMode` constants for details. .. rst-class:: classref-item-separator @@ -1296,7 +1290,7 @@ Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode`, checked\: :ref:`bool`\ ) +|void| **set_checked**\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) :ref:`🔗` If ``checked`` is ``true``, the given ``column`` is checked. Clears column's indeterminate status. @@ -1308,7 +1302,7 @@ If ``checked`` is ``true``, the given ``column`` is checked. Clears column's ind .. rst-class:: classref-method -|void| **set_collapsed_recursive**\ (\ enable\: :ref:`bool`\ ) +|void| **set_collapsed_recursive**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` Collapses or uncollapses this **TreeItem** and all the descendants of this item. @@ -1320,11 +1314,9 @@ Collapses or uncollapses this **TreeItem** and all the descendants of this item. .. rst-class:: classref-method -|void| **set_custom_as_button**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) - -.. container:: contribute +|void| **set_custom_as_button**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` - There is currently no description for this method. Please help us by :ref:`contributing one `! +Makes a cell with :ref:`CELL_MODE_CUSTOM` display as a non-flat button with a :ref:`StyleBox`. .. rst-class:: classref-item-separator @@ -1334,7 +1326,7 @@ Collapses or uncollapses this **TreeItem** and all the descendants of this item. .. rst-class:: classref-method -|void| **set_custom_bg_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) +|void| **set_custom_bg_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) :ref:`🔗` Sets the given column's custom background color and whether to just use it as an outline. @@ -1346,7 +1338,7 @@ Sets the given column's custom background color and whether to just use it as an .. rst-class:: classref-method -|void| **set_custom_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) +|void| **set_custom_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the given column's custom color. @@ -1358,7 +1350,7 @@ Sets the given column's custom color. .. rst-class:: classref-method -|void| **set_custom_draw**\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) +|void| **set_custom_draw**\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) :ref:`🔗` **Deprecated:** Use :ref:`set_custom_draw_callback` instead. @@ -1374,9 +1366,9 @@ The method named ``callback`` should accept two arguments: the **TreeItem** that .. rst-class:: classref-method -|void| **set_custom_draw_callback**\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) +|void| **set_custom_draw_callback**\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` -Sets the given column's custom draw callback. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. +Sets the given column's custom draw callback. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. The cell has to be in :ref:`CELL_MODE_CUSTOM` to use this feature. The ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2`. @@ -1388,7 +1380,7 @@ The ``callback`` should accept two arguments: the **TreeItem** that is drawn and .. rst-class:: classref-method -|void| **set_custom_font**\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) +|void| **set_custom_font**\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) :ref:`🔗` Sets custom font used to draw text in the given ``column``. @@ -1400,7 +1392,7 @@ Sets custom font used to draw text in the given ``column``. .. rst-class:: classref-method -|void| **set_custom_font_size**\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) +|void| **set_custom_font_size**\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) :ref:`🔗` Sets custom font size used to draw text in the given ``column``. @@ -1412,7 +1404,7 @@ Sets custom font size used to draw text in the given ``column``. .. rst-class:: classref-method -|void| **set_edit_multiline**\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) +|void| **set_edit_multiline**\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) :ref:`🔗` If ``multiline`` is ``true``, the given ``column`` is multiline editable. @@ -1426,7 +1418,7 @@ If ``multiline`` is ``true``, the given ``column`` is multiline editable. .. rst-class:: classref-method -|void| **set_editable**\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) +|void| **set_editable**\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``enabled`` is ``true``, the given ``column`` is editable. @@ -1438,7 +1430,7 @@ If ``enabled`` is ``true``, the given ``column`` is editable. .. rst-class:: classref-method -|void| **set_expand_right**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) +|void| **set_expand_right**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` If ``enable`` is ``true``, the given ``column`` is expanded to the right. @@ -1450,9 +1442,9 @@ If ``enable`` is ``true``, the given ``column`` is expanded to the right. .. rst-class:: classref-method -|void| **set_icon**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) +|void| **set_icon**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` -Sets the given column's icon :ref:`Texture2D`. +Sets the given cell's icon :ref:`Texture2D`. The cell has to be in :ref:`CELL_MODE_ICON` mode. .. rst-class:: classref-item-separator @@ -1462,7 +1454,7 @@ Sets the given column's icon :ref:`Texture2D`. .. rst-class:: classref-method -|void| **set_icon_max_width**\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) +|void| **set_icon_max_width**\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) :ref:`🔗` Sets the maximum allowed width of the icon in the given ``column``. This limit is applied on top of the default size of the icon and on top of :ref:`Tree.icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1474,7 +1466,7 @@ Sets the maximum allowed width of the icon in the given ``column``. This limit i .. rst-class:: classref-method -|void| **set_icon_modulate**\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) +|void| **set_icon_modulate**\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) :ref:`🔗` Modulates the given column's icon with ``modulate``. @@ -1486,7 +1478,7 @@ Modulates the given column's icon with ``modulate``. .. rst-class:: classref-method -|void| **set_icon_region**\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) +|void| **set_icon_region**\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) :ref:`🔗` Sets the given column's icon's texture region. @@ -1498,7 +1490,7 @@ Sets the given column's icon's texture region. .. rst-class:: classref-method -|void| **set_indeterminate**\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) +|void| **set_indeterminate**\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) :ref:`🔗` If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate. @@ -1512,7 +1504,7 @@ If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate. .. rst-class:: classref-method -|void| **set_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) +|void| **set_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1524,7 +1516,7 @@ Sets language code of item's text used for line-breaking and text shaping algori .. rst-class:: classref-method -|void| **set_metadata**\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) +|void| **set_metadata**\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata value for the given column, which can be retrieved later using :ref:`get_metadata`. This can be used, for example, to store a reference to the original data. @@ -1536,7 +1528,7 @@ Sets the metadata value for the given column, which can be retrieved later using .. rst-class:: classref-method -|void| **set_range**\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) +|void| **set_range**\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of a :ref:`CELL_MODE_RANGE` column. @@ -1548,7 +1540,7 @@ Sets the value of a :ref:`CELL_MODE_RANGE`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) +|void| **set_range_config**\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) :ref:`🔗` Sets the range of accepted values for a column. The column must be in the :ref:`CELL_MODE_RANGE` mode. @@ -1562,7 +1554,7 @@ If ``expr`` is ``true``, the edit mode slider will use an exponential scale as w .. rst-class:: classref-method -|void| **set_selectable**\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) +|void| **set_selectable**\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) :ref:`🔗` If ``selectable`` is ``true``, the given ``column`` is selectable. @@ -1574,11 +1566,9 @@ If ``selectable`` is ``true``, the given ``column`` is selectable. .. rst-class:: classref-method -|void| **set_structured_text_bidi_override**\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) +|void| **set_structured_text_bidi_override**\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) :ref:`🔗` -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Set BiDi algorithm override for the structured text. Has effect for cells that display text. .. rst-class:: classref-item-separator @@ -1588,11 +1578,9 @@ If ``selectable`` is ``true``, the given ``column`` is selectable. .. rst-class:: classref-method -|void| **set_structured_text_bidi_override_options**\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) - -.. container:: contribute +|void| **set_structured_text_bidi_override_options**\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) :ref:`🔗` - There is currently no description for this method. Please help us by :ref:`contributing one `! +Set additional options for BiDi override. Has effect for cells that display text. .. rst-class:: classref-item-separator @@ -1602,7 +1590,7 @@ If ``selectable`` is ``true``, the given ``column`` is selectable. .. rst-class:: classref-method -|void| **set_suffix**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_suffix**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets a string to be shown after a column's value (for example, a unit abbreviation). @@ -1614,7 +1602,7 @@ Sets a string to be shown after a column's value (for example, a unit abbreviati .. rst-class:: classref-method -|void| **set_text**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) +|void| **set_text**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` Sets the given column's text value. @@ -1626,7 +1614,7 @@ Sets the given column's text value. .. rst-class:: classref-method -|void| **set_text_alignment**\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) +|void| **set_text_alignment**\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` Sets the given column's text alignment. See :ref:`HorizontalAlignment` for possible values. @@ -1638,7 +1626,7 @@ Sets the given column's text alignment. See :ref:`HorizontalAlignment`, direction\: :ref:`TextDirection`\ ) +|void| **set_text_direction**\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) :ref:`🔗` Sets item's text base writing direction. @@ -1650,7 +1638,7 @@ Sets item's text base writing direction. .. rst-class:: classref-method -|void| **set_text_overrun_behavior**\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) +|void| **set_text_overrun_behavior**\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) :ref:`🔗` Sets the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``. @@ -1662,7 +1650,7 @@ Sets the clipping behavior when the text exceeds the item's bounding rectangle i .. rst-class:: classref-method -|void| **set_tooltip_text**\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) +|void| **set_tooltip_text**\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the given column's tooltip text. @@ -1674,7 +1662,7 @@ Sets the given column's tooltip text. .. rst-class:: classref-method -|void| **uncollapse_tree**\ (\ ) +|void| **uncollapse_tree**\ (\ ) :ref:`🔗` Uncollapses all **TreeItem**\ s necessary to reveal this **TreeItem**, i.e. all ancestor **TreeItem**\ s. diff --git a/classes/class_tubetrailmesh.rst b/classes/class_tubetrailmesh.rst index 86aa24b08a4..f54fdaba20e 100644 --- a/classes/class_tubetrailmesh.rst +++ b/classes/class_tubetrailmesh.rst @@ -71,7 +71,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **cap_bottom** = ``true`` +:ref:`bool` **cap_bottom** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -88,7 +88,7 @@ If ``true``, generates a cap at the bottom of the tube. This can be set to ``fal .. rst-class:: classref-property -:ref:`bool` **cap_top** = ``true`` +:ref:`bool` **cap_top** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -105,7 +105,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` .. rst-class:: classref-property -:ref:`Curve` **curve** +:ref:`Curve` **curve** :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Determines the radius of the tube along its length. The radius of a particular s .. rst-class:: classref-property -:ref:`int` **radial_steps** = ``8`` +:ref:`int` **radial_steps** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -139,7 +139,7 @@ The number of sides on the tube. For example, a value of ``5`` means the tube wi .. rst-class:: classref-property -:ref:`float` **radius** = ``0.5`` +:ref:`float` **radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -156,7 +156,7 @@ The baseline radius of the tube. The radius of a particular section ring is obta .. rst-class:: classref-property -:ref:`float` **section_length** = ``0.2`` +:ref:`float` **section_length** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -173,7 +173,7 @@ The length of a section of the tube. .. rst-class:: classref-property -:ref:`int` **section_rings** = ``3`` +:ref:`int` **section_rings** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ The number of rings in a section. The :ref:`curve` **sections** = ``5`` +:ref:`int` **sections** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 5ee13ac0d99..615b14683d0 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -216,7 +216,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when the **Tween** has finished all tweening. Never emitted when the **Tween** is set to infinite looping (see :ref:`set_loops`). @@ -228,7 +228,7 @@ Emitted when the **Tween** has finished all tweening. Never emitted when the **T .. rst-class:: classref-signal -**loop_finished**\ (\ loop_count\: :ref:`int`\ ) +**loop_finished**\ (\ loop_count\: :ref:`int`\ ) :ref:`🔗` Emitted when a full loop is complete (see :ref:`set_loops`), providing the loop index. This signal is not emitted after the final loop, use :ref:`finished` instead for this case. @@ -240,7 +240,7 @@ Emitted when a full loop is complete (see :ref:`set_loops`\ ) +**step_finished**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` Emitted when one step of the **Tween** is complete, providing the step index. One step is either a single :ref:`Tweener` or a group of :ref:`Tweener`\ s running in parallel. @@ -257,7 +257,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TweenProcessMode**: +enum **TweenProcessMode**: :ref:`🔗` .. _class_Tween_constant_TWEEN_PROCESS_PHYSICS: @@ -283,7 +283,7 @@ The **Tween** updates after each process frame (see :ref:`Node._process` .. _class_Tween_constant_TWEEN_PAUSE_BOUND: @@ -317,7 +317,7 @@ The **Tween** will process regardless of whether :ref:`SceneTree` .. _class_Tween_constant_TRANS_LINEAR: @@ -423,7 +423,7 @@ The animation is interpolated like a spring towards the end. .. rst-class:: classref-enumeration -enum **EaseType**: +enum **EaseType**: :ref:`🔗` .. _class_Tween_constant_EASE_IN: @@ -470,7 +470,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Tween` **bind_node**\ (\ node\: :ref:`Node`\ ) +:ref:`Tween` **bind_node**\ (\ node\: :ref:`Node`\ ) :ref:`🔗` Binds this **Tween** with the given ``node``. **Tween**\ s are processed directly by the :ref:`SceneTree`, so they run independently of the animated nodes. When you bind a :ref:`Node` with the **Tween**, the **Tween** will halt the animation when the object is not inside tree and the **Tween** will be automatically killed when the bound object is freed. Also :ref:`TWEEN_PAUSE_BOUND` will make the pausing behavior dependent on the bound node. @@ -484,7 +484,7 @@ For a shorter way to create and bind a **Tween**, you can use :ref:`Node.create_ .. rst-class:: classref-method -:ref:`Tween` **chain**\ (\ ) +:ref:`Tween` **chain**\ (\ ) :ref:`🔗` Used to chain two :ref:`Tweener`\ s after :ref:`set_parallel` is called with ``true``. @@ -515,7 +515,7 @@ Used to chain two :ref:`Tweener`\ s after :ref:`set_parallel` **custom_step**\ (\ delta\: :ref:`float`\ ) +:ref:`bool` **custom_step**\ (\ delta\: :ref:`float`\ ) :ref:`🔗` Processes the **Tween** by the given ``delta`` value, in seconds. This is mostly useful for manual control when the **Tween** is paused. It can also be used to end the **Tween** animation immediately, by setting ``delta`` longer than the whole duration of the **Tween** animation. @@ -529,7 +529,7 @@ Returns ``true`` if the **Tween** still has :ref:`Tweener`\ s tha .. rst-class:: classref-method -:ref:`int` **get_loops_left**\ (\ ) |const| +:ref:`int` **get_loops_left**\ (\ ) |const| :ref:`🔗` Returns the number of remaining loops for this **Tween** (see :ref:`set_loops`). A return value of ``-1`` indicates an infinitely looping **Tween**, and a return value of ``0`` indicates that the **Tween** has already finished. @@ -541,7 +541,7 @@ Returns the number of remaining loops for this **Tween** (see :ref:`set_loops` **get_total_elapsed_time**\ (\ ) |const| +:ref:`float` **get_total_elapsed_time**\ (\ ) |const| :ref:`🔗` Returns the total time in seconds the **Tween** has been animating (i.e. the time since it started, not counting pauses etc.). The time is affected by :ref:`set_speed_scale`, and :ref:`stop` will reset it to ``0``. @@ -555,7 +555,7 @@ Returns the total time in seconds the **Tween** has been animating (i.e. the tim .. rst-class:: classref-method -:ref:`Variant` **interpolate_value**\ (\ initial_value\: :ref:`Variant`, delta_value\: :ref:`Variant`, elapsed_time\: :ref:`float`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType`, ease_type\: :ref:`EaseType`\ ) |static| +:ref:`Variant` **interpolate_value**\ (\ initial_value\: :ref:`Variant`, delta_value\: :ref:`Variant`, elapsed_time\: :ref:`float`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType`, ease_type\: :ref:`EaseType`\ ) |static| :ref:`🔗` This method can be used for manual interpolation of a value, when you don't want **Tween** to do animating for you. It's similar to :ref:`@GlobalScope.lerp`, but with support for custom transition and easing. @@ -577,7 +577,7 @@ This method can be used for manual interpolation of a value, when you don't want .. rst-class:: classref-method -:ref:`bool` **is_running**\ (\ ) +:ref:`bool` **is_running**\ (\ ) :ref:`🔗` Returns whether the **Tween** is currently running, i.e. it wasn't paused and it's not finished. @@ -589,7 +589,7 @@ Returns whether the **Tween** is currently running, i.e. it wasn't paused and it .. rst-class:: classref-method -:ref:`bool` **is_valid**\ (\ ) +:ref:`bool` **is_valid**\ (\ ) :ref:`🔗` Returns whether the **Tween** is valid. A valid **Tween** is a **Tween** contained by the scene tree (i.e. the array from :ref:`SceneTree.get_processed_tweens` will contain this **Tween**). A **Tween** might become invalid when it has finished tweening, is killed, or when created with ``Tween.new()``. Invalid **Tween**\ s can't have :ref:`Tweener`\ s appended. @@ -601,7 +601,7 @@ Returns whether the **Tween** is valid. A valid **Tween** is a **Tween** contain .. rst-class:: classref-method -|void| **kill**\ (\ ) +|void| **kill**\ (\ ) :ref:`🔗` Aborts all tweening operations and invalidates the **Tween**. @@ -613,7 +613,7 @@ Aborts all tweening operations and invalidates the **Tween**. .. rst-class:: classref-method -:ref:`Tween` **parallel**\ (\ ) +:ref:`Tween` **parallel**\ (\ ) :ref:`🔗` Makes the next :ref:`Tweener` run parallelly to the previous one. @@ -650,7 +650,7 @@ You can make the **Tween** parallel by default by using :ref:`set_parallel` Pauses the tweening. The animation can be resumed by using :ref:`play`. @@ -664,7 +664,7 @@ Pauses the tweening. The animation can be resumed by using :ref:`play` Resumes a paused or stopped **Tween**. @@ -676,7 +676,7 @@ Resumes a paused or stopped **Tween**. .. rst-class:: classref-method -:ref:`Tween` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) +:ref:`Tween` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) :ref:`🔗` Sets the default ease type for :ref:`PropertyTweener`\ s and :ref:`MethodTweener`\ s animated by this **Tween**. @@ -690,7 +690,7 @@ If not specified, the default value is :ref:`EASE_IN_OUT` **set_loops**\ (\ loops\: :ref:`int` = 0\ ) +:ref:`Tween` **set_loops**\ (\ loops\: :ref:`int` = 0\ ) :ref:`🔗` Sets the number of times the tweening sequence will be repeated, i.e. ``set_loops(2)`` will run the animation twice. @@ -706,7 +706,7 @@ Calling this method without arguments will make the **Tween** run infinitely, un .. rst-class:: classref-method -:ref:`Tween` **set_parallel**\ (\ parallel\: :ref:`bool` = true\ ) +:ref:`Tween` **set_parallel**\ (\ parallel\: :ref:`bool` = true\ ) :ref:`🔗` If ``parallel`` is ``true``, the :ref:`Tweener`\ s appended after this method will by default run simultaneously, as opposed to sequentially. @@ -726,7 +726,7 @@ If ``parallel`` is ``true``, the :ref:`Tweener`\ s appended after .. rst-class:: classref-method -:ref:`Tween` **set_pause_mode**\ (\ mode\: :ref:`TweenPauseMode`\ ) +:ref:`Tween` **set_pause_mode**\ (\ mode\: :ref:`TweenPauseMode`\ ) :ref:`🔗` Determines the behavior of the **Tween** when the :ref:`SceneTree` is paused. Check :ref:`TweenPauseMode` for options. @@ -740,7 +740,7 @@ Default value is :ref:`TWEEN_PAUSE_BOUND .. rst-class:: classref-method -:ref:`Tween` **set_process_mode**\ (\ mode\: :ref:`TweenProcessMode`\ ) +:ref:`Tween` **set_process_mode**\ (\ mode\: :ref:`TweenProcessMode`\ ) :ref:`🔗` Determines whether the **Tween** should run after process frames (see :ref:`Node._process`) or physics frames (see :ref:`Node._physics_process`). @@ -754,7 +754,7 @@ Default value is :ref:`TWEEN_PROCESS_IDLE` **set_speed_scale**\ (\ speed\: :ref:`float`\ ) +:ref:`Tween` **set_speed_scale**\ (\ speed\: :ref:`float`\ ) :ref:`🔗` Scales the speed of tweening. This affects all :ref:`Tweener`\ s and their delays. @@ -766,7 +766,7 @@ Scales the speed of tweening. This affects all :ref:`Tweener`\ s .. rst-class:: classref-method -:ref:`Tween` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) +:ref:`Tween` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) :ref:`🔗` Sets the default transition type for :ref:`PropertyTweener`\ s and :ref:`MethodTweener`\ s animated by this **Tween**. @@ -780,7 +780,7 @@ If not specified, the default value is :ref:`TRANS_LINEAR` Stops the tweening and resets the **Tween** to its initial state. This will not remove any appended :ref:`Tweener`\ s. @@ -794,7 +794,7 @@ Stops the tweening and resets the **Tween** to its initial state. This will not .. rst-class:: classref-method -:ref:`CallbackTweener` **tween_callback**\ (\ callback\: :ref:`Callable`\ ) +:ref:`CallbackTweener` **tween_callback**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Creates and appends a :ref:`CallbackTweener`. This method can be used to call an arbitrary method in any object. Use :ref:`Callable.bind` to bind additional arguments for the call. @@ -843,7 +843,7 @@ Creates and appends a :ref:`CallbackTweener`. This method .. rst-class:: classref-method -:ref:`IntervalTweener` **tween_interval**\ (\ time\: :ref:`float`\ ) +:ref:`IntervalTweener` **tween_interval**\ (\ time\: :ref:`float`\ ) :ref:`🔗` Creates and appends an :ref:`IntervalTweener`. This method can be used to create delays in the tween animation, as an alternative to using the delay in other :ref:`Tweener`\ s, or when there's no animation (in which case the **Tween** acts as a timer). ``time`` is the length of the interval, in seconds. @@ -901,7 +901,7 @@ Creates and appends an :ref:`IntervalTweener`. This metho .. rst-class:: classref-method -:ref:`MethodTweener` **tween_method**\ (\ method\: :ref:`Callable`, from\: :ref:`Variant`, to\: :ref:`Variant`, duration\: :ref:`float`\ ) +:ref:`MethodTweener` **tween_method**\ (\ method\: :ref:`Callable`, from\: :ref:`Variant`, to\: :ref:`Variant`, duration\: :ref:`float`\ ) :ref:`🔗` Creates and appends a :ref:`MethodTweener`. This method is similar to a combination of :ref:`tween_callback` and :ref:`tween_property`. It calls a method over time with a tweened value provided as an argument. The value is tweened between ``from`` and ``to`` over the time specified by ``duration``, in seconds. Use :ref:`Callable.bind` to bind additional arguments for the call. You can use :ref:`MethodTweener.set_ease` and :ref:`MethodTweener.set_trans` to tweak the easing and transition of the value or :ref:`MethodTweener.set_delay` to delay the tweening. @@ -961,7 +961,7 @@ Creates and appends a :ref:`MethodTweener`. This method is .. rst-class:: classref-method -:ref:`PropertyTweener` **tween_property**\ (\ object\: :ref:`Object`, property\: :ref:`NodePath`, final_val\: :ref:`Variant`, duration\: :ref:`float`\ ) +:ref:`PropertyTweener` **tween_property**\ (\ object\: :ref:`Object`, property\: :ref:`NodePath`, final_val\: :ref:`Variant`, duration\: :ref:`float`\ ) :ref:`🔗` Creates and appends a :ref:`PropertyTweener`. This method tweens a ``property`` of an ``object`` between an initial value and ``final_val`` in a span of time equal to ``duration``, in seconds. The initial value by default is the property's value at the time the tweening of the :ref:`PropertyTweener` starts. diff --git a/classes/class_tweener.rst b/classes/class_tweener.rst index c408da06e5f..355996804c2 100644 --- a/classes/class_tweener.rst +++ b/classes/class_tweener.rst @@ -36,7 +36,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when the **Tweener** has just finished its job. diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index f22f451d8ed..bf506f3dd9f 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -198,7 +198,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **max_pending_connections** = ``16`` +:ref:`int` **max_pending_connections** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -220,7 +220,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_local_port**\ (\ ) |const| +:ref:`int` **get_local_port**\ (\ ) |const| :ref:`🔗` Returns the local port this server is listening to. @@ -232,7 +232,7 @@ Returns the local port this server is listening to. .. rst-class:: classref-method -:ref:`bool` **is_connection_available**\ (\ ) |const| +:ref:`bool` **is_connection_available**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a packet with a new address/port combination was received on the socket. @@ -244,7 +244,7 @@ Returns ``true`` if a packet with a new address/port combination was received on .. rst-class:: classref-method -:ref:`bool` **is_listening**\ (\ ) |const| +:ref:`bool` **is_listening**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the socket is open and listening on a port. @@ -256,7 +256,7 @@ Returns ``true`` if the socket is open and listening on a port. .. rst-class:: classref-method -:ref:`Error` **listen**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) +:ref:`Error` **listen**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) :ref:`🔗` Starts the server by opening a UDP socket listening on the given ``port``. You can optionally specify a ``bind_address`` to only listen for packets sent to that address. See also :ref:`PacketPeerUDP.bind`. @@ -268,7 +268,7 @@ Starts the server by opening a UDP socket listening on the given ``port``. You c .. rst-class:: classref-method -:ref:`Error` **poll**\ (\ ) +:ref:`Error` **poll**\ (\ ) :ref:`🔗` Call this method at regular intervals (e.g. inside :ref:`Node._process`) to process new packets. And packet from known address/port pair will be delivered to the appropriate :ref:`PacketPeerUDP`, any packet received from an unknown address/port pair will be added as a pending connection (see :ref:`is_connection_available`, :ref:`take_connection`). The maximum number of pending connection is defined via :ref:`max_pending_connections`. @@ -280,7 +280,7 @@ Call this method at regular intervals (e.g. inside :ref:`Node._process` Stops the server, closing the UDP socket if open. Will close all connected :ref:`PacketPeerUDP` accepted via :ref:`take_connection` (remote peers will not be notified). @@ -292,7 +292,7 @@ Stops the server, closing the UDP socket if open. Will close all connected :ref: .. rst-class:: classref-method -:ref:`PacketPeerUDP` **take_connection**\ (\ ) +:ref:`PacketPeerUDP` **take_connection**\ (\ ) :ref:`🔗` Returns the first pending connection (connected to the appropriate address/port). Will return ``null`` if no new connection is available. See also :ref:`is_connection_available`, :ref:`PacketPeerUDP.connect_to_host`. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 8fc8c1b1f4c..83b5df292aa 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -197,7 +197,7 @@ Signals .. rst-class:: classref-signal -**version_changed**\ (\ ) +**version_changed**\ (\ ) :ref:`🔗` Called when :ref:`undo` or :ref:`redo` was called. @@ -214,7 +214,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **MergeMode**: +enum **MergeMode**: :ref:`🔗` .. _class_UndoRedo_constant_MERGE_DISABLE: @@ -253,7 +253,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **max_steps** = ``0`` +:ref:`int` **max_steps** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -275,7 +275,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_do_method**\ (\ callable\: :ref:`Callable`\ ) +|void| **add_do_method**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Register a :ref:`Callable` that will be called when the action is committed. @@ -287,7 +287,7 @@ Register a :ref:`Callable` that will be called when the action i .. rst-class:: classref-method -|void| **add_do_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **add_do_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Register a ``property`` that would change its value to ``value`` when the action is committed. @@ -299,7 +299,7 @@ Register a ``property`` that would change its value to ``value`` when the action .. rst-class:: classref-method -|void| **add_do_reference**\ (\ object\: :ref:`Object`\ ) +|void| **add_do_reference**\ (\ object\: :ref:`Object`\ ) :ref:`🔗` Register a reference to an object that will be erased if the "do" history is deleted. This is useful for objects added by the "do" action and removed by the "undo" action. @@ -322,7 +322,7 @@ When the "do" history is deleted, if the object is a :ref:`RefCounted`\ ) +|void| **add_undo_method**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Register a :ref:`Callable` that will be called when the action is undone. @@ -334,7 +334,7 @@ Register a :ref:`Callable` that will be called when the action i .. rst-class:: classref-method -|void| **add_undo_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **add_undo_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` Register a ``property`` that would change its value to ``value`` when the action is undone. @@ -346,7 +346,7 @@ Register a ``property`` that would change its value to ``value`` when the action .. rst-class:: classref-method -|void| **add_undo_reference**\ (\ object\: :ref:`Object`\ ) +|void| **add_undo_reference**\ (\ object\: :ref:`Object`\ ) :ref:`🔗` Register a reference to an object that will be erased if the "undo" history is deleted. This is useful for objects added by the "undo" action and removed by the "do" action. @@ -369,7 +369,7 @@ When the "undo" history is deleted, if the object is a :ref:`RefCounted` = true\ ) +|void| **clear_history**\ (\ increase_version\: :ref:`bool` = true\ ) :ref:`🔗` Clear the undo/redo history and associated references. @@ -383,7 +383,7 @@ Passing ``false`` to ``increase_version`` will prevent the version number from i .. rst-class:: classref-method -|void| **commit_action**\ (\ execute\: :ref:`bool` = true\ ) +|void| **commit_action**\ (\ execute\: :ref:`bool` = true\ ) :ref:`🔗` Commit the action. If ``execute`` is ``true`` (which it is by default), all "do" methods/properties are called/set when this function is called. @@ -395,7 +395,7 @@ Commit the action. If ``execute`` is ``true`` (which it is by default), all "do" .. rst-class:: classref-method -|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, backward_undo_ops\: :ref:`bool` = false\ ) +|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, backward_undo_ops\: :ref:`bool` = false\ ) :ref:`🔗` Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. @@ -411,7 +411,7 @@ The way undo operation are ordered in actions is dictated by ``backward_undo_ops .. rst-class:: classref-method -|void| **end_force_keep_in_merge_ends**\ (\ ) +|void| **end_force_keep_in_merge_ends**\ (\ ) :ref:`🔗` 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`. @@ -423,7 +423,7 @@ Stops marking operations as to be processed even if the action gets merged with .. rst-class:: classref-method -:ref:`String` **get_action_name**\ (\ id\: :ref:`int`\ ) +:ref:`String` **get_action_name**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Gets the action name from its index. @@ -435,7 +435,7 @@ Gets the action name from its index. .. rst-class:: classref-method -:ref:`int` **get_current_action**\ (\ ) +:ref:`int` **get_current_action**\ (\ ) :ref:`🔗` Gets the index of the current action. @@ -447,7 +447,7 @@ Gets the index of the current action. .. rst-class:: classref-method -:ref:`String` **get_current_action_name**\ (\ ) |const| +:ref:`String` **get_current_action_name**\ (\ ) |const| :ref:`🔗` Gets the name of the current action, equivalent to ``get_action_name(get_current_action())``. @@ -459,7 +459,7 @@ Gets the name of the current action, equivalent to ``get_action_name(get_current .. rst-class:: classref-method -:ref:`int` **get_history_count**\ (\ ) +:ref:`int` **get_history_count**\ (\ ) :ref:`🔗` Returns how many elements are in the history. @@ -471,7 +471,7 @@ Returns how many elements are in the history. .. rst-class:: classref-method -:ref:`int` **get_version**\ (\ ) |const| +:ref:`int` **get_version**\ (\ ) |const| :ref:`🔗` Gets the version. Every time a new action is committed, the **UndoRedo**'s version number is increased automatically. @@ -485,7 +485,7 @@ This is useful mostly to check if something changed from a saved version. .. rst-class:: classref-method -:ref:`bool` **has_redo**\ (\ ) |const| +:ref:`bool` **has_redo**\ (\ ) |const| :ref:`🔗` Returns ``true`` if a "redo" action is available. @@ -497,7 +497,7 @@ Returns ``true`` if a "redo" action is available. .. rst-class:: classref-method -:ref:`bool` **has_undo**\ (\ ) |const| +:ref:`bool` **has_undo**\ (\ ) |const| :ref:`🔗` Returns ``true`` if an "undo" action is available. @@ -509,7 +509,7 @@ Returns ``true`` if an "undo" action is available. .. rst-class:: classref-method -:ref:`bool` **is_committing_action**\ (\ ) |const| +:ref:`bool` **is_committing_action**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the **UndoRedo** is currently committing the action, i.e. running its "do" method or property change (see :ref:`commit_action`). @@ -521,7 +521,7 @@ Returns ``true`` if the **UndoRedo** is currently committing the action, i.e. ru .. rst-class:: classref-method -:ref:`bool` **redo**\ (\ ) +:ref:`bool` **redo**\ (\ ) :ref:`🔗` Redo the last action. @@ -533,7 +533,7 @@ Redo the last action. .. rst-class:: classref-method -|void| **start_force_keep_in_merge_ends**\ (\ ) +|void| **start_force_keep_in_merge_ends**\ (\ ) :ref:`🔗` 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`. @@ -545,7 +545,7 @@ Marks the next "do" and "undo" operations to be processed even if the action get .. rst-class:: classref-method -:ref:`bool` **undo**\ (\ ) +:ref:`bool` **undo**\ (\ ) :ref:`🔗` Undo the last action. diff --git a/classes/class_uniformsetcacherd.rst b/classes/class_uniformsetcacherd.rst index 07b0eb41a94..5f3c198d611 100644 --- a/classes/class_uniformsetcacherd.rst +++ b/classes/class_uniformsetcacherd.rst @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_cache**\ (\ shader\: :ref:`RID`, set\: :ref:`int`, uniforms\: :ref:`Array`\[:ref:`RDUniform`\]\ ) |static| +:ref:`RID` **get_cache**\ (\ shader\: :ref:`RID`, set\: :ref:`int`, uniforms\: :ref:`Array`\[:ref:`RDUniform`\]\ ) |static| :ref:`🔗` Creates/returns a cached uniform set based on the provided uniforms for a given shader. diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 1e4cc837f69..c178ce766c1 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -146,7 +146,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **UPNPResult**: +enum **UPNPResult**: :ref:`🔗` .. _class_UPNP_constant_UPNP_RESULT_SUCCESS: @@ -393,7 +393,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **discover_ipv6** = ``false`` +:ref:`bool` **discover_ipv6** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -410,7 +410,7 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. .. rst-class:: classref-property -:ref:`int` **discover_local_port** = ``0`` +:ref:`int` **discover_local_port** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -427,7 +427,7 @@ If ``0``, the local port to use for discovery is chosen automatically by the sys .. rst-class:: classref-property -:ref:`String` **discover_multicast_if** = ``""`` +:ref:`String` **discover_multicast_if** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -449,7 +449,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_device**\ (\ device\: :ref:`UPNPDevice`\ ) +|void| **add_device**\ (\ device\: :ref:`UPNPDevice`\ ) :ref:`🔗` Adds the given :ref:`UPNPDevice` to the list of discovered devices. @@ -461,7 +461,7 @@ Adds the given :ref:`UPNPDevice` to the list of discovered dev .. rst-class:: classref-method -:ref:`int` **add_port_mapping**\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| +:ref:`int` **add_port_mapping**\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| :ref:`🔗` Adds a mapping to forward the external ``port`` (between 1 and 65535, although recommended to use port 1024 or above) on the default gateway (see :ref:`get_gateway`) to the ``port_internal`` on the local machine for the given protocol ``proto`` (either ``"TCP"`` or ``"UDP"``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. Note that forwarding a well-known port (below 1024) with UPnP may fail depending on the device. @@ -483,7 +483,7 @@ See :ref:`UPNPResult` for possible return values. .. rst-class:: classref-method -|void| **clear_devices**\ (\ ) +|void| **clear_devices**\ (\ ) :ref:`🔗` Clears the list of discovered devices. @@ -495,7 +495,7 @@ Clears the list of discovered devices. .. rst-class:: classref-method -:ref:`int` **delete_port_mapping**\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| +:ref:`int` **delete_port_mapping**\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| :ref:`🔗` Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``"TCP"`` or ``"UDP"``. May be refused for mappings pointing to addresses other than this one, for well-known ports (below 1024), or for mappings not added via UPnP. See :ref:`UPNPResult` for possible return values. @@ -507,7 +507,7 @@ Deletes the port mapping for the given port and protocol combination on the defa .. rst-class:: classref-method -:ref:`int` **discover**\ (\ timeout\: :ref:`int` = 2000, ttl\: :ref:`int` = 2, device_filter\: :ref:`String` = "InternetGatewayDevice"\ ) +:ref:`int` **discover**\ (\ timeout\: :ref:`int` = 2000, ttl\: :ref:`int` = 2, device_filter\: :ref:`String` = "InternetGatewayDevice"\ ) :ref:`🔗` Discovers local :ref:`UPNPDevice`\ s. Clears the list of previously discovered devices. @@ -523,7 +523,7 @@ See :ref:`UPNPResult` for possible return values. .. rst-class:: classref-method -:ref:`UPNPDevice` **get_device**\ (\ index\: :ref:`int`\ ) |const| +:ref:`UPNPDevice` **get_device**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`UPNPDevice` at the given ``index``. @@ -535,7 +535,7 @@ Returns the :ref:`UPNPDevice` at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_device_count**\ (\ ) |const| +:ref:`int` **get_device_count**\ (\ ) |const| :ref:`🔗` Returns the number of discovered :ref:`UPNPDevice`\ s. @@ -547,7 +547,7 @@ Returns the number of discovered :ref:`UPNPDevice`\ s. .. rst-class:: classref-method -:ref:`UPNPDevice` **get_gateway**\ (\ ) |const| +:ref:`UPNPDevice` **get_gateway**\ (\ ) |const| :ref:`🔗` Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). @@ -559,7 +559,7 @@ Returns the default gateway. That is the first discovered :ref:`UPNPDevice` **query_external_address**\ (\ ) |const| +:ref:`String` **query_external_address**\ (\ ) |const| :ref:`🔗` Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. @@ -571,7 +571,7 @@ Returns the external :ref:`IP` address of the default gateway (see :re .. rst-class:: classref-method -|void| **remove_device**\ (\ index\: :ref:`int`\ ) +|void| **remove_device**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Removes the device at ``index`` from the list of discovered devices. @@ -583,7 +583,7 @@ Removes the device at ``index`` from the list of discovered devices. .. rst-class:: classref-method -|void| **set_device**\ (\ index\: :ref:`int`, device\: :ref:`UPNPDevice`\ ) +|void| **set_device**\ (\ index\: :ref:`int`, device\: :ref:`UPNPDevice`\ ) :ref:`🔗` Sets the device at ``index`` from the list of discovered devices to ``device``. diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 5fb89a4a4f6..d93766f1814 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -74,7 +74,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **IGDStatus**: +enum **IGDStatus**: :ref:`🔗` .. _class_UPNPDevice_constant_IGD_STATUS_OK: @@ -173,7 +173,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **description_url** = ``""`` +:ref:`String` **description_url** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -190,7 +190,7 @@ URL to the device description. .. rst-class:: classref-property -:ref:`String` **igd_control_url** = ``""`` +:ref:`String` **igd_control_url** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -207,7 +207,7 @@ IDG control URL. .. rst-class:: classref-property -:ref:`String` **igd_our_addr** = ``""`` +:ref:`String` **igd_our_addr** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -224,7 +224,7 @@ Address of the local machine in the network connecting it to this **UPNPDevice** .. rst-class:: classref-property -:ref:`String` **igd_service_type** = ``""`` +:ref:`String` **igd_service_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -241,7 +241,7 @@ IGD service type. .. rst-class:: classref-property -:ref:`IGDStatus` **igd_status** = ``9`` +:ref:`IGDStatus` **igd_status** = ``9`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ IGD status. See :ref:`IGDStatus`. .. rst-class:: classref-property -:ref:`String` **service_type** = ``""`` +:ref:`String` **service_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -280,7 +280,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_port_mapping**\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| +:ref:`int` **add_port_mapping**\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| :ref:`🔗` Adds a port mapping to forward the given external port on this **UPNPDevice** for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. @@ -292,7 +292,7 @@ Adds a port mapping to forward the given external port on this **UPNPDevice** fo .. rst-class:: classref-method -:ref:`int` **delete_port_mapping**\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| +:ref:`int` **delete_port_mapping**\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| :ref:`🔗` Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. @@ -304,7 +304,7 @@ Deletes the port mapping identified by the given port and protocol combination o .. rst-class:: classref-method -:ref:`bool` **is_valid_gateway**\ (\ ) |const| +:ref:`bool` **is_valid_gateway**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. @@ -316,7 +316,7 @@ Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentiall .. rst-class:: classref-method -:ref:`String` **query_external_address**\ (\ ) |const| +:ref:`String` **query_external_address**\ (\ ) |const| :ref:`🔗` Returns the external IP address of this **UPNPDevice** or an empty string. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index a8abb364dec..2f8f61bf404 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -239,7 +239,7 @@ Constants .. rst-class:: classref-constant -**AXIS_X** = ``0`` +**AXIS_X** = ``0`` :ref:`🔗` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -247,7 +247,7 @@ Enumerated value for the X axis. Returned by :ref:`max_axis_index` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -255,7 +255,7 @@ Enumerated value for the Y axis. Returned by :ref:`max_axis_index` Zero vector, a vector with all components set to ``0``. @@ -263,7 +263,7 @@ Zero vector, a vector with all components set to ``0``. .. rst-class:: classref-constant -**ONE** = ``Vector2(1, 1)`` +**ONE** = ``Vector2(1, 1)`` :ref:`🔗` One vector, a vector with all components set to ``1``. @@ -271,7 +271,7 @@ One vector, a vector with all components set to ``1``. .. rst-class:: classref-constant -**INF** = ``Vector2(inf, inf)`` +**INF** = ``Vector2(inf, inf)`` :ref:`🔗` Infinity vector, a vector with all components set to :ref:`@GDScript.INF`. @@ -279,7 +279,7 @@ Infinity vector, a vector with all components set to :ref:`@GDScript.INF` Left unit vector. Represents the direction of left. @@ -287,7 +287,7 @@ Left unit vector. Represents the direction of left. .. rst-class:: classref-constant -**RIGHT** = ``Vector2(1, 0)`` +**RIGHT** = ``Vector2(1, 0)`` :ref:`🔗` Right unit vector. Represents the direction of right. @@ -295,7 +295,7 @@ Right unit vector. Represents the direction of right. .. rst-class:: classref-constant -**UP** = ``Vector2(0, -1)`` +**UP** = ``Vector2(0, -1)`` :ref:`🔗` Up unit vector. Y is down in 2D, so this vector points -Y. @@ -303,7 +303,7 @@ Up unit vector. Y is down in 2D, so this vector points -Y. .. rst-class:: classref-constant -**DOWN** = ``Vector2(0, 1)`` +**DOWN** = ``Vector2(0, 1)`` :ref:`🔗` Down unit vector. Y is down in 2D, so this vector points +Y. @@ -320,7 +320,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **x** = ``0.0`` +:ref:`float` **x** = ``0.0`` :ref:`🔗` The vector's X component. Also accessible by using the index position ``[0]``. @@ -332,7 +332,7 @@ The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-property -:ref:`float` **y** = ``0.0`` +:ref:`float` **y** = ``0.0`` :ref:`🔗` The vector's Y component. Also accessible by using the index position ``[1]``. @@ -349,7 +349,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector2` **Vector2**\ (\ ) +:ref:`Vector2` **Vector2**\ (\ ) :ref:`🔗` Constructs a default-initialized **Vector2** with all components set to ``0``. @@ -396,7 +396,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **abs**\ (\ ) |const| +:ref:`Vector2` **abs**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components in absolute values (i.e. positive). @@ -408,7 +408,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`float` **angle**\ (\ ) |const| +:ref:`float` **angle**\ (\ ) |const| :ref:`🔗` Returns this vector's angle with respect to the positive X axis, or ``(1, 0)`` vector, in radians. @@ -426,7 +426,7 @@ Equivalent to the result of :ref:`@GlobalScope.atan2` **angle_to**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`float` **angle_to**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the angle to the given vector, in radians. @@ -440,7 +440,7 @@ Returns the angle to the given vector, in radians. .. rst-class:: classref-method -:ref:`float` **angle_to_point**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`float` **angle_to_point**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the angle between the line connecting the two points and the X axis, in radians. @@ -456,7 +456,7 @@ Returns the angle between the line connecting the two points and the X axis, in .. rst-class:: classref-method -:ref:`float` **aspect**\ (\ ) |const| +:ref:`float` **aspect**\ (\ ) |const| :ref:`🔗` Returns the aspect ratio of this vector, the ratio of :ref:`x` to :ref:`y`. @@ -468,7 +468,7 @@ Returns the aspect ratio of this vector, the ratio of :ref:`x` **bezier_derivative**\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| +:ref:`Vector2` **bezier_derivative**\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| :ref:`🔗` Returns the derivative at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -480,7 +480,7 @@ Returns the derivative at the given ``t`` on the `Bézier curve ` **bezier_interpolate**\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| +:ref:`Vector2` **bezier_interpolate**\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| :ref:`🔗` Returns the point at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -492,7 +492,7 @@ Returns the point at the given ``t`` on the `Bézier curve ` **bounce**\ (\ n\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **bounce**\ (\ n\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the vector "bounced off" from a line defined by the given normal ``n`` perpendicular to the line. @@ -506,7 +506,7 @@ Returns the vector "bounced off" from a line defined by the given normal ``n`` p .. rst-class:: classref-method -:ref:`Vector2` **ceil**\ (\ ) |const| +:ref:`Vector2` **ceil**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded up (towards positive infinity). @@ -518,7 +518,7 @@ Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-method -:ref:`Vector2` **clamp**\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **clamp**\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -530,7 +530,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector2` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| +:ref:`Vector2` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -542,7 +542,7 @@ Returns a new vector with all components clamped between ``min`` and ``max``, by .. rst-class:: classref-method -:ref:`float` **cross**\ (\ with\: :ref:`Vector2`\ ) |const| +:ref:`float` **cross**\ (\ with\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the 2D analog of the cross product for this vector and ``with``. @@ -558,7 +558,7 @@ This is the signed area of the parallelogram formed by the two vectors. If the s .. rst-class:: classref-method -:ref:`Vector2` **cubic_interpolate**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| +:ref:`Vector2` **cubic_interpolate**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -570,7 +570,7 @@ Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and .. rst-class:: classref-method -:ref:`Vector2` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| +:ref:`Vector2` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -584,7 +584,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **direction_to**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **direction_to**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. @@ -596,7 +596,7 @@ Returns the normalized vector pointing from this vector to ``to``. This is equiv .. rst-class:: classref-method -:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the squared distance between this vector and ``to``. @@ -610,7 +610,7 @@ This method runs faster than :ref:`distance_to .. rst-class:: classref-method -:ref:`float` **distance_to**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the distance between this vector and ``to``. @@ -622,7 +622,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **dot**\ (\ with\: :ref:`Vector2`\ ) |const| +:ref:`float` **dot**\ (\ with\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the dot product of this vector and ``with``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. @@ -640,7 +640,7 @@ When using unit (normalized) vectors, the result will always be between ``-1.0`` .. rst-class:: classref-method -:ref:`Vector2` **floor**\ (\ ) |const| +:ref:`Vector2` **floor**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded down (towards negative infinity). @@ -652,7 +652,7 @@ Returns a new vector with all components rounded down (towards negative infinity .. rst-class:: classref-method -:ref:`Vector2` **from_angle**\ (\ angle\: :ref:`float`\ ) |static| +:ref:`Vector2` **from_angle**\ (\ angle\: :ref:`float`\ ) |static| :ref:`🔗` Creates a unit **Vector2** rotated to the given ``angle`` in radians. This is equivalent to doing ``Vector2(cos(angle), sin(angle))`` or ``Vector2.RIGHT.rotated(angle)``. @@ -670,7 +670,7 @@ Creates a unit **Vector2** rotated to the given ``angle`` in radians. This is eq .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector2`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -682,7 +682,7 @@ Returns ``true`` if this vector and ``to`` are approximately equal, by running : .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -694,7 +694,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini .. rst-class:: classref-method -:ref:`bool` **is_normalized**\ (\ ) |const| +:ref:`bool` **is_normalized**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. @@ -706,7 +706,7 @@ Returns ``true`` if the vector is normalized, i.e. its length is approximately e .. rst-class:: classref-method -:ref:`bool` **is_zero_approx**\ (\ ) |const| +:ref:`bool` **is_zero_approx**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. @@ -720,7 +720,7 @@ This method is faster than using :ref:`is_equal_approx` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns the length (magnitude) of this vector. @@ -732,7 +732,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`float` **length_squared**\ (\ ) |const| +:ref:`float` **length_squared**\ (\ ) |const| :ref:`🔗` Returns the squared length (squared magnitude) of this vector. @@ -746,7 +746,7 @@ This method runs faster than :ref:`length`, so pref .. rst-class:: classref-method -:ref:`Vector2` **lerp**\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| +:ref:`Vector2` **lerp**\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. @@ -758,7 +758,7 @@ Returns the result of the linear interpolation between this vector and ``to`` by .. rst-class:: classref-method -:ref:`Vector2` **limit_length**\ (\ length\: :ref:`float` = 1.0\ ) |const| +:ref:`Vector2` **limit_length**\ (\ length\: :ref:`float` = 1.0\ ) |const| :ref:`🔗` Returns the vector with a maximum length by limiting its length to ``length``. @@ -770,7 +770,7 @@ Returns the vector with a maximum length by limiting its length to ``length``. .. rst-class:: classref-method -:ref:`Vector2` **max**\ (\ with\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **max**\ (\ with\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2(maxf(x, with.x), maxf(y, with.y))``. @@ -782,7 +782,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`int` **max_axis_index**\ (\ ) |const| +:ref:`int` **max_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -794,7 +794,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector2` **maxf**\ (\ with\: :ref:`float`\ ) |const| +:ref:`Vector2` **maxf**\ (\ with\: :ref:`float`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2(maxf(x, with), maxf(y, with))``. @@ -806,7 +806,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`Vector2` **min**\ (\ with\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **min**\ (\ with\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2(minf(x, with.x), minf(y, with.y))``. @@ -818,7 +818,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`int` **min_axis_index**\ (\ ) |const| +:ref:`int` **min_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Y`. @@ -830,7 +830,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector2` **minf**\ (\ with\: :ref:`float`\ ) |const| +:ref:`Vector2` **minf**\ (\ with\: :ref:`float`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2(minf(x, with), minf(y, with))``. @@ -842,7 +842,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`Vector2` **move_toward**\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| +:ref:`Vector2` **move_toward**\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not go past the final value. @@ -854,7 +854,7 @@ Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not .. rst-class:: classref-method -:ref:`Vector2` **normalized**\ (\ ) |const| +:ref:`Vector2` **normalized**\ (\ ) |const| :ref:`🔗` Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. @@ -868,7 +868,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l .. rst-class:: classref-method -:ref:`Vector2` **orthogonal**\ (\ ) |const| +:ref:`Vector2` **orthogonal**\ (\ ) |const| :ref:`🔗` Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length. @@ -880,7 +880,7 @@ Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to .. rst-class:: classref-method -:ref:`Vector2` **posmod**\ (\ mod\: :ref:`float`\ ) |const| +:ref:`Vector2` **posmod**\ (\ mod\: :ref:`float`\ ) |const| :ref:`🔗` Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. @@ -892,7 +892,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **posmodv**\ (\ modv\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **posmodv**\ (\ modv\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. @@ -904,7 +904,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **project**\ (\ b\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **project**\ (\ b\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a new vector resulting from projecting this vector onto the given vector ``b``. The resulting new vector is parallel to ``b``. See also :ref:`slide`. @@ -918,7 +918,7 @@ Returns a new vector resulting from projecting this vector onto the given vector .. rst-class:: classref-method -:ref:`Vector2` **reflect**\ (\ line\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **reflect**\ (\ line\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the result of reflecting the vector from a line defined by the given direction vector ``line``. @@ -932,7 +932,7 @@ Returns the result of reflecting the vector from a line defined by the given dir .. rst-class:: classref-method -:ref:`Vector2` **rotated**\ (\ angle\: :ref:`float`\ ) |const| +:ref:`Vector2` **rotated**\ (\ angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of rotating this vector by ``angle`` (in radians). See also :ref:`@GlobalScope.deg_to_rad`. @@ -944,7 +944,7 @@ Returns the result of rotating this vector by ``angle`` (in radians). See also : .. rst-class:: classref-method -:ref:`Vector2` **round**\ (\ ) |const| +:ref:`Vector2` **round**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. @@ -956,7 +956,7 @@ Returns a new vector with all components rounded to the nearest integer, with ha .. rst-class:: classref-method -:ref:`Vector2` **sign**\ (\ ) |const| +:ref:`Vector2` **sign**\ (\ ) |const| :ref:`🔗` Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -968,7 +968,7 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 .. rst-class:: classref-method -:ref:`Vector2` **slerp**\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| +:ref:`Vector2` **slerp**\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of spherical linear interpolation between this vector and ``to``, by amount ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -982,7 +982,7 @@ This method also handles interpolating the lengths if the input vectors have dif .. rst-class:: classref-method -:ref:`Vector2` **slide**\ (\ n\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **slide**\ (\ n\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a new vector resulting from sliding this vector along a line with normal ``n``. The resulting new vector is perpendicular to ``n``, and is equivalent to this vector minus its projection on ``n``. See also :ref:`project`. @@ -996,7 +996,7 @@ Returns a new vector resulting from sliding this vector along a line with normal .. rst-class:: classref-method -:ref:`Vector2` **snapped**\ (\ step\: :ref:`Vector2`\ ) |const| +:ref:`Vector2` **snapped**\ (\ step\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -1008,7 +1008,7 @@ Returns a new vector with each component snapped to the nearest multiple of the .. rst-class:: classref-method -:ref:`Vector2` **snappedf**\ (\ step\: :ref:`float`\ ) |const| +:ref:`Vector2` **snappedf**\ (\ step\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -1025,7 +1025,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector2`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Returns ``true`` if the vectors are not equal. @@ -1041,7 +1041,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`Transform2D`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Vector2** by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -1057,7 +1057,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Multiplies each component of the **Vector2** by the components of the given **Vector2**. @@ -1073,7 +1073,7 @@ Multiplies each component of the **Vector2** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Vector2** by the given :ref:`float`. @@ -1085,7 +1085,7 @@ Multiplies each component of the **Vector2** by the given :ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Vector2** by the given :ref:`int`. @@ -1097,7 +1097,7 @@ Multiplies each component of the **Vector2** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Vector2` **operator +**\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator +**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Adds each component of the **Vector2** by the components of the given **Vector2**. @@ -1113,7 +1113,7 @@ Adds each component of the **Vector2** by the components of the given **Vector2* .. rst-class:: classref-operator -:ref:`Vector2` **operator -**\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator -**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Subtracts each component of the **Vector2** by the components of the given **Vector2**. @@ -1129,7 +1129,7 @@ Subtracts each component of the **Vector2** by the components of the given **Vec .. rst-class:: classref-operator -:ref:`Vector2` **operator /**\ (\ right\: :ref:`Vector2`\ ) +:ref:`Vector2` **operator /**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Divides each component of the **Vector2** by the components of the given **Vector2**. @@ -1145,7 +1145,7 @@ Divides each component of the **Vector2** by the components of the given **Vecto .. rst-class:: classref-operator -:ref:`Vector2` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Vector2` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Vector2** by the given :ref:`float`. @@ -1157,7 +1157,7 @@ Divides each component of the **Vector2** by the given :ref:`float` .. rst-class:: classref-operator -:ref:`Vector2` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Vector2` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Vector2** by the given :ref:`int`. @@ -1169,7 +1169,7 @@ Divides each component of the **Vector2** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Vector2`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Compares two **Vector2** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1183,7 +1183,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector2`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Compares two **Vector2** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1197,7 +1197,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector2`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Returns ``true`` if the vectors are exactly equal. @@ -1213,7 +1213,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Vector2`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Compares two **Vector2** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1227,7 +1227,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector2`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector2`\ ) :ref:`🔗` Compares two **Vector2** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1241,7 +1241,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, and ``v[1]`` is equivalent to ``v.y``. @@ -1253,7 +1253,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector2` **operator unary+**\ (\ ) +:ref:`Vector2` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -1265,7 +1265,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector2` **operator unary-**\ (\ ) +:ref:`Vector2` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Vector2**. This is the same as writing ``Vector2(-v.x, -v.y)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index 2a82f489276..0f8d9b61531 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -171,7 +171,7 @@ Constants .. rst-class:: classref-constant -**AXIS_X** = ``0`` +**AXIS_X** = ``0`` :ref:`🔗` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -179,7 +179,7 @@ Enumerated value for the X axis. Returned by :ref:`max_axis_index` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -187,7 +187,7 @@ Enumerated value for the Y axis. Returned by :ref:`max_axis_index` Zero vector, a vector with all components set to ``0``. @@ -195,7 +195,7 @@ Zero vector, a vector with all components set to ``0``. .. rst-class:: classref-constant -**ONE** = ``Vector2i(1, 1)`` +**ONE** = ``Vector2i(1, 1)`` :ref:`🔗` One vector, a vector with all components set to ``1``. @@ -203,7 +203,7 @@ One vector, a vector with all components set to ``1``. .. rst-class:: classref-constant -**MIN** = ``Vector2i(-2147483648, -2147483648)`` +**MIN** = ``Vector2i(-2147483648, -2147483648)`` :ref:`🔗` Min vector, a vector with all components equal to ``INT32_MIN``. Can be used as a negative integer equivalent of :ref:`Vector2.INF`. @@ -211,7 +211,7 @@ Min vector, a vector with all components equal to ``INT32_MIN``. Can be used as .. rst-class:: classref-constant -**MAX** = ``Vector2i(2147483647, 2147483647)`` +**MAX** = ``Vector2i(2147483647, 2147483647)`` :ref:`🔗` Max vector, a vector with all components equal to ``INT32_MAX``. Can be used as an integer equivalent of :ref:`Vector2.INF`. @@ -219,7 +219,7 @@ Max vector, a vector with all components equal to ``INT32_MAX``. Can be used as .. rst-class:: classref-constant -**LEFT** = ``Vector2i(-1, 0)`` +**LEFT** = ``Vector2i(-1, 0)`` :ref:`🔗` Left unit vector. Represents the direction of left. @@ -227,7 +227,7 @@ Left unit vector. Represents the direction of left. .. rst-class:: classref-constant -**RIGHT** = ``Vector2i(1, 0)`` +**RIGHT** = ``Vector2i(1, 0)`` :ref:`🔗` Right unit vector. Represents the direction of right. @@ -235,7 +235,7 @@ Right unit vector. Represents the direction of right. .. rst-class:: classref-constant -**UP** = ``Vector2i(0, -1)`` +**UP** = ``Vector2i(0, -1)`` :ref:`🔗` Up unit vector. Y is down in 2D, so this vector points -Y. @@ -243,7 +243,7 @@ Up unit vector. Y is down in 2D, so this vector points -Y. .. rst-class:: classref-constant -**DOWN** = ``Vector2i(0, 1)`` +**DOWN** = ``Vector2i(0, 1)`` :ref:`🔗` Down unit vector. Y is down in 2D, so this vector points +Y. @@ -260,7 +260,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **x** = ``0`` +:ref:`int` **x** = ``0`` :ref:`🔗` The vector's X component. Also accessible by using the index position ``[0]``. @@ -272,7 +272,7 @@ The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-property -:ref:`int` **y** = ``0`` +:ref:`int` **y** = ``0`` :ref:`🔗` The vector's Y component. Also accessible by using the index position ``[1]``. @@ -289,7 +289,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector2i` **Vector2i**\ (\ ) +:ref:`Vector2i` **Vector2i**\ (\ ) :ref:`🔗` Constructs a default-initialized **Vector2i** with all components set to ``0``. @@ -336,7 +336,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2i` **abs**\ (\ ) |const| +:ref:`Vector2i` **abs**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components in absolute values (i.e. positive). @@ -348,7 +348,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`float` **aspect**\ (\ ) |const| +:ref:`float` **aspect**\ (\ ) |const| :ref:`🔗` Returns the aspect ratio of this vector, the ratio of :ref:`x` to :ref:`y`. @@ -360,7 +360,7 @@ Returns the aspect ratio of this vector, the ratio of :ref:`x` **clamp**\ (\ min\: :ref:`Vector2i`, max\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **clamp**\ (\ min\: :ref:`Vector2i`, max\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -372,7 +372,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector2i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| +:ref:`Vector2i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -384,7 +384,7 @@ Returns a new vector with all components clamped between ``min`` and ``max``, by .. rst-class:: classref-method -:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector2i`\ ) |const| +:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the squared distance between this vector and ``to``. @@ -398,7 +398,7 @@ This method runs faster than :ref:`distance_to` **distance_to**\ (\ to\: :ref:`Vector2i`\ ) |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the distance between this vector and ``to``. @@ -410,7 +410,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns the length (magnitude) of this vector. @@ -422,7 +422,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`int` **length_squared**\ (\ ) |const| +:ref:`int` **length_squared**\ (\ ) |const| :ref:`🔗` Returns the squared length (squared magnitude) of this vector. @@ -436,7 +436,7 @@ This method runs faster than :ref:`length`, so pre .. rst-class:: classref-method -:ref:`Vector2i` **max**\ (\ with\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **max**\ (\ with\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2i(maxi(x, with.x), maxi(y, with.y))``. @@ -448,7 +448,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`int` **max_axis_index**\ (\ ) |const| +:ref:`int` **max_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -460,7 +460,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector2i` **maxi**\ (\ with\: :ref:`int`\ ) |const| +:ref:`Vector2i` **maxi**\ (\ with\: :ref:`int`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2i(maxi(x, with), maxi(y, with))``. @@ -472,7 +472,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`Vector2i` **min**\ (\ with\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **min**\ (\ with\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2i(mini(x, with.x), mini(y, with.y))``. @@ -484,7 +484,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`int` **min_axis_index**\ (\ ) |const| +:ref:`int` **min_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Y`. @@ -496,7 +496,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector2i` **mini**\ (\ with\: :ref:`int`\ ) |const| +:ref:`Vector2i` **mini**\ (\ with\: :ref:`int`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2i(mini(x, with), mini(y, with))``. @@ -508,7 +508,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2 .. rst-class:: classref-method -:ref:`Vector2i` **sign**\ (\ ) |const| +:ref:`Vector2i` **sign**\ (\ ) |const| :ref:`🔗` Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -520,7 +520,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i .. rst-class:: classref-method -:ref:`Vector2i` **snapped**\ (\ step\: :ref:`Vector2i`\ ) |const| +:ref:`Vector2i` **snapped**\ (\ step\: :ref:`Vector2i`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. @@ -532,7 +532,7 @@ Returns a new vector with each component snapped to the closest multiple of the .. rst-class:: classref-method -:ref:`Vector2i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| +:ref:`Vector2i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the closest multiple of ``step``. @@ -549,7 +549,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Returns ``true`` if the vectors are not equal. @@ -561,7 +561,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector2i` **operator %**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2i` **operator %**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Gets the remainder of each component of the **Vector2i** with the components of the given **Vector2i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -577,7 +577,7 @@ Gets the remainder of each component of the **Vector2i** with the components of .. rst-class:: classref-operator -:ref:`Vector2i` **operator %**\ (\ right\: :ref:`int`\ ) +:ref:`Vector2i` **operator %**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Gets the remainder of each component of the **Vector2i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -593,7 +593,7 @@ Gets the remainder of each component of the **Vector2i** with the given :ref:`in .. rst-class:: classref-operator -:ref:`Vector2i` **operator ***\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2i` **operator ***\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Multiplies each component of the **Vector2i** by the components of the given **Vector2i**. @@ -609,7 +609,7 @@ Multiplies each component of the **Vector2i** by the components of the given **V .. rst-class:: classref-operator -:ref:`Vector2` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Vector2` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Vector2i** by the given :ref:`float`. Returns a :ref:`Vector2`. @@ -625,7 +625,7 @@ Multiplies each component of the **Vector2i** by the given :ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Vector2i` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Vector2i** by the given :ref:`int`. @@ -637,7 +637,7 @@ Multiplies each component of the **Vector2i** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`Vector2i` **operator +**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2i` **operator +**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Adds each component of the **Vector2i** by the components of the given **Vector2i**. @@ -653,7 +653,7 @@ Adds each component of the **Vector2i** by the components of the given **Vector2 .. rst-class:: classref-operator -:ref:`Vector2i` **operator -**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2i` **operator -**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Subtracts each component of the **Vector2i** by the components of the given **Vector2i**. @@ -669,7 +669,7 @@ Subtracts each component of the **Vector2i** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector2i` **operator /**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`Vector2i` **operator /**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Divides each component of the **Vector2i** by the components of the given **Vector2i**. @@ -685,7 +685,7 @@ Divides each component of the **Vector2i** by the components of the given **Vect .. rst-class:: classref-operator -:ref:`Vector2` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Vector2` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Vector2i** by the given :ref:`float`. Returns a :ref:`Vector2`. @@ -701,7 +701,7 @@ Divides each component of the **Vector2i** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Vector2i` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Vector2i` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Vector2i** by the given :ref:`int`. @@ -713,7 +713,7 @@ Divides each component of the **Vector2i** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Compares two **Vector2i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -725,7 +725,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Compares two **Vector2i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -737,7 +737,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Returns ``true`` if the vectors are equal. @@ -749,7 +749,7 @@ Returns ``true`` if the vectors are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Compares two **Vector2i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -761,7 +761,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector2i`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector2i`\ ) :ref:`🔗` Compares two **Vector2i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -773,7 +773,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, and ``v[1]`` is equivalent to ``v.y``. @@ -785,7 +785,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector2i` **operator unary+**\ (\ ) +:ref:`Vector2i` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -797,7 +797,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector2i` **operator unary-**\ (\ ) +:ref:`Vector2i` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Vector2i**. This is the same as writing ``Vector2i(-v.x, -v.y)``. This operation flips the direction of the vector while keeping the same magnitude. diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index f6672415b88..cf480aa2d70 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -245,7 +245,7 @@ Constants .. rst-class:: classref-constant -**AXIS_X** = ``0`` +**AXIS_X** = ``0`` :ref:`🔗` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -253,7 +253,7 @@ Enumerated value for the X axis. Returned by :ref:`max_axis_index` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -261,7 +261,7 @@ Enumerated value for the Y axis. Returned by :ref:`max_axis_index` Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -269,7 +269,7 @@ Enumerated value for the Z axis. Returned by :ref:`max_axis_index` Zero vector, a vector with all components set to ``0``. @@ -277,7 +277,7 @@ Zero vector, a vector with all components set to ``0``. .. rst-class:: classref-constant -**ONE** = ``Vector3(1, 1, 1)`` +**ONE** = ``Vector3(1, 1, 1)`` :ref:`🔗` One vector, a vector with all components set to ``1``. @@ -285,7 +285,7 @@ One vector, a vector with all components set to ``1``. .. rst-class:: classref-constant -**INF** = ``Vector3(inf, inf, inf)`` +**INF** = ``Vector3(inf, inf, inf)`` :ref:`🔗` Infinity vector, a vector with all components set to :ref:`@GDScript.INF`. @@ -293,7 +293,7 @@ Infinity vector, a vector with all components set to :ref:`@GDScript.INF` Left unit vector. Represents the local direction of left, and the global direction of west. @@ -301,7 +301,7 @@ Left unit vector. Represents the local direction of left, and the global directi .. rst-class:: classref-constant -**RIGHT** = ``Vector3(1, 0, 0)`` +**RIGHT** = ``Vector3(1, 0, 0)`` :ref:`🔗` Right unit vector. Represents the local direction of right, and the global direction of east. @@ -309,7 +309,7 @@ Right unit vector. Represents the local direction of right, and the global direc .. rst-class:: classref-constant -**UP** = ``Vector3(0, 1, 0)`` +**UP** = ``Vector3(0, 1, 0)`` :ref:`🔗` Up unit vector. @@ -317,7 +317,7 @@ Up unit vector. .. rst-class:: classref-constant -**DOWN** = ``Vector3(0, -1, 0)`` +**DOWN** = ``Vector3(0, -1, 0)`` :ref:`🔗` Down unit vector. @@ -325,7 +325,7 @@ Down unit vector. .. rst-class:: classref-constant -**FORWARD** = ``Vector3(0, 0, -1)`` +**FORWARD** = ``Vector3(0, 0, -1)`` :ref:`🔗` Forward unit vector. Represents the local direction of forward, and the global direction of north. Keep in mind that the forward direction for lights, cameras, etc is different from 3D assets like characters, which face towards the camera by convention. Use :ref:`MODEL_FRONT` and similar constants when working in 3D asset space. @@ -333,7 +333,7 @@ Forward unit vector. Represents the local direction of forward, and the global d .. rst-class:: classref-constant -**BACK** = ``Vector3(0, 0, 1)`` +**BACK** = ``Vector3(0, 0, 1)`` :ref:`🔗` Back unit vector. Represents the local direction of back, and the global direction of south. @@ -341,7 +341,7 @@ Back unit vector. Represents the local direction of back, and the global directi .. rst-class:: classref-constant -**MODEL_LEFT** = ``Vector3(1, 0, 0)`` +**MODEL_LEFT** = ``Vector3(1, 0, 0)`` :ref:`🔗` Unit vector pointing towards the left side of imported 3D assets. @@ -349,7 +349,7 @@ Unit vector pointing towards the left side of imported 3D assets. .. rst-class:: classref-constant -**MODEL_RIGHT** = ``Vector3(-1, 0, 0)`` +**MODEL_RIGHT** = ``Vector3(-1, 0, 0)`` :ref:`🔗` Unit vector pointing towards the right side of imported 3D assets. @@ -357,7 +357,7 @@ Unit vector pointing towards the right side of imported 3D assets. .. rst-class:: classref-constant -**MODEL_TOP** = ``Vector3(0, 1, 0)`` +**MODEL_TOP** = ``Vector3(0, 1, 0)`` :ref:`🔗` Unit vector pointing towards the top side (up) of imported 3D assets. @@ -365,7 +365,7 @@ Unit vector pointing towards the top side (up) of imported 3D assets. .. rst-class:: classref-constant -**MODEL_BOTTOM** = ``Vector3(0, -1, 0)`` +**MODEL_BOTTOM** = ``Vector3(0, -1, 0)`` :ref:`🔗` Unit vector pointing towards the bottom side (down) of imported 3D assets. @@ -373,7 +373,7 @@ Unit vector pointing towards the bottom side (down) of imported 3D assets. .. rst-class:: classref-constant -**MODEL_FRONT** = ``Vector3(0, 0, 1)`` +**MODEL_FRONT** = ``Vector3(0, 0, 1)`` :ref:`🔗` Unit vector pointing towards the front side (facing forward) of imported 3D assets. @@ -381,7 +381,7 @@ Unit vector pointing towards the front side (facing forward) of imported 3D asse .. rst-class:: classref-constant -**MODEL_REAR** = ``Vector3(0, 0, -1)`` +**MODEL_REAR** = ``Vector3(0, 0, -1)`` :ref:`🔗` Unit vector pointing towards the rear side (back) of imported 3D assets. @@ -398,7 +398,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **x** = ``0.0`` +:ref:`float` **x** = ``0.0`` :ref:`🔗` The vector's X component. Also accessible by using the index position ``[0]``. @@ -410,7 +410,7 @@ The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-property -:ref:`float` **y** = ``0.0`` +:ref:`float` **y** = ``0.0`` :ref:`🔗` The vector's Y component. Also accessible by using the index position ``[1]``. @@ -422,7 +422,7 @@ The vector's Y component. Also accessible by using the index position ``[1]``. .. rst-class:: classref-property -:ref:`float` **z** = ``0.0`` +:ref:`float` **z** = ``0.0`` :ref:`🔗` The vector's Z component. Also accessible by using the index position ``[2]``. @@ -439,7 +439,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector3` **Vector3**\ (\ ) +:ref:`Vector3` **Vector3**\ (\ ) :ref:`🔗` Constructs a default-initialized **Vector3** with all components set to ``0``. @@ -486,7 +486,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **abs**\ (\ ) |const| +:ref:`Vector3` **abs**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components in absolute values (i.e. positive). @@ -498,7 +498,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`float` **angle_to**\ (\ to\: :ref:`Vector3`\ ) |const| +:ref:`float` **angle_to**\ (\ to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the unsigned minimum angle to the given vector, in radians. @@ -510,7 +510,7 @@ Returns the unsigned minimum angle to the given vector, in radians. .. rst-class:: classref-method -:ref:`Vector3` **bezier_derivative**\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| +:ref:`Vector3` **bezier_derivative**\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| :ref:`🔗` Returns the derivative at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -522,7 +522,7 @@ Returns the derivative at the given ``t`` on the `Bézier curve ` **bezier_interpolate**\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| +:ref:`Vector3` **bezier_interpolate**\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| :ref:`🔗` Returns the point at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -534,7 +534,7 @@ Returns the point at the given ``t`` on the `Bézier curve ` **bounce**\ (\ n\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **bounce**\ (\ n\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the vector "bounced off" from a plane defined by the given normal ``n``. @@ -548,7 +548,7 @@ Returns the vector "bounced off" from a plane defined by the given normal ``n``. .. rst-class:: classref-method -:ref:`Vector3` **ceil**\ (\ ) |const| +:ref:`Vector3` **ceil**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded up (towards positive infinity). @@ -560,7 +560,7 @@ Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-method -:ref:`Vector3` **clamp**\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **clamp**\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -572,7 +572,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector3` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| +:ref:`Vector3` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -584,7 +584,7 @@ Returns a new vector with all components clamped between ``min`` and ``max``, by .. rst-class:: classref-method -:ref:`Vector3` **cross**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **cross**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the cross product of this vector and ``with``. @@ -598,7 +598,7 @@ This returns a vector perpendicular to both this and ``with``, which would be th .. rst-class:: classref-method -:ref:`Vector3` **cubic_interpolate**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| +:ref:`Vector3` **cubic_interpolate**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -610,7 +610,7 @@ Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and .. rst-class:: classref-method -:ref:`Vector3` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| +:ref:`Vector3` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -624,7 +624,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **direction_to**\ (\ to\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **direction_to**\ (\ to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. @@ -636,7 +636,7 @@ Returns the normalized vector pointing from this vector to ``to``. This is equiv .. rst-class:: classref-method -:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector3`\ ) |const| +:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the squared distance between this vector and ``to``. @@ -650,7 +650,7 @@ This method runs faster than :ref:`distance_to .. rst-class:: classref-method -:ref:`float` **distance_to**\ (\ to\: :ref:`Vector3`\ ) |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the distance between this vector and ``to``. @@ -662,7 +662,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **dot**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`float` **dot**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the dot product of this vector and ``with``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. @@ -680,7 +680,7 @@ When using unit (normalized) vectors, the result will always be between ``-1.0`` .. rst-class:: classref-method -:ref:`Vector3` **floor**\ (\ ) |const| +:ref:`Vector3` **floor**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded down (towards negative infinity). @@ -692,7 +692,7 @@ Returns a new vector with all components rounded down (towards negative infinity .. rst-class:: classref-method -:ref:`Vector3` **inverse**\ (\ ) |const| +:ref:`Vector3` **inverse**\ (\ ) |const| :ref:`🔗` Returns the inverse of the vector. This is the same as ``Vector3(1.0 / v.x, 1.0 / v.y, 1.0 / v.z)``. @@ -704,7 +704,7 @@ Returns the inverse of the vector. This is the same as ``Vector3(1.0 / v.x, 1.0 .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector3`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -716,7 +716,7 @@ Returns ``true`` if this vector and ``to`` are approximately equal, by running : .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -728,7 +728,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini .. rst-class:: classref-method -:ref:`bool` **is_normalized**\ (\ ) |const| +:ref:`bool` **is_normalized**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. @@ -740,7 +740,7 @@ Returns ``true`` if the vector is normalized, i.e. its length is approximately e .. rst-class:: classref-method -:ref:`bool` **is_zero_approx**\ (\ ) |const| +:ref:`bool` **is_zero_approx**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. @@ -754,7 +754,7 @@ This method is faster than using :ref:`is_equal_approx` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns the length (magnitude) of this vector. @@ -766,7 +766,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`float` **length_squared**\ (\ ) |const| +:ref:`float` **length_squared**\ (\ ) |const| :ref:`🔗` Returns the squared length (squared magnitude) of this vector. @@ -780,7 +780,7 @@ This method runs faster than :ref:`length`, so pref .. rst-class:: classref-method -:ref:`Vector3` **lerp**\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| +:ref:`Vector3` **lerp**\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. @@ -792,7 +792,7 @@ Returns the result of the linear interpolation between this vector and ``to`` by .. rst-class:: classref-method -:ref:`Vector3` **limit_length**\ (\ length\: :ref:`float` = 1.0\ ) |const| +:ref:`Vector3` **limit_length**\ (\ length\: :ref:`float` = 1.0\ ) |const| :ref:`🔗` Returns the vector with a maximum length by limiting its length to ``length``. @@ -804,7 +804,7 @@ Returns the vector with a maximum length by limiting its length to ``length``. .. rst-class:: classref-method -:ref:`Vector3` **max**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **max**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3(maxf(x, with.x), maxf(y, with.y), maxf(z, with.z))``. @@ -816,7 +816,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`int` **max_axis_index**\ (\ ) |const| +:ref:`int` **max_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -828,7 +828,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector3` **maxf**\ (\ with\: :ref:`float`\ ) |const| +:ref:`Vector3` **maxf**\ (\ with\: :ref:`float`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3(maxf(x, with), maxf(y, with), maxf(z, with))``. @@ -840,7 +840,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`Vector3` **min**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **min**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3(minf(x, with.x), minf(y, with.y), minf(z, with.z))``. @@ -852,7 +852,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`int` **min_axis_index**\ (\ ) |const| +:ref:`int` **min_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Z`. @@ -864,7 +864,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector3` **minf**\ (\ with\: :ref:`float`\ ) |const| +:ref:`Vector3` **minf**\ (\ with\: :ref:`float`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3(minf(x, with), minf(y, with), minf(z, with))``. @@ -876,7 +876,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`Vector3` **move_toward**\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| +:ref:`Vector3` **move_toward**\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not go past the final value. @@ -888,7 +888,7 @@ Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not .. rst-class:: classref-method -:ref:`Vector3` **normalized**\ (\ ) |const| +:ref:`Vector3` **normalized**\ (\ ) |const| :ref:`🔗` Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. @@ -902,7 +902,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l .. rst-class:: classref-method -:ref:`Vector3` **octahedron_decode**\ (\ uv\: :ref:`Vector2`\ ) |static| +:ref:`Vector3` **octahedron_decode**\ (\ uv\: :ref:`Vector2`\ ) |static| :ref:`🔗` Returns the **Vector3** from an octahedral-compressed form created using :ref:`octahedron_encode` (stored as a :ref:`Vector2`). @@ -914,7 +914,7 @@ Returns the **Vector3** from an octahedral-compressed form created using :ref:`o .. rst-class:: classref-method -:ref:`Vector2` **octahedron_encode**\ (\ ) |const| +:ref:`Vector2` **octahedron_encode**\ (\ ) |const| :ref:`🔗` Returns the octahedral-encoded (oct32) form of this **Vector3** as a :ref:`Vector2`. Since a :ref:`Vector2` occupies 1/3 less memory compared to **Vector3**, this form of compression can be used to pass greater amounts of :ref:`normalized` **Vector3**\ s without increasing storage or memory requirements. See also :ref:`octahedron_decode`. @@ -930,7 +930,7 @@ Returns the octahedral-encoded (oct32) form of this **Vector3** as a :ref:`Vecto .. rst-class:: classref-method -:ref:`Basis` **outer**\ (\ with\: :ref:`Vector3`\ ) |const| +:ref:`Basis` **outer**\ (\ with\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the outer product with ``with``. @@ -942,7 +942,7 @@ Returns the outer product with ``with``. .. rst-class:: classref-method -:ref:`Vector3` **posmod**\ (\ mod\: :ref:`float`\ ) |const| +:ref:`Vector3` **posmod**\ (\ mod\: :ref:`float`\ ) |const| :ref:`🔗` Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. @@ -954,7 +954,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **posmodv**\ (\ modv\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **posmodv**\ (\ modv\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. @@ -966,7 +966,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **project**\ (\ b\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **project**\ (\ b\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a new vector resulting from projecting this vector onto the given vector ``b``. The resulting new vector is parallel to ``b``. See also :ref:`slide`. @@ -980,7 +980,7 @@ Returns a new vector resulting from projecting this vector onto the given vector .. rst-class:: classref-method -:ref:`Vector3` **reflect**\ (\ n\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **reflect**\ (\ n\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the result of reflecting the vector through a plane defined by the given normal vector ``n``. @@ -994,7 +994,7 @@ Returns the result of reflecting the vector through a plane defined by the given .. rst-class:: classref-method -:ref:`Vector3` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| +:ref:`Vector3` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of rotating this vector around a given axis by ``angle`` (in radians). The axis must be a normalized vector. See also :ref:`@GlobalScope.deg_to_rad`. @@ -1006,7 +1006,7 @@ Returns the result of rotating this vector around a given axis by ``angle`` (in .. rst-class:: classref-method -:ref:`Vector3` **round**\ (\ ) |const| +:ref:`Vector3` **round**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. @@ -1018,7 +1018,7 @@ Returns a new vector with all components rounded to the nearest integer, with ha .. rst-class:: classref-method -:ref:`Vector3` **sign**\ (\ ) |const| +:ref:`Vector3` **sign**\ (\ ) |const| :ref:`🔗` Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -1030,7 +1030,7 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 .. rst-class:: classref-method -:ref:`float` **signed_angle_to**\ (\ to\: :ref:`Vector3`, axis\: :ref:`Vector3`\ ) |const| +:ref:`float` **signed_angle_to**\ (\ to\: :ref:`Vector3`, axis\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the ``axis``. @@ -1042,7 +1042,7 @@ Returns the signed angle to the given vector, in radians. The sign of the angle .. rst-class:: classref-method -:ref:`Vector3` **slerp**\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| +:ref:`Vector3` **slerp**\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of spherical linear interpolation between this vector and ``to``, by amount ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -1056,7 +1056,7 @@ This method also handles interpolating the lengths if the input vectors have dif .. rst-class:: classref-method -:ref:`Vector3` **slide**\ (\ n\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **slide**\ (\ n\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a new vector resulting from sliding this vector along a plane with normal ``n``. The resulting new vector is perpendicular to ``n``, and is equivalent to this vector minus its projection on ``n``. See also :ref:`project`. @@ -1070,7 +1070,7 @@ Returns a new vector resulting from sliding this vector along a plane with norma .. rst-class:: classref-method -:ref:`Vector3` **snapped**\ (\ step\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **snapped**\ (\ step\: :ref:`Vector3`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -1082,7 +1082,7 @@ Returns a new vector with each component snapped to the nearest multiple of the .. rst-class:: classref-method -:ref:`Vector3` **snappedf**\ (\ step\: :ref:`float`\ ) |const| +:ref:`Vector3` **snappedf**\ (\ step\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -1099,7 +1099,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector3`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Returns ``true`` if the vectors are not equal. @@ -1115,7 +1115,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Basis`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Basis`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Vector3** by the given :ref:`Basis` matrix, under the assumption that the basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -1131,7 +1131,7 @@ For transforming by inverse of a non-orthonormal basis (e.g. with scaling) ``bas .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Quaternion`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Quaternion`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Vector3** by the given :ref:`Quaternion`. @@ -1145,7 +1145,7 @@ Inversely transforms (multiplies) the **Vector3** by the given :ref:`Quaternion< .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Transform3D`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Transform3D`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Vector3** by the given :ref:`Transform3D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -1161,7 +1161,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Multiplies each component of the **Vector3** by the components of the given **Vector3**. @@ -1177,7 +1177,7 @@ Multiplies each component of the **Vector3** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Vector3** by the given :ref:`float`. @@ -1189,7 +1189,7 @@ Multiplies each component of the **Vector3** by the given :ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Vector3** by the given :ref:`int`. @@ -1201,7 +1201,7 @@ Multiplies each component of the **Vector3** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Vector3` **operator +**\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator +**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Adds each component of the **Vector3** by the components of the given **Vector3**. @@ -1217,7 +1217,7 @@ Adds each component of the **Vector3** by the components of the given **Vector3* .. rst-class:: classref-operator -:ref:`Vector3` **operator -**\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator -**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Subtracts each component of the **Vector3** by the components of the given **Vector3**. @@ -1233,7 +1233,7 @@ Subtracts each component of the **Vector3** by the components of the given **Vec .. rst-class:: classref-operator -:ref:`Vector3` **operator /**\ (\ right\: :ref:`Vector3`\ ) +:ref:`Vector3` **operator /**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Divides each component of the **Vector3** by the components of the given **Vector3**. @@ -1249,7 +1249,7 @@ Divides each component of the **Vector3** by the components of the given **Vecto .. rst-class:: classref-operator -:ref:`Vector3` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Vector3` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Vector3** by the given :ref:`float`. @@ -1261,7 +1261,7 @@ Divides each component of the **Vector3** by the given :ref:`float` .. rst-class:: classref-operator -:ref:`Vector3` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Vector3` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Vector3** by the given :ref:`int`. @@ -1273,7 +1273,7 @@ Divides each component of the **Vector3** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Vector3`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Compares two **Vector3** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1287,7 +1287,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector3`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Compares two **Vector3** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1301,7 +1301,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector3`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Returns ``true`` if the vectors are exactly equal. @@ -1317,7 +1317,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Vector3`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Compares two **Vector3** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1331,7 +1331,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector3`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector3`\ ) :ref:`🔗` Compares two **Vector3** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1345,7 +1345,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, and ``v[2]`` is equivalent to ``v.z``. @@ -1357,7 +1357,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector3` **operator unary+**\ (\ ) +:ref:`Vector3` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -1369,7 +1369,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector3` **operator unary-**\ (\ ) +:ref:`Vector3` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Vector3**. This is the same as writing ``Vector3(-v.x, -v.y, -v.z)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index 5c7174f0b96..51271258b43 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -171,7 +171,7 @@ Constants .. rst-class:: classref-constant -**AXIS_X** = ``0`` +**AXIS_X** = ``0`` :ref:`🔗` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -179,7 +179,7 @@ Enumerated value for the X axis. Returned by :ref:`max_axis_index` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -187,7 +187,7 @@ Enumerated value for the Y axis. Returned by :ref:`max_axis_index` Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -195,7 +195,7 @@ Enumerated value for the Z axis. Returned by :ref:`max_axis_index` Zero vector, a vector with all components set to ``0``. @@ -203,7 +203,7 @@ Zero vector, a vector with all components set to ``0``. .. rst-class:: classref-constant -**ONE** = ``Vector3i(1, 1, 1)`` +**ONE** = ``Vector3i(1, 1, 1)`` :ref:`🔗` One vector, a vector with all components set to ``1``. @@ -211,7 +211,7 @@ One vector, a vector with all components set to ``1``. .. rst-class:: classref-constant -**MIN** = ``Vector3i(-2147483648, -2147483648, -2147483648)`` +**MIN** = ``Vector3i(-2147483648, -2147483648, -2147483648)`` :ref:`🔗` Min vector, a vector with all components equal to ``INT32_MIN``. Can be used as a negative integer equivalent of :ref:`Vector3.INF`. @@ -219,7 +219,7 @@ Min vector, a vector with all components equal to ``INT32_MIN``. Can be used as .. rst-class:: classref-constant -**MAX** = ``Vector3i(2147483647, 2147483647, 2147483647)`` +**MAX** = ``Vector3i(2147483647, 2147483647, 2147483647)`` :ref:`🔗` Max vector, a vector with all components equal to ``INT32_MAX``. Can be used as an integer equivalent of :ref:`Vector3.INF`. @@ -227,7 +227,7 @@ Max vector, a vector with all components equal to ``INT32_MAX``. Can be used as .. rst-class:: classref-constant -**LEFT** = ``Vector3i(-1, 0, 0)`` +**LEFT** = ``Vector3i(-1, 0, 0)`` :ref:`🔗` Left unit vector. Represents the local direction of left, and the global direction of west. @@ -235,7 +235,7 @@ Left unit vector. Represents the local direction of left, and the global directi .. rst-class:: classref-constant -**RIGHT** = ``Vector3i(1, 0, 0)`` +**RIGHT** = ``Vector3i(1, 0, 0)`` :ref:`🔗` Right unit vector. Represents the local direction of right, and the global direction of east. @@ -243,7 +243,7 @@ Right unit vector. Represents the local direction of right, and the global direc .. rst-class:: classref-constant -**UP** = ``Vector3i(0, 1, 0)`` +**UP** = ``Vector3i(0, 1, 0)`` :ref:`🔗` Up unit vector. @@ -251,7 +251,7 @@ Up unit vector. .. rst-class:: classref-constant -**DOWN** = ``Vector3i(0, -1, 0)`` +**DOWN** = ``Vector3i(0, -1, 0)`` :ref:`🔗` Down unit vector. @@ -259,7 +259,7 @@ Down unit vector. .. rst-class:: classref-constant -**FORWARD** = ``Vector3i(0, 0, -1)`` +**FORWARD** = ``Vector3i(0, 0, -1)`` :ref:`🔗` Forward unit vector. Represents the local direction of forward, and the global direction of north. @@ -267,7 +267,7 @@ Forward unit vector. Represents the local direction of forward, and the global d .. rst-class:: classref-constant -**BACK** = ``Vector3i(0, 0, 1)`` +**BACK** = ``Vector3i(0, 0, 1)`` :ref:`🔗` Back unit vector. Represents the local direction of back, and the global direction of south. @@ -284,7 +284,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **x** = ``0`` +:ref:`int` **x** = ``0`` :ref:`🔗` The vector's X component. Also accessible by using the index position ``[0]``. @@ -296,7 +296,7 @@ The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-property -:ref:`int` **y** = ``0`` +:ref:`int` **y** = ``0`` :ref:`🔗` The vector's Y component. Also accessible by using the index position ``[1]``. @@ -308,7 +308,7 @@ The vector's Y component. Also accessible by using the index position ``[1]``. .. rst-class:: classref-property -:ref:`int` **z** = ``0`` +:ref:`int` **z** = ``0`` :ref:`🔗` The vector's Z component. Also accessible by using the index position ``[2]``. @@ -325,7 +325,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector3i` **Vector3i**\ (\ ) +:ref:`Vector3i` **Vector3i**\ (\ ) :ref:`🔗` Constructs a default-initialized **Vector3i** with all components set to ``0``. @@ -372,7 +372,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3i` **abs**\ (\ ) |const| +:ref:`Vector3i` **abs**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components in absolute values (i.e. positive). @@ -384,7 +384,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`Vector3i` **clamp**\ (\ min\: :ref:`Vector3i`, max\: :ref:`Vector3i`\ ) |const| +:ref:`Vector3i` **clamp**\ (\ min\: :ref:`Vector3i`, max\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -396,7 +396,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector3i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| +:ref:`Vector3i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -408,7 +408,7 @@ Returns a new vector with all components clamped between ``min`` and ``max``, by .. rst-class:: classref-method -:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector3i`\ ) |const| +:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns the squared distance between this vector and ``to``. @@ -422,7 +422,7 @@ This method runs faster than :ref:`distance_to` **distance_to**\ (\ to\: :ref:`Vector3i`\ ) |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns the distance between this vector and ``to``. @@ -434,7 +434,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns the length (magnitude) of this vector. @@ -446,7 +446,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`int` **length_squared**\ (\ ) |const| +:ref:`int` **length_squared**\ (\ ) |const| :ref:`🔗` Returns the squared length (squared magnitude) of this vector. @@ -460,7 +460,7 @@ This method runs faster than :ref:`length`, so pre .. rst-class:: classref-method -:ref:`Vector3i` **max**\ (\ with\: :ref:`Vector3i`\ ) |const| +:ref:`Vector3i` **max**\ (\ with\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3i(maxi(x, with.x), maxi(y, with.y), maxi(z, with.z))``. @@ -472,7 +472,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`int` **max_axis_index**\ (\ ) |const| +:ref:`int` **max_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -484,7 +484,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector3i` **maxi**\ (\ with\: :ref:`int`\ ) |const| +:ref:`Vector3i` **maxi**\ (\ with\: :ref:`int`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3i(maxi(x, with), maxi(y, with), maxi(z, with))``. @@ -496,7 +496,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`Vector3i` **min**\ (\ with\: :ref:`Vector3i`\ ) |const| +:ref:`Vector3i` **min**\ (\ with\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3i(mini(x, with.x), mini(y, with.y), mini(z, with.z))``. @@ -508,7 +508,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`int` **min_axis_index**\ (\ ) |const| +:ref:`int` **min_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Z`. @@ -520,7 +520,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector3i` **mini**\ (\ with\: :ref:`int`\ ) |const| +:ref:`Vector3i` **mini**\ (\ with\: :ref:`int`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3i(mini(x, with), mini(y, with), mini(z, with))``. @@ -532,7 +532,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3 .. rst-class:: classref-method -:ref:`Vector3i` **sign**\ (\ ) |const| +:ref:`Vector3i` **sign**\ (\ ) |const| :ref:`🔗` Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -544,7 +544,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i .. rst-class:: classref-method -:ref:`Vector3i` **snapped**\ (\ step\: :ref:`Vector3i`\ ) |const| +:ref:`Vector3i` **snapped**\ (\ step\: :ref:`Vector3i`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. @@ -556,7 +556,7 @@ Returns a new vector with each component snapped to the closest multiple of the .. rst-class:: classref-method -:ref:`Vector3i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| +:ref:`Vector3i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the closest multiple of ``step``. @@ -573,7 +573,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Returns ``true`` if the vectors are not equal. @@ -585,7 +585,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector3i` **operator %**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3i` **operator %**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Gets the remainder of each component of the **Vector3i** with the components of the given **Vector3i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -601,7 +601,7 @@ Gets the remainder of each component of the **Vector3i** with the components of .. rst-class:: classref-operator -:ref:`Vector3i` **operator %**\ (\ right\: :ref:`int`\ ) +:ref:`Vector3i` **operator %**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Gets the remainder of each component of the **Vector3i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -617,7 +617,7 @@ Gets the remainder of each component of the **Vector3i** with the given :ref:`in .. rst-class:: classref-operator -:ref:`Vector3i` **operator ***\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3i` **operator ***\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Multiplies each component of the **Vector3i** by the components of the given **Vector3i**. @@ -633,7 +633,7 @@ Multiplies each component of the **Vector3i** by the components of the given **V .. rst-class:: classref-operator -:ref:`Vector3` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Vector3` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Vector3i** by the given :ref:`float`. Returns a :ref:`Vector3`. @@ -649,7 +649,7 @@ Multiplies each component of the **Vector3i** by the given :ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Vector3i` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Vector3i** by the given :ref:`int`. @@ -661,7 +661,7 @@ Multiplies each component of the **Vector3i** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`Vector3i` **operator +**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3i` **operator +**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Adds each component of the **Vector3i** by the components of the given **Vector3i**. @@ -677,7 +677,7 @@ Adds each component of the **Vector3i** by the components of the given **Vector3 .. rst-class:: classref-operator -:ref:`Vector3i` **operator -**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3i` **operator -**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Subtracts each component of the **Vector3i** by the components of the given **Vector3i**. @@ -693,7 +693,7 @@ Subtracts each component of the **Vector3i** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector3i` **operator /**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`Vector3i` **operator /**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Divides each component of the **Vector3i** by the components of the given **Vector3i**. @@ -709,7 +709,7 @@ Divides each component of the **Vector3i** by the components of the given **Vect .. rst-class:: classref-operator -:ref:`Vector3` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Vector3` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Vector3i** by the given :ref:`float`. Returns a :ref:`Vector3`. @@ -725,7 +725,7 @@ Divides each component of the **Vector3i** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Vector3i` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Vector3i` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Vector3i** by the given :ref:`int`. @@ -737,7 +737,7 @@ Divides each component of the **Vector3i** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Compares two **Vector3i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -749,7 +749,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Compares two **Vector3i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -761,7 +761,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Returns ``true`` if the vectors are equal. @@ -773,7 +773,7 @@ Returns ``true`` if the vectors are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Compares two **Vector3i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -785,7 +785,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector3i`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector3i`\ ) :ref:`🔗` Compares two **Vector3i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -797,7 +797,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, and ``v[2]`` is equivalent to ``v.z``. @@ -809,7 +809,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector3i` **operator unary+**\ (\ ) +:ref:`Vector3i` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -821,7 +821,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector3i` **operator unary-**\ (\ ) +:ref:`Vector3i` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Vector3i**. This is the same as writing ``Vector3i(-v.x, -v.y, -v.z)``. This operation flips the direction of the vector while keeping the same magnitude. diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index 5e6dea7ece7..729df652054 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -194,7 +194,7 @@ Constants .. rst-class:: classref-constant -**AXIS_X** = ``0`` +**AXIS_X** = ``0`` :ref:`🔗` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -202,7 +202,7 @@ Enumerated value for the X axis. Returned by :ref:`max_axis_index` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -210,7 +210,7 @@ Enumerated value for the Y axis. Returned by :ref:`max_axis_index` Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -218,7 +218,7 @@ Enumerated value for the Z axis. Returned by :ref:`max_axis_index` Enumerated value for the W axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -226,7 +226,7 @@ Enumerated value for the W axis. Returned by :ref:`max_axis_index` Zero vector, a vector with all components set to ``0``. @@ -234,7 +234,7 @@ Zero vector, a vector with all components set to ``0``. .. rst-class:: classref-constant -**ONE** = ``Vector4(1, 1, 1, 1)`` +**ONE** = ``Vector4(1, 1, 1, 1)`` :ref:`🔗` One vector, a vector with all components set to ``1``. @@ -242,7 +242,7 @@ One vector, a vector with all components set to ``1``. .. rst-class:: classref-constant -**INF** = ``Vector4(inf, inf, inf, inf)`` +**INF** = ``Vector4(inf, inf, inf, inf)`` :ref:`🔗` Infinity vector, a vector with all components set to :ref:`@GDScript.INF`. @@ -259,7 +259,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **w** = ``0.0`` +:ref:`float` **w** = ``0.0`` :ref:`🔗` The vector's W component. Also accessible by using the index position ``[3]``. @@ -271,7 +271,7 @@ The vector's W component. Also accessible by using the index position ``[3]``. .. rst-class:: classref-property -:ref:`float` **x** = ``0.0`` +:ref:`float` **x** = ``0.0`` :ref:`🔗` The vector's X component. Also accessible by using the index position ``[0]``. @@ -283,7 +283,7 @@ The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-property -:ref:`float` **y** = ``0.0`` +:ref:`float` **y** = ``0.0`` :ref:`🔗` The vector's Y component. Also accessible by using the index position ``[1]``. @@ -295,7 +295,7 @@ The vector's Y component. Also accessible by using the index position ``[1]``. .. rst-class:: classref-property -:ref:`float` **z** = ``0.0`` +:ref:`float` **z** = ``0.0`` :ref:`🔗` The vector's Z component. Also accessible by using the index position ``[2]``. @@ -312,7 +312,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector4` **Vector4**\ (\ ) +:ref:`Vector4` **Vector4**\ (\ ) :ref:`🔗` Constructs a default-initialized **Vector4** with all components set to ``0``. @@ -359,7 +359,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector4` **abs**\ (\ ) |const| +:ref:`Vector4` **abs**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components in absolute values (i.e. positive). @@ -371,7 +371,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`Vector4` **ceil**\ (\ ) |const| +:ref:`Vector4` **ceil**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded up (towards positive infinity). @@ -383,7 +383,7 @@ Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-method -:ref:`Vector4` **clamp**\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| +:ref:`Vector4` **clamp**\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -395,7 +395,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector4` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| +:ref:`Vector4` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -407,7 +407,7 @@ Returns a new vector with all components clamped between ``min`` and ``max``, by .. rst-class:: classref-method -:ref:`Vector4` **cubic_interpolate**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| +:ref:`Vector4` **cubic_interpolate**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -419,7 +419,7 @@ Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and .. rst-class:: classref-method -:ref:`Vector4` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| +:ref:`Vector4` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -433,7 +433,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **direction_to**\ (\ to\: :ref:`Vector4`\ ) |const| +:ref:`Vector4` **direction_to**\ (\ to\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. @@ -445,7 +445,7 @@ Returns the normalized vector pointing from this vector to ``to``. This is equiv .. rst-class:: classref-method -:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector4`\ ) |const| +:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the squared distance between this vector and ``to``. @@ -459,7 +459,7 @@ This method runs faster than :ref:`distance_to .. rst-class:: classref-method -:ref:`float` **distance_to**\ (\ to\: :ref:`Vector4`\ ) |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the distance between this vector and ``to``. @@ -471,7 +471,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **dot**\ (\ with\: :ref:`Vector4`\ ) |const| +:ref:`float` **dot**\ (\ with\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the dot product of this vector and ``with``. @@ -483,7 +483,7 @@ Returns the dot product of this vector and ``with``. .. rst-class:: classref-method -:ref:`Vector4` **floor**\ (\ ) |const| +:ref:`Vector4` **floor**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded down (towards negative infinity). @@ -495,7 +495,7 @@ Returns a new vector with all components rounded down (towards negative infinity .. rst-class:: classref-method -:ref:`Vector4` **inverse**\ (\ ) |const| +:ref:`Vector4` **inverse**\ (\ ) |const| :ref:`🔗` Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 / v.y, 1.0 / v.z, 1.0 / v.w)``. @@ -507,7 +507,7 @@ Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 .. rst-class:: classref-method -:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector4`\ ) |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -519,7 +519,7 @@ Returns ``true`` if this vector and ``to`` are approximately equal, by running : .. rst-class:: classref-method -:ref:`bool` **is_finite**\ (\ ) |const| +:ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -531,7 +531,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini .. rst-class:: classref-method -:ref:`bool` **is_normalized**\ (\ ) |const| +:ref:`bool` **is_normalized**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. @@ -543,7 +543,7 @@ Returns ``true`` if the vector is normalized, i.e. its length is approximately e .. rst-class:: classref-method -:ref:`bool` **is_zero_approx**\ (\ ) |const| +:ref:`bool` **is_zero_approx**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. @@ -557,7 +557,7 @@ This method is faster than using :ref:`is_equal_approx` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns the length (magnitude) of this vector. @@ -569,7 +569,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`float` **length_squared**\ (\ ) |const| +:ref:`float` **length_squared**\ (\ ) |const| :ref:`🔗` Returns the squared length (squared magnitude) of this vector. @@ -583,7 +583,7 @@ This method runs faster than :ref:`length`, so pref .. rst-class:: classref-method -:ref:`Vector4` **lerp**\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| +:ref:`Vector4` **lerp**\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| :ref:`🔗` Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. @@ -595,7 +595,7 @@ Returns the result of the linear interpolation between this vector and ``to`` by .. rst-class:: classref-method -:ref:`Vector4` **max**\ (\ with\: :ref:`Vector4`\ ) |const| +:ref:`Vector4` **max**\ (\ with\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4(maxf(x, with.x), maxf(y, with.y), maxf(z, with.z), maxf(w, with.w))``. @@ -607,7 +607,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`int` **max_axis_index**\ (\ ) |const| +:ref:`int` **max_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -619,7 +619,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector4` **maxf**\ (\ with\: :ref:`float`\ ) |const| +:ref:`Vector4` **maxf**\ (\ with\: :ref:`float`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4(maxf(x, with), maxf(y, with), maxf(z, with), maxf(w, with))``. @@ -631,7 +631,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`Vector4` **min**\ (\ with\: :ref:`Vector4`\ ) |const| +:ref:`Vector4` **min**\ (\ with\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4(minf(x, with.x), minf(y, with.y), minf(z, with.z), minf(w, with.w))``. @@ -643,7 +643,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`int` **min_axis_index**\ (\ ) |const| +:ref:`int` **min_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W`. @@ -655,7 +655,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector4` **minf**\ (\ with\: :ref:`float`\ ) |const| +:ref:`Vector4` **minf**\ (\ with\: :ref:`float`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4(minf(x, with), minf(y, with), minf(z, with), minf(w, with))``. @@ -667,7 +667,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`Vector4` **normalized**\ (\ ) |const| +:ref:`Vector4` **normalized**\ (\ ) |const| :ref:`🔗` Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. @@ -681,7 +681,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l .. rst-class:: classref-method -:ref:`Vector4` **posmod**\ (\ mod\: :ref:`float`\ ) |const| +:ref:`Vector4` **posmod**\ (\ mod\: :ref:`float`\ ) |const| :ref:`🔗` Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. @@ -693,7 +693,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **posmodv**\ (\ modv\: :ref:`Vector4`\ ) |const| +:ref:`Vector4` **posmodv**\ (\ modv\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. @@ -705,7 +705,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **round**\ (\ ) |const| +:ref:`Vector4` **round**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. @@ -717,7 +717,7 @@ Returns a new vector with all components rounded to the nearest integer, with ha .. rst-class:: classref-method -:ref:`Vector4` **sign**\ (\ ) |const| +:ref:`Vector4` **sign**\ (\ ) |const| :ref:`🔗` Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -729,7 +729,7 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 .. rst-class:: classref-method -:ref:`Vector4` **snapped**\ (\ step\: :ref:`Vector4`\ ) |const| +:ref:`Vector4` **snapped**\ (\ step\: :ref:`Vector4`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -741,7 +741,7 @@ Returns a new vector with each component snapped to the nearest multiple of the .. rst-class:: classref-method -:ref:`Vector4` **snappedf**\ (\ step\: :ref:`float`\ ) |const| +:ref:`Vector4` **snappedf**\ (\ step\: :ref:`float`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -758,7 +758,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector4`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Returns ``true`` if the vectors are not equal. @@ -774,7 +774,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`Projection`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Projection`\ ) :ref:`🔗` Transforms (multiplies) the **Vector4** by the transpose of the given :ref:`Projection` matrix. @@ -788,7 +788,7 @@ For transforming by inverse of a projection ``projection.inverse() * vector`` ca .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Multiplies each component of the **Vector4** by the components of the given **Vector4**. @@ -804,7 +804,7 @@ Multiplies each component of the **Vector4** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Vector4** by the given :ref:`float`. @@ -820,7 +820,7 @@ Multiplies each component of the **Vector4** by the given :ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Vector4** by the given :ref:`int`. @@ -832,7 +832,7 @@ Multiplies each component of the **Vector4** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Vector4` **operator +**\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator +**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Adds each component of the **Vector4** by the components of the given **Vector4**. @@ -848,7 +848,7 @@ Adds each component of the **Vector4** by the components of the given **Vector4* .. rst-class:: classref-operator -:ref:`Vector4` **operator -**\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator -**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Subtracts each component of the **Vector4** by the components of the given **Vector4**. @@ -864,7 +864,7 @@ Subtracts each component of the **Vector4** by the components of the given **Vec .. rst-class:: classref-operator -:ref:`Vector4` **operator /**\ (\ right\: :ref:`Vector4`\ ) +:ref:`Vector4` **operator /**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Divides each component of the **Vector4** by the components of the given **Vector4**. @@ -880,7 +880,7 @@ Divides each component of the **Vector4** by the components of the given **Vecto .. rst-class:: classref-operator -:ref:`Vector4` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Vector4` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Vector4** by the given :ref:`float`. @@ -896,7 +896,7 @@ Divides each component of the **Vector4** by the given :ref:`float` .. rst-class:: classref-operator -:ref:`Vector4` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Vector4` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Vector4** by the given :ref:`int`. @@ -908,7 +908,7 @@ Divides each component of the **Vector4** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Vector4`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Compares two **Vector4** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -922,7 +922,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector4`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Compares two **Vector4** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -936,7 +936,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector4`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Returns ``true`` if the vectors are exactly equal. @@ -952,7 +952,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Vector4`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Compares two **Vector4** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -966,7 +966,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector4`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector4`\ ) :ref:`🔗` Compares two **Vector4** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -980,7 +980,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``. @@ -992,7 +992,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector4` **operator unary+**\ (\ ) +:ref:`Vector4` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -1004,7 +1004,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector4` **operator unary-**\ (\ ) +:ref:`Vector4` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Vector4**. This is the same as writing ``Vector4(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index d3b9bb388a1..87bb06bdca1 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -162,7 +162,7 @@ Constants .. rst-class:: classref-constant -**AXIS_X** = ``0`` +**AXIS_X** = ``0`` :ref:`🔗` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -170,7 +170,7 @@ Enumerated value for the X axis. Returned by :ref:`max_axis_index` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -178,7 +178,7 @@ Enumerated value for the Y axis. Returned by :ref:`max_axis_index` Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -186,7 +186,7 @@ Enumerated value for the Z axis. Returned by :ref:`max_axis_index` Enumerated value for the W axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. @@ -194,7 +194,7 @@ Enumerated value for the W axis. Returned by :ref:`max_axis_index` Zero vector, a vector with all components set to ``0``. @@ -202,7 +202,7 @@ Zero vector, a vector with all components set to ``0``. .. rst-class:: classref-constant -**ONE** = ``Vector4i(1, 1, 1, 1)`` +**ONE** = ``Vector4i(1, 1, 1, 1)`` :ref:`🔗` One vector, a vector with all components set to ``1``. @@ -210,7 +210,7 @@ One vector, a vector with all components set to ``1``. .. rst-class:: classref-constant -**MIN** = ``Vector4i(-2147483648, -2147483648, -2147483648, -2147483648)`` +**MIN** = ``Vector4i(-2147483648, -2147483648, -2147483648, -2147483648)`` :ref:`🔗` Min vector, a vector with all components equal to ``INT32_MIN``. Can be used as a negative integer equivalent of :ref:`Vector4.INF`. @@ -218,7 +218,7 @@ Min vector, a vector with all components equal to ``INT32_MIN``. Can be used as .. rst-class:: classref-constant -**MAX** = ``Vector4i(2147483647, 2147483647, 2147483647, 2147483647)`` +**MAX** = ``Vector4i(2147483647, 2147483647, 2147483647, 2147483647)`` :ref:`🔗` Max vector, a vector with all components equal to ``INT32_MAX``. Can be used as an integer equivalent of :ref:`Vector4.INF`. @@ -235,7 +235,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **w** = ``0`` +:ref:`int` **w** = ``0`` :ref:`🔗` The vector's W component. Also accessible by using the index position ``[3]``. @@ -247,7 +247,7 @@ The vector's W component. Also accessible by using the index position ``[3]``. .. rst-class:: classref-property -:ref:`int` **x** = ``0`` +:ref:`int` **x** = ``0`` :ref:`🔗` The vector's X component. Also accessible by using the index position ``[0]``. @@ -259,7 +259,7 @@ The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-property -:ref:`int` **y** = ``0`` +:ref:`int` **y** = ``0`` :ref:`🔗` The vector's Y component. Also accessible by using the index position ``[1]``. @@ -271,7 +271,7 @@ The vector's Y component. Also accessible by using the index position ``[1]``. .. rst-class:: classref-property -:ref:`int` **z** = ``0`` +:ref:`int` **z** = ``0`` :ref:`🔗` The vector's Z component. Also accessible by using the index position ``[2]``. @@ -288,7 +288,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector4i` **Vector4i**\ (\ ) +:ref:`Vector4i` **Vector4i**\ (\ ) :ref:`🔗` Constructs a default-initialized **Vector4i** with all components set to ``0``. @@ -335,7 +335,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector4i` **abs**\ (\ ) |const| +:ref:`Vector4i` **abs**\ (\ ) |const| :ref:`🔗` Returns a new vector with all components in absolute values (i.e. positive). @@ -347,7 +347,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`Vector4i` **clamp**\ (\ min\: :ref:`Vector4i`, max\: :ref:`Vector4i`\ ) |const| +:ref:`Vector4i` **clamp**\ (\ min\: :ref:`Vector4i`, max\: :ref:`Vector4i`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -359,7 +359,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector4i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| +:ref:`Vector4i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| :ref:`🔗` Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -371,7 +371,7 @@ Returns a new vector with all components clamped between ``min`` and ``max``, by .. rst-class:: classref-method -:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector4i`\ ) |const| +:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector4i`\ ) |const| :ref:`🔗` Returns the squared distance between this vector and ``to``. @@ -385,7 +385,7 @@ This method runs faster than :ref:`distance_to` **distance_to**\ (\ to\: :ref:`Vector4i`\ ) |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector4i`\ ) |const| :ref:`🔗` Returns the distance between this vector and ``to``. @@ -397,7 +397,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **length**\ (\ ) |const| +:ref:`float` **length**\ (\ ) |const| :ref:`🔗` Returns the length (magnitude) of this vector. @@ -409,7 +409,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`int` **length_squared**\ (\ ) |const| +:ref:`int` **length_squared**\ (\ ) |const| :ref:`🔗` Returns the squared length (squared magnitude) of this vector. @@ -423,7 +423,7 @@ This method runs faster than :ref:`length`, so pre .. rst-class:: classref-method -:ref:`Vector4i` **max**\ (\ with\: :ref:`Vector4i`\ ) |const| +:ref:`Vector4i` **max**\ (\ with\: :ref:`Vector4i`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4i(maxi(x, with.x), maxi(y, with.y), maxi(z, with.z), maxi(w, with.w))``. @@ -435,7 +435,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`int` **max_axis_index**\ (\ ) |const| +:ref:`int` **max_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -447,7 +447,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector4i` **maxi**\ (\ with\: :ref:`int`\ ) |const| +:ref:`Vector4i` **maxi**\ (\ with\: :ref:`int`\ ) |const| :ref:`🔗` Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4i(maxi(x, with), maxi(y, with), maxi(z, with), maxi(w, with))``. @@ -459,7 +459,7 @@ Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`Vector4i` **min**\ (\ with\: :ref:`Vector4i`\ ) |const| +:ref:`Vector4i` **min**\ (\ with\: :ref:`Vector4i`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4i(mini(x, with.x), mini(y, with.y), mini(z, with.z), mini(w, with.w))``. @@ -471,7 +471,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`int` **min_axis_index**\ (\ ) |const| +:ref:`int` **min_axis_index**\ (\ ) |const| :ref:`🔗` Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W`. @@ -483,7 +483,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector4i` **mini**\ (\ with\: :ref:`int`\ ) |const| +:ref:`Vector4i` **mini**\ (\ with\: :ref:`int`\ ) |const| :ref:`🔗` Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4i(mini(x, with), mini(y, with), mini(z, with), mini(w, with))``. @@ -495,7 +495,7 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4 .. rst-class:: classref-method -:ref:`Vector4i` **sign**\ (\ ) |const| +:ref:`Vector4i` **sign**\ (\ ) |const| :ref:`🔗` Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -507,7 +507,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i .. rst-class:: classref-method -:ref:`Vector4i` **snapped**\ (\ step\: :ref:`Vector4i`\ ) |const| +:ref:`Vector4i` **snapped**\ (\ step\: :ref:`Vector4i`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. @@ -519,7 +519,7 @@ Returns a new vector with each component snapped to the closest multiple of the .. rst-class:: classref-method -:ref:`Vector4i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| +:ref:`Vector4i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| :ref:`🔗` Returns a new vector with each component snapped to the closest multiple of ``step``. @@ -536,7 +536,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Returns ``true`` if the vectors are not equal. @@ -548,7 +548,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector4i` **operator %**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4i` **operator %**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Gets the remainder of each component of the **Vector4i** with the components of the given **Vector4i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -564,7 +564,7 @@ Gets the remainder of each component of the **Vector4i** with the components of .. rst-class:: classref-operator -:ref:`Vector4i` **operator %**\ (\ right\: :ref:`int`\ ) +:ref:`Vector4i` **operator %**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Gets the remainder of each component of the **Vector4i** with the the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -580,7 +580,7 @@ Gets the remainder of each component of the **Vector4i** with the the given :ref .. rst-class:: classref-operator -:ref:`Vector4i` **operator ***\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4i` **operator ***\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Multiplies each component of the **Vector4i** by the components of the given **Vector4i**. @@ -596,7 +596,7 @@ Multiplies each component of the **Vector4i** by the components of the given **V .. rst-class:: classref-operator -:ref:`Vector4` **operator ***\ (\ right\: :ref:`float`\ ) +:ref:`Vector4` **operator ***\ (\ right\: :ref:`float`\ ) :ref:`🔗` Multiplies each component of the **Vector4i** by the given :ref:`float`. @@ -614,7 +614,7 @@ Returns a Vector4 value due to floating-point operations. .. rst-class:: classref-operator -:ref:`Vector4i` **operator ***\ (\ right\: :ref:`int`\ ) +:ref:`Vector4i` **operator ***\ (\ right\: :ref:`int`\ ) :ref:`🔗` Multiplies each component of the **Vector4i** by the given :ref:`int`. @@ -626,7 +626,7 @@ Multiplies each component of the **Vector4i** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`Vector4i` **operator +**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4i` **operator +**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Adds each component of the **Vector4i** by the components of the given **Vector4i**. @@ -642,7 +642,7 @@ Adds each component of the **Vector4i** by the components of the given **Vector4 .. rst-class:: classref-operator -:ref:`Vector4i` **operator -**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4i` **operator -**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Subtracts each component of the **Vector4i** by the components of the given **Vector4i**. @@ -658,7 +658,7 @@ Subtracts each component of the **Vector4i** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector4i` **operator /**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`Vector4i` **operator /**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Divides each component of the **Vector4i** by the components of the given **Vector4i**. @@ -674,7 +674,7 @@ Divides each component of the **Vector4i** by the components of the given **Vect .. rst-class:: classref-operator -:ref:`Vector4` **operator /**\ (\ right\: :ref:`float`\ ) +:ref:`Vector4` **operator /**\ (\ right\: :ref:`float`\ ) :ref:`🔗` Divides each component of the **Vector4i** by the given :ref:`float`. @@ -692,7 +692,7 @@ Returns a Vector4 value due to floating-point operations. .. rst-class:: classref-operator -:ref:`Vector4i` **operator /**\ (\ right\: :ref:`int`\ ) +:ref:`Vector4i` **operator /**\ (\ right\: :ref:`int`\ ) :ref:`🔗` Divides each component of the **Vector4i** by the given :ref:`int`. @@ -704,7 +704,7 @@ Divides each component of the **Vector4i** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Compares two **Vector4i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -716,7 +716,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Compares two **Vector4i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -728,7 +728,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Returns ``true`` if the vectors are exactly equal. @@ -740,7 +740,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Compares two **Vector4i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -752,7 +752,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector4i`\ ) +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector4i`\ ) :ref:`🔗` Compares two **Vector4i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -764,7 +764,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``. @@ -776,7 +776,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector4i` **operator unary+**\ (\ ) +:ref:`Vector4i` **operator unary+**\ (\ ) :ref:`🔗` Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -788,7 +788,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector4i` **operator unary-**\ (\ ) +:ref:`Vector4i` **operator unary-**\ (\ ) :ref:`🔗` Returns the negative value of the **Vector4i**. This is the same as writing ``Vector4i(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. diff --git a/classes/class_vehiclebody3d.rst b/classes/class_vehiclebody3d.rst index 34960605904..c1b78483f55 100644 --- a/classes/class_vehiclebody3d.rst +++ b/classes/class_vehiclebody3d.rst @@ -63,7 +63,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **brake** = ``0.0`` +:ref:`float` **brake** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -80,7 +80,7 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed d .. rst-class:: classref-property -:ref:`float` **engine_force** = ``0.0`` +:ref:`float` **engine_force** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ A negative value will result in the vehicle reversing. .. rst-class:: classref-property -:ref:`float` **steering** = ``0.0`` +:ref:`float` **steering** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_vehiclewheel3d.rst b/classes/class_vehiclewheel3d.rst index 5a4d42d5f2b..1df0021c1e3 100644 --- a/classes/class_vehiclewheel3d.rst +++ b/classes/class_vehiclewheel3d.rst @@ -99,7 +99,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **brake** = ``0.0`` +:ref:`float` **brake** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -116,7 +116,7 @@ Slows down the wheel by applying a braking force. The wheel is only slowed down .. rst-class:: classref-property -:ref:`float` **damping_compression** = ``0.83`` +:ref:`float` **damping_compression** = ``0.83`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The damping applied to the spring when the spring is being compressed. This valu .. rst-class:: classref-property -:ref:`float` **damping_relaxation** = ``0.88`` +:ref:`float` **damping_relaxation** = ``0.88`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ The damping applied to the spring when relaxing. This value should be between 0. .. rst-class:: classref-property -:ref:`float` **engine_force** = ``0.0`` +:ref:`float` **engine_force** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ A negative value will result in the wheel reversing. .. rst-class:: classref-property -:ref:`float` **steering** = ``0.0`` +:ref:`float` **steering** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ The steering angle for the wheel, in radians. Setting this to a non-zero value w .. rst-class:: classref-property -:ref:`float` **suspension_max_force** = ``6000.0`` +:ref:`float` **suspension_max_force** = ``6000.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -205,7 +205,7 @@ The maximum force the spring can resist. This value should be higher than a quar .. rst-class:: classref-property -:ref:`float` **suspension_stiffness** = ``5.88`` +:ref:`float` **suspension_stiffness** = ``5.88`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -222,7 +222,7 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo .. rst-class:: classref-property -:ref:`float` **suspension_travel** = ``0.2`` +:ref:`float` **suspension_travel** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -239,7 +239,7 @@ This is the distance the suspension can travel. As Godot units are equivalent to .. rst-class:: classref-property -:ref:`bool` **use_as_steering** = ``false`` +:ref:`bool` **use_as_steering** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -256,7 +256,7 @@ If ``true``, this wheel will be turned when the car steers. This value is used i .. rst-class:: classref-property -:ref:`bool` **use_as_traction** = ``false`` +:ref:`bool` **use_as_traction** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -273,7 +273,7 @@ If ``true``, this wheel transfers engine force to the ground to propel the vehic .. rst-class:: classref-property -:ref:`float` **wheel_friction_slip** = ``10.5`` +:ref:`float` **wheel_friction_slip** = ``10.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -292,7 +292,7 @@ It's best to set this to 1.0 when starting out. .. rst-class:: classref-property -:ref:`float` **wheel_radius** = ``0.5`` +:ref:`float` **wheel_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -309,7 +309,7 @@ The radius of the wheel in meters. .. rst-class:: classref-property -:ref:`float` **wheel_rest_length** = ``0.15`` +:ref:`float` **wheel_rest_length** = ``0.15`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -326,7 +326,7 @@ This is the distance in meters the wheel is lowered from its origin point. Don't .. rst-class:: classref-property -:ref:`float` **wheel_roll_influence** = ``0.1`` +:ref:`float` **wheel_roll_influence** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -348,7 +348,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Node3D` **get_contact_body**\ (\ ) |const| +:ref:`Node3D` **get_contact_body**\ (\ ) |const| :ref:`🔗` Returns the contacting body node if valid in the tree, as :ref:`Node3D`. At the moment, :ref:`GridMap` is not supported so the node will be always of type :ref:`PhysicsBody3D`. @@ -362,7 +362,7 @@ Returns ``null`` if the wheel is not in contact with a surface, or the contact b .. rst-class:: classref-method -:ref:`float` **get_rpm**\ (\ ) |const| +:ref:`float` **get_rpm**\ (\ ) |const| :ref:`🔗` Returns the rotational speed of the wheel in revolutions per minute. @@ -374,7 +374,7 @@ Returns the rotational speed of the wheel in revolutions per minute. .. rst-class:: classref-method -:ref:`float` **get_skidinfo**\ (\ ) |const| +:ref:`float` **get_skidinfo**\ (\ ) |const| :ref:`🔗` Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road). @@ -386,7 +386,7 @@ Returns a value between 0.0 and 1.0 that indicates whether this wheel is skiddin .. rst-class:: classref-method -:ref:`bool` **is_in_contact**\ (\ ) |const| +:ref:`bool` **is_in_contact**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this wheel is in contact with a surface. diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index de78ae31f2e..ba676bba4ef 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -69,7 +69,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **file** = ``""`` +:ref:`String` **file** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`VideoStreamPlayback` **_instantiate_playback**\ (\ ) |virtual| +:ref:`VideoStreamPlayback` **_instantiate_playback**\ (\ ) |virtual| :ref:`🔗` Called when the video starts playing, to initialize and return a subclass of :ref:`VideoStreamPlayback`. diff --git a/classes/class_videostreamplayback.rst b/classes/class_videostreamplayback.rst index 6c418975a04..b0e3cf5a022 100644 --- a/classes/class_videostreamplayback.rst +++ b/classes/class_videostreamplayback.rst @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_channels**\ (\ ) |virtual| |const| +:ref:`int` **_get_channels**\ (\ ) |virtual| |const| :ref:`🔗` Returns the number of audio channels. @@ -84,7 +84,7 @@ Returns the number of audio channels. .. rst-class:: classref-method -:ref:`float` **_get_length**\ (\ ) |virtual| |const| +:ref:`float` **_get_length**\ (\ ) |virtual| |const| :ref:`🔗` Returns the video duration in seconds, if known, or 0 if unknown. @@ -96,7 +96,7 @@ Returns the video duration in seconds, if known, or 0 if unknown. .. rst-class:: classref-method -:ref:`int` **_get_mix_rate**\ (\ ) |virtual| |const| +:ref:`int` **_get_mix_rate**\ (\ ) |virtual| |const| :ref:`🔗` Returns the audio sample rate used for mixing. @@ -108,7 +108,7 @@ Returns the audio sample rate used for mixing. .. rst-class:: classref-method -:ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| +:ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| :ref:`🔗` Return the current playback timestamp. Called in response to the :ref:`VideoStreamPlayer.stream_position` getter. @@ -120,7 +120,7 @@ Return the current playback timestamp. Called in response to the :ref:`VideoStre .. rst-class:: classref-method -:ref:`Texture2D` **_get_texture**\ (\ ) |virtual| |const| +:ref:`Texture2D` **_get_texture**\ (\ ) |virtual| |const| :ref:`🔗` Allocates a :ref:`Texture2D` in which decoded video frames will be drawn. @@ -132,7 +132,7 @@ Allocates a :ref:`Texture2D` in which decoded video frames will .. rst-class:: classref-method -:ref:`bool` **_is_paused**\ (\ ) |virtual| |const| +:ref:`bool` **_is_paused**\ (\ ) |virtual| |const| :ref:`🔗` Returns the paused status, as set by :ref:`_set_paused`. @@ -144,7 +144,7 @@ Returns the paused status, as set by :ref:`_set_paused` **_is_playing**\ (\ ) |virtual| |const| +:ref:`bool` **_is_playing**\ (\ ) |virtual| |const| :ref:`🔗` Returns the playback state, as determined by calls to :ref:`_play` and :ref:`_stop`. @@ -156,7 +156,7 @@ Returns the playback state, as determined by calls to :ref:`_play` Called in response to :ref:`VideoStreamPlayer.autoplay` or :ref:`VideoStreamPlayer.play`. Note that manual playback may also invoke :ref:`_stop` multiple times before this method is called. :ref:`_is_playing` should return true once playing. @@ -168,7 +168,7 @@ Called in response to :ref:`VideoStreamPlayer.autoplay`\ ) |virtual| +|void| **_seek**\ (\ time\: :ref:`float`\ ) |virtual| :ref:`🔗` Seeks to ``time`` seconds. Called in response to the :ref:`VideoStreamPlayer.stream_position` setter. @@ -180,7 +180,7 @@ Seeks to ``time`` seconds. Called in response to the :ref:`VideoStreamPlayer.str .. rst-class:: classref-method -|void| **_set_audio_track**\ (\ idx\: :ref:`int`\ ) |virtual| +|void| **_set_audio_track**\ (\ idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Select the audio track ``idx``. Called when playback starts, and in response to the :ref:`VideoStreamPlayer.audio_track` setter. @@ -192,7 +192,7 @@ Select the audio track ``idx``. Called when playback starts, and in response to .. rst-class:: classref-method -|void| **_set_paused**\ (\ paused\: :ref:`bool`\ ) |virtual| +|void| **_set_paused**\ (\ paused\: :ref:`bool`\ ) |virtual| :ref:`🔗` Set the paused status of video playback. :ref:`_is_paused` must return ``paused``. Called in response to the :ref:`VideoStreamPlayer.paused` setter. @@ -204,7 +204,7 @@ Set the paused status of video playback. :ref:`_is_paused` Stops playback. May be called multiple times before :ref:`_play`, or in response to :ref:`VideoStreamPlayer.stop`. :ref:`_is_playing` should return false once stopped. @@ -216,7 +216,7 @@ Stops playback. May be called multiple times before :ref:`_play`\ ) |virtual| +|void| **_update**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` Ticks video playback for ``delta`` seconds. Called every frame as long as :ref:`_is_paused` and :ref:`_is_playing` return true. @@ -228,7 +228,7 @@ Ticks video playback for ``delta`` seconds. Called every frame as long as :ref:` .. rst-class:: classref-method -:ref:`int` **mix_audio**\ (\ num_frames\: :ref:`int`, buffer\: :ref:`PackedFloat32Array` = PackedFloat32Array(), offset\: :ref:`int` = 0\ ) +:ref:`int` **mix_audio**\ (\ num_frames\: :ref:`int`, buffer\: :ref:`PackedFloat32Array` = PackedFloat32Array(), offset\: :ref:`int` = 0\ ) :ref:`🔗` Render ``num_frames`` audio frames (of :ref:`_get_channels` floats each) from ``buffer``, starting from index ``offset`` in the array. Returns the number of audio frames rendered, or -1 on error. diff --git a/classes/class_videostreamplayer.rst b/classes/class_videostreamplayer.rst index 1ea9e318851..ff2dbe5acdd 100644 --- a/classes/class_videostreamplayer.rst +++ b/classes/class_videostreamplayer.rst @@ -99,7 +99,7 @@ Signals .. rst-class:: classref-signal -**finished**\ (\ ) +**finished**\ (\ ) :ref:`🔗` Emitted when playback is finished. @@ -116,7 +116,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **audio_track** = ``0`` +:ref:`int` **audio_track** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The embedded audio track to play. .. rst-class:: classref-property -:ref:`bool` **autoplay** = ``false`` +:ref:`bool` **autoplay** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ If ``true``, playback starts when the scene loads. .. rst-class:: classref-property -:ref:`int` **buffering_msec** = ``500`` +:ref:`int` **buffering_msec** = ``500`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ Amount of time in milliseconds to store in buffer while playing. .. rst-class:: classref-property -:ref:`StringName` **bus** = ``&"Master"`` +:ref:`StringName` **bus** = ``&"Master"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -184,7 +184,7 @@ Audio bus to use for sound playback. .. rst-class:: classref-property -:ref:`bool` **expand** = ``false`` +:ref:`bool` **expand** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -201,7 +201,7 @@ If ``true``, the video scales to the control size. Otherwise, the control minimu .. rst-class:: classref-property -:ref:`bool` **loop** = ``false`` +:ref:`bool` **loop** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -218,7 +218,7 @@ If ``true``, the video restarts when it reaches its end. .. rst-class:: classref-property -:ref:`bool` **paused** = ``false`` +:ref:`bool` **paused** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -235,7 +235,7 @@ If ``true``, the video is paused. .. rst-class:: classref-property -:ref:`VideoStream` **stream** +:ref:`VideoStream` **stream** :ref:`🔗` .. rst-class:: classref-property-setget @@ -252,7 +252,7 @@ The assigned video stream. See description for supported formats. .. rst-class:: classref-property -:ref:`float` **stream_position** +:ref:`float` **stream_position** :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ The current position of the stream, in seconds. .. rst-class:: classref-property -:ref:`float` **volume** +:ref:`float` **volume** :ref:`🔗` .. rst-class:: classref-property-setget @@ -288,7 +288,7 @@ Audio volume as a linear value. .. rst-class:: classref-property -:ref:`float` **volume_db** = ``0.0`` +:ref:`float` **volume_db** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -310,7 +310,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_stream_length**\ (\ ) |const| +:ref:`float` **get_stream_length**\ (\ ) |const| :ref:`🔗` The length of the current stream, in seconds. @@ -324,7 +324,7 @@ The length of the current stream, in seconds. .. rst-class:: classref-method -:ref:`String` **get_stream_name**\ (\ ) |const| +:ref:`String` **get_stream_name**\ (\ ) |const| :ref:`🔗` Returns the video stream's name, or ``""`` if no video stream is assigned. @@ -336,7 +336,7 @@ Returns the video stream's name, or ``""`` if no video stream is assi .. rst-class:: classref-method -:ref:`Texture2D` **get_video_texture**\ (\ ) |const| +:ref:`Texture2D` **get_video_texture**\ (\ ) |const| :ref:`🔗` Returns the current frame as a :ref:`Texture2D`. @@ -348,7 +348,7 @@ Returns the current frame as a :ref:`Texture2D`. .. rst-class:: classref-method -:ref:`bool` **is_playing**\ (\ ) |const| +:ref:`bool` **is_playing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the video is playing. @@ -362,7 +362,7 @@ Returns ``true`` if the video is playing. .. rst-class:: classref-method -|void| **play**\ (\ ) +|void| **play**\ (\ ) :ref:`🔗` Starts the video playback from the beginning. If the video is paused, this will not unpause the video. @@ -374,7 +374,7 @@ Starts the video playback from the beginning. If the video is paused, this will .. rst-class:: classref-method -|void| **stop**\ (\ ) +|void| **stop**\ (\ ) :ref:`🔗` Stops the video playback and sets the stream position to 0. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index c559a4b59f0..a49e66d7ff7 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -235,7 +235,7 @@ Signals .. rst-class:: classref-signal -**gui_focus_changed**\ (\ node\: :ref:`Control`\ ) +**gui_focus_changed**\ (\ node\: :ref:`Control`\ ) :ref:`🔗` Emitted when a Control node grabs keyboard focus. @@ -249,7 +249,7 @@ Emitted when a Control node grabs keyboard focus. .. rst-class:: classref-signal -**size_changed**\ (\ ) +**size_changed**\ (\ ) :ref:`🔗` Emitted when the size of the viewport is changed, whether by resizing of window, or some other means. @@ -266,7 +266,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PositionalShadowAtlasQuadrantSubdiv**: +enum **PositionalShadowAtlasQuadrantSubdiv**: :ref:`🔗` .. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED: @@ -340,7 +340,7 @@ Represents the size of the :ref:`PositionalShadowAtlasQuadrantSubdiv` .. _class_Viewport_constant_SCALING_3D_MODE_BILINEAR: @@ -382,7 +382,7 @@ Represents the size of the :ref:`Scaling3DMode` enu .. rst-class:: classref-enumeration -enum **MSAA**: +enum **MSAA**: :ref:`🔗` .. _class_Viewport_constant_MSAA_DISABLED: @@ -432,7 +432,7 @@ Represents the size of the :ref:`MSAA` enum. .. rst-class:: classref-enumeration -enum **ScreenSpaceAA**: +enum **ScreenSpaceAA**: :ref:`🔗` .. _class_Viewport_constant_SCREEN_SPACE_AA_DISABLED: @@ -466,7 +466,7 @@ Represents the size of the :ref:`ScreenSpaceAA` enu .. rst-class:: classref-enumeration -enum **RenderInfo**: +enum **RenderInfo**: :ref:`🔗` .. _class_Viewport_constant_RENDER_INFO_OBJECTS_IN_FRAME: @@ -508,7 +508,7 @@ Represents the size of the :ref:`RenderInfo` enum. .. rst-class:: classref-enumeration -enum **RenderInfoType**: +enum **RenderInfoType**: :ref:`🔗` .. _class_Viewport_constant_RENDER_INFO_TYPE_VISIBLE: @@ -550,7 +550,7 @@ Represents the size of the :ref:`RenderInfoType` e .. rst-class:: classref-enumeration -enum **DebugDraw**: +enum **DebugDraw**: :ref:`🔗` .. _class_Viewport_constant_DEBUG_DRAW_DISABLED: @@ -780,7 +780,7 @@ Draws the internal resolution buffer of the scene before post-processing is appl .. rst-class:: classref-enumeration -enum **DefaultCanvasItemTextureFilter**: +enum **DefaultCanvasItemTextureFilter**: :ref:`🔗` .. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST: @@ -834,7 +834,7 @@ Represents the size of the :ref:`DefaultCanvasItemTextureFilter` .. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED: @@ -876,7 +876,7 @@ Represents the size of the :ref:`DefaultCanvasItemTextureRepeat` .. _class_Viewport_constant_SDF_OVERSIZE_100_PERCENT: @@ -926,7 +926,7 @@ Represents the size of the :ref:`SDFOversize` enum. .. rst-class:: classref-enumeration -enum **SDFScale**: +enum **SDFScale**: :ref:`🔗` .. _class_Viewport_constant_SDF_SCALE_100_PERCENT: @@ -968,7 +968,7 @@ Represents the size of the :ref:`SDFScale` enum. .. rst-class:: classref-enumeration -enum **VRSMode**: +enum **VRSMode**: :ref:`🔗` .. _class_Viewport_constant_VRS_DISABLED: @@ -1010,7 +1010,7 @@ Represents the size of the :ref:`VRSMode` enum. .. rst-class:: classref-enumeration -enum **VRSUpdateMode**: +enum **VRSUpdateMode**: :ref:`🔗` .. _class_Viewport_constant_VRS_UPDATE_DISABLED: @@ -1057,7 +1057,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **audio_listener_enable_2d** = ``false`` +:ref:`bool` **audio_listener_enable_2d** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1074,7 +1074,7 @@ If ``true``, the viewport will process 2D audio streams. .. rst-class:: classref-property -:ref:`bool` **audio_listener_enable_3d** = ``false`` +:ref:`bool` **audio_listener_enable_3d** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1091,7 +1091,7 @@ If ``true``, the viewport will process 3D audio streams. .. rst-class:: classref-property -:ref:`int` **canvas_cull_mask** = ``4294967295`` +:ref:`int` **canvas_cull_mask** = ``4294967295`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1108,7 +1108,7 @@ The rendering layers in which this **Viewport** renders :ref:`CanvasItem` **canvas_item_default_texture_filter** = ``1`` +:ref:`DefaultCanvasItemTextureFilter` **canvas_item_default_texture_filter** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1125,7 +1125,7 @@ Sets the default filter mode used by :ref:`CanvasItem`\ s in t .. rst-class:: classref-property -:ref:`DefaultCanvasItemTextureRepeat` **canvas_item_default_texture_repeat** = ``0`` +:ref:`DefaultCanvasItemTextureRepeat` **canvas_item_default_texture_repeat** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1142,7 +1142,7 @@ Sets the default repeat mode used by :ref:`CanvasItem`\ s in t .. rst-class:: classref-property -:ref:`Transform2D` **canvas_transform** +:ref:`Transform2D` **canvas_transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1159,7 +1159,7 @@ The canvas transform of the viewport, useful for changing the on-screen position .. rst-class:: classref-property -:ref:`DebugDraw` **debug_draw** = ``0`` +:ref:`DebugDraw` **debug_draw** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1176,7 +1176,7 @@ The overlay mode for test rendered geometry in debug purposes. .. rst-class:: classref-property -:ref:`bool` **disable_3d** = ``false`` +:ref:`bool` **disable_3d** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1193,7 +1193,7 @@ Disable 3D rendering (but keep 2D rendering). .. rst-class:: classref-property -:ref:`float` **fsr_sharpness** = ``0.2`` +:ref:`float` **fsr_sharpness** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1212,7 +1212,7 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property -:ref:`Transform2D` **global_canvas_transform** +:ref:`Transform2D` **global_canvas_transform** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1229,7 +1229,7 @@ The global canvas transform of the viewport. The canvas transform is relative to .. rst-class:: classref-property -:ref:`bool` **gui_disable_input** = ``false`` +:ref:`bool` **gui_disable_input** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1246,7 +1246,7 @@ If ``true``, the viewport will not receive input events. .. rst-class:: classref-property -:ref:`bool` **gui_embed_subwindows** = ``false`` +:ref:`bool` **gui_embed_subwindows** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1263,7 +1263,7 @@ If ``true``, sub-windows (popups and dialogs) will be embedded inside applicatio .. rst-class:: classref-property -:ref:`bool` **gui_snap_controls_to_pixels** = ``true`` +:ref:`bool` **gui_snap_controls_to_pixels** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1280,7 +1280,7 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. .. rst-class:: classref-property -:ref:`bool` **handle_input_locally** = ``true`` +:ref:`bool` **handle_input_locally** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1301,7 +1301,7 @@ See also :ref:`set_input_as_handled` .. rst-class:: classref-property -:ref:`float` **mesh_lod_threshold** = ``1.0`` +:ref:`float` **mesh_lod_threshold** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1322,7 +1322,7 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property -:ref:`MSAA` **msaa_2d** = ``0`` +:ref:`MSAA` **msaa_2d** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1339,7 +1339,7 @@ The multisample anti-aliasing mode for 2D/Canvas rendering. A higher number resu .. rst-class:: classref-property -:ref:`MSAA` **msaa_3d** = ``0`` +:ref:`MSAA` **msaa_3d** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1356,7 +1356,7 @@ The multisample anti-aliasing mode for 3D rendering. A higher number results in .. rst-class:: classref-property -:ref:`bool` **own_world_3d** = ``false`` +:ref:`bool` **own_world_3d** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1373,7 +1373,7 @@ If ``true``, the viewport will use a unique copy of the :ref:`World3D` **physics_object_picking** = ``false`` +:ref:`bool` **physics_object_picking** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1392,7 +1392,7 @@ If ``true``, the objects rendered by viewport become subjects of mouse picking p .. rst-class:: classref-property -:ref:`bool` **physics_object_picking_first_only** = ``false`` +:ref:`bool` **physics_object_picking_first_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1413,7 +1413,7 @@ This applies to 2D CanvasItem object picking only. .. rst-class:: classref-property -:ref:`bool` **physics_object_picking_sort** = ``false`` +:ref:`bool` **physics_object_picking_sort** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1434,7 +1434,7 @@ If ``true``, objects receive mouse picking events sorted primarily by their :ref .. rst-class:: classref-property -:ref:`bool` **positional_shadow_atlas_16_bits** = ``true`` +:ref:`bool` **positional_shadow_atlas_16_bits** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1451,7 +1451,7 @@ Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows .. rst-class:: classref-property -:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_0** = ``2`` +:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_0** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1468,7 +1468,7 @@ The subdivision amount of the first quadrant on the shadow atlas. .. rst-class:: classref-property -:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_1** = ``2`` +:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_1** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1485,7 +1485,7 @@ The subdivision amount of the second quadrant on the shadow atlas. .. rst-class:: classref-property -:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_2** = ``3`` +:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_2** = ``3`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1502,7 +1502,7 @@ The subdivision amount of the third quadrant on the shadow atlas. .. rst-class:: classref-property -:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_3** = ``4`` +:ref:`PositionalShadowAtlasQuadrantSubdiv` **positional_shadow_atlas_quad_3** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1519,7 +1519,7 @@ The subdivision amount of the fourth quadrant on the shadow atlas. .. rst-class:: classref-property -:ref:`int` **positional_shadow_atlas_size** = ``2048`` +:ref:`int` **positional_shadow_atlas_size** = ``2048`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1538,7 +1538,7 @@ The shadow atlas' resolution (used for omni and spot lights). The value is round .. rst-class:: classref-property -:ref:`Scaling3DMode` **scaling_3d_mode** = ``0`` +:ref:`Scaling3DMode` **scaling_3d_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1557,7 +1557,7 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property -:ref:`float` **scaling_3d_scale** = ``1.0`` +:ref:`float` **scaling_3d_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1578,7 +1578,7 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property -:ref:`ScreenSpaceAA` **screen_space_aa** = ``0`` +:ref:`ScreenSpaceAA` **screen_space_aa** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1595,7 +1595,7 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works .. rst-class:: classref-property -:ref:`SDFOversize` **sdf_oversize** = ``1`` +:ref:`SDFOversize` **sdf_oversize** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1614,7 +1614,7 @@ The percentage is added on each axis and on both sides. For example, with the de .. rst-class:: classref-property -:ref:`SDFScale` **sdf_scale** = ``1`` +:ref:`SDFScale` **sdf_scale** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1631,7 +1631,7 @@ The resolution scale to use for the 2D signed distance field. Higher values lead .. rst-class:: classref-property -:ref:`bool` **snap_2d_transforms_to_pixel** = ``false`` +:ref:`bool` **snap_2d_transforms_to_pixel** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1648,7 +1648,7 @@ If ``true``, :ref:`CanvasItem` nodes will internally snap to f .. rst-class:: classref-property -:ref:`bool` **snap_2d_vertices_to_pixel** = ``false`` +:ref:`bool` **snap_2d_vertices_to_pixel** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1665,7 +1665,7 @@ If ``true``, vertices of :ref:`CanvasItem` nodes will snap to .. rst-class:: classref-property -:ref:`float` **texture_mipmap_bias** = ``0.0`` +:ref:`float` **texture_mipmap_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1688,7 +1688,7 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property -:ref:`bool` **transparent_bg** = ``false`` +:ref:`bool` **transparent_bg** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1705,7 +1705,7 @@ If ``true``, the viewport should render its background as transparent. .. rst-class:: classref-property -:ref:`bool` **use_debanding** = ``false`` +:ref:`bool` **use_debanding** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1724,7 +1724,7 @@ In some cases, debanding may introduce a slightly noticeable dithering pattern. .. rst-class:: classref-property -:ref:`bool` **use_hdr_2d** = ``false`` +:ref:`bool` **use_hdr_2d** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1743,7 +1743,7 @@ If ``true``, 2D rendering will use an high dynamic range (HDR) format framebuffe .. rst-class:: classref-property -:ref:`bool` **use_occlusion_culling** = ``false`` +:ref:`bool` **use_occlusion_culling** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1764,7 +1764,7 @@ If ``true``, :ref:`OccluderInstance3D` nodes will be u .. rst-class:: classref-property -:ref:`bool` **use_taa** = ``false`` +:ref:`bool` **use_taa** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1783,7 +1783,7 @@ Enables Temporal Anti-Aliasing for this viewport. TAA works by jittering the cam .. rst-class:: classref-property -:ref:`bool` **use_xr** = ``false`` +:ref:`bool` **use_xr** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1800,7 +1800,7 @@ If ``true``, the viewport will use the primary XR interface to render XR output. .. rst-class:: classref-property -:ref:`VRSMode` **vrs_mode** = ``0`` +:ref:`VRSMode` **vrs_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1817,7 +1817,7 @@ The Variable Rate Shading (VRS) mode that is used for this viewport. Note, if ha .. rst-class:: classref-property -:ref:`Texture2D` **vrs_texture** +:ref:`Texture2D` **vrs_texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1849,7 +1849,7 @@ The texture *must* use a lossless compression format so that colors can be match .. rst-class:: classref-property -:ref:`VRSUpdateMode` **vrs_update_mode** = ``1`` +:ref:`VRSUpdateMode` **vrs_update_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1866,7 +1866,7 @@ Sets the update mode for Variable Rate Shading (VRS) for the viewport. VRS requi .. rst-class:: classref-property -:ref:`World2D` **world_2d** +:ref:`World2D` **world_2d** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1883,7 +1883,7 @@ The custom :ref:`World2D` which can be used as 2D environment sou .. rst-class:: classref-property -:ref:`World3D` **world_3d** +:ref:`World3D` **world_3d** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1905,7 +1905,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`World2D` **find_world_2d**\ (\ ) |const| +:ref:`World2D` **find_world_2d**\ (\ ) |const| :ref:`🔗` Returns the first valid :ref:`World2D` for this viewport, searching the :ref:`world_2d` property of itself and any Viewport ancestor. @@ -1917,7 +1917,7 @@ Returns the first valid :ref:`World2D` for this viewport, searchi .. rst-class:: classref-method -:ref:`World3D` **find_world_3d**\ (\ ) |const| +:ref:`World3D` **find_world_3d**\ (\ ) |const| :ref:`🔗` Returns the first valid :ref:`World3D` for this viewport, searching the :ref:`world_3d` property of itself and any Viewport ancestor. @@ -1929,7 +1929,7 @@ Returns the first valid :ref:`World3D` for this viewport, searchi .. rst-class:: classref-method -:ref:`Camera2D` **get_camera_2d**\ (\ ) |const| +:ref:`Camera2D` **get_camera_2d**\ (\ ) |const| :ref:`🔗` Returns the currently active 2D camera. Returns null if there are no active cameras. @@ -1941,7 +1941,7 @@ Returns the currently active 2D camera. Returns null if there are no active came .. rst-class:: classref-method -:ref:`Camera3D` **get_camera_3d**\ (\ ) |const| +:ref:`Camera3D` **get_camera_3d**\ (\ ) |const| :ref:`🔗` Returns the currently active 3D camera. @@ -1953,7 +1953,7 @@ Returns the currently active 3D camera. .. rst-class:: classref-method -:ref:`bool` **get_canvas_cull_mask_bit**\ (\ layer\: :ref:`int`\ ) |const| +:ref:`bool` **get_canvas_cull_mask_bit**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` Returns an individual bit on the rendering layer mask. @@ -1965,7 +1965,7 @@ Returns an individual bit on the rendering layer mask. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Window`\] **get_embedded_subwindows**\ (\ ) |const| +:ref:`Array`\[:ref:`Window`\] **get_embedded_subwindows**\ (\ ) |const| :ref:`🔗` Returns a list of the visible embedded :ref:`Window`\ s inside the viewport. @@ -1979,7 +1979,7 @@ Returns a list of the visible embedded :ref:`Window`\ s inside the .. rst-class:: classref-method -:ref:`Transform2D` **get_final_transform**\ (\ ) |const| +:ref:`Transform2D` **get_final_transform**\ (\ ) |const| :ref:`🔗` Returns the transform from the viewport's coordinate system to the embedder's coordinate system. @@ -1991,7 +1991,7 @@ Returns the transform from the viewport's coordinate system to the embedder's co .. rst-class:: classref-method -:ref:`Vector2` **get_mouse_position**\ (\ ) |const| +:ref:`Vector2` **get_mouse_position**\ (\ ) |const| :ref:`🔗` Returns the mouse's position in this **Viewport** using the coordinate system of this **Viewport**. @@ -2003,7 +2003,7 @@ Returns the mouse's position in this **Viewport** using the coordinate system of .. rst-class:: classref-method -:ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| +:ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| :ref:`🔗` Returns the positional shadow atlas quadrant subdivision of the specified quadrant. @@ -2015,7 +2015,7 @@ Returns the positional shadow atlas quadrant subdivision of the specified quadra .. rst-class:: classref-method -:ref:`int` **get_render_info**\ (\ type\: :ref:`RenderInfoType`, info\: :ref:`RenderInfo`\ ) +:ref:`int` **get_render_info**\ (\ type\: :ref:`RenderInfoType`, info\: :ref:`RenderInfo`\ ) :ref:`🔗` Returns rendering statistics of the given type. See :ref:`RenderInfoType` and :ref:`RenderInfo` for options. @@ -2027,7 +2027,7 @@ Returns rendering statistics of the given type. See :ref:`RenderInfoType` **get_screen_transform**\ (\ ) |const| +:ref:`Transform2D` **get_screen_transform**\ (\ ) |const| :ref:`🔗` Returns the transform from the Viewport's coordinates to the screen coordinates of the containing window manager window. @@ -2039,7 +2039,7 @@ Returns the transform from the Viewport's coordinates to the screen coordinates .. rst-class:: classref-method -:ref:`ViewportTexture` **get_texture**\ (\ ) |const| +:ref:`ViewportTexture` **get_texture**\ (\ ) |const| :ref:`🔗` Returns the viewport's texture. @@ -2059,7 +2059,7 @@ Returns the viewport's texture. .. rst-class:: classref-method -:ref:`RID` **get_viewport_rid**\ (\ ) |const| +:ref:`RID` **get_viewport_rid**\ (\ ) |const| :ref:`🔗` Returns the viewport's RID from the :ref:`RenderingServer`. @@ -2071,7 +2071,7 @@ Returns the viewport's RID from the :ref:`RenderingServer .. rst-class:: classref-method -:ref:`Rect2` **get_visible_rect**\ (\ ) |const| +:ref:`Rect2` **get_visible_rect**\ (\ ) |const| :ref:`🔗` Returns the visible rectangle in global screen coordinates. @@ -2083,7 +2083,7 @@ Returns the visible rectangle in global screen coordinates. .. rst-class:: classref-method -:ref:`Variant` **gui_get_drag_data**\ (\ ) |const| +:ref:`Variant` **gui_get_drag_data**\ (\ ) |const| :ref:`🔗` Returns the drag data from the GUI, that was previously returned by :ref:`Control._get_drag_data`. @@ -2095,7 +2095,7 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro .. rst-class:: classref-method -:ref:`Control` **gui_get_focus_owner**\ (\ ) |const| +:ref:`Control` **gui_get_focus_owner**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Control` having the focus within this viewport. If no :ref:`Control` has the focus, returns null. @@ -2107,7 +2107,7 @@ Returns the :ref:`Control` having the focus within this viewport. .. rst-class:: classref-method -:ref:`Control` **gui_get_hovered_control**\ (\ ) |const| +:ref:`Control` **gui_get_hovered_control**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Control` that the mouse is currently hovering over in this viewport. If no :ref:`Control` has the cursor, returns null. @@ -2121,7 +2121,7 @@ Typically the leaf :ref:`Control` node or deepest level of the su .. rst-class:: classref-method -:ref:`bool` **gui_is_drag_successful**\ (\ ) |const| +:ref:`bool` **gui_is_drag_successful**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the drag operation is successful. @@ -2133,7 +2133,7 @@ Returns ``true`` if the drag operation is successful. .. rst-class:: classref-method -:ref:`bool` **gui_is_dragging**\ (\ ) |const| +:ref:`bool` **gui_is_dragging**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the viewport is currently performing a drag operation. @@ -2147,7 +2147,7 @@ Alternative to :ref:`Node.NOTIFICATION_DRAG_BEGIN` Removes the focus from the currently focused :ref:`Control` within this viewport. If no :ref:`Control` has the focus, does nothing. @@ -2159,7 +2159,7 @@ Removes the focus from the currently focused :ref:`Control` withi .. rst-class:: classref-method -:ref:`bool` **is_input_handled**\ (\ ) |const| +:ref:`bool` **is_input_handled**\ (\ ) |const| :ref:`🔗` Returns whether the current :ref:`InputEvent` has been handled. Input events are not handled until :ref:`set_input_as_handled` has been called during the lifetime of an :ref:`InputEvent`. @@ -2175,7 +2175,7 @@ If :ref:`handle_input_locally` is .. rst-class:: classref-method -|void| **push_input**\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) +|void| **push_input**\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) :ref:`🔗` Triggers the given ``event`` in this **Viewport**. This can be used to pass an :ref:`InputEvent` between viewports, or to locally apply inputs that were sent over the network or saved to a file. @@ -2207,7 +2207,7 @@ If none of the methods handle the event and :ref:`physics_object_picking`\ ) +|void| **push_text_input**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Helper method which calls the ``set_text()`` method on the currently focused :ref:`Control`, provided that it is defined (e.g. if the focused Control is :ref:`Button` or :ref:`LineEdit`). @@ -2219,7 +2219,7 @@ Helper method which calls the ``set_text()`` method on the currently focused :re .. rst-class:: classref-method -|void| **push_unhandled_input**\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) +|void| **push_unhandled_input**\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) :ref:`🔗` **Deprecated:** Use :ref:`push_input` instead. @@ -2249,7 +2249,7 @@ If none of the methods handle the event and :ref:`physics_object_picking`, enable\: :ref:`bool`\ ) +|void| **set_canvas_cull_mask_bit**\ (\ layer\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Set/clear individual bits on the rendering layer mask. This simplifies editing this **Viewport**'s layers. @@ -2261,7 +2261,7 @@ Set/clear individual bits on the rendering layer mask. This simplifies editing t .. rst-class:: classref-method -|void| **set_input_as_handled**\ (\ ) +|void| **set_input_as_handled**\ (\ ) :ref:`🔗` Stops the input from propagating further down the :ref:`SceneTree`. @@ -2275,7 +2275,7 @@ Stops the input from propagating further down the :ref:`SceneTree`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) +|void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) :ref:`🔗` Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible. @@ -2287,7 +2287,7 @@ Sets the number of subdivisions to use in the specified quadrant. A higher numbe .. rst-class:: classref-method -|void| **update_mouse_cursor_state**\ (\ ) +|void| **update_mouse_cursor_state**\ (\ ) :ref:`🔗` Force instantly updating the display based on the current mouse cursor position. This includes updating the mouse cursor shape and sending necessary :ref:`Control.mouse_entered`, :ref:`CollisionObject2D.mouse_entered`, :ref:`CollisionObject3D.mouse_entered` and :ref:`Window.mouse_entered` signals and their respective ``mouse_exited`` counterparts. @@ -2299,7 +2299,7 @@ Force instantly updating the display based on the current mouse cursor position. .. rst-class:: classref-method -|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) +|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) :ref:`🔗` Moves the mouse pointer to the specified position in this **Viewport** using the coordinate system of this **Viewport**. diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 8373e35c256..96387139a62 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`NodePath` **viewport_path** = ``NodePath("")`` +:ref:`NodePath` **viewport_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visibleonscreenenabler2d.rst b/classes/class_visibleonscreenenabler2d.rst index 73deed1f778..22bcbefea46 100644 --- a/classes/class_visibleonscreenenabler2d.rst +++ b/classes/class_visibleonscreenenabler2d.rst @@ -52,7 +52,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **EnableMode**: +enum **EnableMode**: :ref:`🔗` .. _class_VisibleOnScreenEnabler2D_constant_ENABLE_MODE_INHERIT: @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`EnableMode` **enable_mode** = ``0`` +:ref:`EnableMode` **enable_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ Determines how the target node is enabled. Corresponds to :ref:`ProcessMode` **enable_node_path** = ``NodePath("..")`` +:ref:`NodePath` **enable_node_path** = ``NodePath("..")`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visibleonscreenenabler3d.rst b/classes/class_visibleonscreenenabler3d.rst index b75dc63aac4..37ef22cf1c4 100644 --- a/classes/class_visibleonscreenenabler3d.rst +++ b/classes/class_visibleonscreenenabler3d.rst @@ -52,7 +52,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **EnableMode**: +enum **EnableMode**: :ref:`🔗` .. _class_VisibleOnScreenEnabler3D_constant_ENABLE_MODE_INHERIT: @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`EnableMode` **enable_mode** = ``0`` +:ref:`EnableMode` **enable_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ Determines how the target node is enabled. Corresponds to :ref:`ProcessMode` **enable_node_path** = ``NodePath("..")`` +:ref:`NodePath` **enable_node_path** = ``NodePath("..")`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visibleonscreennotifier2d.rst b/classes/class_visibleonscreennotifier2d.rst index 600c8dd3e14..37e3e0554ab 100644 --- a/classes/class_visibleonscreennotifier2d.rst +++ b/classes/class_visibleonscreennotifier2d.rst @@ -71,7 +71,7 @@ Signals .. rst-class:: classref-signal -**screen_entered**\ (\ ) +**screen_entered**\ (\ ) :ref:`🔗` Emitted when the VisibleOnScreenNotifier2D enters the screen. @@ -83,7 +83,7 @@ Emitted when the VisibleOnScreenNotifier2D enters the screen. .. rst-class:: classref-signal -**screen_exited**\ (\ ) +**screen_exited**\ (\ ) :ref:`🔗` Emitted when the VisibleOnScreenNotifier2D exits the screen. @@ -100,7 +100,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Rect2` **rect** = ``Rect2(-10, -10, 20, 20)`` +:ref:`Rect2` **rect** = ``Rect2(-10, -10, 20, 20)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -122,7 +122,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_on_screen**\ (\ ) |const| +:ref:`bool` **is_on_screen**\ (\ ) |const| :ref:`🔗` If ``true``, the bounding rectangle is on the screen. diff --git a/classes/class_visibleonscreennotifier3d.rst b/classes/class_visibleonscreennotifier3d.rst index ae3a2984d8d..d201ffa6166 100644 --- a/classes/class_visibleonscreennotifier3d.rst +++ b/classes/class_visibleonscreennotifier3d.rst @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**screen_entered**\ (\ ) +**screen_entered**\ (\ ) :ref:`🔗` Emitted when the **VisibleOnScreenNotifier3D** enters the screen. @@ -76,7 +76,7 @@ Emitted when the **VisibleOnScreenNotifier3D** enters the screen. .. rst-class:: classref-signal -**screen_exited**\ (\ ) +**screen_exited**\ (\ ) :ref:`🔗` Emitted when the **VisibleOnScreenNotifier3D** exits the screen. @@ -93,7 +93,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`AABB` **aabb** = ``AABB(-1, -1, -1, 2, 2, 2)`` +:ref:`AABB` **aabb** = ``AABB(-1, -1, -1, 2, 2, 2)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_on_screen**\ (\ ) |const| +:ref:`bool` **is_on_screen**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the bounding box is on the screen. diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index 1015a3dab94..3ff32cf6412 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -76,7 +76,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **layers** = ``1`` +:ref:`int` **layers** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -101,7 +101,7 @@ To adjust :ref:`layers` more easily usin .. rst-class:: classref-property -:ref:`float` **sorting_offset** = ``0.0`` +:ref:`float` **sorting_offset** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -118,7 +118,7 @@ The amount by which the depth of this **VisualInstance3D** will be adjusted when .. rst-class:: classref-property -:ref:`bool` **sorting_use_aabb_center** +:ref:`bool` **sorting_use_aabb_center** :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| +:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -156,7 +156,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **get_aabb**\ (\ ) |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| :ref:`🔗` Returns the :ref:`AABB` (also known as the bounding box) for this **VisualInstance3D**. @@ -168,7 +168,7 @@ Returns the :ref:`AABB` (also known as the bounding box) for this ** .. rst-class:: classref-method -:ref:`RID` **get_base**\ (\ ) |const| +:ref:`RID` **get_base**\ (\ ) |const| :ref:`🔗` Returns the RID of the resource associated with this **VisualInstance3D**. For example, if the Node is a :ref:`MeshInstance3D`, this will return the RID of the associated :ref:`Mesh`. @@ -180,7 +180,7 @@ Returns the RID of the resource associated with this **VisualInstance3D**. For e .. rst-class:: classref-method -:ref:`RID` **get_instance**\ (\ ) |const| +:ref:`RID` **get_instance**\ (\ ) |const| :ref:`🔗` Returns the RID of this instance. This RID is the same as the RID returned by :ref:`RenderingServer.instance_create`. This RID is needed if you want to call :ref:`RenderingServer` functions directly on this **VisualInstance3D**. @@ -192,7 +192,7 @@ Returns the RID of this instance. This RID is the same as the RID returned by :r .. rst-class:: classref-method -:ref:`bool` **get_layer_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| +:ref:`bool` **get_layer_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`layers` is enabled, given a ``layer_number`` between 1 and 20. @@ -204,7 +204,7 @@ Returns whether or not the specified layer of the :ref:`layers`\ ) +|void| **set_base**\ (\ base\: :ref:`RID`\ ) :ref:`🔗` Sets the resource that is instantiated by this **VisualInstance3D**, which changes how the engine handles the **VisualInstance3D** under the hood. Equivalent to :ref:`RenderingServer.instance_set_base`. @@ -216,7 +216,7 @@ Sets the resource that is instantiated by this **VisualInstance3D**, which chang .. rst-class:: classref-method -|void| **set_layer_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) +|void| **set_layer_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`layers`, given a ``layer_number`` between 1 and 20. diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 8ea6a2a9876..146d43726b4 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -103,7 +103,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Type**: +enum **Type**: :ref:`🔗` .. _class_VisualShader_constant_TYPE_VERTEX: @@ -201,7 +201,7 @@ Represents the size of the :ref:`Type` enum. .. rst-class:: classref-enumeration -enum **VaryingMode**: +enum **VaryingMode**: :ref:`🔗` .. _class_VisualShader_constant_VARYING_MODE_VERTEX_TO_FRAG_LIGHT: @@ -235,7 +235,7 @@ Represents the size of the :ref:`VaryingMode` enu .. rst-class:: classref-enumeration -enum **VaryingType**: +enum **VaryingType**: :ref:`🔗` .. _class_VisualShader_constant_VARYING_TYPE_FLOAT: @@ -322,7 +322,7 @@ Constants .. rst-class:: classref-constant -**NODE_ID_INVALID** = ``-1`` +**NODE_ID_INVALID** = ``-1`` :ref:`🔗` Indicates an invalid **VisualShader** node. @@ -330,7 +330,7 @@ Indicates an invalid **VisualShader** node. .. rst-class:: classref-constant -**NODE_ID_OUTPUT** = ``0`` +**NODE_ID_OUTPUT** = ``0`` :ref:`🔗` Indicates an output node of **VisualShader**. @@ -347,7 +347,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **graph_offset** = ``Vector2(0, 0)`` +:ref:`Vector2` **graph_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -369,7 +369,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_node**\ (\ type\: :ref:`Type`, node\: :ref:`VisualShaderNode`, position\: :ref:`Vector2`, id\: :ref:`int`\ ) +|void| **add_node**\ (\ type\: :ref:`Type`, node\: :ref:`VisualShaderNode`, position\: :ref:`Vector2`, id\: :ref:`int`\ ) :ref:`🔗` Adds the specified ``node`` to the shader. @@ -381,7 +381,7 @@ Adds the specified ``node`` to the shader. .. rst-class:: classref-method -|void| **add_varying**\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) +|void| **add_varying**\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) :ref:`🔗` Adds a new varying value node to the shader. @@ -393,7 +393,7 @@ Adds a new varying value node to the shader. .. rst-class:: classref-method -|void| **attach_node_to_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`, frame\: :ref:`int`\ ) +|void| **attach_node_to_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`, frame\: :ref:`int`\ ) :ref:`🔗` Attaches the given node to the given frame. @@ -405,7 +405,7 @@ Attaches the given node to the given frame. .. rst-class:: classref-method -:ref:`bool` **can_connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| +:ref:`bool` **can_connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified nodes and ports can be connected together. @@ -417,7 +417,7 @@ Returns ``true`` if the specified nodes and ports can be connected together. .. rst-class:: classref-method -:ref:`Error` **connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) +:ref:`Error` **connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) :ref:`🔗` Connects the specified nodes and ports. @@ -429,7 +429,7 @@ Connects the specified nodes and ports. .. rst-class:: classref-method -|void| **connect_nodes_forced**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) +|void| **connect_nodes_forced**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) :ref:`🔗` Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. @@ -441,7 +441,7 @@ Connects the specified nodes and ports, even if they can't be connected. Such co .. rst-class:: classref-method -|void| **detach_node_from_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) +|void| **detach_node_from_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) :ref:`🔗` Detaches the given node from the frame it is attached to. @@ -453,7 +453,7 @@ Detaches the given node from the frame it is attached to. .. rst-class:: classref-method -|void| **disconnect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) +|void| **disconnect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) :ref:`🔗` Connects the specified nodes and ports. @@ -465,7 +465,7 @@ Connects the specified nodes and ports. .. rst-class:: classref-method -:ref:`VisualShaderNode` **get_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| +:ref:`VisualShaderNode` **get_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the shader node instance with specified ``type`` and ``id``. @@ -477,7 +477,7 @@ Returns the shader node instance with specified ``type`` and ``id``. .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_node_connections**\ (\ type\: :ref:`Type`\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_node_connections**\ (\ type\: :ref:`Type`\ ) |const| :ref:`🔗` Returns the list of connected nodes with the specified type. @@ -489,7 +489,7 @@ Returns the list of connected nodes with the specified type. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_node_list**\ (\ type\: :ref:`Type`\ ) |const| +:ref:`PackedInt32Array` **get_node_list**\ (\ type\: :ref:`Type`\ ) |const| :ref:`🔗` Returns the list of all nodes in the shader with the specified type. @@ -501,7 +501,7 @@ Returns the list of all nodes in the shader with the specified type. .. rst-class:: classref-method -:ref:`Vector2` **get_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| +:ref:`Vector2` **get_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the specified node within the shader graph. @@ -513,7 +513,7 @@ Returns the position of the specified node within the shader graph. .. rst-class:: classref-method -:ref:`int` **get_valid_node_id**\ (\ type\: :ref:`Type`\ ) |const| +:ref:`int` **get_valid_node_id**\ (\ type\: :ref:`Type`\ ) |const| :ref:`🔗` Returns next valid node ID that can be added to the shader graph. @@ -525,7 +525,7 @@ Returns next valid node ID that can be added to the shader graph. .. rst-class:: classref-method -:ref:`bool` **has_varying**\ (\ name\: :ref:`String`\ ) |const| +:ref:`bool` **has_varying**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the shader has a varying with the given ``name``. @@ -537,7 +537,7 @@ Returns ``true`` if the shader has a varying with the given ``name``. .. rst-class:: classref-method -:ref:`bool` **is_node_connection**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| +:ref:`bool` **is_node_connection**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified node and port connection exist. @@ -549,7 +549,7 @@ Returns ``true`` if the specified node and port connection exist. .. rst-class:: classref-method -|void| **remove_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) +|void| **remove_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) :ref:`🔗` Removes the specified node from the shader. @@ -561,7 +561,7 @@ Removes the specified node from the shader. .. rst-class:: classref-method -|void| **remove_varying**\ (\ name\: :ref:`String`\ ) +|void| **remove_varying**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Removes a varying value node with the given ``name``. Prints an error if a node with this name is not found. @@ -573,7 +573,7 @@ Removes a varying value node with the given ``name``. Prints an error if a node .. rst-class:: classref-method -|void| **replace_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`, new_class\: :ref:`StringName`\ ) +|void| **replace_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`, new_class\: :ref:`StringName`\ ) :ref:`🔗` Replaces the specified node with a node of new class type. @@ -585,7 +585,7 @@ Replaces the specified node with a node of new class type. .. rst-class:: classref-method -|void| **set_mode**\ (\ mode\: :ref:`Mode`\ ) +|void| **set_mode**\ (\ mode\: :ref:`Mode`\ ) :ref:`🔗` Sets the mode of this shader. @@ -597,7 +597,7 @@ Sets the mode of this shader. .. rst-class:: classref-method -|void| **set_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`, position\: :ref:`Vector2`\ ) +|void| **set_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position of the specified node. diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 192a93916a4..33d49987758 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -81,7 +81,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **PortType**: +enum **PortType**: :ref:`🔗` .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR: @@ -176,7 +176,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **linked_parent_graph_frame** = ``-1`` +:ref:`int` **linked_parent_graph_frame** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ Represents the index of the frame this node is linked to. If set to ``-1`` the n .. rst-class:: classref-property -:ref:`int` **output_port_for_preview** = ``-1`` +:ref:`int` **output_port_for_preview** = ``-1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **clear_default_input_values**\ (\ ) +|void| **clear_default_input_values**\ (\ ) :ref:`🔗` Clears the default input ports value. @@ -227,7 +227,7 @@ Clears the default input ports value. .. rst-class:: classref-method -:ref:`int` **get_default_input_port**\ (\ type\: :ref:`PortType`\ ) |const| +:ref:`int` **get_default_input_port**\ (\ type\: :ref:`PortType`\ ) |const| :ref:`🔗` Returns the input port which should be connected by default when this node is created as a result of dragging a connection from an existing node to the empty space on the graph. @@ -239,7 +239,7 @@ Returns the input port which should be connected by default when this node is cr .. rst-class:: classref-method -:ref:`Array` **get_default_input_values**\ (\ ) |const| +:ref:`Array` **get_default_input_values**\ (\ ) |const| :ref:`🔗` Returns an :ref:`Array` containing default values for all of the input ports of the node in the form ``[index0, value0, index1, value1, ...]``. @@ -251,7 +251,7 @@ Returns an :ref:`Array` containing default values for all of the in .. rst-class:: classref-method -:ref:`Variant` **get_input_port_default_value**\ (\ port\: :ref:`int`\ ) |const| +:ref:`Variant` **get_input_port_default_value**\ (\ port\: :ref:`int`\ ) |const| :ref:`🔗` Returns the default value of the input ``port``. @@ -263,7 +263,7 @@ Returns the default value of the input ``port``. .. rst-class:: classref-method -|void| **remove_input_port_default_value**\ (\ port\: :ref:`int`\ ) +|void| **remove_input_port_default_value**\ (\ port\: :ref:`int`\ ) :ref:`🔗` Removes the default value of the input ``port``. @@ -275,7 +275,7 @@ Removes the default value of the input ``port``. .. rst-class:: classref-method -|void| **set_default_input_values**\ (\ values\: :ref:`Array`\ ) +|void| **set_default_input_values**\ (\ values\: :ref:`Array`\ ) :ref:`🔗` Sets the default input ports values using an :ref:`Array` of the form ``[index0, value0, index1, value1, ...]``. For example: ``[0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)]``. @@ -287,7 +287,7 @@ Sets the default input ports values using an :ref:`Array` of the fo .. rst-class:: classref-method -|void| **set_input_port_default_value**\ (\ port\: :ref:`int`, value\: :ref:`Variant`, prev_value\: :ref:`Variant` = null\ ) +|void| **set_input_port_default_value**\ (\ port\: :ref:`int`, value\: :ref:`Variant`, prev_value\: :ref:`Variant` = null\ ) :ref:`🔗` Sets the default ``value`` for the selected input ``port``. diff --git a/classes/class_visualshadernodebillboard.rst b/classes/class_visualshadernodebillboard.rst index 2a269a91276..5a03dc8074e 100644 --- a/classes/class_visualshadernodebillboard.rst +++ b/classes/class_visualshadernodebillboard.rst @@ -48,7 +48,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BillboardType**: +enum **BillboardType**: :ref:`🔗` .. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_DISABLED: @@ -103,7 +103,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BillboardType` **billboard_type** = ``1`` +:ref:`BillboardType` **billboard_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ Controls how the object faces the camera. See :ref:`BillboardType` **keep_scale** = ``false`` +:ref:`bool` **keep_scale** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 67911450e3a..4285bf08347 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **constant** = ``false`` +:ref:`bool` **constant** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodebooleanparameter.rst b/classes/class_visualshadernodebooleanparameter.rst index 2cf5f65b851..06823706a8a 100644 --- a/classes/class_visualshadernodebooleanparameter.rst +++ b/classes/class_visualshadernodebooleanparameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **default_value** = ``false`` +:ref:`bool` **default_value** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeclamp.rst b/classes/class_visualshadernodeclamp.rst index 3a08a2ef1b2..e1c114721e8 100644 --- a/classes/class_visualshadernodeclamp.rst +++ b/classes/class_visualshadernodeclamp.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeClamp_constant_OP_TYPE_FLOAT: @@ -117,7 +117,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index cdebaa66d4f..1fa8bcc8d28 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **constant** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **constant** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index cfcc484f2e1..42967c9bb50 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeColorFunc_constant_FUNC_GRAYSCALE: @@ -117,7 +117,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 4ff98196677..67d410f47df 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeColorOp_constant_OP_SCREEN: @@ -201,7 +201,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecolorparameter.rst b/classes/class_visualshadernodecolorparameter.rst index 51de02b4ace..e4411cb6031 100644 --- a/classes/class_visualshadernodecolorparameter.rst +++ b/classes/class_visualshadernodecolorparameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Color` **default_value** = ``Color(1, 1, 1, 1)`` +:ref:`Color` **default_value** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecomment.rst b/classes/class_visualshadernodecomment.rst index 53b8548056c..12f7d6f5246 100644 --- a/classes/class_visualshadernodecomment.rst +++ b/classes/class_visualshadernodecomment.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **description** = ``""`` +:ref:`String` **description** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index 025b7eccffd..2487b8d05c8 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ComparisonType**: +enum **ComparisonType**: :ref:`🔗` .. _class_VisualShaderNodeCompare_constant_CTYPE_SCALAR: @@ -132,7 +132,7 @@ Represents the size of the :ref:`ComparisonType` .. _class_VisualShaderNodeCompare_constant_FUNC_EQUAL: @@ -198,7 +198,7 @@ Represents the size of the :ref:`Function .. rst-class:: classref-enumeration -enum **Condition**: +enum **Condition**: :ref:`🔗` .. _class_VisualShaderNodeCompare_constant_COND_ALL: @@ -237,7 +237,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Condition` **condition** = ``0`` +:ref:`Condition` **condition** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -254,7 +254,7 @@ Extra condition which is applied if :ref:`type` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -271,7 +271,7 @@ A comparison function. See :ref:`Function .. rst-class:: classref-property -:ref:`ComparisonType` **type** = ``0`` +:ref:`ComparisonType` **type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 926ce3dbaf2..4e4b786940b 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Source**: +enum **Source**: :ref:`🔗` .. _class_VisualShaderNodeCubemap_constant_SOURCE_TEXTURE: @@ -84,7 +84,7 @@ Represents the size of the :ref:`Source` en .. rst-class:: classref-enumeration -enum **TextureType**: +enum **TextureType**: :ref:`🔗` .. _class_VisualShaderNodeCubemap_constant_TYPE_DATA: @@ -131,7 +131,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Cubemap` **cube_map** +:ref:`Cubemap` **cube_map** :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ The :ref:`Cubemap` texture to sample when using :ref:`SOURCE_TEXT .. rst-class:: classref-property -:ref:`Source` **source** = ``0`` +:ref:`Source` **source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -165,7 +165,7 @@ Defines which source should be used for the sampling. See :ref:`Source` **texture_type** = ``0`` +:ref:`TextureType` **texture_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecurvetexture.rst b/classes/class_visualshadernodecurvetexture.rst index 7c89c00dec6..efb32850105 100644 --- a/classes/class_visualshadernodecurvetexture.rst +++ b/classes/class_visualshadernodecurvetexture.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CurveTexture` **texture** +:ref:`CurveTexture` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecurvexyztexture.rst b/classes/class_visualshadernodecurvexyztexture.rst index df92c3d4a00..ad92c0fbc84 100644 --- a/classes/class_visualshadernodecurvexyztexture.rst +++ b/classes/class_visualshadernodecurvexyztexture.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CurveXYZTexture` **texture** +:ref:`CurveXYZTexture` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index b88fc312f0f..ff0cc375ad8 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_category**\ (\ ) |virtual| |const| +:ref:`String` **_get_category**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the path to the associated custom node in the Visual Shader Editor's members dialog. The path may look like ``"MyGame/MyFunctions/Noise"``. @@ -117,7 +117,7 @@ Defining this method is **optional**. If not overridden, the node will be filed .. rst-class:: classref-method -:ref:`String` **_get_code**\ (\ input_vars\: :ref:`Array`\[:ref:`String`\], output_vars\: :ref:`Array`\[:ref:`String`\], mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| +:ref:`String` **_get_code**\ (\ input_vars\: :ref:`Array`\[:ref:`String`\], output_vars\: :ref:`Array`\[:ref:`String`\], mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| :ref:`🔗` Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -137,7 +137,7 @@ Defining this method is **required**. .. rst-class:: classref-method -:ref:`int` **_get_default_input_port**\ (\ type\: :ref:`PortType`\ ) |virtual| |const| +:ref:`int` **_get_default_input_port**\ (\ type\: :ref:`PortType`\ ) |virtual| |const| :ref:`🔗` Override this method to define the input port which should be connected by default when this node is created as a result of dragging a connection from an existing node to the empty space on the graph. @@ -151,7 +151,7 @@ Defining this method is **optional**. If not overridden, the connection will be .. rst-class:: classref-method -:ref:`String` **_get_description**\ (\ ) |virtual| |const| +:ref:`String` **_get_description**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog. @@ -165,7 +165,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`String` **_get_func_code**\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| +:ref:`String` **_get_func_code**\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| :ref:`🔗` Override this method to add a shader code to the beginning of each shader function (once). The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -183,7 +183,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`String` **_get_global_code**\ (\ mode\: :ref:`Mode`\ ) |virtual| |const| +:ref:`String` **_get_global_code**\ (\ mode\: :ref:`Mode`\ ) |virtual| |const| :ref:`🔗` Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -201,7 +201,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`int` **_get_input_port_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_input_port_count**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the number of input ports of the associated custom node. @@ -215,7 +215,7 @@ Defining this method is **required**. If not overridden, the node has no input p .. rst-class:: classref-method -:ref:`Variant` **_get_input_port_default_value**\ (\ port\: :ref:`int`\ ) |virtual| |const| +:ref:`Variant` **_get_input_port_default_value**\ (\ port\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the default value for the specified input port. Prefer use this over :ref:`VisualShaderNode.set_input_port_default_value`. @@ -229,7 +229,7 @@ Defining this method is **required**. If not overridden, the node has no default .. rst-class:: classref-method -:ref:`String` **_get_input_port_name**\ (\ port\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_get_input_port_name**\ (\ port\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the ``input_vars`` array in :ref:`_get_code`. @@ -243,7 +243,7 @@ Defining this method is **optional**, but recommended. If not overridden, input .. rst-class:: classref-method -:ref:`PortType` **_get_input_port_type**\ (\ port\: :ref:`int`\ ) |virtual| |const| +:ref:`PortType` **_get_input_port_type**\ (\ port\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the returned type of each input port of the associated custom node (see :ref:`PortType` for possible types). @@ -257,7 +257,7 @@ Defining this method is **optional**, but recommended. If not overridden, input .. rst-class:: classref-method -:ref:`String` **_get_name**\ (\ ) |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the name of the associated custom node in the Visual Shader Editor's members dialog and graph. @@ -271,7 +271,7 @@ Defining this method is **optional**, but recommended. If not overridden, the no .. rst-class:: classref-method -:ref:`int` **_get_output_port_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_output_port_count**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the number of output ports of the associated custom node. @@ -285,7 +285,7 @@ Defining this method is **required**. If not overridden, the node has no output .. rst-class:: classref-method -:ref:`String` **_get_output_port_name**\ (\ port\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_get_output_port_name**\ (\ port\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the ``output_vars`` array in :ref:`_get_code`. @@ -299,7 +299,7 @@ Defining this method is **optional**, but recommended. If not overridden, output .. rst-class:: classref-method -:ref:`PortType` **_get_output_port_type**\ (\ port\: :ref:`int`\ ) |virtual| |const| +:ref:`PortType` **_get_output_port_type**\ (\ port\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the returned type of each output port of the associated custom node (see :ref:`PortType` for possible types). @@ -313,7 +313,7 @@ Defining this method is **optional**, but recommended. If not overridden, output .. rst-class:: classref-method -:ref:`int` **_get_property_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_property_count**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the number of the properties. @@ -327,7 +327,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`int` **_get_property_default_index**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`int` **_get_property_default_index**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the default index of the property of the associated custom node. @@ -341,7 +341,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`String` **_get_property_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`String` **_get_property_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the names of the property of the associated custom node. @@ -355,7 +355,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_property_options**\ (\ index\: :ref:`int`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_property_options**\ (\ index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Override this method to define the options inside the drop-down list property of the associated custom node. @@ -369,7 +369,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`PortType` **_get_return_icon_type**\ (\ ) |virtual| |const| +:ref:`PortType` **_get_return_icon_type**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to define the return icon of the associated custom node in the Visual Shader Editor's members dialog. @@ -383,7 +383,7 @@ Defining this method is **optional**. If not overridden, no return icon is shown .. rst-class:: classref-method -:ref:`bool` **_is_available**\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| +:ref:`bool` **_is_available**\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| :ref:`🔗` Override this method to prevent the node to be visible in the member dialog for the certain ``mode`` (see :ref:`Mode`) and/or ``type`` (see :ref:`Type`). @@ -397,7 +397,7 @@ Defining this method is **optional**. If not overridden, it's ``true``. .. rst-class:: classref-method -:ref:`bool` **_is_highend**\ (\ ) |virtual| |const| +:ref:`bool` **_is_highend**\ (\ ) |virtual| |const| :ref:`🔗` Override this method to enable high-end mark in the Visual Shader Editor's members dialog. @@ -411,7 +411,7 @@ Defining this method is **optional**. If not overridden, it's ``false``. .. rst-class:: classref-method -:ref:`int` **get_option_index**\ (\ option\: :ref:`int`\ ) |const| +:ref:`int` **get_option_index**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the selected index of the drop-down list option within a graph. You may use this function to define the specific behavior in the :ref:`_get_code` or :ref:`_get_global_code`. diff --git a/classes/class_visualshadernodederivativefunc.rst b/classes/class_visualshadernodederivativefunc.rst index 07a98340ff5..4d0dfa7ca9e 100644 --- a/classes/class_visualshadernodederivativefunc.rst +++ b/classes/class_visualshadernodederivativefunc.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeDerivativeFunc_constant_OP_TYPE_SCALAR: @@ -100,7 +100,7 @@ Represents the size of the :ref:`OpType` .. _class_VisualShaderNodeDerivativeFunc_constant_FUNC_SUM: @@ -142,7 +142,7 @@ Represents the size of the :ref:`Function` .. _class_VisualShaderNodeDerivativeFunc_constant_PRECISION_NONE: @@ -189,7 +189,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -206,7 +206,7 @@ A derivative function type. See :ref:`Function` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -223,7 +223,7 @@ A type of operands and returned value. See :ref:`OpType` **precision** = ``0`` +:ref:`Precision` **precision** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 67d2955e1aa..08065ad3816 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **expression** = ``""`` +:ref:`String` **expression** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodefloatconstant.rst b/classes/class_visualshadernodefloatconstant.rst index b1a924bad7e..2e96c00d120 100644 --- a/classes/class_visualshadernodefloatconstant.rst +++ b/classes/class_visualshadernodefloatconstant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **constant** = ``0.0`` +:ref:`float` **constant** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodefloatfunc.rst b/classes/class_visualshadernodefloatfunc.rst index cc7cb528aa7..1cad1d664b6 100644 --- a/classes/class_visualshadernodefloatfunc.rst +++ b/classes/class_visualshadernodefloatfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIN: @@ -325,7 +325,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``13`` +:ref:`Function` **function** = ``13`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodefloatop.rst b/classes/class_visualshadernodefloatop.rst index 2c23cd62076..7a1c5510641 100644 --- a/classes/class_visualshadernodefloatop.rst +++ b/classes/class_visualshadernodefloatop.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeFloatOp_constant_OP_ADD: @@ -149,7 +149,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodefloatparameter.rst b/classes/class_visualshadernodefloatparameter.rst index 0e10f870248..56c7e822f25 100644 --- a/classes/class_visualshadernodefloatparameter.rst +++ b/classes/class_visualshadernodefloatparameter.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Hint**: +enum **Hint**: :ref:`🔗` .. _class_VisualShaderNodeFloatParameter_constant_HINT_NONE: @@ -103,7 +103,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **default_value** = ``0.0`` +:ref:`float` **default_value** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ Enables usage of the :ref:`default_value` **hint** = ``0`` +:ref:`Hint` **hint** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ A hint applied to the uniform, which controls the values it can take when set th .. rst-class:: classref-property -:ref:`float` **max** = ``1.0`` +:ref:`float` **max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ Minimum value for range hints. Used if :ref:`hint` **min** = ``0.0`` +:ref:`float` **min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ Maximum value for range hints. Used if :ref:`hint` **step** = ``0.1`` +:ref:`float` **step** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeframe.rst b/classes/class_visualshadernodeframe.rst index 800da319f88..631c7480d60 100644 --- a/classes/class_visualshadernodeframe.rst +++ b/classes/class_visualshadernodeframe.rst @@ -74,7 +74,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedInt32Array` **attached_nodes** = ``PackedInt32Array()`` +:ref:`PackedInt32Array` **attached_nodes** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -93,7 +93,7 @@ The list of nodes attached to the frame. .. rst-class:: classref-property -:ref:`bool` **autoshrink** = ``true`` +:ref:`bool` **autoshrink** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -110,7 +110,7 @@ If ``true``, the frame will automatically resize to enclose all attached nodes. .. rst-class:: classref-property -:ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` +:ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -127,7 +127,7 @@ The color of the frame when :ref:`tint_color_enabled` **tint_color_enabled** = ``false`` +:ref:`bool` **tint_color_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -144,7 +144,7 @@ If ``true``, the frame will be tinted with the color specified in :ref:`tint_col .. rst-class:: classref-property -:ref:`String` **title** = ``"Title"`` +:ref:`String` **title** = ``"Title"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -166,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_attached_node**\ (\ node\: :ref:`int`\ ) +|void| **add_attached_node**\ (\ node\: :ref:`int`\ ) :ref:`🔗` Adds a node to the list of nodes attached to the frame. Should not be called directly, use the :ref:`VisualShader.attach_node_to_frame` method instead. @@ -178,7 +178,7 @@ Adds a node to the list of nodes attached to the frame. Should not be called dir .. rst-class:: classref-method -|void| **remove_attached_node**\ (\ node\: :ref:`int`\ ) +|void| **remove_attached_node**\ (\ node\: :ref:`int`\ ) :ref:`🔗` Removes a node from the list of nodes attached to the frame. Should not be called directly, use the :ref:`VisualShader.detach_node_from_frame` method instead. diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index d736022fbc8..ea0c2a97dc5 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_input_port**\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) +|void| **add_input_port**\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Adds an input port with the specified ``type`` (see :ref:`PortType`) and ``name``. @@ -100,7 +100,7 @@ Adds an input port with the specified ``type`` (see :ref:`PortType`, type\: :ref:`int`, name\: :ref:`String`\ ) +|void| **add_output_port**\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Adds an output port with the specified ``type`` (see :ref:`PortType`) and ``name``. @@ -112,7 +112,7 @@ Adds an output port with the specified ``type`` (see :ref:`PortType` Removes all previously specified input ports. @@ -124,7 +124,7 @@ Removes all previously specified input ports. .. rst-class:: classref-method -|void| **clear_output_ports**\ (\ ) +|void| **clear_output_ports**\ (\ ) :ref:`🔗` Removes all previously specified output ports. @@ -136,7 +136,7 @@ Removes all previously specified output ports. .. rst-class:: classref-method -:ref:`int` **get_free_input_port_id**\ (\ ) |const| +:ref:`int` **get_free_input_port_id**\ (\ ) |const| :ref:`🔗` Returns a free input port ID which can be used in :ref:`add_input_port`. @@ -148,7 +148,7 @@ Returns a free input port ID which can be used in :ref:`add_input_port` **get_free_output_port_id**\ (\ ) |const| +:ref:`int` **get_free_output_port_id**\ (\ ) |const| :ref:`🔗` Returns a free output port ID which can be used in :ref:`add_output_port`. @@ -160,7 +160,7 @@ Returns a free output port ID which can be used in :ref:`add_output_port` **get_input_port_count**\ (\ ) |const| +:ref:`int` **get_input_port_count**\ (\ ) |const| :ref:`🔗` Returns the number of input ports in use. Alternative for :ref:`get_free_input_port_id`. @@ -172,7 +172,7 @@ Returns the number of input ports in use. Alternative for :ref:`get_free_input_p .. rst-class:: classref-method -:ref:`String` **get_inputs**\ (\ ) |const| +:ref:`String` **get_inputs**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` description of the input ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port`). @@ -184,7 +184,7 @@ Returns a :ref:`String` description of the input ports as a colon- .. rst-class:: classref-method -:ref:`int` **get_output_port_count**\ (\ ) |const| +:ref:`int` **get_output_port_count**\ (\ ) |const| :ref:`🔗` Returns the number of output ports in use. Alternative for :ref:`get_free_output_port_id`. @@ -196,7 +196,7 @@ Returns the number of output ports in use. Alternative for :ref:`get_free_output .. rst-class:: classref-method -:ref:`String` **get_outputs**\ (\ ) |const| +:ref:`String` **get_outputs**\ (\ ) |const| :ref:`🔗` Returns a :ref:`String` description of the output ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_output_port`). @@ -208,7 +208,7 @@ Returns a :ref:`String` description of the output ports as a colon .. rst-class:: classref-method -:ref:`bool` **has_input_port**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **has_input_port**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified input port exists. @@ -220,7 +220,7 @@ Returns ``true`` if the specified input port exists. .. rst-class:: classref-method -:ref:`bool` **has_output_port**\ (\ id\: :ref:`int`\ ) |const| +:ref:`bool` **has_output_port**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified output port exists. @@ -232,7 +232,7 @@ Returns ``true`` if the specified output port exists. .. rst-class:: classref-method -:ref:`bool` **is_valid_port_name**\ (\ name\: :ref:`String`\ ) |const| +:ref:`bool` **is_valid_port_name**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader. @@ -244,7 +244,7 @@ Returns ``true`` if the specified port name does not override an existed port na .. rst-class:: classref-method -|void| **remove_input_port**\ (\ id\: :ref:`int`\ ) +|void| **remove_input_port**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the specified input port. @@ -256,7 +256,7 @@ Removes the specified input port. .. rst-class:: classref-method -|void| **remove_output_port**\ (\ id\: :ref:`int`\ ) +|void| **remove_output_port**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the specified output port. @@ -268,7 +268,7 @@ Removes the specified output port. .. rst-class:: classref-method -|void| **set_input_port_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_input_port_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Renames the specified input port. @@ -280,7 +280,7 @@ Renames the specified input port. .. rst-class:: classref-method -|void| **set_input_port_type**\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) +|void| **set_input_port_type**\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) :ref:`🔗` Sets the specified input port's type (see :ref:`PortType`). @@ -292,7 +292,7 @@ Sets the specified input port's type (see :ref:`PortType`\ ) +|void| **set_inputs**\ (\ inputs\: :ref:`String`\ ) :ref:`🔗` Defines all input ports using a :ref:`String` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_input_port`). @@ -304,7 +304,7 @@ Defines all input ports using a :ref:`String` formatted as a colon .. rst-class:: classref-method -|void| **set_output_port_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) +|void| **set_output_port_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Renames the specified output port. @@ -316,7 +316,7 @@ Renames the specified output port. .. rst-class:: classref-method -|void| **set_output_port_type**\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) +|void| **set_output_port_type**\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) :ref:`🔗` Sets the specified output port's type (see :ref:`PortType`). @@ -328,7 +328,7 @@ Sets the specified output port's type (see :ref:`PortType`\ ) +|void| **set_outputs**\ (\ outputs\: :ref:`String`\ ) :ref:`🔗` Defines all output ports using a :ref:`String` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_output_port`). diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index da30088329a..e4c41f7a9bd 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -65,7 +65,7 @@ Signals .. rst-class:: classref-signal -**input_type_changed**\ (\ ) +**input_type_changed**\ (\ ) :ref:`🔗` Emitted when input is changed via :ref:`input_name`. @@ -82,7 +82,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **input_name** = ``"[None]"`` +:ref:`String` **input_name** = ``"[None]"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -104,7 +104,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_input_real_name**\ (\ ) |const| +:ref:`String` **get_input_real_name**\ (\ ) |const| :ref:`🔗` Returns a translated name of the current constant in the Godot Shader Language. E.g. ``"ALBEDO"`` if the :ref:`input_name` equal to ``"albedo"``. diff --git a/classes/class_visualshadernodeintconstant.rst b/classes/class_visualshadernodeintconstant.rst index e8cfcf8b13e..cd50e99231e 100644 --- a/classes/class_visualshadernodeintconstant.rst +++ b/classes/class_visualshadernodeintconstant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **constant** = ``0`` +:ref:`int` **constant** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeintfunc.rst b/classes/class_visualshadernodeintfunc.rst index b8c58f7349e..4b34e4100ac 100644 --- a/classes/class_visualshadernodeintfunc.rst +++ b/classes/class_visualshadernodeintfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeIntFunc_constant_FUNC_ABS: @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``2`` +:ref:`Function` **function** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeintop.rst b/classes/class_visualshadernodeintop.rst index 3e9e7845f27..fd93ba00ca5 100644 --- a/classes/class_visualshadernodeintop.rst +++ b/classes/class_visualshadernodeintop.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeIntOp_constant_OP_ADD: @@ -165,7 +165,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeintparameter.rst b/classes/class_visualshadernodeintparameter.rst index e8e0bddf616..ee79ad55fc1 100644 --- a/classes/class_visualshadernodeintparameter.rst +++ b/classes/class_visualshadernodeintparameter.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Hint**: +enum **Hint**: :ref:`🔗` .. _class_VisualShaderNodeIntParameter_constant_HINT_NONE: @@ -103,7 +103,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **default_value** = ``0`` +:ref:`int` **default_value** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -120,7 +120,7 @@ Default value of this parameter, which will be used if not set externally. :ref: .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -137,7 +137,7 @@ If ``true``, the node will have a custom default value. .. rst-class:: classref-property -:ref:`Hint` **hint** = ``0`` +:ref:`Hint` **hint** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ Range hint of this node. Use it to customize valid parameter range. .. rst-class:: classref-property -:ref:`int` **max** = ``100`` +:ref:`int` **max** = ``100`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -171,7 +171,7 @@ The maximum value this parameter can take. :ref:`hint` **min** = ``0`` +:ref:`int` **min** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -188,7 +188,7 @@ The minimum value this parameter can take. :ref:`hint` **step** = ``1`` +:ref:`int` **step** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index 528673cc892..a065e952386 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeIs_constant_FUNC_IS_INF: @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodemix.rst b/classes/class_visualshadernodemix.rst index 417868dfdbe..cef04a386d5 100644 --- a/classes/class_visualshadernodemix.rst +++ b/classes/class_visualshadernodemix.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeMix_constant_OP_TYPE_SCALAR: @@ -125,7 +125,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodemultiplyadd.rst b/classes/class_visualshadernodemultiplyadd.rst index 7b8d20ffeb6..bbf6a9ababb 100644 --- a/classes/class_visualshadernodemultiplyadd.rst +++ b/classes/class_visualshadernodemultiplyadd.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_SCALAR: @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparameter.rst b/classes/class_visualshadernodeparameter.rst index 48ff3188759..4bb90905f30 100644 --- a/classes/class_visualshadernodeparameter.rst +++ b/classes/class_visualshadernodeparameter.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Qualifier**: +enum **Qualifier**: :ref:`🔗` .. _class_VisualShaderNodeParameter_constant_QUAL_NONE: @@ -97,7 +97,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **parameter_name** = ``""`` +:ref:`String` **parameter_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ Name of the parameter, by which it can be accessed through the :ref:`ShaderMater .. rst-class:: classref-property -:ref:`Qualifier` **qualifier** = ``0`` +:ref:`Qualifier` **qualifier** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparameterref.rst b/classes/class_visualshadernodeparameterref.rst index 41c07629e3e..b7fccd267f9 100644 --- a/classes/class_visualshadernodeparameterref.rst +++ b/classes/class_visualshadernodeparameterref.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **parameter_name** = ``"[None]"`` +:ref:`String` **parameter_name** = ``"[None]"`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparticleaccelerator.rst b/classes/class_visualshadernodeparticleaccelerator.rst index bf66312b4cf..04472674966 100644 --- a/classes/class_visualshadernodeparticleaccelerator.rst +++ b/classes/class_visualshadernodeparticleaccelerator.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_VisualShaderNodeParticleAccelerator_constant_MODE_LINEAR: @@ -93,7 +93,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Mode` **mode** = ``0`` +:ref:`Mode` **mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparticleemit.rst b/classes/class_visualshadernodeparticleemit.rst index b43119d340e..097848741f8 100644 --- a/classes/class_visualshadernodeparticleemit.rst +++ b/classes/class_visualshadernodeparticleemit.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **EmitFlags**: +enum **EmitFlags**: :ref:`🔗` .. _class_VisualShaderNodeParticleEmit_constant_EMIT_FLAG_POSITION: @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`EmitFlags` **flags** = ``31`` +:ref:`EmitFlags` **flags** = ``31`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparticleemitter.rst b/classes/class_visualshadernodeparticleemitter.rst index 6d9320036a1..d865211d4d3 100644 --- a/classes/class_visualshadernodeparticleemitter.rst +++ b/classes/class_visualshadernodeparticleemitter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **mode_2d** = ``false`` +:ref:`bool` **mode_2d** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparticlemeshemitter.rst b/classes/class_visualshadernodeparticlemeshemitter.rst index fc44b4f07eb..0d02ceafc18 100644 --- a/classes/class_visualshadernodeparticlemeshemitter.rst +++ b/classes/class_visualshadernodeparticlemeshemitter.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Mesh` **mesh** +:ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ The :ref:`Mesh` that defines emission shape. .. rst-class:: classref-property -:ref:`int` **surface_index** = ``0`` +:ref:`int` **surface_index** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -84,7 +84,7 @@ Index of the surface that emits particles. :ref:`use_all_surfaces` **use_all_surfaces** = ``true`` +:ref:`bool` **use_all_surfaces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst index f81b1a60417..91c8dfb79ae 100644 --- a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst +++ b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **degrees_mode** = ``true`` +:ref:`bool` **degrees_mode** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeparticlerandomness.rst b/classes/class_visualshadernodeparticlerandomness.rst index 4532ce944e9..6cbcea20b70 100644 --- a/classes/class_visualshadernodeparticlerandomness.rst +++ b/classes/class_visualshadernodeparticlerandomness.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeParticleRandomness_constant_OP_TYPE_SCALAR: @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodereroute.rst b/classes/class_visualshadernodereroute.rst index dd5bddfdf67..7d8d7ee33f4 100644 --- a/classes/class_visualshadernodereroute.rst +++ b/classes/class_visualshadernodereroute.rst @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PortType` **get_port_type**\ (\ ) |const| +:ref:`PortType` **get_port_type**\ (\ ) |const| :ref:`🔗` Returns the port type of the reroute node. diff --git a/classes/class_visualshadernoderesizablebase.rst b/classes/class_visualshadernoderesizablebase.rst index 656712c60bc..083ce0d4aad 100644 --- a/classes/class_visualshadernoderesizablebase.rst +++ b/classes/class_visualshadernoderesizablebase.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **size** = ``Vector2(0, 0)`` +:ref:`Vector2` **size** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodesample3d.rst b/classes/class_visualshadernodesample3d.rst index ec39b02d7fa..6b3417702af 100644 --- a/classes/class_visualshadernodesample3d.rst +++ b/classes/class_visualshadernodesample3d.rst @@ -48,7 +48,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Source**: +enum **Source**: :ref:`🔗` .. _class_VisualShaderNodeSample3D_constant_SOURCE_TEXTURE: @@ -87,7 +87,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Source` **source** = ``0`` +:ref:`Source` **source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodesmoothstep.rst b/classes/class_visualshadernodesmoothstep.rst index e46396e9989..794bdbf9e7b 100644 --- a/classes/class_visualshadernodesmoothstep.rst +++ b/classes/class_visualshadernodesmoothstep.rst @@ -48,7 +48,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_SCALAR: @@ -127,7 +127,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodestep.rst b/classes/class_visualshadernodestep.rst index 37bd020cc5b..5f80ee06571 100644 --- a/classes/class_visualshadernodestep.rst +++ b/classes/class_visualshadernodestep.rst @@ -48,7 +48,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeStep_constant_OP_TYPE_SCALAR: @@ -127,7 +127,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index 19bb6a10f7e..4bed971b6e1 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_FLOAT: @@ -133,7 +133,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``0`` +:ref:`OpType` **op_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 6db824931e1..7f028b5616b 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -50,7 +50,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Source**: +enum **Source**: :ref:`🔗` .. _class_VisualShaderNodeTexture_constant_SOURCE_TEXTURE: @@ -132,7 +132,7 @@ Represents the size of the :ref:`Source` en .. rst-class:: classref-enumeration -enum **TextureType**: +enum **TextureType**: :ref:`🔗` .. _class_VisualShaderNodeTexture_constant_TYPE_DATA: @@ -179,7 +179,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Source` **source** = ``0`` +:ref:`Source` **source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -196,7 +196,7 @@ Determines the source for the lookup. See :ref:`Source` **texture** +:ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ The source texture, if needed for the selected :ref:`source` **texture_type** = ``0`` +:ref:`TextureType` **texture_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetexture2darray.rst b/classes/class_visualshadernodetexture2darray.rst index 8ee1cc5282d..3b725a70229 100644 --- a/classes/class_visualshadernodetexture2darray.rst +++ b/classes/class_visualshadernodetexture2darray.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture2DArray` **texture_array** +:ref:`Texture2DArray` **texture_array** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetexture3d.rst b/classes/class_visualshadernodetexture3d.rst index 5778c9284f9..5b0ab9bc369 100644 --- a/classes/class_visualshadernodetexture3d.rst +++ b/classes/class_visualshadernodetexture3d.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Texture3D` **texture** +:ref:`Texture3D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetextureparameter.rst b/classes/class_visualshadernodetextureparameter.rst index 48cfda22939..6fef60d77f9 100644 --- a/classes/class_visualshadernodetextureparameter.rst +++ b/classes/class_visualshadernodetextureparameter.rst @@ -56,7 +56,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TextureType**: +enum **TextureType**: :ref:`🔗` .. _class_VisualShaderNodeTextureParameter_constant_TYPE_DATA: @@ -106,7 +106,7 @@ Represents the size of the :ref:`TextureType` .. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_WHITE: @@ -148,7 +148,7 @@ Represents the size of the :ref:`ColorDefault` .. _class_VisualShaderNodeTextureParameter_constant_FILTER_DEFAULT: @@ -230,7 +230,7 @@ Represents the size of the :ref:`TextureFilter` .. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DEFAULT: @@ -272,7 +272,7 @@ Represents the size of the :ref:`TextureRepeat` .. _class_VisualShaderNodeTextureParameter_constant_SOURCE_NONE: @@ -327,7 +327,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`ColorDefault` **color_default** = ``0`` +:ref:`ColorDefault` **color_default** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -344,7 +344,7 @@ Sets the default color if no texture is assigned to the uniform. .. rst-class:: classref-property -:ref:`TextureFilter` **texture_filter** = ``0`` +:ref:`TextureFilter` **texture_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -361,7 +361,7 @@ Sets the texture filtering mode. See :ref:`TextureFilter` **texture_repeat** = ``0`` +:ref:`TextureRepeat` **texture_repeat** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -378,7 +378,7 @@ Sets the texture repeating mode. See :ref:`TextureRepeat` **texture_source** = ``0`` +:ref:`TextureSource` **texture_source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -395,7 +395,7 @@ Sets the texture source mode. Used for reading from the screen, depth, or normal .. rst-class:: classref-property -:ref:`TextureType` **texture_type** = ``0`` +:ref:`TextureType` **texture_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index e917e8516b1..ce0a2578985 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Transform3D` **constant** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **constant** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index 428671f4bd9..25ebffe71a9 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeTransformFunc_constant_FUNC_INVERSE: @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetransformop.rst b/classes/class_visualshadernodetransformop.rst index 8b879cc972c..9c0f8ee792e 100644 --- a/classes/class_visualshadernodetransformop.rst +++ b/classes/class_visualshadernodetransformop.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeTransformOp_constant_OP_AxB: @@ -141,7 +141,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetransformparameter.rst b/classes/class_visualshadernodetransformparameter.rst index b903cd3938a..89856467f6f 100644 --- a/classes/class_visualshadernodetransformparameter.rst +++ b/classes/class_visualshadernodetransformparameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Transform3D` **default_value** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **default_value** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 206b45bdafc..722cf0c4984 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeTransformVecMult_constant_OP_AxB: @@ -101,7 +101,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeuintconstant.rst b/classes/class_visualshadernodeuintconstant.rst index e22605acda3..d458e4061cd 100644 --- a/classes/class_visualshadernodeuintconstant.rst +++ b/classes/class_visualshadernodeuintconstant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **constant** = ``0`` +:ref:`int` **constant** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeuintfunc.rst b/classes/class_visualshadernodeuintfunc.rst index f38c9961641..c13c5407368 100644 --- a/classes/class_visualshadernodeuintfunc.rst +++ b/classes/class_visualshadernodeuintfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeUIntFunc_constant_FUNC_NEGATE: @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeuintop.rst b/classes/class_visualshadernodeuintop.rst index 69c39a439f8..2e1b7d52c6d 100644 --- a/classes/class_visualshadernodeuintop.rst +++ b/classes/class_visualshadernodeuintop.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeUIntOp_constant_OP_ADD: @@ -165,7 +165,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeuintparameter.rst b/classes/class_visualshadernodeuintparameter.rst index f8bcf479609..d16711c5f00 100644 --- a/classes/class_visualshadernodeuintparameter.rst +++ b/classes/class_visualshadernodeuintparameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`int` **default_value** = ``0`` +:ref:`int` **default_value** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ Default value of this parameter, which will be used if not set externally. :ref: .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodeuvfunc.rst b/classes/class_visualshadernodeuvfunc.rst index 094935829d7..a66ed3c36a6 100644 --- a/classes/class_visualshadernodeuvfunc.rst +++ b/classes/class_visualshadernodeuvfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeUVFunc_constant_FUNC_PANNING: @@ -85,7 +85,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevarying.rst b/classes/class_visualshadernodevarying.rst index 90ec47e3583..0cbdfbf4bbb 100644 --- a/classes/class_visualshadernodevarying.rst +++ b/classes/class_visualshadernodevarying.rst @@ -50,7 +50,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **varying_name** = ``"[None]"`` +:ref:`String` **varying_name** = ``"[None]"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ Name of the variable. Must be unique. .. rst-class:: classref-property -:ref:`VaryingType` **varying_type** = ``0`` +:ref:`VaryingType` **varying_type** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevec2constant.rst b/classes/class_visualshadernodevec2constant.rst index 45f5defe33e..e7393756169 100644 --- a/classes/class_visualshadernodevec2constant.rst +++ b/classes/class_visualshadernodevec2constant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **constant** = ``Vector2(0, 0)`` +:ref:`Vector2` **constant** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevec2parameter.rst b/classes/class_visualshadernodevec2parameter.rst index 9c3f64db9d2..d7f58109d4e 100644 --- a/classes/class_visualshadernodevec2parameter.rst +++ b/classes/class_visualshadernodevec2parameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector2` **default_value** = ``Vector2(0, 0)`` +:ref:`Vector2` **default_value** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 422e82575d3..ca898b18955 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **constant** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **constant** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevec3parameter.rst b/classes/class_visualshadernodevec3parameter.rst index ebe66761406..ee1c6f96bbf 100644 --- a/classes/class_visualshadernodevec3parameter.rst +++ b/classes/class_visualshadernodevec3parameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **default_value** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **default_value** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevec4constant.rst b/classes/class_visualshadernodevec4constant.rst index b89af0919d3..d53d379cc1d 100644 --- a/classes/class_visualshadernodevec4constant.rst +++ b/classes/class_visualshadernodevec4constant.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Quaternion` **constant** = ``Quaternion(0, 0, 0, 1)`` +:ref:`Quaternion` **constant** = ``Quaternion(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevec4parameter.rst b/classes/class_visualshadernodevec4parameter.rst index 6f42a6fe82a..7a5147e1006 100644 --- a/classes/class_visualshadernodevec4parameter.rst +++ b/classes/class_visualshadernodevec4parameter.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector4` **default_value** = ``Vector4(0, 0, 0, 0)`` +:ref:`Vector4` **default_value** = ``Vector4(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -65,7 +65,7 @@ A default value to be assigned within the shader. .. rst-class:: classref-property -:ref:`bool` **default_value_enabled** = ``false`` +:ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevectorbase.rst b/classes/class_visualshadernodevectorbase.rst index 80e39582ff1..331aa2d43ea 100644 --- a/classes/class_visualshadernodevectorbase.rst +++ b/classes/class_visualshadernodevectorbase.rst @@ -48,7 +48,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **OpType**: +enum **OpType**: :ref:`🔗` .. _class_VisualShaderNodeVectorBase_constant_OP_TYPE_VECTOR_2D: @@ -95,7 +95,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`OpType` **op_type** = ``1`` +:ref:`OpType` **op_type** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 21b2347a537..b1e437c1a9e 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Function**: +enum **Function**: :ref:`🔗` .. _class_VisualShaderNodeVectorFunc_constant_FUNC_NORMALIZE: @@ -333,7 +333,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Function` **function** = ``0`` +:ref:`Function` **function** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index f6884874a26..a83763e58f8 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -46,7 +46,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Operator**: +enum **Operator**: :ref:`🔗` .. _class_VisualShaderNodeVectorOp_constant_OP_ADD: @@ -165,7 +165,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Operator` **operator** = ``0`` +:ref:`Operator` **operator** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_voxelgi.rst b/classes/class_voxelgi.rst index 7e07e410c73..e473c3bdce0 100644 --- a/classes/class_voxelgi.rst +++ b/classes/class_voxelgi.rst @@ -83,7 +83,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Subdiv**: +enum **Subdiv**: :ref:`🔗` .. _class_VoxelGI_constant_SUBDIV_64: @@ -138,7 +138,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CameraAttributes` **camera_attributes** +:ref:`CameraAttributes` **camera_attributes** :ref:`🔗` .. rst-class:: classref-property-setget @@ -155,7 +155,7 @@ The :ref:`CameraAttributes` resource that specifies expo .. rst-class:: classref-property -:ref:`VoxelGIData` **data** +:ref:`VoxelGIData` **data** :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ The :ref:`VoxelGIData` resource that holds the data for this .. rst-class:: classref-property -:ref:`Vector3` **size** = ``Vector3(20, 20, 20)`` +:ref:`Vector3` **size** = ``Vector3(20, 20, 20)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -191,7 +191,7 @@ The size of the area covered by the **VoxelGI**. If you make the size larger wit .. rst-class:: classref-property -:ref:`Subdiv` **subdiv** = ``1`` +:ref:`Subdiv` **subdiv** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -213,7 +213,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **bake**\ (\ from_node\: :ref:`Node` = null, create_visual_debug\: :ref:`bool` = false\ ) +|void| **bake**\ (\ from_node\: :ref:`Node` = null, create_visual_debug\: :ref:`bool` = false\ ) :ref:`🔗` Bakes the effect from all :ref:`GeometryInstance3D`\ s marked with :ref:`GeometryInstance3D.GI_MODE_STATIC` and :ref:`Light3D`\ s marked with either :ref:`Light3D.BAKE_STATIC` or :ref:`Light3D.BAKE_DYNAMIC`. If ``create_visual_debug`` is ``true``, after baking the light, this will generate a :ref:`MultiMesh` that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the **VoxelGI**'s data and debug any issues that may be occurring. @@ -229,7 +229,7 @@ Bakes the effect from all :ref:`GeometryInstance3D`\ s .. rst-class:: classref-method -|void| **debug_bake**\ (\ ) +|void| **debug_bake**\ (\ ) :ref:`🔗` Calls :ref:`bake` with ``create_visual_debug`` enabled. diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index 9535b135ffa..a45bccc41ed 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -91,7 +91,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **bias** = ``1.5`` +:ref:`float` **bias** = ``1.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -108,7 +108,7 @@ The normal bias to use for indirect lighting and reflections. Higher values redu .. rst-class:: classref-property -:ref:`float` **dynamic_range** = ``2.0`` +:ref:`float` **dynamic_range** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -125,7 +125,7 @@ The dynamic range to use (``1.0`` represents a low dynamic range scene brightnes .. rst-class:: classref-property -:ref:`float` **energy** = ``1.0`` +:ref:`float` **energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -142,7 +142,7 @@ The energy of the indirect lighting and reflections produced by the :ref:`VoxelG .. rst-class:: classref-property -:ref:`bool` **interior** = ``false`` +:ref:`bool` **interior** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -159,7 +159,7 @@ If ``true``, :ref:`Environment` lighting is ignored by the :r .. rst-class:: classref-property -:ref:`float` **normal_bias** = ``0.0`` +:ref:`float` **normal_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -176,7 +176,7 @@ The normal bias to use for indirect lighting and reflections. Higher values redu .. rst-class:: classref-property -:ref:`float` **propagation** = ``0.5`` +:ref:`float` **propagation** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -193,7 +193,7 @@ The multiplier to use when light bounces off a surface. Higher values result in .. rst-class:: classref-property -:ref:`bool` **use_two_bounces** = ``true`` +:ref:`bool` **use_two_bounces** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **allocate**\ (\ to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) +|void| **allocate**\ (\ to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) :ref:`🔗` .. container:: contribute @@ -229,7 +229,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **get_bounds**\ (\ ) |const| +:ref:`AABB` **get_bounds**\ (\ ) |const| :ref:`🔗` Returns the bounds of the baked voxel data as an :ref:`AABB`, which should match :ref:`VoxelGI.size` after being baked (which only contains the size as a :ref:`Vector3`). @@ -243,7 +243,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`PackedByteArray` **get_data_cells**\ (\ ) |const| +:ref:`PackedByteArray` **get_data_cells**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -257,7 +257,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_level_counts**\ (\ ) |const| +:ref:`PackedInt32Array` **get_level_counts**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -271,7 +271,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`PackedByteArray` **get_octree_cells**\ (\ ) |const| +:ref:`PackedByteArray` **get_octree_cells**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -285,7 +285,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`Vector3` **get_octree_size**\ (\ ) |const| +:ref:`Vector3` **get_octree_size**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -299,7 +299,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`Transform3D` **get_to_cell_xform**\ (\ ) |const| +:ref:`Transform3D` **get_to_cell_xform**\ (\ ) |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 150dff4aefb..3108846706f 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_ref**\ (\ ) |const| +:ref:`Variant` **get_ref**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Object` this weakref is referring to. Returns ``null`` if that object no longer exists. diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 5a39b99eeed..0623a5e53e3 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -77,7 +77,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **WriteMode**: +enum **WriteMode**: :ref:`🔗` .. _class_WebRTCDataChannel_constant_WRITE_MODE_TEXT: @@ -103,7 +103,7 @@ Tells the channel to send data over this channel as binary. An external peer (no .. rst-class:: classref-enumeration -enum **ChannelState**: +enum **ChannelState**: :ref:`🔗` .. _class_WebRTCDataChannel_constant_STATE_CONNECTING: @@ -150,7 +150,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`WriteMode` **write_mode** = ``1`` +:ref:`WriteMode` **write_mode** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -172,7 +172,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **close**\ (\ ) +|void| **close**\ (\ ) :ref:`🔗` Closes this data channel, notifying the other peer. @@ -184,7 +184,7 @@ Closes this data channel, notifying the other peer. .. rst-class:: classref-method -:ref:`int` **get_buffered_amount**\ (\ ) |const| +:ref:`int` **get_buffered_amount**\ (\ ) |const| :ref:`🔗` Returns the number of bytes currently queued to be sent over this channel. @@ -196,7 +196,7 @@ Returns the number of bytes currently queued to be sent over this channel. .. rst-class:: classref-method -:ref:`int` **get_id**\ (\ ) |const| +:ref:`int` **get_id**\ (\ ) |const| :ref:`🔗` Returns the ID assigned to this channel during creation (or auto-assigned during negotiation). @@ -210,7 +210,7 @@ If the channel is not negotiated out-of-band the ID will only be available after .. rst-class:: classref-method -:ref:`String` **get_label**\ (\ ) |const| +:ref:`String` **get_label**\ (\ ) |const| :ref:`🔗` Returns the label assigned to this channel during creation. @@ -222,7 +222,7 @@ Returns the label assigned to this channel during creation. .. rst-class:: classref-method -:ref:`int` **get_max_packet_life_time**\ (\ ) |const| +:ref:`int` **get_max_packet_life_time**\ (\ ) |const| :ref:`🔗` Returns the ``maxPacketLifeTime`` value assigned to this channel during creation. @@ -236,7 +236,7 @@ Will be ``65535`` if not specified. .. rst-class:: classref-method -:ref:`int` **get_max_retransmits**\ (\ ) |const| +:ref:`int` **get_max_retransmits**\ (\ ) |const| :ref:`🔗` Returns the ``maxRetransmits`` value assigned to this channel during creation. @@ -250,7 +250,7 @@ Will be ``65535`` if not specified. .. rst-class:: classref-method -:ref:`String` **get_protocol**\ (\ ) |const| +:ref:`String` **get_protocol**\ (\ ) |const| :ref:`🔗` Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. @@ -262,7 +262,7 @@ Returns the sub-protocol assigned to this channel during creation. An empty stri .. rst-class:: classref-method -:ref:`ChannelState` **get_ready_state**\ (\ ) |const| +:ref:`ChannelState` **get_ready_state**\ (\ ) |const| :ref:`🔗` Returns the current state of this channel, see :ref:`ChannelState`. @@ -274,7 +274,7 @@ Returns the current state of this channel, see :ref:`ChannelState` **is_negotiated**\ (\ ) |const| +:ref:`bool` **is_negotiated**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this channel was created with out-of-band configuration. @@ -286,7 +286,7 @@ Returns ``true`` if this channel was created with out-of-band configuration. .. rst-class:: classref-method -:ref:`bool` **is_ordered**\ (\ ) |const| +:ref:`bool` **is_ordered**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this channel was created with ordering enabled (default). @@ -298,7 +298,7 @@ Returns ``true`` if this channel was created with ordering enabled (default). .. rst-class:: classref-method -:ref:`Error` **poll**\ (\ ) +:ref:`Error` **poll**\ (\ ) :ref:`🔗` Reserved, but not used for now. @@ -310,7 +310,7 @@ Reserved, but not used for now. .. rst-class:: classref-method -:ref:`bool` **was_string_packet**\ (\ ) |const| +:ref:`bool` **was_string_packet**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the last received packet was transferred as text. See :ref:`write_mode`. diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 1997f13c6ab..fcca3ba51f4 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_close**\ (\ ) |virtual| +|void| **_close**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -89,7 +89,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_buffered_amount**\ (\ ) |virtual| |const| +:ref:`int` **_get_buffered_amount**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -117,7 +117,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_id**\ (\ ) |virtual| |const| +:ref:`int` **_get_id**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -131,7 +131,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_label**\ (\ ) |virtual| |const| +:ref:`String` **_get_label**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -145,7 +145,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_max_packet_life_time**\ (\ ) |virtual| |const| +:ref:`int` **_get_max_packet_life_time**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -159,7 +159,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -173,7 +173,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_max_retransmits**\ (\ ) |virtual| |const| +:ref:`int` **_get_max_retransmits**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -187,7 +187,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| +:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -201,7 +201,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_protocol**\ (\ ) |virtual| |const| +:ref:`String` **_get_protocol**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ChannelState` **_get_ready_state**\ (\ ) |virtual| |const| +:ref:`ChannelState` **_get_ready_state**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -229,7 +229,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`WriteMode` **_get_write_mode**\ (\ ) |virtual| |const| +:ref:`WriteMode` **_get_write_mode**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -243,7 +243,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_is_negotiated**\ (\ ) |virtual| |const| +:ref:`bool` **_is_negotiated**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -257,7 +257,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_is_ordered**\ (\ ) |virtual| |const| +:ref:`bool` **_is_ordered**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -271,7 +271,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_poll**\ (\ ) |virtual| +:ref:`Error` **_poll**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -285,7 +285,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| +:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -299,7 +299,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_set_write_mode**\ (\ p_write_mode\: :ref:`WriteMode`\ ) |virtual| +|void| **_set_write_mode**\ (\ p_write_mode\: :ref:`WriteMode`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -313,7 +313,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_was_string_packet**\ (\ ) |virtual| |const| +:ref:`bool` **_was_string_packet**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute diff --git a/classes/class_webrtcmultiplayerpeer.rst b/classes/class_webrtcmultiplayerpeer.rst index 22d62b35724..73da750ea2e 100644 --- a/classes/class_webrtcmultiplayerpeer.rst +++ b/classes/class_webrtcmultiplayerpeer.rst @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_peer**\ (\ peer\: :ref:`WebRTCPeerConnection`, peer_id\: :ref:`int`, unreliable_lifetime\: :ref:`int` = 1\ ) +:ref:`Error` **add_peer**\ (\ peer\: :ref:`WebRTCPeerConnection`, peer_id\: :ref:`int`, unreliable_lifetime\: :ref:`int` = 1\ ) :ref:`🔗` Add a new peer to the mesh with the given ``peer_id``. The :ref:`WebRTCPeerConnection` must be in state :ref:`WebRTCPeerConnection.STATE_NEW`. @@ -80,7 +80,7 @@ Three channels will be created for reliable, unreliable, and ordered transport. .. rst-class:: classref-method -:ref:`Error` **create_client**\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) +:ref:`Error` **create_client**\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) :ref:`🔗` Initialize the multiplayer peer as a client with the given ``peer_id`` (must be between 2 and 2147483647). In this mode, you should only call :ref:`add_peer` once and with ``peer_id`` of ``1``. This mode enables :ref:`MultiplayerPeer.is_server_relay_supported`, allowing the upper :ref:`MultiplayerAPI` layer to perform peer exchange and packet relaying. @@ -94,7 +94,7 @@ You can optionally specify a ``channels_config`` array of :ref:`TransferMode` **create_mesh**\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) +:ref:`Error` **create_mesh**\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) :ref:`🔗` Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) with the given ``peer_id`` (must be between 1 and 2147483647). @@ -106,7 +106,7 @@ Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) .. rst-class:: classref-method -:ref:`Error` **create_server**\ (\ channels_config\: :ref:`Array` = []\ ) +:ref:`Error` **create_server**\ (\ channels_config\: :ref:`Array` = []\ ) :ref:`🔗` Initialize the multiplayer peer as a server (with unique ID of ``1``). This mode enables :ref:`MultiplayerPeer.is_server_relay_supported`, allowing the upper :ref:`MultiplayerAPI` layer to perform peer exchange and packet relaying. @@ -120,7 +120,7 @@ You can optionally specify a ``channels_config`` array of :ref:`TransferMode` **get_peer**\ (\ peer_id\: :ref:`int`\ ) +:ref:`Dictionary` **get_peer**\ (\ peer_id\: :ref:`int`\ ) :ref:`🔗` Returns a dictionary representation of the peer with given ``peer_id`` with three keys. ``"connection"`` containing the :ref:`WebRTCPeerConnection` to this peer, ``"channels"`` an array of three :ref:`WebRTCDataChannel`, and ``"connected"`` a boolean representing if the peer connection is currently connected (all three channels are open). @@ -132,7 +132,7 @@ Returns a dictionary representation of the peer with given ``peer_id`` with thre .. rst-class:: classref-method -:ref:`Dictionary` **get_peers**\ (\ ) +:ref:`Dictionary` **get_peers**\ (\ ) :ref:`🔗` Returns a dictionary which keys are the peer ids and values the peer representation as in :ref:`get_peer`. @@ -144,7 +144,7 @@ Returns a dictionary which keys are the peer ids and values the peer representat .. rst-class:: classref-method -:ref:`bool` **has_peer**\ (\ peer_id\: :ref:`int`\ ) +:ref:`bool` **has_peer**\ (\ peer_id\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the given ``peer_id`` is in the peers map (it might not be connected though). @@ -156,7 +156,7 @@ Returns ``true`` if the given ``peer_id`` is in the peers map (it might not be c .. rst-class:: classref-method -|void| **remove_peer**\ (\ peer_id\: :ref:`int`\ ) +|void| **remove_peer**\ (\ peer_id\: :ref:`int`\ ) :ref:`🔗` Remove the peer with given ``peer_id`` from the mesh. If the peer was connected, and :ref:`MultiplayerPeer.peer_connected` was emitted for it, then :ref:`MultiplayerPeer.peer_disconnected` will be emitted. diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index 83bb5472662..66914170673 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -80,7 +80,7 @@ Signals .. rst-class:: classref-signal -**data_channel_received**\ (\ channel\: :ref:`WebRTCDataChannel`\ ) +**data_channel_received**\ (\ channel\: :ref:`WebRTCDataChannel`\ ) :ref:`🔗` Emitted when a new in-band channel is received, i.e. when the channel was created with ``negotiated: false`` (default). @@ -94,7 +94,7 @@ The object will be an instance of :ref:`WebRTCDataChannel`, index\: :ref:`int`, name\: :ref:`String`\ ) +**ice_candidate_created**\ (\ media\: :ref:`String`, index\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Emitted when a new ICE candidate has been created. The three parameters are meant to be passed to the remote peer over the signaling server. @@ -106,7 +106,7 @@ Emitted when a new ICE candidate has been created. The three parameters are mean .. rst-class:: classref-signal -**session_description_created**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) +**session_description_created**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) :ref:`🔗` Emitted after a successful call to :ref:`create_offer` or :ref:`set_remote_description` (when it generates an answer). The parameters are meant to be passed to :ref:`set_local_description` on this object, and sent to the remote peer over the signaling server. @@ -123,7 +123,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ConnectionState**: +enum **ConnectionState**: :ref:`🔗` .. _class_WebRTCPeerConnection_constant_STATE_NEW: @@ -181,7 +181,7 @@ The peer connection is closed (after calling :ref:`close` .. _class_WebRTCPeerConnection_constant_GATHERING_STATE_NEW: @@ -215,7 +215,7 @@ The ICE agent has finished gathering candidates. If something happens that requi .. rst-class:: classref-enumeration -enum **SignalingState**: +enum **SignalingState**: :ref:`🔗` .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_STABLE: @@ -278,7 +278,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_ice_candidate**\ (\ media\: :ref:`String`, index\: :ref:`int`, name\: :ref:`String`\ ) +:ref:`Error` **add_ice_candidate**\ (\ media\: :ref:`String`, index\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Add an ice candidate generated by a remote peer (and received over the signaling server). See :ref:`ice_candidate_created`. @@ -290,7 +290,7 @@ Add an ice candidate generated by a remote peer (and received over the signaling .. rst-class:: classref-method -|void| **close**\ (\ ) +|void| **close**\ (\ ) :ref:`🔗` Close the peer connection and all data channels associated with it. @@ -304,7 +304,7 @@ Close the peer connection and all data channels associated with it. .. rst-class:: classref-method -:ref:`WebRTCDataChannel` **create_data_channel**\ (\ label\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) +:ref:`WebRTCDataChannel` **create_data_channel**\ (\ label\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) :ref:`🔗` Returns a new :ref:`WebRTCDataChannel` (or ``null`` on failure) with given ``label`` and optionally configured via the ``options`` dictionary. This method can only be called when the connection is in state :ref:`STATE_NEW`. @@ -336,7 +336,7 @@ Valid ``options`` are: .. rst-class:: classref-method -:ref:`Error` **create_offer**\ (\ ) +:ref:`Error` **create_offer**\ (\ ) :ref:`🔗` Creates a new SDP offer to start a WebRTC connection with a remote peer. At least one :ref:`WebRTCDataChannel` must have been created before calling this method. @@ -350,7 +350,7 @@ If this functions returns :ref:`@GlobalScope.OK` .. rst-class:: classref-method -:ref:`ConnectionState` **get_connection_state**\ (\ ) |const| +:ref:`ConnectionState` **get_connection_state**\ (\ ) |const| :ref:`🔗` Returns the connection state. See :ref:`ConnectionState`. @@ -362,7 +362,7 @@ Returns the connection state. See :ref:`ConnectionState` **get_gathering_state**\ (\ ) |const| +:ref:`GatheringState` **get_gathering_state**\ (\ ) |const| :ref:`🔗` Returns the ICE :ref:`GatheringState` of the connection. This lets you detect, for example, when collection of ICE candidates has finished. @@ -374,7 +374,7 @@ Returns the ICE :ref:`GatheringState` .. rst-class:: classref-method -:ref:`SignalingState` **get_signaling_state**\ (\ ) |const| +:ref:`SignalingState` **get_signaling_state**\ (\ ) |const| :ref:`🔗` Returns the signaling state on the local end of the connection while connecting or reconnecting to another peer. @@ -386,7 +386,7 @@ Returns the signaling state on the local end of the connection while connecting .. rst-class:: classref-method -:ref:`Error` **initialize**\ (\ configuration\: :ref:`Dictionary` = {}\ ) +:ref:`Error` **initialize**\ (\ configuration\: :ref:`Dictionary` = {}\ ) :ref:`🔗` Re-initialize this peer connection, closing any previously active connection, and going back to state :ref:`STATE_NEW`. A dictionary of ``configuration`` options can be passed to configure the peer connection. @@ -415,7 +415,7 @@ Valid ``configuration`` options are: .. rst-class:: classref-method -:ref:`Error` **poll**\ (\ ) +:ref:`Error` **poll**\ (\ ) :ref:`🔗` Call this method frequently (e.g. in :ref:`Node._process` or :ref:`Node._physics_process`) to properly receive signals. @@ -427,7 +427,7 @@ Call this method frequently (e.g. in :ref:`Node._process`\ ) |static| +|void| **set_default_extension**\ (\ extension_class\: :ref:`StringName`\ ) |static| :ref:`🔗` Sets the ``extension_class`` as the default :ref:`WebRTCPeerConnectionExtension` returned when creating a new **WebRTCPeerConnection**. @@ -439,7 +439,7 @@ Sets the ``extension_class`` as the default :ref:`WebRTCPeerConnectionExtension< .. rst-class:: classref-method -:ref:`Error` **set_local_description**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) +:ref:`Error` **set_local_description**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) :ref:`🔗` Sets the SDP description of the local peer. This should be called in response to :ref:`session_description_created`. @@ -453,7 +453,7 @@ After calling this function the peer will start emitting :ref:`ice_candidate_cre .. rst-class:: classref-method -:ref:`Error` **set_remote_description**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) +:ref:`Error` **set_remote_description**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) :ref:`🔗` Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server. diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index 2e828667d1f..1328db08825 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_add_ice_candidate**\ (\ p_sdp_mid_name\: :ref:`String`, p_sdp_mline_index\: :ref:`int`, p_sdp_name\: :ref:`String`\ ) |virtual| +:ref:`Error` **_add_ice_candidate**\ (\ p_sdp_mid_name\: :ref:`String`, p_sdp_mline_index\: :ref:`int`, p_sdp_name\: :ref:`String`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_close**\ (\ ) |virtual| +|void| **_close**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -89,7 +89,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`WebRTCDataChannel` **_create_data_channel**\ (\ p_label\: :ref:`String`, p_config\: :ref:`Dictionary`\ ) |virtual| +:ref:`WebRTCDataChannel` **_create_data_channel**\ (\ p_label\: :ref:`String`, p_config\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_create_offer**\ (\ ) |virtual| +:ref:`Error` **_create_offer**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -117,7 +117,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ConnectionState` **_get_connection_state**\ (\ ) |virtual| |const| +:ref:`ConnectionState` **_get_connection_state**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -131,7 +131,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GatheringState` **_get_gathering_state**\ (\ ) |virtual| |const| +:ref:`GatheringState` **_get_gathering_state**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -145,7 +145,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`SignalingState` **_get_signaling_state**\ (\ ) |virtual| |const| +:ref:`SignalingState` **_get_signaling_state**\ (\ ) |virtual| |const| :ref:`🔗` .. container:: contribute @@ -159,7 +159,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_initialize**\ (\ p_config\: :ref:`Dictionary`\ ) |virtual| +:ref:`Error` **_initialize**\ (\ p_config\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -173,7 +173,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_poll**\ (\ ) |virtual| +:ref:`Error` **_poll**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -187,7 +187,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_set_local_description**\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| +:ref:`Error` **_set_local_description**\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -201,7 +201,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_set_remote_description**\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| +:ref:`Error` **_set_remote_description**\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| :ref:`🔗` .. container:: contribute diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index f8e3a590a03..468205a0072 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -78,7 +78,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedStringArray` **handshake_headers** = ``PackedStringArray()`` +:ref:`PackedStringArray` **handshake_headers** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -97,7 +97,7 @@ The extra headers to use during handshake. See :ref:`WebSocketPeer.handshake_hea .. rst-class:: classref-property -:ref:`float` **handshake_timeout** = ``3.0`` +:ref:`float` **handshake_timeout** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -114,7 +114,7 @@ The maximum time each peer can stay in a connecting state before being dropped. .. rst-class:: classref-property -:ref:`int` **inbound_buffer_size** = ``65535`` +:ref:`int` **inbound_buffer_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -131,7 +131,7 @@ The inbound buffer size for connected peers. See :ref:`WebSocketPeer.inbound_buf .. rst-class:: classref-property -:ref:`int` **max_queued_packets** = ``2048`` +:ref:`int` **max_queued_packets** = ``2048`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ The maximum number of queued packets for connected peers. See :ref:`WebSocketPee .. rst-class:: classref-property -:ref:`int` **outbound_buffer_size** = ``65535`` +:ref:`int` **outbound_buffer_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -165,7 +165,7 @@ The outbound buffer size for connected peers. See :ref:`WebSocketPeer.outbound_b .. rst-class:: classref-property -:ref:`PackedStringArray` **supported_protocols** = ``PackedStringArray()`` +:ref:`PackedStringArray` **supported_protocols** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -189,7 +189,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **create_client**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **create_client**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Starts a new multiplayer client connecting to the given ``url``. TLS certificates will be verified against the hostname when connecting using the ``wss://`` protocol. You can pass the optional ``tls_client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -203,7 +203,7 @@ Starts a new multiplayer client connecting to the given ``url``. TLS certificate .. rst-class:: classref-method -:ref:`Error` **create_server**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", tls_server_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **create_server**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", tls_server_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Starts a new multiplayer server listening on the given ``port``. You can optionally specify a ``bind_address``, and provide valid ``tls_server_options`` to use TLS. See :ref:`TLSOptions.server`. @@ -215,7 +215,7 @@ Starts a new multiplayer server listening on the given ``port``. You can optiona .. rst-class:: classref-method -:ref:`WebSocketPeer` **get_peer**\ (\ peer_id\: :ref:`int`\ ) |const| +:ref:`WebSocketPeer` **get_peer**\ (\ peer_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. @@ -227,7 +227,7 @@ Returns the :ref:`WebSocketPeer` associated to the given `` .. rst-class:: classref-method -:ref:`String` **get_peer_address**\ (\ id\: :ref:`int`\ ) |const| +:ref:`String` **get_peer_address**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the IP address of the given peer. @@ -239,7 +239,7 @@ Returns the IP address of the given peer. .. rst-class:: classref-method -:ref:`int` **get_peer_port**\ (\ id\: :ref:`int`\ ) |const| +:ref:`int` **get_peer_port**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the remote port of the given peer. diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 586650c1447..c7d7d73de46 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -131,7 +131,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **WriteMode**: +enum **WriteMode**: :ref:`🔗` .. _class_WebSocketPeer_constant_WRITE_MODE_TEXT: @@ -157,7 +157,7 @@ Specifies that WebSockets messages should be transferred as binary payload (any .. rst-class:: classref-enumeration -enum **State**: +enum **State**: :ref:`🔗` .. _class_WebSocketPeer_constant_STATE_CONNECTING: @@ -204,7 +204,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedStringArray` **handshake_headers** = ``PackedStringArray()`` +:ref:`PackedStringArray` **handshake_headers** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -225,7 +225,7 @@ The extra HTTP headers to be sent during the WebSocket handshake. .. rst-class:: classref-property -:ref:`int` **inbound_buffer_size** = ``65535`` +:ref:`int` **inbound_buffer_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -242,7 +242,7 @@ The size of the input buffer in bytes (roughly the maximum amount of memory that .. rst-class:: classref-property -:ref:`int` **max_queued_packets** = ``2048`` +:ref:`int` **max_queued_packets** = ``2048`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -259,7 +259,7 @@ The maximum amount of packets that will be allowed in the queues (both inbound a .. rst-class:: classref-property -:ref:`int` **outbound_buffer_size** = ``65535`` +:ref:`int` **outbound_buffer_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -276,7 +276,7 @@ The size of the input buffer in bytes (roughly the maximum amount of memory that .. rst-class:: classref-property -:ref:`PackedStringArray` **supported_protocols** = ``PackedStringArray()`` +:ref:`PackedStringArray` **supported_protocols** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -300,7 +300,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **accept_stream**\ (\ stream\: :ref:`StreamPeer`\ ) +:ref:`Error` **accept_stream**\ (\ stream\: :ref:`StreamPeer`\ ) :ref:`🔗` Accepts a peer connection performing the HTTP handshake as a WebSocket server. The ``stream`` must be a valid TCP stream retrieved via :ref:`TCPServer.take_connection`, or a TLS stream accepted via :ref:`StreamPeerTLS.accept_stream`. @@ -314,7 +314,7 @@ Accepts a peer connection performing the HTTP handshake as a WebSocket server. T .. rst-class:: classref-method -|void| **close**\ (\ code\: :ref:`int` = 1000, reason\: :ref:`String` = ""\ ) +|void| **close**\ (\ code\: :ref:`int` = 1000, reason\: :ref:`String` = ""\ ) :ref:`🔗` Closes this WebSocket connection. ``code`` is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). ``reason`` is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). If ``code`` is negative, the connection will be closed immediately without notifying the remote peer. @@ -330,7 +330,7 @@ Closes this WebSocket connection. ``code`` is the status code for the closure (s .. rst-class:: classref-method -:ref:`Error` **connect_to_url**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) +:ref:`Error` **connect_to_url**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Connects to the given URL. TLS certificates will be verified against the hostname when connecting using the ``wss://`` protocol. You can pass the optional ``tls_client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -344,7 +344,7 @@ Connects to the given URL. TLS certificates will be verified against the hostnam .. rst-class:: classref-method -:ref:`int` **get_close_code**\ (\ ) |const| +:ref:`int` **get_close_code**\ (\ ) |const| :ref:`🔗` Returns the received WebSocket close frame status code, or ``-1`` when the connection was not cleanly closed. Only call this method when :ref:`get_ready_state` returns :ref:`STATE_CLOSED`. @@ -356,7 +356,7 @@ Returns the received WebSocket close frame status code, or ``-1`` when the conne .. rst-class:: classref-method -:ref:`String` **get_close_reason**\ (\ ) |const| +:ref:`String` **get_close_reason**\ (\ ) |const| :ref:`🔗` Returns the received WebSocket close frame status reason string. Only call this method when :ref:`get_ready_state` returns :ref:`STATE_CLOSED`. @@ -368,7 +368,7 @@ Returns the received WebSocket close frame status reason string. Only call this .. rst-class:: classref-method -:ref:`String` **get_connected_host**\ (\ ) |const| +:ref:`String` **get_connected_host**\ (\ ) |const| :ref:`🔗` Returns the IP address of the connected peer. @@ -382,7 +382,7 @@ Returns the IP address of the connected peer. .. rst-class:: classref-method -:ref:`int` **get_connected_port**\ (\ ) |const| +:ref:`int` **get_connected_port**\ (\ ) |const| :ref:`🔗` Returns the remote port of the connected peer. @@ -396,7 +396,7 @@ Returns the remote port of the connected peer. .. rst-class:: classref-method -:ref:`int` **get_current_outbound_buffered_amount**\ (\ ) |const| +:ref:`int` **get_current_outbound_buffered_amount**\ (\ ) |const| :ref:`🔗` Returns the current amount of data in the outbound websocket buffer. **Note:** Web exports use WebSocket.bufferedAmount, while other platforms use an internal buffer. @@ -408,7 +408,7 @@ Returns the current amount of data in the outbound websocket buffer. **Note:** W .. rst-class:: classref-method -:ref:`State` **get_ready_state**\ (\ ) |const| +:ref:`State` **get_ready_state**\ (\ ) |const| :ref:`🔗` Returns the ready state of the connection. See :ref:`State`. @@ -420,7 +420,7 @@ Returns the ready state of the connection. See :ref:`State` **get_requested_url**\ (\ ) |const| +:ref:`String` **get_requested_url**\ (\ ) |const| :ref:`🔗` Returns the URL requested by this peer. The URL is derived from the ``url`` passed to :ref:`connect_to_url` or from the HTTP headers when acting as server (i.e. when using :ref:`accept_stream`). @@ -432,7 +432,7 @@ Returns the URL requested by this peer. The URL is derived from the ``url`` pass .. rst-class:: classref-method -:ref:`String` **get_selected_protocol**\ (\ ) |const| +:ref:`String` **get_selected_protocol**\ (\ ) |const| :ref:`🔗` Returns the selected WebSocket sub-protocol for this connection or an empty string if the sub-protocol has not been selected yet. @@ -444,7 +444,7 @@ Returns the selected WebSocket sub-protocol for this connection or an empty stri .. rst-class:: classref-method -|void| **poll**\ (\ ) +|void| **poll**\ (\ ) :ref:`🔗` Updates the connection state and receive incoming packets. Call this function regularly to keep it in a clean state. @@ -456,7 +456,7 @@ Updates the connection state and receive incoming packets. Call this function re .. rst-class:: classref-method -:ref:`Error` **send**\ (\ message\: :ref:`PackedByteArray`, write_mode\: :ref:`WriteMode` = 1\ ) +:ref:`Error` **send**\ (\ message\: :ref:`PackedByteArray`, write_mode\: :ref:`WriteMode` = 1\ ) :ref:`🔗` Sends the given ``message`` using the desired ``write_mode``. When sending a :ref:`String`, prefer using :ref:`send_text`. @@ -468,7 +468,7 @@ Sends the given ``message`` using the desired ``write_mode``. When sending a :re .. rst-class:: classref-method -:ref:`Error` **send_text**\ (\ message\: :ref:`String`\ ) +:ref:`Error` **send_text**\ (\ message\: :ref:`String`\ ) :ref:`🔗` Sends the given ``message`` using WebSocket text mode. Prefer this method over :ref:`PacketPeer.put_packet` when interacting with third-party text-based API (e.g. when using :ref:`JSON` formatted messages). @@ -480,7 +480,7 @@ Sends the given ``message`` using WebSocket text mode. Prefer this method over : .. rst-class:: classref-method -|void| **set_no_delay**\ (\ enabled\: :ref:`bool`\ ) +|void| **set_no_delay**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` Disable Nagle's algorithm on the underling TCP socket (default). See :ref:`StreamPeerTCP.set_no_delay` for more information. @@ -494,7 +494,7 @@ Disable Nagle's algorithm on the underling TCP socket (default). See :ref:`Strea .. rst-class:: classref-method -:ref:`bool` **was_string_packet**\ (\ ) |const| +:ref:`bool` **was_string_packet**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode`. diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index ae152d72797..e99fd78f484 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -181,7 +181,7 @@ Signals .. rst-class:: classref-signal -**display_refresh_rate_changed**\ (\ ) +**display_refresh_rate_changed**\ (\ ) :ref:`🔗` Emitted after the display's refresh rate has changed. @@ -193,7 +193,7 @@ Emitted after the display's refresh rate has changed. .. rst-class:: classref-signal -**reference_space_reset**\ (\ ) +**reference_space_reset**\ (\ ) :ref:`🔗` Emitted to indicate that the reference space has been reset or reconfigured. @@ -209,7 +209,7 @@ See `WebXR's XRReferenceSpace reset event `\ ) +**select**\ (\ input_source_id\: :ref:`int`\ ) :ref:`🔗` Emitted after one of the input sources has finished its "primary action". @@ -223,7 +223,7 @@ Use :ref:`get_input_source_tracker`\ ) +**selectend**\ (\ input_source_id\: :ref:`int`\ ) :ref:`🔗` Emitted when one of the input sources has finished its "primary action". @@ -237,7 +237,7 @@ Use :ref:`get_input_source_tracker`\ ) +**selectstart**\ (\ input_source_id\: :ref:`int`\ ) :ref:`🔗` Emitted when one of the input source has started its "primary action". @@ -251,7 +251,7 @@ Use :ref:`get_input_source_tracker` Emitted when the user ends the WebXR session (which can be done using UI from the browser or device). @@ -265,7 +265,7 @@ At this point, you should do ``get_viewport().use_xr = false`` to instruct Godot .. rst-class:: classref-signal -**session_failed**\ (\ message\: :ref:`String`\ ) +**session_failed**\ (\ message\: :ref:`String`\ ) :ref:`🔗` Emitted by :ref:`XRInterface.initialize` if the session fails to start. @@ -279,7 +279,7 @@ Emitted by :ref:`XRInterface.initialize` if .. rst-class:: classref-signal -**session_started**\ (\ ) +**session_started**\ (\ ) :ref:`🔗` Emitted by :ref:`XRInterface.initialize` if the session is successfully started. @@ -293,7 +293,7 @@ At this point, it's safe to do ``get_viewport().use_xr = true`` to instruct Godo .. rst-class:: classref-signal -**session_supported**\ (\ session_mode\: :ref:`String`, supported\: :ref:`bool`\ ) +**session_supported**\ (\ session_mode\: :ref:`String`, supported\: :ref:`bool`\ ) :ref:`🔗` Emitted by :ref:`is_session_supported` to indicate if the given ``session_mode`` is supported or not. @@ -305,7 +305,7 @@ Emitted by :ref:`is_session_supported`\ ) +**squeeze**\ (\ input_source_id\: :ref:`int`\ ) :ref:`🔗` Emitted after one of the input sources has finished its "primary squeeze action". @@ -319,7 +319,7 @@ Use :ref:`get_input_source_tracker`\ ) +**squeezeend**\ (\ input_source_id\: :ref:`int`\ ) :ref:`🔗` Emitted when one of the input sources has finished its "primary squeeze action". @@ -333,7 +333,7 @@ Use :ref:`get_input_source_tracker`\ ) +**squeezestart**\ (\ input_source_id\: :ref:`int`\ ) :ref:`🔗` Emitted when one of the input sources has started its "primary squeeze action". @@ -347,7 +347,7 @@ Use :ref:`get_input_source_tracker` Emitted when :ref:`visibility_state` has changed. @@ -364,7 +364,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TargetRayMode**: +enum **TargetRayMode**: :ref:`🔗` .. _class_WebXRInterface_constant_TARGET_RAY_MODE_UNKNOWN: @@ -411,7 +411,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **enabled_features** +:ref:`String` **enabled_features** :ref:`🔗` .. rst-class:: classref-property-setget @@ -429,7 +429,7 @@ This may include features requested by setting :ref:`required_features` **optional_features** +:ref:`String` **optional_features** :ref:`🔗` .. rst-class:: classref-property-setget @@ -452,7 +452,7 @@ Possible values come from `WebXR's XRReferenceSpaceType ` **reference_space_type** +:ref:`String` **reference_space_type** :ref:`🔗` .. rst-class:: classref-property-setget @@ -470,7 +470,7 @@ Possible values come from `WebXR's XRReferenceSpaceType ` **requested_reference_space_types** +:ref:`String` **requested_reference_space_types** :ref:`🔗` .. rst-class:: classref-property-setget @@ -493,7 +493,7 @@ Possible values come from `WebXR's XRReferenceSpaceType ` **required_features** +:ref:`String` **required_features** :ref:`🔗` .. rst-class:: classref-property-setget @@ -516,7 +516,7 @@ Possible values come from `WebXR's XRReferenceSpaceType ` **session_mode** +:ref:`String` **session_mode** :ref:`🔗` .. rst-class:: classref-property-setget @@ -537,7 +537,7 @@ Possible values come from `WebXR's XRSessionMode ` **visibility_state** +:ref:`String` **visibility_state** :ref:`🔗` .. rst-class:: classref-property-setget @@ -560,7 +560,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| +:ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| :ref:`🔗` Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the web browser and after the interface has been initialized. @@ -572,7 +572,7 @@ Returns display refresh rates supported by the current HMD. Only returned if thi .. rst-class:: classref-method -:ref:`float` **get_display_refresh_rate**\ (\ ) |const| +:ref:`float` **get_display_refresh_rate**\ (\ ) |const| :ref:`🔗` Returns the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It may not report an accurate value until after using :ref:`set_display_refresh_rate`. @@ -584,7 +584,7 @@ Returns the display refresh rate for the current HMD. Not supported on all HMDs .. rst-class:: classref-method -:ref:`TargetRayMode` **get_input_source_target_ray_mode**\ (\ input_source_id\: :ref:`int`\ ) |const| +:ref:`TargetRayMode` **get_input_source_target_ray_mode**\ (\ input_source_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the target ray mode for the given ``input_source_id``. @@ -598,7 +598,7 @@ This can help interpret the input coming from that input source. See `XRInputSou .. rst-class:: classref-method -:ref:`XRControllerTracker` **get_input_source_tracker**\ (\ input_source_id\: :ref:`int`\ ) |const| +:ref:`XRControllerTracker` **get_input_source_tracker**\ (\ input_source_id\: :ref:`int`\ ) |const| :ref:`🔗` Gets an :ref:`XRControllerTracker` for the given ``input_source_id``. @@ -626,7 +626,7 @@ Use this method to get information about the input source that triggered one of .. rst-class:: classref-method -:ref:`bool` **is_input_source_active**\ (\ input_source_id\: :ref:`int`\ ) |const| +:ref:`bool` **is_input_source_active**\ (\ input_source_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if there is an active input source with the given ``input_source_id``. @@ -638,7 +638,7 @@ Returns ``true`` if there is an active input source with the given ``input_sourc .. rst-class:: classref-method -|void| **is_session_supported**\ (\ session_mode\: :ref:`String`\ ) +|void| **is_session_supported**\ (\ session_mode\: :ref:`String`\ ) :ref:`🔗` Checks if the given ``session_mode`` is supported by the user's browser. @@ -654,7 +654,7 @@ This method returns nothing, instead it emits the :ref:`session_supported`\ ) +|void| **set_display_refresh_rate**\ (\ refresh_rate\: :ref:`float`\ ) :ref:`🔗` Sets the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It won't take effect right away until after :ref:`display_refresh_rate_changed` is emitted. diff --git a/classes/class_window.rst b/classes/class_window.rst index 6f7d814b786..bf0a89c2cf9 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -302,7 +302,7 @@ Signals .. rst-class:: classref-signal -**about_to_popup**\ (\ ) +**about_to_popup**\ (\ ) :ref:`🔗` Emitted right after :ref:`popup` call, before the **Window** appears or does anything. @@ -314,7 +314,7 @@ Emitted right after :ref:`popup` call, before the **W .. rst-class:: classref-signal -**close_requested**\ (\ ) +**close_requested**\ (\ ) :ref:`🔗` Emitted when the **Window**'s close button is pressed or when :ref:`popup_window` is enabled and user clicks outside the window. @@ -328,7 +328,7 @@ This signal can be used to handle window closing, e.g. by connecting it to :ref: .. rst-class:: classref-signal -**dpi_changed**\ (\ ) +**dpi_changed**\ (\ ) :ref:`🔗` Emitted when the **Window**'s DPI changes as a result of OS-level changes (e.g. moving the window from a Retina display to a lower resolution one). @@ -342,7 +342,7 @@ Emitted when the **Window**'s DPI changes as a result of OS-level changes (e.g. .. rst-class:: classref-signal -**files_dropped**\ (\ files\: :ref:`PackedStringArray`\ ) +**files_dropped**\ (\ files\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths. @@ -366,7 +366,7 @@ Example usage: .. rst-class:: classref-signal -**focus_entered**\ (\ ) +**focus_entered**\ (\ ) :ref:`🔗` Emitted when the **Window** gains focus. @@ -378,7 +378,7 @@ Emitted when the **Window** gains focus. .. rst-class:: classref-signal -**focus_exited**\ (\ ) +**focus_exited**\ (\ ) :ref:`🔗` Emitted when the **Window** loses its focus. @@ -390,7 +390,7 @@ Emitted when the **Window** loses its focus. .. rst-class:: classref-signal -**go_back_requested**\ (\ ) +**go_back_requested**\ (\ ) :ref:`🔗` Emitted when a go back request is sent (e.g. pressing the "Back" button on Android), right after :ref:`Node.NOTIFICATION_WM_GO_BACK_REQUEST`. @@ -402,7 +402,7 @@ Emitted when a go back request is sent (e.g. pressing the "Back" button on Andro .. rst-class:: classref-signal -**mouse_entered**\ (\ ) +**mouse_entered**\ (\ ) :ref:`🔗` Emitted when the mouse cursor enters the **Window**'s visible area, that is not occluded behind other :ref:`Control`\ s or windows, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. @@ -414,7 +414,7 @@ Emitted when the mouse cursor enters the **Window**'s visible area, that is not .. rst-class:: classref-signal -**mouse_exited**\ (\ ) +**mouse_exited**\ (\ ) :ref:`🔗` Emitted when the mouse cursor leaves the **Window**'s visible area, that is not occluded behind other :ref:`Control`\ s or windows, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. @@ -426,7 +426,7 @@ Emitted when the mouse cursor leaves the **Window**'s visible area, that is not .. rst-class:: classref-signal -**theme_changed**\ (\ ) +**theme_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`NOTIFICATION_THEME_CHANGED` notification is sent. @@ -438,7 +438,7 @@ Emitted when the :ref:`NOTIFICATION_THEME_CHANGED` Emitted when window title bar decorations are changed, e.g. macOS window enter/exit full screen mode, or extend-to-title flag is changed. @@ -450,7 +450,7 @@ Emitted when window title bar decorations are changed, e.g. macOS window enter/e .. rst-class:: classref-signal -**visibility_changed**\ (\ ) +**visibility_changed**\ (\ ) :ref:`🔗` Emitted when **Window** is made visible or disappears. @@ -462,7 +462,7 @@ Emitted when **Window** is made visible or disappears. .. rst-class:: classref-signal -**window_input**\ (\ event\: :ref:`InputEvent`\ ) +**window_input**\ (\ event\: :ref:`InputEvent`\ ) :ref:`🔗` Emitted when the **Window** is currently focused and receives any input, passing the received event as an argument. The event's position, if present, is in the embedder's coordinate system. @@ -479,7 +479,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Mode**: +enum **Mode**: :ref:`🔗` .. _class_Window_constant_MODE_WINDOWED: @@ -547,7 +547,7 @@ Full screen window covers the entire display area of a screen and has no border .. rst-class:: classref-enumeration -enum **Flags**: +enum **Flags**: :ref:`🔗` .. _class_Window_constant_FLAG_RESIZE_DISABLED: @@ -639,7 +639,7 @@ Max value of the :ref:`Flags`. .. rst-class:: classref-enumeration -enum **ContentScaleMode**: +enum **ContentScaleMode**: :ref:`🔗` .. _class_Window_constant_CONTENT_SCALE_MODE_DISABLED: @@ -673,7 +673,7 @@ The content will be rendered at the base size and then scaled to the target size .. rst-class:: classref-enumeration -enum **ContentScaleAspect**: +enum **ContentScaleAspect**: :ref:`🔗` .. _class_Window_constant_CONTENT_SCALE_ASPECT_IGNORE: @@ -723,7 +723,7 @@ The content's aspect will be preserved. If the target size has different aspect .. rst-class:: classref-enumeration -enum **ContentScaleStretch**: +enum **ContentScaleStretch**: :ref:`🔗` .. _class_Window_constant_CONTENT_SCALE_STRETCH_FRACTIONAL: @@ -749,7 +749,7 @@ The content will be stretched only according to an integer factor, preserving sh .. rst-class:: classref-enumeration -enum **LayoutDirection**: +enum **LayoutDirection**: :ref:`🔗` .. _class_Window_constant_LAYOUT_DIRECTION_INHERITED: @@ -791,7 +791,7 @@ Right-to-left layout direction. .. rst-class:: classref-enumeration -enum **WindowInitialPosition**: +enum **WindowInitialPosition**: :ref:`🔗` .. _class_Window_constant_WINDOW_INITIAL_POSITION_ABSOLUTE: @@ -854,7 +854,7 @@ Constants .. rst-class:: classref-constant -**NOTIFICATION_VISIBILITY_CHANGED** = ``30`` +**NOTIFICATION_VISIBILITY_CHANGED** = ``30`` :ref:`🔗` Emitted when **Window**'s visibility changes, right before :ref:`visibility_changed`. @@ -862,7 +862,7 @@ Emitted when **Window**'s visibility changes, right before :ref:`visibility_chan .. rst-class:: classref-constant -**NOTIFICATION_THEME_CHANGED** = ``32`` +**NOTIFICATION_THEME_CHANGED** = ``32`` :ref:`🔗` Sent when the node needs to refresh its theme items. This happens in one of the following cases: @@ -887,7 +887,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **always_on_top** = ``false`` +:ref:`bool` **always_on_top** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -904,7 +904,7 @@ If ``true``, the window will be on top of all other windows. Does not work if :r .. rst-class:: classref-property -:ref:`bool` **auto_translate** = ``true`` +:ref:`bool` **auto_translate** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -923,7 +923,7 @@ Toggles if any text should automatically change to its translated version depend .. rst-class:: classref-property -:ref:`bool` **borderless** = ``false`` +:ref:`bool` **borderless** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -940,7 +940,7 @@ If ``true``, the window will have no borders. .. rst-class:: classref-property -:ref:`ContentScaleAspect` **content_scale_aspect** = ``0`` +:ref:`ContentScaleAspect` **content_scale_aspect** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -957,7 +957,7 @@ Specifies how the content's aspect behaves when the **Window** is resized. The b .. rst-class:: classref-property -:ref:`float` **content_scale_factor** = ``1.0`` +:ref:`float` **content_scale_factor** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -974,7 +974,7 @@ Specifies the base scale of **Window**'s content when its :ref:`size` **content_scale_mode** = ``0`` +:ref:`ContentScaleMode` **content_scale_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -991,7 +991,7 @@ Specifies how the content is scaled when the **Window** is resized. .. rst-class:: classref-property -:ref:`Vector2i` **content_scale_size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **content_scale_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1008,7 +1008,7 @@ Base size of the content (i.e. nodes that are drawn inside the window). If non-z .. rst-class:: classref-property -:ref:`ContentScaleStretch` **content_scale_stretch** = ``0`` +:ref:`ContentScaleStretch` **content_scale_stretch** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1025,7 +1025,7 @@ The policy to use to determine the final scale factor for 2D elements. This affe .. rst-class:: classref-property -:ref:`int` **current_screen** +:ref:`int` **current_screen** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1042,7 +1042,7 @@ The screen the window is currently on. .. rst-class:: classref-property -:ref:`bool` **exclusive** = ``false`` +:ref:`bool` **exclusive** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1061,7 +1061,7 @@ Needs :ref:`transient` enabled to work. .. rst-class:: classref-property -:ref:`bool` **extend_to_title** = ``false`` +:ref:`bool` **extend_to_title** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1082,7 +1082,7 @@ If ``true``, the **Window** contents is expanded to the full size of the window, .. rst-class:: classref-property -:ref:`bool` **force_native** = ``false`` +:ref:`bool` **force_native** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1099,7 +1099,7 @@ If ``true``, native window will be used regardless of parent viewport and projec .. rst-class:: classref-property -:ref:`WindowInitialPosition` **initial_position** = ``0`` +:ref:`WindowInitialPosition` **initial_position** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1116,7 +1116,7 @@ Specifies the initial type of position for the **Window**. See :ref:`WindowIniti .. rst-class:: classref-property -:ref:`bool` **keep_title_visible** = ``false`` +:ref:`bool` **keep_title_visible** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1133,7 +1133,7 @@ If ``true``, the **Window** width is expanded to keep the title bar text fully v .. rst-class:: classref-property -:ref:`Vector2i` **max_size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **max_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1152,7 +1152,7 @@ If non-zero, the **Window** can't be resized to be bigger than this size. .. rst-class:: classref-property -:ref:`Vector2i` **min_size** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **min_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1171,7 +1171,7 @@ If non-zero, the **Window** can't be resized to be smaller than this size. .. rst-class:: classref-property -:ref:`Mode` **mode** = ``0`` +:ref:`Mode` **mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1192,7 +1192,7 @@ Set's the window's current mode. .. rst-class:: classref-property -:ref:`bool` **mouse_passthrough** = ``false`` +:ref:`bool` **mouse_passthrough** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1213,7 +1213,7 @@ If ``true``, all mouse events will be passed to the underlying window of the sam .. rst-class:: classref-property -:ref:`PackedVector2Array` **mouse_passthrough_polygon** = ``PackedVector2Array()`` +:ref:`PackedVector2Array` **mouse_passthrough_polygon** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1267,7 +1267,7 @@ Passing an empty array will disable passthrough support (all mouse events will b .. rst-class:: classref-property -:ref:`bool` **popup_window** = ``false`` +:ref:`bool` **popup_window** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1284,7 +1284,7 @@ If ``true``, the **Window** will be considered a popup. Popups are sub-windows t .. rst-class:: classref-property -:ref:`Vector2i` **position** = ``Vector2i(0, 0)`` +:ref:`Vector2i` **position** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1305,7 +1305,7 @@ If :ref:`ProjectSettings.display/window/subwindows/embed_subwindows` **size** = ``Vector2i(100, 100)`` +:ref:`Vector2i` **size** = ``Vector2i(100, 100)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1322,7 +1322,7 @@ The window's size in pixels. .. rst-class:: classref-property -:ref:`Theme` **theme** +:ref:`Theme` **theme** :ref:`🔗` .. rst-class:: classref-property-setget @@ -1341,7 +1341,7 @@ The :ref:`Theme` resource this node and all its :ref:`Control` **theme_type_variation** = ``&""`` +:ref:`StringName` **theme_type_variation** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1358,7 +1358,7 @@ The name of a theme type variation used by this **Window** to look up its own th .. rst-class:: classref-property -:ref:`String` **title** = ``""`` +:ref:`String` **title** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1375,7 +1375,7 @@ The window's title. If the **Window** is native, title styles set in :ref:`Theme .. rst-class:: classref-property -:ref:`bool` **transient** = ``false`` +:ref:`bool` **transient** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1394,7 +1394,7 @@ Note that behavior might be different depending on the platform. .. rst-class:: classref-property -:ref:`bool` **transient_to_focused** = ``false`` +:ref:`bool` **transient_to_focused** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1411,7 +1411,7 @@ If ``true``, and the **Window** is :ref:`transient` **transparent** = ``false`` +:ref:`bool` **transparent** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1432,7 +1432,7 @@ If ``true``, the **Window**'s background can be transparent. This is best used w .. rst-class:: classref-property -:ref:`bool` **unfocusable** = ``false`` +:ref:`bool` **unfocusable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1449,7 +1449,7 @@ If ``true``, the **Window** can't be focused nor interacted with. It can still b .. rst-class:: classref-property -:ref:`bool` **unresizable** = ``false`` +:ref:`bool` **unresizable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1466,7 +1466,7 @@ If ``true``, the window can't be resized. Minimize and maximize buttons are disa .. rst-class:: classref-property -:ref:`bool` **visible** = ``true`` +:ref:`bool` **visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1483,7 +1483,7 @@ If ``true``, the window is visible. .. rst-class:: classref-property -:ref:`bool` **wrap_controls** = ``false`` +:ref:`bool` **wrap_controls** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1507,7 +1507,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **_get_contents_minimum_size**\ (\ ) |virtual| |const| +:ref:`Vector2` **_get_contents_minimum_size**\ (\ ) |virtual| |const| :ref:`🔗` Virtual method to be implemented by the user. Overrides the value returned by :ref:`get_contents_minimum_size`. @@ -1519,7 +1519,7 @@ Virtual method to be implemented by the user. Overrides the value returned by :r .. rst-class:: classref-method -|void| **add_theme_color_override**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) +|void| **add_theme_color_override**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) :ref:`🔗` Creates a local override for a theme :ref:`Color` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_color_override`. @@ -1533,7 +1533,7 @@ See also :ref:`get_theme_color` and :ref:`C .. rst-class:: classref-method -|void| **add_theme_constant_override**\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) +|void| **add_theme_constant_override**\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) :ref:`🔗` Creates a local override for a theme constant with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_constant_override`. @@ -1547,7 +1547,7 @@ See also :ref:`get_theme_constant`. .. rst-class:: classref-method -|void| **add_theme_font_override**\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) +|void| **add_theme_font_override**\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) :ref:`🔗` Creates a local override for a theme :ref:`Font` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_override`. @@ -1561,7 +1561,7 @@ See also :ref:`get_theme_font`. .. rst-class:: classref-method -|void| **add_theme_font_size_override**\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) +|void| **add_theme_font_size_override**\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) :ref:`🔗` Creates a local override for a theme font size with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_size_override`. @@ -1575,7 +1575,7 @@ See also :ref:`get_theme_font_size`. .. rst-class:: classref-method -|void| **add_theme_icon_override**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) +|void| **add_theme_icon_override**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Creates a local override for a theme icon with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_icon_override`. @@ -1589,7 +1589,7 @@ See also :ref:`get_theme_icon`. .. rst-class:: classref-method -|void| **add_theme_stylebox_override**\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) +|void| **add_theme_stylebox_override**\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) :ref:`🔗` Creates a local override for a theme :ref:`StyleBox` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_stylebox_override`. @@ -1603,7 +1603,7 @@ See also :ref:`get_theme_stylebox` and : .. rst-class:: classref-method -|void| **begin_bulk_theme_override**\ (\ ) +|void| **begin_bulk_theme_override**\ (\ ) :ref:`🔗` Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_CHANGED` until :ref:`end_bulk_theme_override` is called. @@ -1615,7 +1615,7 @@ Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_C .. rst-class:: classref-method -:ref:`bool` **can_draw**\ (\ ) |const| +:ref:`bool` **can_draw**\ (\ ) |const| :ref:`🔗` Returns whether the window is being drawn to the screen. @@ -1627,7 +1627,7 @@ Returns whether the window is being drawn to the screen. .. rst-class:: classref-method -|void| **child_controls_changed**\ (\ ) +|void| **child_controls_changed**\ (\ ) :ref:`🔗` Requests an update of the **Window** size to fit underlying :ref:`Control` nodes. @@ -1639,7 +1639,7 @@ Requests an update of the **Window** size to fit underlying :ref:`Control` Ends a bulk theme override update. See :ref:`begin_bulk_theme_override`. @@ -1651,7 +1651,7 @@ Ends a bulk theme override update. See :ref:`begin_bulk_theme_override` **get_contents_minimum_size**\ (\ ) |const| +:ref:`Vector2` **get_contents_minimum_size**\ (\ ) |const| :ref:`🔗` Returns the combined minimum size from the child :ref:`Control` nodes of the window. Use :ref:`child_controls_changed` to update it when child nodes have changed. @@ -1665,7 +1665,7 @@ The value returned by this method can be overridden with :ref:`_get_contents_min .. rst-class:: classref-method -:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| +:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| :ref:`🔗` Returns ``true`` if the ``flag`` is set. @@ -1677,7 +1677,7 @@ Returns ``true`` if the ``flag`` is set. .. rst-class:: classref-method -:ref:`LayoutDirection` **get_layout_direction**\ (\ ) |const| +:ref:`LayoutDirection` **get_layout_direction**\ (\ ) |const| :ref:`🔗` Returns layout direction and text writing direction. @@ -1689,10 +1689,12 @@ Returns layout direction and text writing direction. .. rst-class:: classref-method -:ref:`Vector2i` **get_position_with_decorations**\ (\ ) |const| +:ref:`Vector2i` **get_position_with_decorations**\ (\ ) |const| :ref:`🔗` Returns the window's position including its border. +\ **Note:** If :ref:`visible` is ``false``, this method returns the same value as :ref:`position`. + .. rst-class:: classref-item-separator ---- @@ -1701,10 +1703,12 @@ Returns the window's position including its border. .. rst-class:: classref-method -:ref:`Vector2i` **get_size_with_decorations**\ (\ ) |const| +:ref:`Vector2i` **get_size_with_decorations**\ (\ ) |const| :ref:`🔗` Returns the window's size including its border. +\ **Note:** If :ref:`visible` is ``false``, this method returns the same value as :ref:`size`. + .. rst-class:: classref-item-separator ---- @@ -1713,7 +1717,7 @@ Returns the window's size including its border. .. rst-class:: classref-method -:ref:`Color` **get_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`Color` **get_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a :ref:`Color` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a color item with the specified ``name`` and ``theme_type``. @@ -1727,7 +1731,7 @@ See :ref:`Control.get_theme_color` for mor .. rst-class:: classref-method -:ref:`int` **get_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`int` **get_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a constant from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a constant item with the specified ``name`` and ``theme_type``. @@ -1741,7 +1745,7 @@ See :ref:`Control.get_theme_color` for mor .. rst-class:: classref-method -:ref:`float` **get_theme_default_base_scale**\ (\ ) |const| +:ref:`float` **get_theme_default_base_scale**\ (\ ) |const| :ref:`🔗` Returns the default base scale value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_base_scale` value. @@ -1755,7 +1759,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`Font` **get_theme_default_font**\ (\ ) |const| +:ref:`Font` **get_theme_default_font**\ (\ ) |const| :ref:`🔗` Returns the default font from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font` value. @@ -1769,7 +1773,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`int` **get_theme_default_font_size**\ (\ ) |const| +:ref:`int` **get_theme_default_font_size**\ (\ ) |const| :ref:`🔗` Returns the default font size value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font_size` value. @@ -1783,7 +1787,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`Font` **get_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`Font` **get_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a :ref:`Font` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font item with the specified ``name`` and ``theme_type``. @@ -1797,7 +1801,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`int` **get_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`int` **get_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a font size from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font size item with the specified ``name`` and ``theme_type``. @@ -1811,7 +1815,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`Texture2D` **get_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`Texture2D` **get_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns an icon from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has an icon item with the specified ``name`` and ``theme_type``. @@ -1825,7 +1829,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`StyleBox` **get_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`StyleBox` **get_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns a :ref:`StyleBox` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a stylebox item with the specified ``name`` and ``theme_type``. @@ -1839,7 +1843,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`int` **get_window_id**\ (\ ) |const| +:ref:`int` **get_window_id**\ (\ ) |const| :ref:`🔗` Returns the ID of the window. @@ -1851,7 +1855,7 @@ Returns the ID of the window. .. rst-class:: classref-method -|void| **grab_focus**\ (\ ) +|void| **grab_focus**\ (\ ) :ref:`🔗` Causes the window to grab focus, allowing it to receive user input. @@ -1863,7 +1867,7 @@ Causes the window to grab focus, allowing it to receive user input. .. rst-class:: classref-method -:ref:`bool` **has_focus**\ (\ ) |const| +:ref:`bool` **has_focus**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the window is focused. @@ -1875,7 +1879,7 @@ Returns ``true`` if the window is focused. .. rst-class:: classref-method -:ref:`bool` **has_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a color item with the specified ``name`` and ``theme_type``. @@ -1889,7 +1893,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_color_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_color_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme :ref:`Color` with the specified ``name`` in this :ref:`Control` node. @@ -1903,7 +1907,7 @@ See :ref:`add_theme_color_override .. rst-class:: classref-method -:ref:`bool` **has_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a constant item with the specified ``name`` and ``theme_type``. @@ -1917,7 +1921,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme constant with the specified ``name`` in this :ref:`Control` node. @@ -1931,7 +1935,7 @@ See :ref:`add_theme_constant_override` **has_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font item with the specified ``name`` and ``theme_type``. @@ -1945,7 +1949,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_font_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_font_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme :ref:`Font` with the specified ``name`` in this :ref:`Control` node. @@ -1959,7 +1963,7 @@ See :ref:`add_theme_font_override`. .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font size item with the specified ``name`` and ``theme_type``. @@ -1973,7 +1977,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme font size with the specified ``name`` in this :ref:`Control` node. @@ -1987,7 +1991,7 @@ See :ref:`add_theme_font_size_override` **has_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has an icon item with the specified ``name`` and ``theme_type``. @@ -2001,7 +2005,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme icon with the specified ``name`` in this :ref:`Control` node. @@ -2015,7 +2019,7 @@ See :ref:`add_theme_icon_override`. .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| +:ref:`bool` **has_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a stylebox item with the specified ``name`` and ``theme_type``. @@ -2029,7 +2033,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if there is a local override for a theme :ref:`StyleBox` with the specified ``name`` in this :ref:`Control` node. @@ -2043,7 +2047,7 @@ See :ref:`add_theme_stylebox_override` Hides the window. This is not the same as minimized state. Hidden window can't be interacted with and needs to be made visible with :ref:`show`. @@ -2055,7 +2059,7 @@ Hides the window. This is not the same as minimized state. Hidden window can't b .. rst-class:: classref-method -:ref:`bool` **is_embedded**\ (\ ) |const| +:ref:`bool` **is_embedded**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the window is currently embedded in another window. @@ -2067,7 +2071,7 @@ Returns ``true`` if the window is currently embedded in another window. .. rst-class:: classref-method -:ref:`bool` **is_layout_rtl**\ (\ ) |const| +:ref:`bool` **is_layout_rtl**\ (\ ) |const| :ref:`🔗` Returns ``true`` if layout is right-to-left. @@ -2079,7 +2083,7 @@ Returns ``true`` if layout is right-to-left. .. rst-class:: classref-method -:ref:`bool` **is_maximize_allowed**\ (\ ) |const| +:ref:`bool` **is_maximize_allowed**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the window can be maximized (the maximize button is enabled). @@ -2091,7 +2095,7 @@ Returns ``true`` if the window can be maximized (the maximize button is enabled) .. rst-class:: classref-method -:ref:`bool` **is_using_font_oversampling**\ (\ ) |const| +:ref:`bool` **is_using_font_oversampling**\ (\ ) |const| :ref:`🔗` Returns ``true`` if font oversampling is enabled. See :ref:`set_use_font_oversampling`. @@ -2103,7 +2107,7 @@ Returns ``true`` if font oversampling is enabled. See :ref:`set_use_font_oversam .. rst-class:: classref-method -|void| **move_to_center**\ (\ ) +|void| **move_to_center**\ (\ ) :ref:`🔗` Centers a native window on the current screen and an embedded window on its embedder :ref:`Viewport`. @@ -2115,7 +2119,7 @@ Centers a native window on the current screen and an embedded window on its embe .. rst-class:: classref-method -|void| **move_to_foreground**\ (\ ) +|void| **move_to_foreground**\ (\ ) :ref:`🔗` **Deprecated:** Use :ref:`grab_focus` instead. @@ -2129,7 +2133,7 @@ Causes the window to grab focus, allowing it to receive user input. .. rst-class:: classref-method -|void| **popup**\ (\ rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) +|void| **popup**\ (\ rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) :ref:`🔗` Shows the **Window** and makes it transient (see :ref:`transient`). If ``rect`` is provided, it will be set as the **Window**'s size. Fails if called on the main window. @@ -2141,7 +2145,7 @@ Shows the **Window** and makes it transient (see :ref:`transient` = Vector2i(0, 0)\ ) +|void| **popup_centered**\ (\ minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) :ref:`🔗` Popups the **Window** at the center of the current screen, with optionally given minimum size. If the **Window** is embedded, it will be centered in the parent :ref:`Viewport` instead. @@ -2155,7 +2159,7 @@ Popups the **Window** at the center of the current screen, with optionally given .. rst-class:: classref-method -|void| **popup_centered_clamped**\ (\ minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) +|void| **popup_centered_clamped**\ (\ minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) :ref:`🔗` Popups the **Window** centered inside its parent **Window**. ``fallback_ratio`` determines the maximum size of the **Window**, in relation to its parent. @@ -2169,7 +2173,7 @@ Popups the **Window** centered inside its parent **Window**. ``fallback_ratio`` .. rst-class:: classref-method -|void| **popup_centered_ratio**\ (\ ratio\: :ref:`float` = 0.8\ ) +|void| **popup_centered_ratio**\ (\ ratio\: :ref:`float` = 0.8\ ) :ref:`🔗` If **Window** is embedded, popups the **Window** centered inside its embedder and sets its size as a ``ratio`` of embedder's size. @@ -2183,7 +2187,7 @@ If **Window** is a native window, popups the **Window** centered inside the scre .. rst-class:: classref-method -|void| **popup_exclusive**\ (\ from_node\: :ref:`Node`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) +|void| **popup_exclusive**\ (\ from_node\: :ref:`Node`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) :ref:`🔗` Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup` on it. The dialog must have no current parent, otherwise the method fails. @@ -2197,7 +2201,7 @@ See also :ref:`set_unparent_when_invisible`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) +|void| **popup_exclusive_centered**\ (\ from_node\: :ref:`Node`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) :ref:`🔗` Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_centered` on it. The dialog must have no current parent, otherwise the method fails. @@ -2211,7 +2215,7 @@ See also :ref:`set_unparent_when_invisible`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) +|void| **popup_exclusive_centered_clamped**\ (\ from_node\: :ref:`Node`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) :ref:`🔗` Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_centered_clamped` on it. The dialog must have no current parent, otherwise the method fails. @@ -2225,7 +2229,7 @@ See also :ref:`set_unparent_when_invisible`, ratio\: :ref:`float` = 0.8\ ) +|void| **popup_exclusive_centered_ratio**\ (\ from_node\: :ref:`Node`, ratio\: :ref:`float` = 0.8\ ) :ref:`🔗` Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_centered_ratio` on it. The dialog must have no current parent, otherwise the method fails. @@ -2239,7 +2243,7 @@ See also :ref:`set_unparent_when_invisible`, parent_rect\: :ref:`Rect2i`\ ) +|void| **popup_exclusive_on_parent**\ (\ from_node\: :ref:`Node`, parent_rect\: :ref:`Rect2i`\ ) :ref:`🔗` Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_on_parent` on it. The dialog must have no current parent, otherwise the method fails. @@ -2253,7 +2257,7 @@ See also :ref:`set_unparent_when_invisible`\ ) +|void| **popup_on_parent**\ (\ parent_rect\: :ref:`Rect2i`\ ) :ref:`🔗` Popups the **Window** with a position shifted by parent **Window**'s position. If the **Window** is embedded, has the same effect as :ref:`popup`. @@ -2265,7 +2269,7 @@ Popups the **Window** with a position shifted by parent **Window**'s position. I .. rst-class:: classref-method -|void| **remove_theme_color_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_color_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme :ref:`Color` with the specified ``name`` previously added by :ref:`add_theme_color_override` or via the Inspector dock. @@ -2277,7 +2281,7 @@ Removes a local override for a theme :ref:`Color` with the specifie .. rst-class:: classref-method -|void| **remove_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme constant with the specified ``name`` previously added by :ref:`add_theme_constant_override` or via the Inspector dock. @@ -2289,7 +2293,7 @@ Removes a local override for a theme constant with the specified ``name`` previo .. rst-class:: classref-method -|void| **remove_theme_font_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_font_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme :ref:`Font` with the specified ``name`` previously added by :ref:`add_theme_font_override` or via the Inspector dock. @@ -2301,7 +2305,7 @@ Removes a local override for a theme :ref:`Font` with the specified .. rst-class:: classref-method -|void| **remove_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme font size with the specified ``name`` previously added by :ref:`add_theme_font_size_override` or via the Inspector dock. @@ -2313,7 +2317,7 @@ Removes a local override for a theme font size with the specified ``name`` previ .. rst-class:: classref-method -|void| **remove_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme icon with the specified ``name`` previously added by :ref:`add_theme_icon_override` or via the Inspector dock. @@ -2325,7 +2329,7 @@ Removes a local override for a theme icon with the specified ``name`` previously .. rst-class:: classref-method -|void| **remove_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) +|void| **remove_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a local override for a theme :ref:`StyleBox` with the specified ``name`` previously added by :ref:`add_theme_stylebox_override` or via the Inspector dock. @@ -2337,7 +2341,7 @@ Removes a local override for a theme :ref:`StyleBox` with the sp .. rst-class:: classref-method -|void| **request_attention**\ (\ ) +|void| **request_attention**\ (\ ) :ref:`🔗` Tells the OS that the **Window** needs an attention. This makes the window stand out in some way depending on the system, e.g. it might blink on the task bar. @@ -2349,7 +2353,7 @@ Tells the OS that the **Window** needs an attention. This makes the window stand .. rst-class:: classref-method -|void| **reset_size**\ (\ ) +|void| **reset_size**\ (\ ) :ref:`🔗` Resets the size to the minimum size, which is the max of :ref:`min_size` and (if :ref:`wrap_controls` is enabled) :ref:`get_contents_minimum_size`. This is equivalent to calling ``set_size(Vector2i())`` (or any size below the minimum). @@ -2361,7 +2365,7 @@ Resets the size to the minimum size, which is the max of :ref:`min_size`, enabled\: :ref:`bool`\ ) +|void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets a specified window flag. @@ -2373,7 +2377,7 @@ Sets a specified window flag. .. rst-class:: classref-method -|void| **set_ime_active**\ (\ active\: :ref:`bool`\ ) +|void| **set_ime_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` If ``active`` is ``true``, enables system's native IME (Input Method Editor). @@ -2385,7 +2389,7 @@ If ``active`` is ``true``, enables system's native IME (Input Method Editor). .. rst-class:: classref-method -|void| **set_ime_position**\ (\ position\: :ref:`Vector2i`\ ) +|void| **set_ime_position**\ (\ position\: :ref:`Vector2i`\ ) :ref:`🔗` Moves IME to the given position. @@ -2397,7 +2401,7 @@ Moves IME to the given position. .. rst-class:: classref-method -|void| **set_layout_direction**\ (\ direction\: :ref:`LayoutDirection`\ ) +|void| **set_layout_direction**\ (\ direction\: :ref:`LayoutDirection`\ ) :ref:`🔗` Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). @@ -2409,7 +2413,7 @@ Sets layout direction and text writing direction. Right-to-left layouts are nece .. rst-class:: classref-method -|void| **set_unparent_when_invisible**\ (\ unparent\: :ref:`bool`\ ) +|void| **set_unparent_when_invisible**\ (\ unparent\: :ref:`bool`\ ) :ref:`🔗` If ``unparent`` is ``true``, the window is automatically unparented when going invisible. @@ -2423,7 +2427,7 @@ If ``unparent`` is ``true``, the window is automatically unparented when going i .. rst-class:: classref-method -|void| **set_use_font_oversampling**\ (\ enable\: :ref:`bool`\ ) +|void| **set_use_font_oversampling**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` Enables font oversampling. This makes fonts look better when they are scaled up. @@ -2435,7 +2439,7 @@ Enables font oversampling. This makes fonts look better when they are scaled up. .. rst-class:: classref-method -|void| **show**\ (\ ) +|void| **show**\ (\ ) :ref:`🔗` Makes the **Window** appear. This enables interactions with the **Window** and doesn't change any of its property other than visibility (unlike e.g. :ref:`popup`). @@ -2452,7 +2456,7 @@ Theme Property Descriptions .. rst-class:: classref-themeproperty -:ref:`Color` **title_color** = ``Color(0.875, 0.875, 0.875, 1)`` +:ref:`Color` **title_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` The color of the title's text. @@ -2464,7 +2468,7 @@ The color of the title's text. .. rst-class:: classref-themeproperty -:ref:`Color` **title_outline_modulate** = ``Color(0, 0, 0, 1)`` +:ref:`Color` **title_outline_modulate** = ``Color(0, 0, 0, 1)`` :ref:`🔗` The color of the title's text outline. @@ -2476,7 +2480,7 @@ The color of the title's text outline. .. rst-class:: classref-themeproperty -:ref:`int` **close_h_offset** = ``18`` +:ref:`int` **close_h_offset** = ``18`` :ref:`🔗` Horizontal position offset of the close button. @@ -2488,7 +2492,7 @@ Horizontal position offset of the close button. .. rst-class:: classref-themeproperty -:ref:`int` **close_v_offset** = ``24`` +:ref:`int` **close_v_offset** = ``24`` :ref:`🔗` Vertical position offset of the close button. @@ -2500,7 +2504,7 @@ Vertical position offset of the close button. .. rst-class:: classref-themeproperty -:ref:`int` **resize_margin** = ``4`` +:ref:`int` **resize_margin** = ``4`` :ref:`🔗` Defines the outside margin at which the window border can be grabbed with mouse and resized. @@ -2512,7 +2516,7 @@ Defines the outside margin at which the window border can be grabbed with mouse .. rst-class:: classref-themeproperty -:ref:`int` **title_height** = ``36`` +:ref:`int` **title_height** = ``36`` :ref:`🔗` Height of the title bar. @@ -2524,7 +2528,7 @@ Height of the title bar. .. rst-class:: classref-themeproperty -:ref:`int` **title_outline_size** = ``0`` +:ref:`int` **title_outline_size** = ``0`` :ref:`🔗` The size of the title outline. @@ -2536,7 +2540,7 @@ The size of the title outline. .. rst-class:: classref-themeproperty -:ref:`Font` **title_font** +:ref:`Font` **title_font** :ref:`🔗` The font used to draw the title. @@ -2548,7 +2552,7 @@ The font used to draw the title. .. rst-class:: classref-themeproperty -:ref:`int` **title_font_size** +:ref:`int` **title_font_size** :ref:`🔗` The size of the title font. @@ -2560,7 +2564,7 @@ The size of the title font. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **close** +:ref:`Texture2D` **close** :ref:`🔗` The icon for the close button. @@ -2572,7 +2576,7 @@ The icon for the close button. .. rst-class:: classref-themeproperty -:ref:`Texture2D` **close_pressed** +:ref:`Texture2D` **close_pressed** :ref:`🔗` The icon for the close button when it's being pressed. @@ -2584,7 +2588,7 @@ The icon for the close button when it's being pressed. .. rst-class:: classref-themeproperty -:ref:`StyleBox` **embedded_border** +:ref:`StyleBox` **embedded_border** :ref:`🔗` The background style used when the **Window** is embedded. Note that this is drawn only under the window's content, excluding the title. For proper borders and title bar style, you can use ``expand_margin_*`` properties of :ref:`StyleBoxFlat`. @@ -2598,7 +2602,7 @@ The background style used when the **Window** is embedded. Note that this is dra .. rst-class:: classref-themeproperty -:ref:`StyleBox` **embedded_unfocused_border** +:ref:`StyleBox` **embedded_unfocused_border** :ref:`🔗` The background style used when the **Window** is embedded and unfocused. diff --git a/classes/class_workerthreadpool.rst b/classes/class_workerthreadpool.rst index d6d1f040b25..8aa1dbc4af8 100644 --- a/classes/class_workerthreadpool.rst +++ b/classes/class_workerthreadpool.rst @@ -112,7 +112,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_group_task**\ (\ action\: :ref:`Callable`, elements\: :ref:`int`, tasks_needed\: :ref:`int` = -1, high_priority\: :ref:`bool` = false, description\: :ref:`String` = ""\ ) +:ref:`int` **add_group_task**\ (\ action\: :ref:`Callable`, elements\: :ref:`int`, tasks_needed\: :ref:`int` = -1, high_priority\: :ref:`bool` = false, description\: :ref:`String` = ""\ ) :ref:`🔗` Adds ``action`` as a group task to be executed by the worker threads. The :ref:`Callable` will be called a number of times based on ``elements``, with the first thread calling it with the value ``0`` as a parameter, and each consecutive execution incrementing this value by 1 until it reaches ``element - 1``. @@ -130,7 +130,7 @@ Returns a group task ID that can be used by other methods. .. rst-class:: classref-method -:ref:`int` **add_task**\ (\ action\: :ref:`Callable`, high_priority\: :ref:`bool` = false, description\: :ref:`String` = ""\ ) +:ref:`int` **add_task**\ (\ action\: :ref:`Callable`, high_priority\: :ref:`bool` = false, description\: :ref:`String` = ""\ ) :ref:`🔗` Adds ``action`` as a task to be executed by a worker thread. ``high_priority`` determines if the task has a high priority or a low priority (default). You can optionally provide a ``description`` to help with debugging. @@ -146,7 +146,7 @@ Returns a task ID that can be used by other methods. .. rst-class:: classref-method -:ref:`int` **get_group_processed_element_count**\ (\ group_id\: :ref:`int`\ ) |const| +:ref:`int` **get_group_processed_element_count**\ (\ group_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns how many times the :ref:`Callable` of the group task with the given ID has already been executed by the worker threads. @@ -160,7 +160,7 @@ Returns how many times the :ref:`Callable` of the group task wit .. rst-class:: classref-method -:ref:`bool` **is_group_task_completed**\ (\ group_id\: :ref:`int`\ ) |const| +:ref:`bool` **is_group_task_completed**\ (\ group_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the group task with the given ID is completed. @@ -174,7 +174,7 @@ Returns ``true`` if the group task with the given ID is completed. .. rst-class:: classref-method -:ref:`bool` **is_task_completed**\ (\ task_id\: :ref:`int`\ ) |const| +:ref:`bool` **is_task_completed**\ (\ task_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the task with the given ID is completed. @@ -188,7 +188,7 @@ Returns ``true`` if the task with the given ID is completed. .. rst-class:: classref-method -|void| **wait_for_group_task_completion**\ (\ group_id\: :ref:`int`\ ) +|void| **wait_for_group_task_completion**\ (\ group_id\: :ref:`int`\ ) :ref:`🔗` Pauses the thread that calls this method until the group task with the given ID is completed. @@ -200,7 +200,7 @@ Pauses the thread that calls this method until the group task with the given ID .. rst-class:: classref-method -:ref:`Error` **wait_for_task_completion**\ (\ task_id\: :ref:`int`\ ) +:ref:`Error` **wait_for_task_completion**\ (\ task_id\: :ref:`int`\ ) :ref:`🔗` Pauses the thread that calls this method until the task with the given ID is completed. diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 77a33a90464..4413b96eda5 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RID` **canvas** +:ref:`RID` **canvas** :ref:`🔗` .. rst-class:: classref-property-setget @@ -75,7 +75,7 @@ The :ref:`RID` of this world's canvas resource. Used by the :ref:`Ren .. rst-class:: classref-property -:ref:`PhysicsDirectSpaceState2D` **direct_space_state** +:ref:`PhysicsDirectSpaceState2D` **direct_space_state** :ref:`🔗` .. rst-class:: classref-property-setget @@ -91,7 +91,7 @@ Direct access to the world's physics 2D space state. Used for querying current a .. rst-class:: classref-property -:ref:`RID` **navigation_map** +:ref:`RID` **navigation_map** :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The :ref:`RID` of this world's navigation map. Used by the :ref:`Navi .. rst-class:: classref-property -:ref:`RID` **space** +:ref:`RID` **space** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_world3d.rst b/classes/class_world3d.rst index 5cf5c472ffe..db863832d08 100644 --- a/classes/class_world3d.rst +++ b/classes/class_world3d.rst @@ -65,7 +65,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CameraAttributes` **camera_attributes** +:ref:`CameraAttributes` **camera_attributes** :ref:`🔗` .. rst-class:: classref-property-setget @@ -82,7 +82,7 @@ The default :ref:`CameraAttributes` resource to use if n .. rst-class:: classref-property -:ref:`PhysicsDirectSpaceState3D` **direct_space_state** +:ref:`PhysicsDirectSpaceState3D` **direct_space_state** :ref:`🔗` .. rst-class:: classref-property-setget @@ -98,7 +98,7 @@ Direct access to the world's physics 3D space state. Used for querying current a .. rst-class:: classref-property -:ref:`Environment` **environment** +:ref:`Environment` **environment** :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ The World3D's :ref:`Environment`. .. rst-class:: classref-property -:ref:`Environment` **fallback_environment** +:ref:`Environment` **fallback_environment** :ref:`🔗` .. rst-class:: classref-property-setget @@ -132,7 +132,7 @@ The World3D's fallback environment will be used if :ref:`environment` **navigation_map** +:ref:`RID` **navigation_map** :ref:`🔗` .. rst-class:: classref-property-setget @@ -148,7 +148,7 @@ The :ref:`RID` of this world's navigation map. Used by the :ref:`Navi .. rst-class:: classref-property -:ref:`RID` **scenario** +:ref:`RID` **scenario** :ref:`🔗` .. rst-class:: classref-property-setget @@ -164,7 +164,7 @@ The World3D's visual scenario. .. rst-class:: classref-property -:ref:`RID` **space** +:ref:`RID` **space** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_worldboundaryshape2d.rst b/classes/class_worldboundaryshape2d.rst index 34bf00942fb..27f0f15b4a7 100644 --- a/classes/class_worldboundaryshape2d.rst +++ b/classes/class_worldboundaryshape2d.rst @@ -48,7 +48,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **distance** = ``0.0`` +:ref:`float` **distance** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -67,7 +67,7 @@ In the scalar equation of the line ``ax + by = d``, this is ``d``, while the ``( .. rst-class:: classref-property -:ref:`Vector2` **normal** = ``Vector2(0, -1)`` +:ref:`Vector2` **normal** = ``Vector2(0, -1)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_worldboundaryshape3d.rst b/classes/class_worldboundaryshape3d.rst index 41f17875ffe..2b3b11222e5 100644 --- a/classes/class_worldboundaryshape3d.rst +++ b/classes/class_worldboundaryshape3d.rst @@ -46,7 +46,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Plane` **plane** = ``Plane(0, 1, 0, 0)`` +:ref:`Plane` **plane** = ``Plane(0, 1, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index e21d74081a2..3d149e818e5 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -68,7 +68,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`CameraAttributes` **camera_attributes** +:ref:`CameraAttributes` **camera_attributes** :ref:`🔗` .. rst-class:: classref-property-setget @@ -85,7 +85,7 @@ The default :ref:`CameraAttributes` resource to use if n .. rst-class:: classref-property -:ref:`Compositor` **compositor** +:ref:`Compositor` **compositor** :ref:`🔗` .. rst-class:: classref-property-setget @@ -102,7 +102,7 @@ The default :ref:`Compositor` resource to use if none set on t .. rst-class:: classref-property -:ref:`Environment` **environment** +:ref:`Environment` **environment** :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_x509certificate.rst b/classes/class_x509certificate.rst index 34194906e71..e7814580293 100644 --- a/classes/class_x509certificate.rst +++ b/classes/class_x509certificate.rst @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Loads a certificate from ``path`` ("\*.crt" file). @@ -73,7 +73,7 @@ Loads a certificate from ``path`` ("\*.crt" file). .. rst-class:: classref-method -:ref:`Error` **load_from_string**\ (\ string\: :ref:`String`\ ) +:ref:`Error` **load_from_string**\ (\ string\: :ref:`String`\ ) :ref:`🔗` Loads a certificate from the given ``string``. @@ -85,7 +85,7 @@ Loads a certificate from the given ``string``. .. rst-class:: classref-method -:ref:`Error` **save**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **save**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Saves a certificate to the given ``path`` (should be a "\*.crt" file). @@ -97,7 +97,7 @@ Saves a certificate to the given ``path`` (should be a "\*.crt" file). .. rst-class:: classref-method -:ref:`String` **save_to_string**\ (\ ) +:ref:`String` **save_to_string**\ (\ ) :ref:`🔗` Returns a string representation of the certificate, or an empty string if the certificate is invalid. diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 81b9c95f57c..6fe88965d4c 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -117,7 +117,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **NodeType**: +enum **NodeType**: :ref:`🔗` .. _class_XMLParser_constant_NODE_NONE: @@ -188,7 +188,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_attribute_count**\ (\ ) |const| +:ref:`int` **get_attribute_count**\ (\ ) |const| :ref:`🔗` Returns the number of attributes in the currently parsed element. @@ -202,7 +202,7 @@ Returns the number of attributes in the currently parsed element. .. rst-class:: classref-method -:ref:`String` **get_attribute_name**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_attribute_name**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of an attribute of the currently parsed element, specified by the ``idx`` index. @@ -214,7 +214,7 @@ Returns the name of an attribute of the currently parsed element, specified by t .. rst-class:: classref-method -:ref:`String` **get_attribute_value**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`String` **get_attribute_value**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of an attribute of the currently parsed element, specified by the ``idx`` index. @@ -226,7 +226,7 @@ Returns the value of an attribute of the currently parsed element, specified by .. rst-class:: classref-method -:ref:`int` **get_current_line**\ (\ ) |const| +:ref:`int` **get_current_line**\ (\ ) |const| :ref:`🔗` Returns the current line in the parsed file, counting from 0. @@ -238,7 +238,7 @@ Returns the current line in the parsed file, counting from 0. .. rst-class:: classref-method -:ref:`String` **get_named_attribute_value**\ (\ name\: :ref:`String`\ ) |const| +:ref:`String` **get_named_attribute_value**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the value of an attribute of the currently parsed element, specified by its ``name``. This method will raise an error if the element has no such attribute. @@ -250,7 +250,7 @@ Returns the value of an attribute of the currently parsed element, specified by .. rst-class:: classref-method -:ref:`String` **get_named_attribute_value_safe**\ (\ name\: :ref:`String`\ ) |const| +:ref:`String` **get_named_attribute_value_safe**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the value of an attribute of the currently parsed element, specified by its ``name``. This method will return an empty string if the element has no such attribute. @@ -262,7 +262,7 @@ Returns the value of an attribute of the currently parsed element, specified by .. rst-class:: classref-method -:ref:`String` **get_node_data**\ (\ ) |const| +:ref:`String` **get_node_data**\ (\ ) |const| :ref:`🔗` Returns the contents of a text node. This method will raise an error if the current parsed node is of any other type. @@ -274,7 +274,7 @@ Returns the contents of a text node. This method will raise an error if the curr .. rst-class:: classref-method -:ref:`String` **get_node_name**\ (\ ) |const| +:ref:`String` **get_node_name**\ (\ ) |const| :ref:`🔗` Returns the name of a node. This method will raise an error if the currently parsed node is a text node. @@ -288,7 +288,7 @@ Returns the name of a node. This method will raise an error if the currently par .. rst-class:: classref-method -:ref:`int` **get_node_offset**\ (\ ) |const| +:ref:`int` **get_node_offset**\ (\ ) |const| :ref:`🔗` Returns the byte offset of the currently parsed node since the beginning of the file or buffer. This is usually equivalent to the number of characters before the read position. @@ -300,7 +300,7 @@ Returns the byte offset of the currently parsed node since the beginning of the .. rst-class:: classref-method -:ref:`NodeType` **get_node_type**\ (\ ) +:ref:`NodeType` **get_node_type**\ (\ ) :ref:`🔗` Returns the type of the current node. Compare with :ref:`NodeType` constants. @@ -312,7 +312,7 @@ Returns the type of the current node. Compare with :ref:`NodeType` **has_attribute**\ (\ name\: :ref:`String`\ ) |const| +:ref:`bool` **has_attribute**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the currently parsed element has an attribute with the ``name``. @@ -324,7 +324,7 @@ Returns ``true`` if the currently parsed element has an attribute with the ``nam .. rst-class:: classref-method -:ref:`bool` **is_empty**\ (\ ) |const| +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the currently parsed element is empty, e.g. ````. @@ -336,7 +336,7 @@ Returns ``true`` if the currently parsed element is empty, e.g. ````. .. rst-class:: classref-method -:ref:`Error` **open**\ (\ file\: :ref:`String`\ ) +:ref:`Error` **open**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Opens an XML ``file`` for parsing. This method returns an error code. @@ -348,7 +348,7 @@ Opens an XML ``file`` for parsing. This method returns an error code. .. rst-class:: classref-method -:ref:`Error` **open_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) +:ref:`Error` **open_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` Opens an XML raw ``buffer`` for parsing. This method returns an error code. @@ -360,7 +360,7 @@ Opens an XML raw ``buffer`` for parsing. This method returns an error code. .. rst-class:: classref-method -:ref:`Error` **read**\ (\ ) +:ref:`Error` **read**\ (\ ) :ref:`🔗` Parses the next node in the file. This method returns an error code. @@ -372,7 +372,7 @@ Parses the next node in the file. This method returns an error code. .. rst-class:: classref-method -:ref:`Error` **seek**\ (\ position\: :ref:`int`\ ) +:ref:`Error` **seek**\ (\ position\: :ref:`int`\ ) :ref:`🔗` Moves the buffer cursor to a certain offset (since the beginning) and reads the next node there. This method returns an error code. @@ -384,7 +384,7 @@ Moves the buffer cursor to a certain offset (since the beginning) and reads the .. rst-class:: classref-method -|void| **skip_section**\ (\ ) +|void| **skip_section**\ (\ ) :ref:`🔗` Skips the current section. If the currently parsed node contains more inner nodes, they will be ignored and the cursor will go to the closing of the current element. diff --git a/classes/class_xranchor3d.rst b/classes/class_xranchor3d.rst index 58d5071a262..5af1357d395 100644 --- a/classes/class_xranchor3d.rst +++ b/classes/class_xranchor3d.rst @@ -59,7 +59,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Plane` **get_plane**\ (\ ) |const| +:ref:`Plane` **get_plane**\ (\ ) |const| :ref:`🔗` Returns a plane aligned with our anchor; handy for intersection testing. @@ -71,7 +71,7 @@ Returns a plane aligned with our anchor; handy for intersection testing. .. rst-class:: classref-method -:ref:`Vector3` **get_size**\ (\ ) |const| +:ref:`Vector3` **get_size**\ (\ ) |const| :ref:`🔗` Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. diff --git a/classes/class_xrbodymodifier3d.rst b/classes/class_xrbodymodifier3d.rst index 3bdff390210..13768cfcb82 100644 --- a/classes/class_xrbodymodifier3d.rst +++ b/classes/class_xrbodymodifier3d.rst @@ -63,7 +63,7 @@ Enumerations .. rst-class:: classref-enumeration -flags **BodyUpdate**: +flags **BodyUpdate**: :ref:`🔗` .. _class_XRBodyModifier3D_constant_BODY_UPDATE_UPPER_BODY: @@ -97,7 +97,7 @@ The skeleton's hand joints are updated. .. rst-class:: classref-enumeration -enum **BoneUpdate**: +enum **BoneUpdate**: :ref:`🔗` .. _class_XRBodyModifier3D_constant_BONE_UPDATE_FULL: @@ -136,7 +136,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **body_tracker** = ``&"/user/body_tracker"`` +:ref:`StringName` **body_tracker** = ``&"/user/body_tracker"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -153,7 +153,7 @@ The name of the :ref:`XRBodyTracker` registered with :ref:` .. rst-class:: classref-property -|bitfield|\[:ref:`BodyUpdate`\] **body_update** = ``7`` +|bitfield|\[:ref:`BodyUpdate`\] **body_update** = ``7`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -170,7 +170,7 @@ Specifies the body parts to update. .. rst-class:: classref-property -:ref:`BoneUpdate` **bone_update** = ``0`` +:ref:`BoneUpdate` **bone_update** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_xrbodytracker.rst b/classes/class_xrbodytracker.rst index 13156551f65..4d7b877ec90 100644 --- a/classes/class_xrbodytracker.rst +++ b/classes/class_xrbodytracker.rst @@ -79,7 +79,7 @@ Enumerations .. rst-class:: classref-enumeration -flags **BodyFlags**: +flags **BodyFlags**: :ref:`🔗` .. _class_XRBodyTracker_constant_BODY_FLAG_UPPER_BODY_SUPPORTED: @@ -113,7 +113,7 @@ Hand tracking supported. .. rst-class:: classref-enumeration -enum **Joint**: +enum **Joint**: :ref:`🔗` .. _class_XRBodyTracker_constant_JOINT_ROOT: @@ -739,7 +739,7 @@ Represents the size of the :ref:`Joint` enum. .. rst-class:: classref-enumeration -flags **JointFlags**: +flags **JointFlags**: :ref:`🔗` .. _class_XRBodyTracker_constant_JOINT_FLAG_ORIENTATION_VALID: @@ -786,7 +786,7 @@ Property Descriptions .. rst-class:: classref-property -|bitfield|\[:ref:`BodyFlags`\] **body_flags** = ``0`` +|bitfield|\[:ref:`BodyFlags`\] **body_flags** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -803,7 +803,7 @@ The type of body tracking data captured. .. rst-class:: classref-property -:ref:`bool` **has_tracking_data** = ``false`` +:ref:`bool` **has_tracking_data** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -825,7 +825,7 @@ Method Descriptions .. rst-class:: classref-method -|bitfield|\[:ref:`JointFlags`\] **get_joint_flags**\ (\ joint\: :ref:`Joint`\ ) |const| +|bitfield|\[:ref:`JointFlags`\] **get_joint_flags**\ (\ joint\: :ref:`Joint`\ ) |const| :ref:`🔗` Returns flags about the validity of the tracking data for the given body joint (see :ref:`JointFlags`). @@ -837,7 +837,7 @@ Returns flags about the validity of the tracking data for the given body joint ( .. rst-class:: classref-method -:ref:`Transform3D` **get_joint_transform**\ (\ joint\: :ref:`Joint`\ ) |const| +:ref:`Transform3D` **get_joint_transform**\ (\ joint\: :ref:`Joint`\ ) |const| :ref:`🔗` Returns the transform for the given body joint. @@ -849,7 +849,7 @@ Returns the transform for the given body joint. .. rst-class:: classref-method -|void| **set_joint_flags**\ (\ joint\: :ref:`Joint`, flags\: |bitfield|\[:ref:`JointFlags`\]\ ) +|void| **set_joint_flags**\ (\ joint\: :ref:`Joint`, flags\: |bitfield|\[:ref:`JointFlags`\]\ ) :ref:`🔗` Sets flags about the validity of the tracking data for the given body joint. @@ -861,7 +861,7 @@ Sets flags about the validity of the tracking data for the given body joint. .. rst-class:: classref-method -|void| **set_joint_transform**\ (\ joint\: :ref:`Joint`, transform\: :ref:`Transform3D`\ ) +|void| **set_joint_transform**\ (\ joint\: :ref:`Joint`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform for the given body joint. diff --git a/classes/class_xrcontroller3d.rst b/classes/class_xrcontroller3d.rst index 2d5019616cd..9c6da2a530d 100644 --- a/classes/class_xrcontroller3d.rst +++ b/classes/class_xrcontroller3d.rst @@ -67,7 +67,7 @@ Signals .. rst-class:: classref-signal -**button_pressed**\ (\ name\: :ref:`String`\ ) +**button_pressed**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Emitted when a button on this controller is pressed. @@ -79,7 +79,7 @@ Emitted when a button on this controller is pressed. .. rst-class:: classref-signal -**button_released**\ (\ name\: :ref:`String`\ ) +**button_released**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Emitted when a button on this controller is released. @@ -91,7 +91,7 @@ Emitted when a button on this controller is released. .. rst-class:: classref-signal -**input_float_changed**\ (\ name\: :ref:`String`, value\: :ref:`float`\ ) +**input_float_changed**\ (\ name\: :ref:`String`, value\: :ref:`float`\ ) :ref:`🔗` Emitted when a trigger or similar input on this controller changes value. @@ -103,7 +103,7 @@ Emitted when a trigger or similar input on this controller changes value. .. rst-class:: classref-signal -**input_vector2_changed**\ (\ name\: :ref:`String`, value\: :ref:`Vector2`\ ) +**input_vector2_changed**\ (\ name\: :ref:`String`, value\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when a thumbstick or thumbpad on this controller is moved. @@ -115,7 +115,7 @@ Emitted when a thumbstick or thumbpad on this controller is moved. .. rst-class:: classref-signal -**profile_changed**\ (\ role\: :ref:`String`\ ) +**profile_changed**\ (\ role\: :ref:`String`\ ) :ref:`🔗` Emitted when the interaction profile on this controller is changed. @@ -132,7 +132,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_float**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`float` **get_float**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a numeric value for the input with the given ``name``. This is used for triggers and grip sensors. @@ -144,7 +144,7 @@ Returns a numeric value for the input with the given ``name``. This is used for .. rst-class:: classref-method -:ref:`Variant` **get_input**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_input**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a :ref:`Variant` for the input with the given ``name``. This works for any input type, the variant will be typed according to the actions configuration. @@ -156,7 +156,7 @@ Returns a :ref:`Variant` for the input with the given ``name``. T .. rst-class:: classref-method -:ref:`TrackerHand` **get_tracker_hand**\ (\ ) |const| +:ref:`TrackerHand` **get_tracker_hand**\ (\ ) |const| :ref:`🔗` Returns the hand holding this controller, if known. See :ref:`TrackerHand`. @@ -168,7 +168,7 @@ Returns the hand holding this controller, if known. See :ref:`TrackerHand` **get_vector2**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Vector2` **get_vector2**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a :ref:`Vector2` for the input with the given ``name``. This is used for thumbsticks and thumbpads found on many controllers. @@ -180,7 +180,7 @@ Returns a :ref:`Vector2` for the input with the given ``name``. T .. rst-class:: classref-method -:ref:`bool` **is_button_pressed**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **is_button_pressed**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the button with the given ``name`` is pressed. diff --git a/classes/class_xrfacemodifier3d.rst b/classes/class_xrfacemodifier3d.rst index 28f19240258..7c32c288d5e 100644 --- a/classes/class_xrfacemodifier3d.rst +++ b/classes/class_xrfacemodifier3d.rst @@ -61,7 +61,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **face_tracker** = ``&"/user/face_tracker"`` +:ref:`StringName` **face_tracker** = ``&"/user/face_tracker"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -78,7 +78,7 @@ The :ref:`XRFaceTracker` path. .. rst-class:: classref-property -:ref:`NodePath` **target** = ``NodePath("")`` +:ref:`NodePath` **target** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_xrfacetracker.rst b/classes/class_xrfacetracker.rst index eca65ea2bac..be5a535f057 100644 --- a/classes/class_xrfacetracker.rst +++ b/classes/class_xrfacetracker.rst @@ -73,7 +73,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BlendShapeEntry**: +enum **BlendShapeEntry**: :ref:`🔗` .. _class_XRFaceTracker_constant_FT_EYE_LOOK_OUT_RIGHT: @@ -1240,7 +1240,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`PackedFloat32Array` **blend_shapes** = ``PackedFloat32Array()`` +:ref:`PackedFloat32Array` **blend_shapes** = ``PackedFloat32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -1264,7 +1264,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_blend_shape**\ (\ blend_shape\: :ref:`BlendShapeEntry`\ ) |const| +:ref:`float` **get_blend_shape**\ (\ blend_shape\: :ref:`BlendShapeEntry`\ ) |const| :ref:`🔗` Returns the requested face blend shape weight. @@ -1276,7 +1276,7 @@ Returns the requested face blend shape weight. .. rst-class:: classref-method -|void| **set_blend_shape**\ (\ blend_shape\: :ref:`BlendShapeEntry`, weight\: :ref:`float`\ ) +|void| **set_blend_shape**\ (\ blend_shape\: :ref:`BlendShapeEntry`, weight\: :ref:`float`\ ) :ref:`🔗` Sets a face blend shape weight. diff --git a/classes/class_xrhandmodifier3d.rst b/classes/class_xrhandmodifier3d.rst index 1f04428adeb..d94d2c5a45c 100644 --- a/classes/class_xrhandmodifier3d.rst +++ b/classes/class_xrhandmodifier3d.rst @@ -59,7 +59,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **BoneUpdate**: +enum **BoneUpdate**: :ref:`🔗` .. _class_XRHandModifier3D_constant_BONE_UPDATE_FULL: @@ -98,7 +98,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`BoneUpdate` **bone_update** = ``0`` +:ref:`BoneUpdate` **bone_update** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -115,7 +115,7 @@ Specifies the type of updates to perform on the bones. .. rst-class:: classref-property -:ref:`StringName` **hand_tracker** = ``&"/user/hand_tracker/left"`` +:ref:`StringName` **hand_tracker** = ``&"/user/hand_tracker/left"`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_xrhandtracker.rst b/classes/class_xrhandtracker.rst index 0c939ac70ad..9aeb48e332c 100644 --- a/classes/class_xrhandtracker.rst +++ b/classes/class_xrhandtracker.rst @@ -91,7 +91,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **HandTrackingSource**: +enum **HandTrackingSource**: :ref:`🔗` .. _class_XRHandTracker_constant_HAND_TRACKING_SOURCE_UNKNOWN: @@ -133,7 +133,7 @@ Represents the size of the :ref:`HandTrackingSource` .. _class_XRHandTracker_constant_HAND_JOINT_PALM: @@ -359,7 +359,7 @@ Represents the size of the :ref:`HandJoint` enum. .. rst-class:: classref-enumeration -flags **HandJointFlags**: +flags **HandJointFlags**: :ref:`🔗` .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_ORIENTATION_VALID: @@ -422,7 +422,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`HandTrackingSource` **hand_tracking_source** = ``0`` +:ref:`HandTrackingSource` **hand_tracking_source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -439,7 +439,7 @@ The source of the hand tracking data. .. rst-class:: classref-property -:ref:`bool` **has_tracking_data** = ``false`` +:ref:`bool` **has_tracking_data** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -461,7 +461,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_angular_velocity**\ (\ joint\: :ref:`HandJoint`\ ) |const| +:ref:`Vector3` **get_hand_joint_angular_velocity**\ (\ joint\: :ref:`HandJoint`\ ) |const| :ref:`🔗` Returns the angular velocity for the given hand joint. @@ -473,7 +473,7 @@ Returns the angular velocity for the given hand joint. .. rst-class:: classref-method -|bitfield|\[:ref:`HandJointFlags`\] **get_hand_joint_flags**\ (\ joint\: :ref:`HandJoint`\ ) |const| +|bitfield|\[:ref:`HandJointFlags`\] **get_hand_joint_flags**\ (\ joint\: :ref:`HandJoint`\ ) |const| :ref:`🔗` Returns flags about the validity of the tracking data for the given hand joint (see :ref:`HandJointFlags`). @@ -485,7 +485,7 @@ Returns flags about the validity of the tracking data for the given hand joint ( .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_linear_velocity**\ (\ joint\: :ref:`HandJoint`\ ) |const| +:ref:`Vector3` **get_hand_joint_linear_velocity**\ (\ joint\: :ref:`HandJoint`\ ) |const| :ref:`🔗` Returns the linear velocity for the given hand joint. @@ -497,7 +497,7 @@ Returns the linear velocity for the given hand joint. .. rst-class:: classref-method -:ref:`float` **get_hand_joint_radius**\ (\ joint\: :ref:`HandJoint`\ ) |const| +:ref:`float` **get_hand_joint_radius**\ (\ joint\: :ref:`HandJoint`\ ) |const| :ref:`🔗` Returns the radius of the given hand joint. @@ -509,7 +509,7 @@ Returns the radius of the given hand joint. .. rst-class:: classref-method -:ref:`Transform3D` **get_hand_joint_transform**\ (\ joint\: :ref:`HandJoint`\ ) |const| +:ref:`Transform3D` **get_hand_joint_transform**\ (\ joint\: :ref:`HandJoint`\ ) |const| :ref:`🔗` Returns the transform for the given hand joint. @@ -521,7 +521,7 @@ Returns the transform for the given hand joint. .. rst-class:: classref-method -|void| **set_hand_joint_angular_velocity**\ (\ joint\: :ref:`HandJoint`, angular_velocity\: :ref:`Vector3`\ ) +|void| **set_hand_joint_angular_velocity**\ (\ joint\: :ref:`HandJoint`, angular_velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets the angular velocity for the given hand joint. @@ -533,7 +533,7 @@ Sets the angular velocity for the given hand joint. .. rst-class:: classref-method -|void| **set_hand_joint_flags**\ (\ joint\: :ref:`HandJoint`, flags\: |bitfield|\[:ref:`HandJointFlags`\]\ ) +|void| **set_hand_joint_flags**\ (\ joint\: :ref:`HandJoint`, flags\: |bitfield|\[:ref:`HandJointFlags`\]\ ) :ref:`🔗` Sets flags about the validity of the tracking data for the given hand joint. @@ -545,7 +545,7 @@ Sets flags about the validity of the tracking data for the given hand joint. .. rst-class:: classref-method -|void| **set_hand_joint_linear_velocity**\ (\ joint\: :ref:`HandJoint`, linear_velocity\: :ref:`Vector3`\ ) +|void| **set_hand_joint_linear_velocity**\ (\ joint\: :ref:`HandJoint`, linear_velocity\: :ref:`Vector3`\ ) :ref:`🔗` Sets the linear velocity for the given hand joint. @@ -557,7 +557,7 @@ Sets the linear velocity for the given hand joint. .. rst-class:: classref-method -|void| **set_hand_joint_radius**\ (\ joint\: :ref:`HandJoint`, radius\: :ref:`float`\ ) +|void| **set_hand_joint_radius**\ (\ joint\: :ref:`HandJoint`, radius\: :ref:`float`\ ) :ref:`🔗` Sets the radius of the given hand joint. @@ -569,7 +569,7 @@ Sets the radius of the given hand joint. .. rst-class:: classref-method -|void| **set_hand_joint_transform**\ (\ joint\: :ref:`HandJoint`, transform\: :ref:`Transform3D`\ ) +|void| **set_hand_joint_transform**\ (\ joint\: :ref:`HandJoint`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform for the given hand joint. diff --git a/classes/class_xrinterface.rst b/classes/class_xrinterface.rst index a6fcc93adfd..ce3e8e907a7 100644 --- a/classes/class_xrinterface.rst +++ b/classes/class_xrinterface.rst @@ -117,7 +117,7 @@ Signals .. rst-class:: classref-signal -**play_area_changed**\ (\ mode\: :ref:`int`\ ) +**play_area_changed**\ (\ mode\: :ref:`int`\ ) :ref:`🔗` 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. @@ -134,7 +134,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **Capabilities**: +enum **Capabilities**: :ref:`🔗` .. _class_XRInterface_constant_XR_NONE: @@ -200,7 +200,7 @@ This interface outputs to an external device. If the main viewport is used, the .. rst-class:: classref-enumeration -enum **TrackingStatus**: +enum **TrackingStatus**: :ref:`🔗` .. _class_XRInterface_constant_XR_NORMAL_TRACKING: @@ -250,7 +250,7 @@ Tracking is not functional (camera not plugged in or obscured, lighthouses turne .. rst-class:: classref-enumeration -enum **PlayAreaMode**: +enum **PlayAreaMode**: :ref:`🔗` .. _class_XRInterface_constant_XR_PLAY_AREA_UNKNOWN: @@ -300,7 +300,7 @@ Same as :ref:`XR_PLAY_AREA_ROOMSCALE` .. _class_XRInterface_constant_XR_ENV_BLEND_MODE_OPAQUE: @@ -339,7 +339,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **ar_is_anchor_detection_enabled** = ``false`` +:ref:`bool` **ar_is_anchor_detection_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -356,7 +356,7 @@ On an AR interface, ``true`` if anchor detection is enabled. .. rst-class:: classref-property -:ref:`EnvironmentBlendMode` **environment_blend_mode** = ``0`` +:ref:`EnvironmentBlendMode` **environment_blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -373,7 +373,7 @@ Specify how XR should blend in the environment. This is specific to certain AR a .. rst-class:: classref-property -:ref:`bool` **interface_is_primary** = ``false`` +:ref:`bool` **interface_is_primary** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -390,7 +390,7 @@ Specify how XR should blend in the environment. This is specific to certain AR a .. rst-class:: classref-property -:ref:`PlayAreaMode` **xr_play_area_mode** = ``0`` +:ref:`PlayAreaMode` **xr_play_area_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -412,7 +412,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_camera_feed_id**\ (\ ) +:ref:`int` **get_camera_feed_id**\ (\ ) :ref:`🔗` If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the :ref:`CameraServer` for this interface. @@ -424,7 +424,7 @@ If this is an AR interface that requires displaying a camera feed as the backgro .. rst-class:: classref-method -:ref:`int` **get_capabilities**\ (\ ) |const| +:ref:`int` **get_capabilities**\ (\ ) |const| :ref:`🔗` Returns a combination of :ref:`Capabilities` flags providing information about the capabilities of this interface. @@ -436,7 +436,7 @@ Returns a combination of :ref:`Capabilities` flag .. rst-class:: classref-method -:ref:`StringName` **get_name**\ (\ ) |const| +:ref:`StringName` **get_name**\ (\ ) |const| :ref:`🔗` Returns the name of this interface (``"OpenXR"``, ``"OpenVR"``, ``"OpenHMD"``, ``"ARKit"``, etc.). @@ -448,7 +448,7 @@ Returns the name of this interface (``"OpenXR"``, ``"OpenVR"``, ``"OpenHMD"``, ` .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_play_area**\ (\ ) |const| +:ref:`PackedVector3Array` **get_play_area**\ (\ ) |const| :ref:`🔗` Returns an array of vectors that represent 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 visualize the play area. This returns an empty array if this feature is not supported or if the information is not yet available. @@ -460,7 +460,7 @@ Returns an array of vectors that represent the physical play area mapped to the .. rst-class:: classref-method -:ref:`Projection` **get_projection_for_view**\ (\ view\: :ref:`int`, aspect\: :ref:`float`, near\: :ref:`float`, far\: :ref:`float`\ ) +:ref:`Projection` **get_projection_for_view**\ (\ view\: :ref:`int`, aspect\: :ref:`float`, near\: :ref:`float`, far\: :ref:`float`\ ) :ref:`🔗` Returns the projection matrix for a view/eye. @@ -472,7 +472,7 @@ Returns the projection matrix for a view/eye. .. rst-class:: classref-method -:ref:`Vector2` **get_render_target_size**\ (\ ) +:ref:`Vector2` **get_render_target_size**\ (\ ) :ref:`🔗` Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. @@ -484,7 +484,7 @@ Returns the resolution at which we should render our intermediate results before .. rst-class:: classref-method -:ref:`Array` **get_supported_environment_blend_modes**\ (\ ) +:ref:`Array` **get_supported_environment_blend_modes**\ (\ ) :ref:`🔗` Returns the an array of supported environment blend modes, see :ref:`EnvironmentBlendMode`. @@ -496,7 +496,7 @@ Returns the an array of supported environment blend modes, see :ref:`Environment .. rst-class:: classref-method -:ref:`Dictionary` **get_system_info**\ (\ ) +:ref:`Dictionary` **get_system_info**\ (\ ) :ref:`🔗` Returns a :ref:`Dictionary` with extra system info. Interfaces are expected to return ``XRRuntimeName`` and ``XRRuntimeVersion`` providing info about the used XR runtime. Additional entries may be provided specific to an interface. @@ -510,7 +510,7 @@ Returns a :ref:`Dictionary` with extra system info. Interfaces .. rst-class:: classref-method -:ref:`TrackingStatus` **get_tracking_status**\ (\ ) |const| +:ref:`TrackingStatus` **get_tracking_status**\ (\ ) |const| :ref:`🔗` If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. @@ -522,7 +522,7 @@ If supported, returns the status of our tracking. This will allow you to provide .. rst-class:: classref-method -:ref:`Transform3D` **get_transform_for_view**\ (\ view\: :ref:`int`, cam_transform\: :ref:`Transform3D`\ ) +:ref:`Transform3D` **get_transform_for_view**\ (\ view\: :ref:`int`, cam_transform\: :ref:`Transform3D`\ ) :ref:`🔗` Returns the transform for a view/eye. @@ -538,7 +538,7 @@ Returns the transform for a view/eye. .. rst-class:: classref-method -:ref:`int` **get_view_count**\ (\ ) +:ref:`int` **get_view_count**\ (\ ) :ref:`🔗` Returns the number of views that need to be rendered for this device. 1 for Monoscopic, 2 for Stereoscopic. @@ -550,7 +550,7 @@ Returns the number of views that need to be rendered for this device. 1 for Mono .. rst-class:: classref-method -:ref:`bool` **initialize**\ (\ ) +:ref:`bool` **initialize**\ (\ ) :ref:`🔗` Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. @@ -570,7 +570,7 @@ While currently not used, you can activate additional interfaces. You may wish t .. rst-class:: classref-method -:ref:`bool` **is_initialized**\ (\ ) |const| +:ref:`bool` **is_initialized**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this interface has been initialized. @@ -582,7 +582,7 @@ Returns ``true`` if this interface has been initialized. .. rst-class:: classref-method -:ref:`bool` **is_passthrough_enabled**\ (\ ) +:ref:`bool` **is_passthrough_enabled**\ (\ ) :ref:`🔗` **Deprecated:** Check if :ref:`environment_blend_mode` is :ref:`XR_ENV_BLEND_MODE_ALPHA_BLEND`, instead. @@ -596,7 +596,7 @@ Returns ``true`` if passthrough is enabled. .. rst-class:: classref-method -:ref:`bool` **is_passthrough_supported**\ (\ ) +:ref:`bool` **is_passthrough_supported**\ (\ ) :ref:`🔗` **Deprecated:** Check that :ref:`XR_ENV_BLEND_MODE_ALPHA_BLEND` is supported using :ref:`get_supported_environment_blend_modes`, instead. @@ -610,7 +610,7 @@ Returns ``true`` if this interface supports passthrough. .. rst-class:: classref-method -:ref:`bool` **set_environment_blend_mode**\ (\ mode\: :ref:`EnvironmentBlendMode`\ ) +:ref:`bool` **set_environment_blend_mode**\ (\ mode\: :ref:`EnvironmentBlendMode`\ ) :ref:`🔗` Sets the active environment blend mode. @@ -640,7 +640,7 @@ Sets the active environment blend mode. .. rst-class:: classref-method -:ref:`bool` **set_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) +:ref:`bool` **set_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) :ref:`🔗` Sets the active play area mode, will return ``false`` if the mode can't be used with this interface. @@ -654,7 +654,7 @@ Sets the active play area mode, will return ``false`` if the mode can't be used .. rst-class:: classref-method -:ref:`bool` **start_passthrough**\ (\ ) +:ref:`bool` **start_passthrough**\ (\ ) :ref:`🔗` **Deprecated:** Set the :ref:`environment_blend_mode` to :ref:`XR_ENV_BLEND_MODE_ALPHA_BLEND`, instead. @@ -670,7 +670,7 @@ Starts passthrough, will return ``false`` if passthrough couldn't be started. .. rst-class:: classref-method -|void| **stop_passthrough**\ (\ ) +|void| **stop_passthrough**\ (\ ) :ref:`🔗` **Deprecated:** Set the :ref:`environment_blend_mode` to :ref:`XR_ENV_BLEND_MODE_OPAQUE`, instead. @@ -684,7 +684,7 @@ Stops passthrough. .. rst-class:: classref-method -:ref:`bool` **supports_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) +:ref:`bool` **supports_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) :ref:`🔗` Call this to find out if a given play area mode is supported by this interface. @@ -696,7 +696,7 @@ Call this to find out if a given play area mode is supported by this interface. .. rst-class:: classref-method -|void| **trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, tracker_name\: :ref:`StringName`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) +|void| **trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, tracker_name\: :ref:`StringName`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) :ref:`🔗` Triggers a haptic pulse on a device associated with this interface. @@ -712,7 +712,7 @@ Triggers a haptic pulse on a device associated with this interface. .. rst-class:: classref-method -|void| **uninitialize**\ (\ ) +|void| **uninitialize**\ (\ ) :ref:`🔗` Turns the interface off. diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index f4012d2014a..c3fd406e0dd 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **_end_frame**\ (\ ) |virtual| +|void| **_end_frame**\ (\ ) |virtual| :ref:`🔗` Called if interface is active and queues have been submitted. @@ -135,7 +135,7 @@ Called if interface is active and queues have been submitted. .. rst-class:: classref-method -:ref:`bool` **_get_anchor_detection_is_enabled**\ (\ ) |virtual| |const| +:ref:`bool` **_get_anchor_detection_is_enabled**\ (\ ) |virtual| |const| :ref:`🔗` Return ``true`` if anchor detection is enabled for this interface. @@ -147,7 +147,7 @@ Return ``true`` if anchor detection is enabled for this interface. .. rst-class:: classref-method -:ref:`int` **_get_camera_feed_id**\ (\ ) |virtual| |const| +:ref:`int` **_get_camera_feed_id**\ (\ ) |virtual| |const| :ref:`🔗` Returns the camera feed ID for the :ref:`CameraFeed` registered with the :ref:`CameraServer` that should be presented as the background on an AR capable device (if applicable). @@ -159,7 +159,7 @@ Returns the camera feed ID for the :ref:`CameraFeed` registere .. rst-class:: classref-method -:ref:`Transform3D` **_get_camera_transform**\ (\ ) |virtual| +:ref:`Transform3D` **_get_camera_transform**\ (\ ) |virtual| :ref:`🔗` Returns the :ref:`Transform3D` that positions the :ref:`XRCamera3D` in the world. @@ -171,7 +171,7 @@ Returns the :ref:`Transform3D` that positions the :ref:`XRCam .. rst-class:: classref-method -:ref:`int` **_get_capabilities**\ (\ ) |virtual| |const| +:ref:`int` **_get_capabilities**\ (\ ) |virtual| |const| :ref:`🔗` Returns the capabilities of this interface. @@ -183,7 +183,7 @@ Returns the capabilities of this interface. .. rst-class:: classref-method -:ref:`RID` **_get_color_texture**\ (\ ) |virtual| +:ref:`RID` **_get_color_texture**\ (\ ) |virtual| :ref:`🔗` Return color texture into which to render (if applicable). @@ -195,7 +195,7 @@ Return color texture into which to render (if applicable). .. rst-class:: classref-method -:ref:`RID` **_get_depth_texture**\ (\ ) |virtual| +:ref:`RID` **_get_depth_texture**\ (\ ) |virtual| :ref:`🔗` Return depth texture into which to render (if applicable). @@ -207,7 +207,7 @@ Return depth texture into which to render (if applicable). .. rst-class:: classref-method -:ref:`StringName` **_get_name**\ (\ ) |virtual| |const| +:ref:`StringName` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` Returns the name of this interface. @@ -219,7 +219,7 @@ Returns the name of this interface. .. rst-class:: classref-method -:ref:`PackedVector3Array` **_get_play_area**\ (\ ) |virtual| |const| +:ref:`PackedVector3Array` **_get_play_area**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`PackedVector3Array` that represents the play areas boundaries (if applicable). @@ -231,7 +231,7 @@ Returns a :ref:`PackedVector3Array` that represents th .. rst-class:: classref-method -:ref:`PlayAreaMode` **_get_play_area_mode**\ (\ ) |virtual| |const| +:ref:`PlayAreaMode` **_get_play_area_mode**\ (\ ) |virtual| |const| :ref:`🔗` Returns the play area mode that sets up our play area. @@ -243,7 +243,7 @@ Returns the play area mode that sets up our play area. .. rst-class:: classref-method -:ref:`PackedFloat64Array` **_get_projection_for_view**\ (\ view\: :ref:`int`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |virtual| +:ref:`PackedFloat64Array` **_get_projection_for_view**\ (\ view\: :ref:`int`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |virtual| :ref:`🔗` Returns the projection matrix for the given view as a :ref:`PackedFloat64Array`. @@ -255,7 +255,7 @@ Returns the projection matrix for the given view as a :ref:`PackedFloat64Array` **_get_render_target_size**\ (\ ) |virtual| +:ref:`Vector2` **_get_render_target_size**\ (\ ) |virtual| :ref:`🔗` Returns the size of our render target for this interface, this overrides the size of the :ref:`Viewport` marked as the xr viewport. @@ -267,7 +267,7 @@ Returns the size of our render target for this interface, this overrides the siz .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_suggested_pose_names**\ (\ tracker_name\: :ref:`StringName`\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_suggested_pose_names**\ (\ tracker_name\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`PackedStringArray` with pose names configured by this interface. Note that user configuration can override this list. @@ -279,7 +279,7 @@ Returns a :ref:`PackedStringArray` with pose names conf .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| |const| +:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`PackedStringArray` with tracker names configured by this interface. Note that user configuration can override this list. @@ -291,7 +291,7 @@ Returns a :ref:`PackedStringArray` with tracker names c .. rst-class:: classref-method -:ref:`Dictionary` **_get_system_info**\ (\ ) |virtual| |const| +:ref:`Dictionary` **_get_system_info**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`Dictionary` with system information related to this interface. @@ -303,7 +303,7 @@ Returns a :ref:`Dictionary` with system information related to .. rst-class:: classref-method -:ref:`TrackingStatus` **_get_tracking_status**\ (\ ) |virtual| |const| +:ref:`TrackingStatus` **_get_tracking_status**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`TrackingStatus` specifying the current status of our tracking. @@ -315,7 +315,7 @@ Returns a :ref:`TrackingStatus` specifying the .. rst-class:: classref-method -:ref:`Transform3D` **_get_transform_for_view**\ (\ view\: :ref:`int`, cam_transform\: :ref:`Transform3D`\ ) |virtual| +:ref:`Transform3D` **_get_transform_for_view**\ (\ view\: :ref:`int`, cam_transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` Returns a :ref:`Transform3D` for a given view. @@ -327,7 +327,7 @@ Returns a :ref:`Transform3D` for a given view. .. rst-class:: classref-method -:ref:`RID` **_get_velocity_texture**\ (\ ) |virtual| +:ref:`RID` **_get_velocity_texture**\ (\ ) |virtual| :ref:`🔗` Return velocity texture into which to render (if applicable). @@ -339,7 +339,7 @@ Return velocity texture into which to render (if applicable). .. rst-class:: classref-method -:ref:`int` **_get_view_count**\ (\ ) |virtual| +:ref:`int` **_get_view_count**\ (\ ) |virtual| :ref:`🔗` Returns the number of views this interface requires, 1 for mono, 2 for stereoscopic. @@ -351,7 +351,7 @@ Returns the number of views this interface requires, 1 for mono, 2 for stereosco .. rst-class:: classref-method -:ref:`RID` **_get_vrs_texture**\ (\ ) |virtual| +:ref:`RID` **_get_vrs_texture**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute @@ -365,7 +365,7 @@ Returns the number of views this interface requires, 1 for mono, 2 for stereosco .. rst-class:: classref-method -:ref:`bool` **_initialize**\ (\ ) |virtual| +:ref:`bool` **_initialize**\ (\ ) |virtual| :ref:`🔗` Initializes the interface, returns ``true`` on success. @@ -377,7 +377,7 @@ Initializes the interface, returns ``true`` on success. .. rst-class:: classref-method -:ref:`bool` **_is_initialized**\ (\ ) |virtual| |const| +:ref:`bool` **_is_initialized**\ (\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if this interface has been initialized. @@ -389,7 +389,7 @@ Returns ``true`` if this interface has been initialized. .. rst-class:: classref-method -|void| **_post_draw_viewport**\ (\ render_target\: :ref:`RID`, screen_rect\: :ref:`Rect2`\ ) |virtual| +|void| **_post_draw_viewport**\ (\ render_target\: :ref:`RID`, screen_rect\: :ref:`Rect2`\ ) |virtual| :ref:`🔗` Called after the XR :ref:`Viewport` draw logic has completed. @@ -401,7 +401,7 @@ Called after the XR :ref:`Viewport` draw logic has completed. .. rst-class:: classref-method -:ref:`bool` **_pre_draw_viewport**\ (\ render_target\: :ref:`RID`\ ) |virtual| +:ref:`bool` **_pre_draw_viewport**\ (\ render_target\: :ref:`RID`\ ) |virtual| :ref:`🔗` Called if this is our primary **XRInterfaceExtension** before we start processing a :ref:`Viewport` for every active XR :ref:`Viewport`, returns ``true`` if that viewport should be rendered. An XR interface may return ``false`` if the user has taken off their headset and we can pause rendering. @@ -413,7 +413,7 @@ Called if this is our primary **XRInterfaceExtension** before we start processin .. rst-class:: classref-method -|void| **_pre_render**\ (\ ) |virtual| +|void| **_pre_render**\ (\ ) |virtual| :ref:`🔗` Called if this **XRInterfaceExtension** is active before rendering starts. Most XR interfaces will sync tracking at this point in time. @@ -425,7 +425,7 @@ Called if this **XRInterfaceExtension** is active before rendering starts. Most .. rst-class:: classref-method -|void| **_process**\ (\ ) |virtual| +|void| **_process**\ (\ ) |virtual| :ref:`🔗` Called if this **XRInterfaceExtension** is active before our physics and game process is called. Most XR interfaces will update its :ref:`XRPositionalTracker`\ s at this point in time. @@ -437,7 +437,7 @@ Called if this **XRInterfaceExtension** is active before our physics and game pr .. rst-class:: classref-method -|void| **_set_anchor_detection_is_enabled**\ (\ enabled\: :ref:`bool`\ ) |virtual| +|void| **_set_anchor_detection_is_enabled**\ (\ enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Enables anchor detection on this interface if supported. @@ -449,7 +449,7 @@ Enables anchor detection on this interface if supported. .. rst-class:: classref-method -:ref:`bool` **_set_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| +:ref:`bool` **_set_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| :ref:`🔗` Set the play area mode for this interface. @@ -461,7 +461,7 @@ Set the play area mode for this interface. .. rst-class:: classref-method -:ref:`bool` **_supports_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| +:ref:`bool` **_supports_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if this interface supports this play area mode. @@ -473,7 +473,7 @@ Returns ``true`` if this interface supports this play area mode. .. rst-class:: classref-method -|void| **_trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, tracker_name\: :ref:`StringName`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) |virtual| +|void| **_trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, tracker_name\: :ref:`StringName`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) |virtual| :ref:`🔗` Triggers a haptic pulse to be emitted on the specified tracker. @@ -485,7 +485,7 @@ Triggers a haptic pulse to be emitted on the specified tracker. .. rst-class:: classref-method -|void| **_uninitialize**\ (\ ) |virtual| +|void| **_uninitialize**\ (\ ) |virtual| :ref:`🔗` Uninitialize the interface. @@ -497,7 +497,7 @@ Uninitialize the interface. .. rst-class:: classref-method -|void| **add_blit**\ (\ render_target\: :ref:`RID`, src_rect\: :ref:`Rect2`, dst_rect\: :ref:`Rect2i`, use_layer\: :ref:`bool`, layer\: :ref:`int`, apply_lens_distortion\: :ref:`bool`, eye_center\: :ref:`Vector2`, k1\: :ref:`float`, k2\: :ref:`float`, upscale\: :ref:`float`, aspect_ratio\: :ref:`float`\ ) +|void| **add_blit**\ (\ render_target\: :ref:`RID`, src_rect\: :ref:`Rect2`, dst_rect\: :ref:`Rect2i`, use_layer\: :ref:`bool`, layer\: :ref:`int`, apply_lens_distortion\: :ref:`bool`, eye_center\: :ref:`Vector2`, k1\: :ref:`float`, k2\: :ref:`float`, upscale\: :ref:`float`, aspect_ratio\: :ref:`float`\ ) :ref:`🔗` Blits our render results to screen optionally applying lens distortion. This can only be called while processing ``_commit_views``. @@ -509,7 +509,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. rst-class:: classref-method -:ref:`RID` **get_color_texture**\ (\ ) +:ref:`RID` **get_color_texture**\ (\ ) :ref:`🔗` .. container:: contribute @@ -523,7 +523,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. rst-class:: classref-method -:ref:`RID` **get_depth_texture**\ (\ ) +:ref:`RID` **get_depth_texture**\ (\ ) :ref:`🔗` .. container:: contribute @@ -537,7 +537,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. rst-class:: classref-method -:ref:`RID` **get_render_target_texture**\ (\ render_target\: :ref:`RID`\ ) +:ref:`RID` **get_render_target_texture**\ (\ render_target\: :ref:`RID`\ ) :ref:`🔗` Returns a valid :ref:`RID` for a texture to which we should render the current frame if supported by the interface. @@ -549,7 +549,7 @@ Returns a valid :ref:`RID` for a texture to which we should render th .. rst-class:: classref-method -:ref:`RID` **get_velocity_texture**\ (\ ) +:ref:`RID` **get_velocity_texture**\ (\ ) :ref:`🔗` .. container:: contribute diff --git a/classes/class_xrnode3d.rst b/classes/class_xrnode3d.rst index ed4d969adf6..675e6db7b89 100644 --- a/classes/class_xrnode3d.rst +++ b/classes/class_xrnode3d.rst @@ -77,7 +77,7 @@ Signals .. rst-class:: classref-signal -**tracking_changed**\ (\ tracking\: :ref:`bool`\ ) +**tracking_changed**\ (\ tracking\: :ref:`bool`\ ) :ref:`🔗` Emitted when the :ref:`tracker` starts or stops receiving updated tracking data for the :ref:`pose` being tracked. The ``tracking`` argument indicates whether the tracker is getting updated tracking data. @@ -94,7 +94,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`StringName` **pose** = ``&"default"`` +:ref:`StringName` **pose** = ``&"default"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -113,7 +113,7 @@ Godot defines number of standard pose names such as ``aim`` and ``grip`` but oth .. rst-class:: classref-property -:ref:`bool` **show_when_tracked** = ``false`` +:ref:`bool` **show_when_tracked** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -130,7 +130,7 @@ Enables showing the node when tracking starts, and hiding the node when tracking .. rst-class:: classref-property -:ref:`StringName` **tracker** = ``&""`` +:ref:`StringName` **tracker** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -154,7 +154,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_has_tracking_data**\ (\ ) |const| +:ref:`bool` **get_has_tracking_data**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`tracker` has current tracking data for the :ref:`pose` being tracked. @@ -166,7 +166,7 @@ Returns ``true`` if the :ref:`tracker` has curr .. rst-class:: classref-method -:ref:`bool` **get_is_active**\ (\ ) |const| +:ref:`bool` **get_is_active**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`tracker` has been registered and the :ref:`pose` is being tracked. @@ -178,7 +178,7 @@ Returns ``true`` if the :ref:`tracker` has been .. rst-class:: classref-method -:ref:`XRPose` **get_pose**\ (\ ) +:ref:`XRPose` **get_pose**\ (\ ) :ref:`🔗` Returns the :ref:`XRPose` containing the current state of the pose being tracked. This gives access to additional properties of this pose. @@ -190,7 +190,7 @@ Returns the :ref:`XRPose` containing the current state of the pose .. rst-class:: classref-method -|void| **trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) +|void| **trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) :ref:`🔗` Triggers a haptic pulse on a device associated with this interface. diff --git a/classes/class_xrorigin3d.rst b/classes/class_xrorigin3d.rst index 8eabb6d97dc..bb1b2731a27 100644 --- a/classes/class_xrorigin3d.rst +++ b/classes/class_xrorigin3d.rst @@ -61,7 +61,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`bool` **current** = ``false`` +:ref:`bool` **current** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -78,7 +78,7 @@ If ``true``, this origin node is currently being used by the :ref:`XRServer` **world_scale** = ``1.0`` +:ref:`float` **world_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_xrpose.rst b/classes/class_xrpose.rst index 6571df35d86..026ac18c5c3 100644 --- a/classes/class_xrpose.rst +++ b/classes/class_xrpose.rst @@ -77,7 +77,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TrackingConfidence**: +enum **TrackingConfidence**: :ref:`🔗` .. _class_XRPose_constant_XR_TRACKING_CONFIDENCE_NONE: @@ -116,7 +116,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -133,7 +133,7 @@ The angular velocity for this pose. .. rst-class:: classref-property -:ref:`bool` **has_tracking_data** = ``false`` +:ref:`bool` **has_tracking_data** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -150,7 +150,7 @@ If ``true`` our tracking data is up to date. If ``false`` we're no longer receiv .. rst-class:: classref-property -:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` +:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -167,7 +167,7 @@ The linear velocity of this pose. .. rst-class:: classref-property -:ref:`StringName` **name** = ``&""`` +:ref:`StringName` **name** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -192,7 +192,7 @@ The name of this pose. Pose names are often driven by an action map setup by the .. rst-class:: classref-property -:ref:`TrackingConfidence` **tracking_confidence** = ``0`` +:ref:`TrackingConfidence` **tracking_confidence** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -209,7 +209,7 @@ The tracking confidence for this pose, provides insight on how accurate the spat .. rst-class:: classref-property -:ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -231,7 +231,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **get_adjusted_transform**\ (\ ) |const| +:ref:`Transform3D` **get_adjusted_transform**\ (\ ) |const| :ref:`🔗` Returns the :ref:`transform` with world scale and our reference frame applied. This is the transform used to position :ref:`XRNode3D` objects. diff --git a/classes/class_xrpositionaltracker.rst b/classes/class_xrpositionaltracker.rst index c271861844e..5afb3a82a29 100644 --- a/classes/class_xrpositionaltracker.rst +++ b/classes/class_xrpositionaltracker.rst @@ -83,7 +83,7 @@ Signals .. rst-class:: classref-signal -**button_pressed**\ (\ name\: :ref:`String`\ ) +**button_pressed**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Emitted when a button on this tracker is pressed. Note that many XR runtimes allow other inputs to be mapped to buttons. @@ -95,7 +95,7 @@ Emitted when a button on this tracker is pressed. Note that many XR runtimes all .. rst-class:: classref-signal -**button_released**\ (\ name\: :ref:`String`\ ) +**button_released**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Emitted when a button on this tracker is released. @@ -107,7 +107,7 @@ Emitted when a button on this tracker is released. .. rst-class:: classref-signal -**input_float_changed**\ (\ name\: :ref:`String`, value\: :ref:`float`\ ) +**input_float_changed**\ (\ name\: :ref:`String`, value\: :ref:`float`\ ) :ref:`🔗` Emitted when a trigger or similar input on this tracker changes value. @@ -119,7 +119,7 @@ Emitted when a trigger or similar input on this tracker changes value. .. rst-class:: classref-signal -**input_vector2_changed**\ (\ name\: :ref:`String`, vector\: :ref:`Vector2`\ ) +**input_vector2_changed**\ (\ name\: :ref:`String`, vector\: :ref:`Vector2`\ ) :ref:`🔗` Emitted when a thumbstick or thumbpad on this tracker moves. @@ -131,7 +131,7 @@ Emitted when a thumbstick or thumbpad on this tracker moves. .. rst-class:: classref-signal -**pose_changed**\ (\ pose\: :ref:`XRPose`\ ) +**pose_changed**\ (\ pose\: :ref:`XRPose`\ ) :ref:`🔗` Emitted when the state of a pose tracked by this tracker changes. @@ -143,7 +143,7 @@ Emitted when the state of a pose tracked by this tracker changes. .. rst-class:: classref-signal -**pose_lost_tracking**\ (\ pose\: :ref:`XRPose`\ ) +**pose_lost_tracking**\ (\ pose\: :ref:`XRPose`\ ) :ref:`🔗` Emitted when a pose tracked by this tracker stops getting updated tracking data. @@ -155,7 +155,7 @@ Emitted when a pose tracked by this tracker stops getting updated tracking data. .. rst-class:: classref-signal -**profile_changed**\ (\ role\: :ref:`String`\ ) +**profile_changed**\ (\ role\: :ref:`String`\ ) :ref:`🔗` Emitted when the profile of our tracker changes. @@ -172,7 +172,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TrackerHand**: +enum **TrackerHand**: :ref:`🔗` .. _class_XRPositionalTracker_constant_TRACKER_HAND_UNKNOWN: @@ -219,7 +219,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`TrackerHand` **hand** = ``0`` +:ref:`TrackerHand` **hand** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -236,7 +236,7 @@ Defines which hand this tracker relates to. .. rst-class:: classref-property -:ref:`String` **profile** = ``""`` +:ref:`String` **profile** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -258,7 +258,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_input**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`Variant` **get_input**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` **Deprecated:** Use through :ref:`XRControllerTracker`. @@ -272,7 +272,7 @@ Returns an input for this tracker. It can return a boolean, float or :ref:`Vecto .. rst-class:: classref-method -:ref:`XRPose` **get_pose**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`XRPose` **get_pose**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the current :ref:`XRPose` state object for the bound ``name`` pose. @@ -284,7 +284,7 @@ Returns the current :ref:`XRPose` state object for the bound ``nam .. rst-class:: classref-method -:ref:`bool` **has_pose**\ (\ name\: :ref:`StringName`\ ) |const| +:ref:`bool` **has_pose**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the tracker is available and is currently tracking the bound ``name`` pose. @@ -296,7 +296,7 @@ Returns ``true`` if the tracker is available and is currently tracking the bound .. rst-class:: classref-method -|void| **invalidate_pose**\ (\ name\: :ref:`StringName`\ ) +|void| **invalidate_pose**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` 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 lose tracking or just remain at their last known position. @@ -308,7 +308,7 @@ Marks this pose as invalid, we don't clear the last reported state but it allows .. rst-class:: classref-method -|void| **set_input**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) +|void| **set_input**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Use through :ref:`XRControllerTracker`. @@ -322,7 +322,7 @@ Changes the value for the given input. This method is called by a :ref:`XRInterf .. rst-class:: classref-method -|void| **set_pose**\ (\ name\: :ref:`StringName`, transform\: :ref:`Transform3D`, linear_velocity\: :ref:`Vector3`, angular_velocity\: :ref:`Vector3`, tracking_confidence\: :ref:`TrackingConfidence`\ ) +|void| **set_pose**\ (\ name\: :ref:`StringName`, transform\: :ref:`Transform3D`, linear_velocity\: :ref:`Vector3`, angular_velocity\: :ref:`Vector3`, tracking_confidence\: :ref:`TrackingConfidence`\ ) :ref:`🔗` Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by a :ref:`XRInterface` implementation and should not be used directly. diff --git a/classes/class_xrserver.rst b/classes/class_xrserver.rst index 938e456dbc4..d1721cc7086 100644 --- a/classes/class_xrserver.rst +++ b/classes/class_xrserver.rst @@ -95,7 +95,7 @@ Signals .. rst-class:: classref-signal -**interface_added**\ (\ interface_name\: :ref:`StringName`\ ) +**interface_added**\ (\ interface_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when a new interface has been added. @@ -107,7 +107,7 @@ Emitted when a new interface has been added. .. rst-class:: classref-signal -**interface_removed**\ (\ interface_name\: :ref:`StringName`\ ) +**interface_removed**\ (\ interface_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when an interface is removed. @@ -115,11 +115,23 @@ Emitted when an interface is removed. ---- +.. _class_XRServer_signal_reference_frame_changed: + +.. rst-class:: classref-signal + +**reference_frame_changed**\ (\ ) :ref:`🔗` + +Emitted when the reference frame transform changes. + +.. rst-class:: classref-item-separator + +---- + .. _class_XRServer_signal_tracker_added: .. rst-class:: classref-signal -**tracker_added**\ (\ tracker_name\: :ref:`StringName`, type\: :ref:`int`\ ) +**tracker_added**\ (\ tracker_name\: :ref:`StringName`, type\: :ref:`int`\ ) :ref:`🔗` 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. @@ -131,7 +143,7 @@ Emitted when a new tracker has been added. If you don't use a fixed number of co .. rst-class:: classref-signal -**tracker_removed**\ (\ tracker_name\: :ref:`StringName`, type\: :ref:`int`\ ) +**tracker_removed**\ (\ tracker_name\: :ref:`StringName`, type\: :ref:`int`\ ) :ref:`🔗` 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). @@ -143,7 +155,7 @@ Emitted when a tracker is removed. You should remove any :ref:`XRController3D`, type\: :ref:`int`\ ) +**tracker_updated**\ (\ tracker_name\: :ref:`StringName`, type\: :ref:`int`\ ) :ref:`🔗` Emitted when an existing tracker has been updated. This can happen if the user switches controllers. @@ -160,7 +172,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **TrackerType**: +enum **TrackerType**: :ref:`🔗` .. _class_XRServer_constant_TRACKER_HEAD: @@ -250,7 +262,7 @@ Used internally to select all trackers. .. rst-class:: classref-enumeration -enum **RotationMode**: +enum **RotationMode**: :ref:`🔗` .. _class_XRServer_constant_RESET_FULL_ROTATION: @@ -289,7 +301,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`XRInterface` **primary_interface** +:ref:`XRInterface` **primary_interface** :ref:`🔗` .. rst-class:: classref-property-setget @@ -306,7 +318,7 @@ The primary :ref:`XRInterface` currently bound to the **XRSer .. rst-class:: classref-property -:ref:`Transform3D` **world_origin** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` +:ref:`Transform3D` **world_origin** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -325,7 +337,7 @@ The current origin of our tracking space in the virtual world. This is used by t .. rst-class:: classref-property -:ref:`float` **world_scale** = ``1.0`` +:ref:`float` **world_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -347,7 +359,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_interface**\ (\ interface\: :ref:`XRInterface`\ ) +|void| **add_interface**\ (\ interface\: :ref:`XRInterface`\ ) :ref:`🔗` Registers an :ref:`XRInterface` object. @@ -359,7 +371,7 @@ Registers an :ref:`XRInterface` object. .. rst-class:: classref-method -|void| **add_tracker**\ (\ tracker\: :ref:`XRTracker`\ ) +|void| **add_tracker**\ (\ tracker\: :ref:`XRTracker`\ ) :ref:`🔗` Registers a new :ref:`XRTracker` that tracks a physical object. @@ -371,7 +383,7 @@ Registers a new :ref:`XRTracker` that tracks a physical object. .. rst-class:: classref-method -|void| **center_on_hmd**\ (\ rotation_mode\: :ref:`RotationMode`, keep_height\: :ref:`bool`\ ) +|void| **center_on_hmd**\ (\ rotation_mode\: :ref:`RotationMode`, keep_height\: :ref:`bool`\ ) :ref:`🔗` This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently. @@ -393,7 +405,7 @@ You should call this method after a few seconds have passed. For example, when t .. rst-class:: classref-method -|void| **clear_reference_frame**\ (\ ) +|void| **clear_reference_frame**\ (\ ) :ref:`🔗` Clears the reference frame that was set by previous calls to :ref:`center_on_hmd`. @@ -405,7 +417,7 @@ Clears the reference frame that was set by previous calls to :ref:`center_on_hmd .. rst-class:: classref-method -:ref:`XRInterface` **find_interface**\ (\ name\: :ref:`String`\ ) |const| +:ref:`XRInterface` **find_interface**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Finds an interface by its ``name``. For example, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. @@ -417,7 +429,7 @@ Finds an interface by its ``name``. For example, if your project uses capabiliti .. rst-class:: classref-method -:ref:`Transform3D` **get_hmd_transform**\ (\ ) +:ref:`Transform3D` **get_hmd_transform**\ (\ ) :ref:`🔗` Returns the primary interface's transformation. @@ -429,7 +441,7 @@ Returns the primary interface's transformation. .. rst-class:: classref-method -:ref:`XRInterface` **get_interface**\ (\ idx\: :ref:`int`\ ) |const| +:ref:`XRInterface` **get_interface**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the interface registered at the given ``idx`` index in the list of interfaces. @@ -441,7 +453,7 @@ Returns the interface registered at the given ``idx`` index in the list of inter .. rst-class:: classref-method -:ref:`int` **get_interface_count**\ (\ ) |const| +:ref:`int` **get_interface_count**\ (\ ) |const| :ref:`🔗` Returns the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns ``true``. @@ -453,7 +465,7 @@ Returns the number of interfaces currently registered with the AR/VR server. If .. rst-class:: classref-method -:ref:`Array`\[:ref:`Dictionary`\] **get_interfaces**\ (\ ) |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_interfaces**\ (\ ) |const| :ref:`🔗` Returns a list of available interfaces the ID and name of each interface. @@ -465,7 +477,7 @@ Returns a list of available interfaces the ID and name of each interface. .. rst-class:: classref-method -:ref:`Transform3D` **get_reference_frame**\ (\ ) |const| +:ref:`Transform3D` **get_reference_frame**\ (\ ) |const| :ref:`🔗` Returns the reference frame transform. Mostly used internally and exposed for GDExtension build interfaces. @@ -477,7 +489,7 @@ Returns the reference frame transform. Mostly used internally and exposed for GD .. rst-class:: classref-method -:ref:`XRTracker` **get_tracker**\ (\ tracker_name\: :ref:`StringName`\ ) |const| +:ref:`XRTracker` **get_tracker**\ (\ tracker_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the positional tracker with the given ``tracker_name``. @@ -489,7 +501,7 @@ Returns the positional tracker with the given ``tracker_name``. .. rst-class:: classref-method -:ref:`Dictionary` **get_trackers**\ (\ tracker_types\: :ref:`int`\ ) +:ref:`Dictionary` **get_trackers**\ (\ tracker_types\: :ref:`int`\ ) :ref:`🔗` Returns a dictionary of trackers for ``tracker_types``. @@ -501,7 +513,7 @@ Returns a dictionary of trackers for ``tracker_types``. .. rst-class:: classref-method -|void| **remove_interface**\ (\ interface\: :ref:`XRInterface`\ ) +|void| **remove_interface**\ (\ interface\: :ref:`XRInterface`\ ) :ref:`🔗` Removes this ``interface``. @@ -513,7 +525,7 @@ Removes this ``interface``. .. rst-class:: classref-method -|void| **remove_tracker**\ (\ tracker\: :ref:`XRTracker`\ ) +|void| **remove_tracker**\ (\ tracker\: :ref:`XRTracker`\ ) :ref:`🔗` Removes this ``tracker``. diff --git a/classes/class_xrtracker.rst b/classes/class_xrtracker.rst index ec088b12469..63219a3b862 100644 --- a/classes/class_xrtracker.rst +++ b/classes/class_xrtracker.rst @@ -59,7 +59,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`String` **description** = ``""`` +:ref:`String` **description** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -76,7 +76,7 @@ The description of this tracker. .. rst-class:: classref-property -:ref:`StringName` **name** = ``&"Unknown"`` +:ref:`StringName` **name** = ``&"Unknown"`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -107,7 +107,7 @@ The unique name of this tracker. The trackers that are available differ between .. rst-class:: classref-property -:ref:`TrackerType` **type** = ``128`` +:ref:`TrackerType` **type** = ``128`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_xrvrs.rst b/classes/class_xrvrs.rst index 0340079a2b4..2bfabac8587 100644 --- a/classes/class_xrvrs.rst +++ b/classes/class_xrvrs.rst @@ -60,7 +60,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`float` **vrs_min_radius** = ``20.0`` +:ref:`float` **vrs_min_radius** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -77,7 +77,7 @@ The minimum radius around the focal point where full quality is guaranteed if VR .. rst-class:: classref-property -:ref:`float` **vrs_strength** = ``1.0`` +:ref:`float` **vrs_strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **make_vrs_texture**\ (\ target_size\: :ref:`Vector2`, eye_foci\: :ref:`PackedVector2Array`\ ) +:ref:`RID` **make_vrs_texture**\ (\ target_size\: :ref:`Vector2`, eye_foci\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Generates the VRS texture based on a render ``target_size`` adjusted by our VRS tile size. For each eyes focal point passed in ``eye_foci`` a layer is created. Focal point should be in NDC. diff --git a/classes/class_zippacker.rst b/classes/class_zippacker.rst index 8aed1b74b71..2b8b9461125 100644 --- a/classes/class_zippacker.rst +++ b/classes/class_zippacker.rst @@ -68,7 +68,7 @@ Enumerations .. rst-class:: classref-enumeration -enum **ZipAppend**: +enum **ZipAppend**: :ref:`🔗` .. _class_ZIPPacker_constant_APPEND_CREATE: @@ -107,7 +107,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **close**\ (\ ) +:ref:`Error` **close**\ (\ ) :ref:`🔗` Closes the underlying resources used by this instance. @@ -119,7 +119,7 @@ Closes the underlying resources used by this instance. .. rst-class:: classref-method -:ref:`Error` **close_file**\ (\ ) +:ref:`Error` **close_file**\ (\ ) :ref:`🔗` Stops writing to a file within the archive. @@ -133,7 +133,7 @@ It will fail if there is no open file. .. rst-class:: classref-method -:ref:`Error` **open**\ (\ path\: :ref:`String`, append\: :ref:`ZipAppend` = 0\ ) +:ref:`Error` **open**\ (\ path\: :ref:`String`, append\: :ref:`ZipAppend` = 0\ ) :ref:`🔗` Opens a zip file for writing at the given path using the specified write mode. @@ -147,7 +147,7 @@ This must be called before everything else. .. rst-class:: classref-method -:ref:`Error` **start_file**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **start_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Starts writing to a file within the archive. Only one file can be written at the same time. @@ -161,7 +161,7 @@ Must be called after :ref:`open`. .. rst-class:: classref-method -:ref:`Error` **write_file**\ (\ data\: :ref:`PackedByteArray`\ ) +:ref:`Error` **write_file**\ (\ data\: :ref:`PackedByteArray`\ ) :ref:`🔗` Write the given ``data`` to the file. diff --git a/classes/class_zipreader.rst b/classes/class_zipreader.rst index ab40abc3f59..a97bb716d6f 100644 --- a/classes/class_zipreader.rst +++ b/classes/class_zipreader.rst @@ -65,7 +65,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **close**\ (\ ) +:ref:`Error` **close**\ (\ ) :ref:`🔗` Closes the underlying resources used by this instance. @@ -77,7 +77,7 @@ Closes the underlying resources used by this instance. .. rst-class:: classref-method -:ref:`bool` **file_exists**\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) +:ref:`bool` **file_exists**\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) :ref:`🔗` Returns ``true`` if the file exists in the loaded zip archive. @@ -91,7 +91,7 @@ Must be called after :ref:`open`. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_files**\ (\ ) +:ref:`PackedStringArray` **get_files**\ (\ ) :ref:`🔗` Returns the list of names of all files in the loaded archive. @@ -105,7 +105,7 @@ Must be called after :ref:`open`. .. rst-class:: classref-method -:ref:`Error` **open**\ (\ path\: :ref:`String`\ ) +:ref:`Error` **open**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Opens the zip archive at the given ``path`` and reads its file index. @@ -117,7 +117,7 @@ Opens the zip archive at the given ``path`` and reads its file index. .. rst-class:: classref-method -:ref:`PackedByteArray` **read_file**\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) +:ref:`PackedByteArray` **read_file**\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) :ref:`🔗` Loads the whole content of a file in the loaded zip archive into memory and returns it. diff --git a/classes/index.rst b/classes/index.rst index 859af3a6b63..9d0275ef3dd 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -767,7 +767,6 @@ Other objects class_gdextensionmanager class_geometry2d class_geometry3d - class_godotsharp class_hashingcontext class_hmaccontext class_httpclient